Mezzanine::Graphics::Procedural::SpherifyModifier Class Reference

A modifier that will increase or decrease the distance to a point to match a specified radius. More...

#include <spherifymodifier.h>

Inheritance diagram for Mezzanine::Graphics::Procedural::SpherifyModifier:

Collaboration diagram for Mezzanine::Graphics::Procedural::SpherifyModifier:

Public Member Functions
	SpherifyModifier ()
	Blank constructor.
virtual	~SpherifyModifier ()
	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...
SpherifyModifier &	SetSphereCenter (const Vector3 &Center)
	Sets the location of the sphere to project to. More...
SpherifyModifier &	SetSphereCenter (const Real X, const Real Y, const Real Z)
	Sets the location of the sphere to project to. More...
SpherifyModifier &	SetSphereRadius (const Real Radius)
	Sets the size of the sphere to project onto. More...
Public Member Functions inherited from Mezzanine::Graphics::Procedural::MeshModifier
	MeshModifier ()
	Blank constructor.
virtual	~MeshModifier ()
	Class destructor.

Protected Attributes
Vector3	SphereCenter
	The central point for the sphere to project vertices onto. More...
Real	SphereRadius
	The radius of the sphere to project vertices onto. More...

Detailed Description

A modifier that will increase or decrease the distance to a point to match a specified radius.

Definition at line 82 of file spherifymodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::SpherifyModifier::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 106 of file spherifymodifier.cpp.

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

virtual

Alters the generated pixels in a TriangleBuffer.

Parameters

Buffer

The buffer to be modified.

Exceptions

If	the SphereRadius is 0 or less when this is called an INVALID_STATE_EXCEPTION will be thrown.

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

Definition at line 90 of file spherifymodifier.cpp.

SpherifyModifier & Mezzanine::Graphics::Procedural::SpherifyModifier::SetSphereCenter

(

const Vector3 &

Center

)

Sets the location of the sphere to project to.

Parameters

Center

The central point for the sphere to project vertices onto.

Returns

Return a reference to this.

Definition at line 112 of file spherifymodifier.cpp.

SpherifyModifier & Mezzanine::Graphics::Procedural::SpherifyModifier::SetSphereCenter	(	const Real	X,
		const Real	Y,
		const Real	Z
	)

Sets the location of the sphere to project to.

Parameters

X	The central point on the X axis for the sphere to project vertices onto.
Y	The central point on the Y axis for the sphere to project vertices onto.
Z	The central point on the Z axis for the sphere to project vertices onto.

Returns

Return a reference to this.

Definition at line 118 of file spherifymodifier.cpp.

SpherifyModifier & Mezzanine::Graphics::Procedural::SpherifyModifier::SetSphereRadius

(

const Real

Radius

)

Sets the size of the sphere to project onto.

Parameters

Radius

The radius of the sphere to project vertices onto.

Returns

Return a reference to this.

Definition at line 124 of file spherifymodifier.cpp.

Member Data Documentation

Vector3 Mezzanine::Graphics::Procedural::SpherifyModifier::SphereCenter

protected

The central point for the sphere to project vertices onto.

Definition at line 87 of file spherifymodifier.h.

Real Mezzanine::Graphics::Procedural::SpherifyModifier::SphereRadius

protected

The radius of the sphere to project vertices onto.

Definition at line 90 of file spherifymodifier.h.

---

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

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