CuboidEntity Class Reference

Cuboid entity. More...

#include <CuboidEntity.h>

Inheritance diagram for CuboidEntity:

[legend]Collaboration diagram for CuboidEntity:

[legend]List of all members.

Public Member Functions
void	deserialize (XMLNode *from)
	Read entity properties and set its in object.
void	setTransformMatrix (TransformMatrix *matrix)
	Set transofrmation matrix.
void	divide (float size)
	Perform patch division.
PatchSequenceEnumerator *	createPatchSequenceEnumerator ()
	Create enumerator for entity's patches.
TriangleSetExt *	computeVertexColors ()
	Compute per-vertex colors using simple interpolation.
XMLNode	serialize ()
	Entity serialization to XMLNode.
void	setName (XMLNode *from, const char *implicit="entity")
	All entities in input file can have explicit name. And this method set it.
void	setName (std::string name)
	Set entity name.
std::string &	getName ()
	Get name of entity.
Static Public Member Functions
static Entity *	create (XMLNode *from)
	Create a instantiate of special entity class.
static bool	colorFromXMLNode (XMLNode *from, XMLCSTR attName, Color &to, int wlevel=2)
	Read color value from attribute of XMLNode and create its object representation.
static void	setColors (XMLNode *from, Color &em, Color &refl, Color &rad)
	Read three colors from XMLnode from specified attributs and ctore its valeus.
Protected Member Functions
void	addTriangle (Triangle *triangle)
	Add triangle to entity using tranformation matrix.

---

Detailed Description

Cuboid entity.

This entity has cuboid as base shape. Size of the cuboid is 1.0x1.0x1.0 and center is in Vertex(0.0, 0.0, 0.0). See documentation of Entity class for more information about transformations, patch division, etc.

Definition at line 20 of file CuboidEntity.h.

---

Member Function Documentation

void CuboidEntity::deserialize

(

XMLNode *

from

)

[virtual]

Read entity properties and set its in object.

Parameters:

from

XMLNode which has tagname cuboid

Reimplemented from Entity.

static Entity* Entity::create

(

XMLNode *

from

)

[static, inherited]

Create a instantiate of special entity class.

Parameters:

from

XMLNode containing entity declaration.

Returns:

entity created from XMLNode

void Entity::setTransformMatrix

(

TransformMatrix *

matrix

)

[inherited]

Set transofrmation matrix.

Attention:

Calling this method after deserialize has no effect.

Parameters:

matrix

Transformation matrix to set. There is no need to keep it in memory after call of this method.

void Entity::divide

(

float

size

)

[inherited]

Perform patch division.

Parameters:

size

Size of the largest acceptable patch.

PatchSequenceEnumerator* Entity::createPatchSequenceEnumerator

(

)

[inherited]

Create enumerator for entity's patches.

Returns:

Return instance of PatchSequenceEnumerator allocated on the heap.

TriangleSetExt* Entity::computeVertexColors

(

)

[inherited]

Compute per-vertex colors using simple interpolation.

Returns:

Return instance of TriangleSetExt allocated on the heap.

XMLNode Entity::serialize

(

)

[inherited]

Entity serialization to XMLNode.

Returns:

XMLNode wich is representation of entity.

void Entity::setName	(	XMLNode *	from,
		const char *	implicit = "entity"
	)			[inherited]

All entities in input file can have explicit name. And this method set it.

Parameters:

	from	XMLNode wich contains entity declaration.
	implicit	name when in xml doesn't exist

void Entity::setName

(

std::string

name

)

[inline, inherited]

Set entity name.

Parameters:

name

of entity

Definition at line 99 of file Entity.h.

std::string& Entity::getName

(

)

[inline, inherited]

Get name of entity.

Returns:

Name of entity

Definition at line 105 of file Entity.h.

static bool Entity::colorFromXMLNode	(	XMLNode *	from,
		XMLCSTR	attName,
		Color &	to,
		int	wlevel = 2
	)			[static, inherited]

Read color value from attribute of XMLNode and create its object representation.

Parameters:

	from	XMLnode with attribute contains color value
	attName	name of attribute with color
	to	reference of object to store value
	wlevel	is warnings level

Returns:

treu if color is succesfuly read and stored

static void Entity::setColors	(	XMLNode *	from,
		Color &	em,
		Color &	refl,
		Color &	rad
	)			[static, inherited]

Read three colors from XMLnode from specified attributs and ctore its valeus.

Parameters:

	from	XMLNode containing entity declaration.
	em	Emmision color value
	refl	Reflectiovity color value
	rad	Radiosity color value

void Entity::addTriangle

(

Triangle *

triangle

)

[protected, inherited]

Add triangle to entity using tranformation matrix.

Parameters:

triangle

Triangle to add.

---

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

• CuboidEntity.h

---