ScEng::DataBool Class Reference

This class stores de Data of int type. More...

#include <databool.h>

Inheritance diagram for ScEng::DataBool:

List of all members.

Public Types
enum	CHUNKS { ID_CHUNKID = 0x00000010, DEFAULT_VALUE_CHUNKID = 0x00000015, DATA_CHUNKID = 0x00000025 }
	Enum Chunks. More...
Public Member Functions
	DataBool (int iid, bool dv, int size)
	Constructor.
void	GetValue (float &value, int time, int item=0)
	Virtual method.
void	GetValue (bool &value, int time, int item=0)
	Get a specified value.
void	GetValue (int &value, int time, int item=0)
	Virtual method.
void	GetValue (GMT::Point3F &value, int time, int item=0)
	Virtual method.
void	GetValue (GMT::Point3I &value, int time, int item=0)
	Virtual method.
void	GetValue (GMT::Color &value, int time, int item=0)
	Virtual method.
Controller *	GetController (int item=0)
	Gets the animation controller. Not implemented yet.
void	SetValue (float &value, int time, int item=0)
	Virtual method.
void	SetValue (int &value, int time, int item=0)
	Virtual method.
void	SetValue (bool &value, int time, int item=0)
	Set a specified value.
void	SetValue (GMT::Point3F &value, int time, int item=0)
	Virtual method.
void	SetValue (GMT::Point3I &value, int time, int item=0)
	Virtual method.
void	SetValue (GMT::Color &value, int time, int item=0)
	Virtual method.
void	SetName (std::string data_name)
	Sets the name for this Data.
void	SetController (Controller *control, int item=0)
	Sets the Controller. Not implemented yet.
int	GetInt (int time, int item=0)
	Virtual method.
float	GetFloat (int time, int item=0)
	Virtual method.
std::string	GetName ()
	Returns the name for this Data.
bool	GetBool (int time, int item=0)
	Returns the specified value.
GMT::Point3F	GetPoint3F (int time, int item=0)
	Virtual method.
GMT::Point3I	GetPoint3I (int time, int item=0)
	Virtual method.
GMT::Color	GetColor (int time, int item=0)
	Virtual method.
int	GetType ()
	Returns the type for this data.
std::string	GetClassName ()
	Returns the name for this class.
BlockType	GetBlockType ()
	Returns the BlockType for this class.
int	NumDependencies ()
	This class has no Dependencies.
void	SetDependency (int id, Block *dependency)
	This class has no Dependencies.
Block *	GetDependency (int id)
	This class has no Dependencies.
std::string	GetDependencyName (int id)
	Gets the name for the specified dependency.
int	GetNumDataTables ()
	This class has no DataTables.
DataTable *	GetDataTable (int id=0)
	This class has no DataTables.
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 ()
	Creates a copy of this object and return it.
int	Save (SceneSave *scene_save)
	Saves the info for this class.
int	Load (SceneLoad *scene_load)
	Loads the info for this class.
void	DeleteThis ()
	Deletes this class.
void	ActionBegin (int time, int action)
void	ActionEnd (int time, int action)
void	Update (int time)
void	GetValidTimeRange (TimeInterval &valid_time_range)
	Intersects the valid_time_range of this data with the valid_time_range in the argument.
Public Attributes
bool	default_value
	Default value.
TimeInterval	valid_time_range
	This Data is valid during this time valid_time_range.
Static Public Attributes
static BlockType	block_type

---

Detailed Description

This class stores de Data of int type.

---

Member Enumeration Documentation

enum ScEng::DataBool::CHUNKS

Enum Chunks.

Enums the chunks used for this class.

Enumerator:

ID_CHUNKID	ID chunk
DEFAULT_VALUE_CHUNKID	Default value chunk
DATA_CHUNKID	Data chunk

---

Constructor & Destructor Documentation

ScEng::DataBool::DataBool	(	int	iid,
		bool	dv,
		int	size
	)

Constructor.

Parameters:

	iid	the id for this DataInt. Must be unique in the DataTable
	dv	the default value for this DataInt
	size	the size for the data table

---

Member Function Documentation

void ScEng::DataBool::GetValue	(	bool &	value,
		int	time,
		int	item = 0
	)			[virtual]

Get a specified value.

Parameters:

	value	here will be stored the required data
	time	the time to get the value
	item	the specified item. Is zero by default

Implements ScEng::Data.

void ScEng::DataBool::SetValue	(	bool &	value,
		int	time,
		int	item = 0
	)			[virtual]

Set a specified value.

Parameters:

	value	this is the value that will be set
	time	the time to set the value
	item	the specified item. Is zero by default

Implements ScEng::Data.

void ScEng::DataBool::SetName

(

std::string

data_name

)

[virtual]

Sets the name for this Data.

Parameters:

data_name

the name to be assigned

Implements ScEng::Data.

std::string ScEng::DataBool::GetName

(

)

[virtual]

Returns the name for this Data.

See also:

Data::name

Implements ScEng::Data.

int ScEng::DataBool::GetType

(

)

[virtual]

Returns the type for this data.

See also:

Data::TYPE

Implements ScEng::Data.

std::string ScEng::DataBool::GetClassName

(

)

[virtual]

Returns the name for this class.

Returns:

Returns "DataInt"

Implements ScEng::Block.

BlockType ScEng::DataBool::GetBlockType

(

)

[virtual]

Returns the BlockType for this class.

Returns:

Returns SE_DATA_BOOL_BLOCK_TYPE

Implements ScEng::Block.

int ScEng::DataBool::NumDependencies

(

)

[virtual]

This class has no Dependencies.

Returns:

Returns 0

Implements ScEng::Block.

Block * ScEng::DataBool::GetDependency

(

int

id

)

[virtual]

This class has no Dependencies.

Returns:

Returns NULL

Implements ScEng::Block.

DataTable* ScEng::DataBool::GetDataTable

(

int

id = 0

)

[inline, virtual]

This class has no DataTables.

Returns:

Returns NULL

Reimplemented from ScEng::Block.

Block * ScEng::DataBool::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::DataBool::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::DataBool::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::DataBool::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::DataBool::block_type [static]

The type of this block BlockType DataBool::block_type( BlockType::DATA, 0x01000000,0x00000030 )

---

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

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

---