ScEng::Place3DTexture

ScEng::Place3DTexture Class Reference

3D Texture placement More...

#include <placetexture3d.h>

Inheritance diagram for ScEng::Place3DTexture:

ScEng::Material ScEng::Block List of all members.

Public Types

enum  DATAID { , id_map_ch, id_offset, id_angle, id_scale }
 Enum DATAID. More...
enum  DEPENDENCIES { DATA_TABLE_DEPENDENCY = 0 }
 Enum DEPENDENCIES. More...

Public Member Functions

 Place3DTexture (bool create_dependencies)
 Constructor.
 ~Place3DTexture ()
 Destructor.
std::string GetClassName ()
 Virtual function.
BlockType GetBlockType ()
 Virtual function.
int NumDependencies ()
 Returns the number of Dependencies for this class.
void SetDependency (int i, Block *dependency)
 Sets the dependency to the DataTable.
Block * GetDependency (int i)
 Returns the DataTable.
std::string GetDependencyName (int i)
 Gets the name for the specified dependency.
unsigned int GetDependencyType (int i)
std::string GetName ()
 Returns the name for this class.
int GetType (int t)
 Returns the type.
int GetMapChannel (int t)
 Returns the map channel.
GMT::Point3F GetOffset (int t)
 Returns the offset.
GMT::Point3F GetAngle (int t)
 Returns the angle.
GMT::Point3F GetScale (int t)
 Returns the scale.
void SetName (std::string new_name)
 Please add comments here.
void SetType (int type_val, int t)
 Sets the ype.
void SetMapChannel (int map_ch_val, int t)
 Sets the map channel.
void SetOffset (GMT::Point3F offset, int t)
 Sets the offset.
void SetAngle (GMT::Point3F angle, int t)
 Sets the X angle.
void SetScale (GMT::Point3F scale, int t)
 Sets the X scale.
void SetNumSubMaterials (int num)
 This texture placement has no sub-materials.
int GetNumSubMaterials ()
 This texture placement has no sub-materials.
Material * GetSubMaterial (int i)
 This texture placement has no sub-materials.
void SetSubMaterial (int i, Material *material)
 This texture placement has no sub-materials.
void SetNumSubTextures (int num)
 This texture placement has no sub-textures.
int GetNumSubTextures ()
 This texture placement has no sub-textures.
Texture * GetSubTexture (int i)
 This texture placement has no sub-textures.
void SetSubTexture (int i, Texture *texture)
 This texture placement has no sub-textures.
void UpdateDataTable (int id=0)
 Updates the indexes for the DataTable.
int GetNumDataTables ()
 Returns the number of DataTables used 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.
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 Shade (DifferentialGeometry &dg)
 This class doesn't do material shading.

Static Public Attributes

static BlockType block_type

Detailed Description

3D Texture placement

A class that stores the tiling and offseting values of texture that use UV

Member Enumeration Documentation

enum ScEng::Place3DTexture::DATAID

Enum DATAID.

Enumerates the Ids for the differents Data used for the Place3DTexture

Enumerator:
id_map_ch  <The id for the type in the DataTable
id_offset  <The id for the map_ch in the DataTable
id_angle  <The id for the offset in the DataTable
id_scale  <The id for the scale in the DataTable

enum ScEng::Place3DTexture::DEPENDENCIES

Enum DEPENDENCIES.

Enumerates the chunks used for this class

Enumerator:
DATA_TABLE_DEPENDENCY  The dependency to the DataTable

Member Function Documentation

int ScEng::Place3DTexture::NumDependencies (  )  [virtual]

Returns the number of Dependencies for this class.

Returns:
Returns 1

Implements ScEng::Block.

unsigned int ScEng::Place3DTexture::GetDependencyType ( int  i  )  [virtual]

Returns the type of the i-th dependency of this block.

Returns:
The type of the dependency. This is the type defined in BlockType::type.
See also:
BlockType

Reimplemented from ScEng::Block.

std::string ScEng::Place3DTexture::GetName (  )  [virtual]

Returns the name for this class.

Returns:
Returns "Place3DTexture"

Implements ScEng::Material.

Block * ScEng::Place3DTexture::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::Place3DTexture::ActionBegin ( int  time,
int  action 
) [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::Place3DTexture::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::Place3DTexture::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::Place3DTexture::block_type [static]

The type of this block BlockType Place3DTexture::block_type( BlockType::PLACE_TEXTURE, 0x00400000, 0x00000010 )

The documentation for this class was generated from the following files:
Generated on Thu Sep 6 10:49:23 2007 for SceneEngine by  doxygen 1.5.1-p1