ScEng::Point3FController Class Reference

The Controller for the Point3F. More...

#include <control.h>

Inheritance diagram for ScEng::Point3FController:

List of all members.

Public Member Functions
	Point3FController (bool create_dependencies)
std::string	GetClassName ()
BlockType	GetBlockType ()
int	NumDependencies ()
void	SetDependency (int id, Block *se_block)
Block *	GetDependency (int id)
std::string	GetDependencyName (int id)
	Gets the name for the specified dependency.
int	GetNumDataTables ()
	Returns the number of DataTables for this class.
DataTable *	GetDataTable (int id=0)
	Returns the specified DataTable.
void	SetDataTable (DataTable *d, int i=0)
	Sets the i_th data table.
void	UpdateDataTable (int id=0)
	Updates the DataTable.
int	Save (SceneSave *scene_save)
	Saves the info for this class.
int	Load (SceneLoad *scene_load)
	Loads the info for this class.
void	DeleteThis ()
	Delete this class.
void	ActionBegin (int time, int action)
void	ActionEnd (int time, int action)
void	Update (int time)
Block *	Clone ()
GMT::Point3F	GetPoint3F (int time)
	Returns the Point3F at the time.
void	SetPoint3F (int time, GMT::Point3F point)
	Sets the Point3F point at the time.
Public Attributes
float	x_value
	The x value if no controller is present.
FloatController *	x_control
	The controller for the x value.
float	y_value
	The y value if no controller is present.
FloatController *	y_control
	The controller for the y value.
float	z_value
	The z value if no controller is present.
FloatController *	z_control
	The controller for the z value.
Static Public Attributes
static BlockType	block_type

---

Detailed Description

The Controller for the Point3F.

---

Constructor & Destructor Documentation

ScEng::Point3FController::Point3FController

(

bool

create_dependencies

)

Constructor Makes the dependencies with the three FloatController

---

Member Function Documentation

std::string ScEng::Point3FController::GetClassName

(

)

[virtual]

Returns the name for this class

Returns:

Returns "Point3FController"

Implements ScEng::Block.

BlockType ScEng::Point3FController::GetBlockType

(

)

[virtual]

Returns the BlockType for this class

Returns:

Returns SE_POINT3F_CONTROLLER_BLOCK_TYPE

Implements ScEng::Block.

int ScEng::Point3FController::NumDependencies

(

)

[virtual]

Returns the number of Dependencies for this class

Returns:

Returns 3

Implements ScEng::Block.

void ScEng::Point3FController::SetDependency	(	int	id,
		Block *	se_block
	)			[virtual]

Sets the specified dependency Sets the X,Y and Z controls. To set the X control the id must be 0 To set the Y control the id must be 1 To set the Z control the id must be 2

Parameters:

	id	the id for the dependency out
	se_block	the Block to be dependency

Implements ScEng::Block.

Block * ScEng::Point3FController::GetDependency

(

int

id

)

[virtual]

Returns the specified dependency Returns the X,Y and Z controls. To get the X control the id must be 0 To get the Y control the id must be 1 To get the Z control the id must be 2

Parameters:

id

the id for the dependency out

Returns:

If the id is 0,1 or 2 return the Block, if not returns False

Implements ScEng::Block.

void ScEng::Point3FController::ActionBegin	(	int	time,
		int	action
	)			[inline, virtual]

Informs the block that an action will begin

Parameters:

time

the time at which the action begins. more details about the action, for example, it can be a RENDER_ACTION, or a SAVE_ACTION.

Reimplemented from ScEng::Block.

void ScEng::Point3FController::ActionEnd	(	int	time,
		int	action
	)			[inline, virtual]

Informs the block that an action will end.

Parameters:

time

the time at which the action ends. more details about the action, for example, it can be a RENDER_ACTION, or a SAVE_ACTION.

Reimplemented from ScEng::Block.

void ScEng::Point3FController::Update

(

int

time

)

[inline, virtual]

Informs the block that it needs to update its data. For example, texture and material blocks usually move all their animated parameters from the data_table to int or float variables. This is specially useful when rendering, so there is no need to interpolate a data_value every time.

Parameters:

time

the time at which the block needs to update its data.

Reimplemented from ScEng::Block.

Block * ScEng::Point3FController::Clone

(

)

[virtual]

Creates a copy of this object and return it. The caller of this function is responsible to add this block to the DAG or to delete it.

Implements ScEng::Block.

---

Member Data Documentation

BlockType ScEng::Point3FController::block_type [static]

The type of this block BlockType Point3FController::block_type( BlockType::CONTROL, 0x00900000,0x00000020 )

---

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

• C:/SceneEngine/SourceForge/SceneEngine/ScEngLibs/include/ScEng/control.h
• C:/SceneEngine/SourceForge/SceneEngine/ScEngLibs/src/base/control.cpp
• C:/SceneEngine/SourceForge/SceneEngine/ScEngLibs/src/base/controlpoint3f.cpp

---