ScEng::FloatBezierController Class Reference

#include <control.h>

Inheritance diagram for ScEng::FloatBezierController:

List of all members.

Public Types
enum	CHUNKs { FLOATBEZ_CTRL_CHUNKID = 0x00000010, KEYS_CHUNKID = 0x00000015, CONSTANT_CHUNKID = 0x00000020 }
Public Member Functions
	FloatBezierController (bool create_dependencies)
	Constructor.
std::string	GetClassName ()
BlockType	GetBlockType ()
float	GetFloat (int time)
	Returns the constant_float value.
void	SetFloat (int time, float float_val)
	Sets the constant_float value.
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 ()
	This class has no DataTables.
DataTable *	GetDataTable (int id=0)
void	SetDataTable (DataTable *d, int i=0)
	Sets the i_th data table.
void	UpdateDataTable (int id=0)
	This class has no DataTables.
Block *	Clone ()
int	Save (SceneSave *scene_save)
	Saves the info of this class.
int	Load (SceneLoad *scene_load)
	Loads the info of this class.
void	DeleteThis ()
	Delete this class.
void	ActionBegin (int time, int action)
void	ActionEnd (int time, int action)
void	Update (int time)
Public Attributes
float	constant_float
	constant_float
std::vector< FloatBezierKey >	bezier_keys
	bezier_keys
Static Public Attributes
static BlockType	block_type

---

Detailed Description

FloatBezierController Please add comments here

---

Member Enumeration Documentation

enum ScEng::FloatBezierController::CHUNKs

Enum Chunk ids Enum the chunks used for this class

Enumerator:

FLOATBEZ_CTRL_CHUNKID	Float bezier control Chunk.
KEYS_CHUNKID	Keys Chunk.
CONSTANT_CHUNKID	Constanteys Chunk.

---

Member Function Documentation

std::string ScEng::FloatBezierController::GetClassName

(

)

[virtual]

Returns the name of this class

Returns:

Returns "FloatController"

Implements ScEng::Block.

BlockType ScEng::FloatBezierController::GetBlockType

(

)

[virtual]

Returns the BlockType for this class

Returns:

Returns SE_FLOAT_BEZIER_CONTROLLER_BLOCK_TYPE

Implements ScEng::Block.

int ScEng::FloatBezierController::NumDependencies

(

)

[virtual]

Returns the number of dependencies This class have no dependencies

Returns:

Returns 0

Implements ScEng::Block.

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

Sets a Dependency This class have no dependencies

Implements ScEng::Block.

Block * ScEng::FloatBezierController::GetDependency

(

int

id

)

[virtual]

Returns a dependency This class have no dependencies

Returns:

NULL

Implements ScEng::Block.

DataTable* ScEng::FloatBezierController::GetDataTable

(

int

id = 0

)

[inline, virtual]

This class has no DataTables

Returns:

Returns NULL

Reimplemented from ScEng::Block.

Block * ScEng::FloatBezierController::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.

void ScEng::FloatBezierController::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::FloatBezierController::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::FloatBezierController::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.

---

Member Data Documentation

BlockType ScEng::FloatBezierController::block_type [static]

The type of this block BlockType FloatBezierController::block_type( BlockType::CONTROL, 0x00900000,0x00000010 )

---

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/controlfloatbezier.cpp

---