ScEng::PolyLineObject Class Reference

The PolyLine Object. More...

#include <polylineobject.h>

Inheritance diagram for ScEng::PolyLineObject:

List of all members.

Public Member Functions
	PolyLineObject (bool create_dependencies)
	Constructor.
	~PolyLineObject ()
	Destructor.
std::string	GetClassName ()
	Returns the name for this class.
BlockType	GetBlockType ()
	Virtual function.
int	NumDependencies ()
	This class has no Dependencies.
void	SetDependency (int id, Block *se_block)
	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.
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)
Block *	Clone ()
	Creates a copy of this object and return it.
GMT::Box3F	GetObjectBoundingBox (int time)
	Returns the Object bounding box in local coordinates.
Public Attributes
PolyLine *	poly_line
	A pointer to the PolyLine.
Static Public Attributes
static BlockType	block_type

---

Detailed Description

The PolyLine Object.

This object stores a PolyLine.

---

Constructor & Destructor Documentation

ScEng::PolyLineObject::PolyLineObject

(

bool

create_dependencies

)

Constructor.

Sets the poly_line pointer to NULL

---

Member Function Documentation

std::string ScEng::PolyLineObject::GetClassName

(

)

[virtual]

Returns the name for this class.

Returns:

Returns "PolyLineObject"

Implements ScEng::Block.

int ScEng::PolyLineObject::NumDependencies

(

)

[virtual]

This class has no Dependencies.

Returns:

Returns 0

Implements ScEng::Block.

Block * ScEng::PolyLineObject::GetDependency

(

int

id

)

[virtual]

This class has no Dependencies.

Returns:

Returns NULL

Implements ScEng::Block.

DataTable* ScEng::PolyLineObject::GetDataTable

(

int

id = 0

)

[inline, virtual]

This class has no DataTables.

Returns:

Returns NULL

Reimplemented from ScEng::Block.

void ScEng::PolyLineObject::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::PolyLineObject::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::PolyLineObject::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::PolyLineObject::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::PolyLineObject::block_type [static]

The type of this block BlockType PolyLineObject::block_type( BlockType::OBJECT_RAW, 0x00800000,0x00000050 )

---

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

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

---