Mezzanine::Graphics::Procedural::PlaneUVModifier Class Reference

A modifier that will generate UV coordinates as they would need to be on a plane model. More...

#include <planeuvmodifier.h>

Inheritance diagram for Mezzanine::Graphics::Procedural::PlaneUVModifier:

Collaboration diagram for Mezzanine::Graphics::Procedural::PlaneUVModifier:

Public Member Functions
	PlaneUVModifier ()
	Blank constructor.
virtual	~PlaneUVModifier ()
	Class destructor.
virtual String	GetName () const
	Gets the name of this modifier. More...
virtual void	Modify (TriangleBuffer &Buffer)
	Alters the generated pixels in a TriangleBuffer. More...
PlaneUVModifier &	SetPlaneCenter (const Vector3 &Center)
	Sets the central location of the Plane to project UV's onto. More...
PlaneUVModifier &	SetPlaneCenter (const Real X, const Real Y, const Real Z)
	Sets the central location of the Plane to project UV's onto. More...
PlaneUVModifier &	SetPlaneNormal (const Vector3 &Normal)
	Sets the facing direction of the Plane to project UV's onto. More...
PlaneUVModifier &	SetPlaneNormal (const Real X, const Real Y, const Real Z)
	Sets the facing direction of the Plane to project UV's onto. More...
PlaneUVModifier &	SetPlaneSize (const Vector2 &Size)
	Sets the size of the Plane to project UV's onto. More...
PlaneUVModifier &	SetPlaneSize (const Real X, const Real Y)
	Sets the size of the Plane to project UV's onto. More...
Public Member Functions inherited from Mezzanine::Graphics::Procedural::MeshModifier
	MeshModifier ()
	Blank constructor.
virtual	~MeshModifier ()
	Class destructor.

Protected Attributes
Vector3	PlaneCenter
	The location of the center of the Plane. More...
Vector3	PlaneNormal
	The facing direction of the Plane. More...
Vector2	PlaneSize
	The size of the bounded area of the plane. More...

Detailed Description

A modifier that will generate UV coordinates as they would need to be on a plane model.

Definition at line 82 of file planeuvmodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::PlaneUVModifier::GetName ( ) const

virtual

Gets the name of this modifier.

Returns

Returns a string containing the name of this modifier.

Implements Mezzanine::Graphics::Procedural::MeshModifier.

Definition at line 99 of file planeuvmodifier.cpp.

void Mezzanine::Graphics::Procedural::PlaneUVModifier::Modify ( TriangleBuffer &  Buffer )

virtual

Alters the generated pixels in a TriangleBuffer.

Parameters

Buffer

The buffer to be modified.

Implements Mezzanine::Graphics::Procedural::MeshModifier.

Definition at line 87 of file planeuvmodifier.cpp.

PlaneUVModifier & Mezzanine::Graphics::Procedural::PlaneUVModifier::SetPlaneCenter

(

const Vector3 &

Center

)

Sets the central location of the Plane to project UV's onto.

Parameters

Center

The location of the center of the Plane.

Returns

Returns a reference to this.

Definition at line 107 of file planeuvmodifier.cpp.

PlaneUVModifier & Mezzanine::Graphics::Procedural::PlaneUVModifier::SetPlaneCenter	(	const Real	X,
		const Real	Y,
		const Real	Z
	)

Sets the central location of the Plane to project UV's onto.

Parameters

X	The location of the center of the Plane on the X axis.
Y	The location of the center of the Plane on the Y axis.
Z	The location of the center of the Plane on the Z axis.

Returns

Returns a reference to this.

Definition at line 113 of file planeuvmodifier.cpp.

PlaneUVModifier & Mezzanine::Graphics::Procedural::PlaneUVModifier::SetPlaneNormal

(

const Vector3 &

Normal

)

Sets the facing direction of the Plane to project UV's onto.

Parameters

Normal

The facing direction of the Plane.

Returns

Returns a reference to this.

Definition at line 119 of file planeuvmodifier.cpp.

PlaneUVModifier & Mezzanine::Graphics::Procedural::PlaneUVModifier::SetPlaneNormal	(	const Real	X,
		const Real	Y,
		const Real	Z
	)

Sets the facing direction of the Plane to project UV's onto.

Parameters

X	The X component of the directional vector the Plane is facing.
Y	The Y component of the directional vector the Plane is facing.
Z	The Z component of the directional vector the Plane is facing.

Returns

Returns a reference to this.

Definition at line 125 of file planeuvmodifier.cpp.

PlaneUVModifier & Mezzanine::Graphics::Procedural::PlaneUVModifier::SetPlaneSize

(

const Vector2 &

Size

)

Sets the size of the Plane to project UV's onto.

Parameters

Size	The size of the bounded area of the Plane.

Returns

Returns a reference to this.

Definition at line 131 of file planeuvmodifier.cpp.

PlaneUVModifier & Mezzanine::Graphics::Procedural::PlaneUVModifier::SetPlaneSize	(	const Real	X,
		const Real	Y
	)

Sets the size of the Plane to project UV's onto.

Parameters

X	The size of the bounded area of the Plane on the X axis.
Y	The size of the bounded area of the Plane on the Y axis.

Returns

Returns a reference to this.

Definition at line 137 of file planeuvmodifier.cpp.

Member Data Documentation

Vector3 Mezzanine::Graphics::Procedural::PlaneUVModifier::PlaneCenter

protected

The location of the center of the Plane.

Definition at line 87 of file planeuvmodifier.h.

Vector3 Mezzanine::Graphics::Procedural::PlaneUVModifier::PlaneNormal

protected

The facing direction of the Plane.

Definition at line 90 of file planeuvmodifier.h.

Vector2 Mezzanine::Graphics::Procedural::PlaneUVModifier::PlaneSize

protected

The size of the bounded area of the plane.

Definition at line 93 of file planeuvmodifier.h.

---

The documentation for this class was generated from the following files:

• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Graphics/Procedural/Mesh/planeuvmodifier.h
• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Graphics/Procedural/Mesh/planeuvmodifier.cpp