ScEng::SimbionTexture Class Reference

Please add comments here. More...

#include <simbiontexture.h>

Inheritance diagram for ScEng::SimbionTexture:

List of all members.

Public Types
enum	DEPENDENCIES { PLACE3DTEX_DEPENDENCY = 0 }
	Enum Dependencies. More...
enum	CHUNKS {   NAME_CHUNKID = 0x00000005, FILENAME_CHUNKID = 0x00000010, TWEAKS_SIZE_CHUNKID = 0x00000015, TWEAKS_TYPES_CHUNKID = 0x00000020,   TWEAKS_NAMES_CHUNKID = 0x00000025, TWEAKS_COLORS_CHUNKID = 0x00000030, TWEAKS_INTEGERS_CHUNKID = 0x00000035, TWEAKS_PERCENTS_CHUNKID = 0x00000040 }
	Enum Chunks. More...
Public Member Functions
	SimbionTexture (bool create_dependencies)
	Constructor.
	~SimbionTexture ()
	Destructor.
std::string	GetClassName ()
	Returns the name for this class.
BlockType	GetBlockType ()
	Virtual function.
int	NumDependencies ()
	Returns the number of Dependencies for this class.
void	SetDependency (int id, Block *dependency)
	Sets a Dependency.
Block *	GetDependency (int id)
	Returns the specified dependency.
std::string	GetDependencyName (int id)
	Gets the name for the specified dependency.
std::string	GetName ()
	Returns the name for this texture.
void	SetName (std::string new_name)
	Sets the name for this texture.
void	SetNumSubTextures (int num)
	This texture has no sub-textures.
int	GetNumSubTextures ()
	This texture has no sub-textures.
Texture *	GetSubTexture (int i)
	This texture has no sub-textures.
void	SetSubTexture (int i, Texture *texture)
	This texture has no sub-textures.
void	SetPlace3DTexture (Place3DTexture *place_3D_texture)
	Sets the Place3DTexture for this texture.
Place3DTexture *	GetPlace3DTexture ()
	Returns the Place3DTexture for this texture.
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 ()
	Clones this object. Not implemented yetç.
int	Save (SceneSave *scene_save)
	Saves the info for this class.
int	Load (SceneLoad *scene_load)
	Loads the info for this class.
void	SetFilePath (std::string name)
	Sets the filepath for this texture.
std::string	GetFilePath ()
	Returns the filepath for this texture.
void	DeleteThis ()
	Deletes this class.
void	ActionBegin (int time, int action)
void	ActionEnd (int time, int action)
void	Update (int time)
GMT::AColor	EvaluateColor (DifferentialGeometry &dg)
	Returns the color of the texture in the position specified by the differential geometry instance.
GMT::Point3F	EvaluateBump (DifferentialGeometry &dg)
	Returns the normal perturbation produced by the texture in the position specified by the differential geometry instance.
Public Attributes
std::string	name
	The name for the texture.
std::string	file_path
	The file path for the image file.
Place3DTexture *	place_tex
	The Place3DTexture for this texture.
std::vector< int >	tweaks_types
	Please add comments here.
std::vector< std::string >	tweaks_names
	Please add comments here.
std::vector< GMT::Color >	tweaks_colors
	Please add comments here.
std::vector< int >	tweaks_integers
	Please add comments here.
std::vector< float >	tweaks_percents
	Please add comments here.
Static Public Attributes
static BlockType	block_type

---

Detailed Description

Please add comments here.

---

Member Enumeration Documentation

enum ScEng::SimbionTexture::DEPENDENCIES

Enum Dependencies.

Enums the possible dependencies for this class

Enumerator:

PLACE3DTEX_DEPENDENCY

A dependency to a Place3DTex

enum ScEng::SimbionTexture::CHUNKS

Enum Chunks.

Enums the chunks used for this class

Enumerator:

NAME_CHUNKID	Name Chunk
FILENAME_CHUNKID	File name Chunk
TWEAKS_SIZE_CHUNKID	Tweaks size Chunk
TWEAKS_TYPES_CHUNKID	Tweaks types Chunk
TWEAKS_NAMES_CHUNKID	Tweaks names Chunk
TWEAKS_COLORS_CHUNKID	Tweaks colors Chunk
TWEAKS_INTEGERS_CHUNKID	Tweaks integers Chunk
TWEAKS_PERCENTS_CHUNKID	Tweaks percents Chunk

---

Constructor & Destructor Documentation

ScEng::SimbionTexture::SimbionTexture

(

bool

create_dependencies

)

Constructor.

Sets the Place3DTexture pointer to NULL

---

Member Function Documentation

std::string ScEng::SimbionTexture::GetClassName

(

)

[virtual]

Returns the name for this class.

Returns:

Returns "SimbionTexture"

Implements ScEng::Block.

int ScEng::SimbionTexture::NumDependencies

(

)

[virtual]

Returns the number of Dependencies for this class.

Returns:

Returns 1

Implements ScEng::Block.

void ScEng::SimbionTexture::SetDependency	(	int	id,
		Block *	dependency
	)			[virtual]

Sets a Dependency.

If the id is equal to PLACE3DTEX_DEPENDENCY sets the Place3DTexture for this texture.

Parameters:

	id	the ID for the dependency
	dependency	the Block to be set

Implements ScEng::Block.

Block * ScEng::SimbionTexture::GetDependency

(

int

id

)

[virtual]

Returns the specified dependency.

Parameters:

id

the ID for the dependency

Returns:

If the id is equal to PLACE3DTEX_DEPENDENCY returns the Place3DTexture for this texture.

If the id is different of PLACE3DTEX_DEPENDENCY returns NULL

Implements ScEng::Block.

int ScEng::SimbionTexture::GetNumSubTextures

(

)

[virtual]

This texture has no sub-textures.

Returns:

Returns 0

Implements ScEng::Material.

Texture * ScEng::SimbionTexture::GetSubTexture

(

int

i

)

[virtual]

This texture has no sub-textures.

Returns:

Returns NULL

Implements ScEng::Material.

void ScEng::SimbionTexture::SetPlace3DTexture

(

Place3DTexture *

place_3D_texture

)

Sets the Place3DTexture for this texture.

Sets the Place3DTexture using MakeDependencyByID

Parameters:

place_3D_texture

the Place3DTexture to be set

See also:

SCBlock::MakeDependencyByID

DataTable* ScEng::SimbionTexture::GetDataTable

(

int

id = 0

)

[inline, virtual]

This class has no DataTables.

Returns:

Returns NULL

Reimplemented from ScEng::Block.

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

The type of this block BlockType SimbionTexture::block_type( BlockType::TEXTURE, 0x00500000, 0x00000030 )

---

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

• C:/SceneEngine/SourceForge/SceneEngine/ScEngLibs/include/ScEng/simbiontexture.h
• C:/SceneEngine/SourceForge/SceneEngine/ScEngLibs/src/materials/simbiontexture.cpp

---