ScEng::BlockType Class Reference

#include <block.h>

List of all members.

Public Types

enum  TYPES {
  MAIN_SCENE = 1000, BLOCK_VECTOR = 1010, NODE_TRANSFORM = 1015, NODE = 1020,
  SCENE_PROPERTIES = 1025, DATA = 2000, DATA_TABLE = 2010, CONTROL = 3000,
  MTL_TEX = 4000, MATERIAL = 4010, TEXTURE = 4020, PLACE_TEXTURE_2D = 4030,
  PLACE_TEXTURE_3D = 4040, OBJECT = 5000, OBJECT_BASE = 5010, OBJECT_PRIMITIVE = 5010,
  OBJECT_RAW = 5020, OBJECT_MODIFIER = 5030, CAMERA = 6000, LIGHT = 7000,
  MODIFIER = 8000, TOOL = 10000
}

Public Member Functions

 BlockType ()
 BlockType (unsigned int aaa, unsigned int bbb)
int operator== (const BlockType &bt) const
 Operator == overload.
int operator!= (const BlockType &bt) const
 Operator != overload.

Public Attributes

unsigned int type
 The type of this block. See enum.
unsigned int aa
 Unique identifier part aa.
unsigned int bb
 Unique identifier part bb.


Detailed Description

Block Type This class represents the individual type of the block. Blocks can be derived from many SceneEngine classes (Node, Materials, Textures, Objects, Modifiers). This class provides information for what type of block is the owner of this data, and to what can it be converted. It also give an unique identifier to each block. No two blocks can have the same ids aa-bb.


Member Enumeration Documentation

enum ScEng::BlockType::TYPES

These are the available block types. All blocks must have a type, and ideally this type should match the class functionality, as this block type can be used to convert the block to the super class that provides its interface. For example, a material block should have type MATERIAL. This way the users of this class can know it's a material and can safely convert it to a Material.

Enumerator:
MAIN_SCENE  Types for blocks For the main_scene.
BLOCK_VECTOR  Type of the block vectors.
NODE_TRANSFORM  Type for the node transform.
NODE  Type for the nodes.
SCENE_PROPERTIES  Type for the scene properties.
DATA  Major type for data blocks.
DATA_TABLE  Type for the data table.
CONTROL  Major type for controls.
MTL_TEX  Major type for materials, textures and place textures.
MATERIAL  Type for materials.
TEXTURE  Type for textures.
PLACE_TEXTURE_2D  Type for 2d place textures.
PLACE_TEXTURE_3D  Type for 3d place textures.
OBJECT  Major base type for objects.
OBJECT_BASE  For base objects like cameras and lights.
OBJECT_PRIMITIVE  For primitive objects like sphere, torus, etc...
OBJECT_RAW  For raw objects like TriMeshObject, PolyLineObject, etc...
OBJECT_MODIFIER  For object modifiers.
CAMERA  Type for cameras.
LIGHT  Type for lights.
MODIFIER  Major type for modifiers.
TOOL  Major type for tools.


Constructor & Destructor Documentation

ScEng::BlockType::BlockType (  ) 

Constructor Sets the values of aa and bb to zero

ScEng::BlockType::BlockType ( unsigned int  aaa,
unsigned int  bbb 
)

Constructor

Parameters:
aaa the value to be assigned to aa
bbb the value to be assigned to bb


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