dtDAL::DataType Class Reference

The DataType class is an enumeration representing the different datatypes that are supported by the Delta3D engine. More...

#include <datatype.h>

Inheritance diagram for dtDAL::DataType:

List of all members.

Public Types
enum	DataTypeId {   UNKNOWN_ID = 0, CHAR_ID, UCHAR_ID, FLOAT_ID,   DOUBLE_ID, INT_ID, UINT_ID, LONGINT_ID,   ULONGINT_ID, SHORTINT_ID, USHORTINT_ID, STRING_ID,   BOOLEAN_ID, VEC4_ID, VEC3_ID, VEC2_ID,   VEC4F_ID, VEC3F_ID, VEC2F_ID, VEC4D_ID,   VEC3D_ID, VEC2D_ID, RGBCOLOR_ID, RGBACOLOR_ID,   GROUP_ID, ACTOR_ID, ENUMERATION_ID, GAMEEVENT_ID,   STATICMESH_ID, TEXTURE_ID, CHARACTER_ID, TERRAIN_ID,   SOUND_ID, PARTICLESYSTEM_ID, SKELETAL_MESH_ID }
Public Member Functions
bool	IsResource () const
	Returns: true if this datatype represents a resource
const std::string &	GetDisplayName ()
	Gets a pretty name that can be used in the UI.
unsigned char	GetTypeId () const
	Gets the id associated with this datatype.
void	SetTypeId (unsigned char newId)
	Sets the id of a datatype.
Static Public Attributes
static DataType	UNKNOWN
	Data type used to represent an unknown type.
static DataType	CHAR
	Standard 8-bit signed char value.
static DataType	UCHAR
	Standard 8-bit unsigned char value.
static DataType	FLOAT
	Standard 32-bit floating point value.
static DataType	DOUBLE
	Standard 64-bit precision decimal number.
static DataType	INT
	Standard 32-bit signed integer value.
static DataType	UINT
	Standard 32-bit unsigned integer value.
static DataType	LONGINT
	Similar to the long datatype.
static DataType	ULONGINT
	Similar to the unsigned long datatype.
static DataType	SHORTINT
	Similar to the short datatype.
static DataType	USHORTINT
	Similar to the unsigned short datatype.
static DataType	STRING
	String data type.
static DataType	BOOLEAN
	Boolean data type.
static DataType	VEC4
	A vector of 4 values.
static DataType	VEC3
	A vector of 3 values.
static DataType	VEC2
	A vector of 2 values.
static DataType	VEC4F
	A vector of 4 values.
static DataType	VEC3F
	A vector of 3 values.
static DataType	VEC2F
	A vector of 2 values.
static DataType	VEC4D
	A vector of 4 values.
static DataType	VEC3D
	A vector of 3 values.
static DataType	VEC2D
	A vector of 2 values.
static DataType	RGBCOLOR
	A color data type with 3 values, Red, Green, and Blue.
static DataType	RGBACOLOR
	A color data type with 4 values, Red, Green, Blue, and Alpha.
static DataType	GROUP
	A group.
static DataType	ACTOR
	An actor.
static DataType	ENUMERATION
	Datatype which represents an enumeration.
static DataType	GAME_EVENT
	Game event data type.
static DataType	STATIC_MESH
	A static mesh resource.
static DataType	SKELETAL_MESH
	A Skeletal Mesh.
static DataType	TEXTURE
	A texture resource.
static DataType	CHARACTER
	A replicant body character.
static DataType	TERRAIN
	Geometry, textures, etc that together should be used as a terrain.
static DataType	SOUND
	A Sound resource.
static DataType	PARTICLE_SYSTEM
	A Particle System resource.

---

Detailed Description

The DataType class is an enumeration representing the different datatypes that are supported by the Delta3D engine.

---

Member Enumeration Documentation

enum dtDAL::DataType::DataTypeId

Enumerator:

UNKNOWN_ID
CHAR_ID
UCHAR_ID
FLOAT_ID
DOUBLE_ID
INT_ID
UINT_ID
LONGINT_ID
ULONGINT_ID
SHORTINT_ID
USHORTINT_ID
STRING_ID
BOOLEAN_ID
VEC4_ID
VEC3_ID
VEC2_ID
VEC4F_ID
VEC3F_ID
VEC2F_ID
VEC4D_ID
VEC3D_ID
VEC2D_ID
RGBCOLOR_ID
RGBACOLOR_ID
GROUP_ID
ACTOR_ID
ENUMERATION_ID
GAMEEVENT_ID
STATICMESH_ID
TEXTURE_ID
CHARACTER_ID
TERRAIN_ID
SOUND_ID
PARTICLESYSTEM_ID
SKELETAL_MESH_ID

---

Member Function Documentation

bool dtDAL::DataType::IsResource

(

)

const [inline]

Returns:

true if this datatype represents a resource

const std::string& dtDAL::DataType::GetDisplayName

(

)

[inline]

Gets a pretty name that can be used in the UI.

Returns:

The pretty name

unsigned char dtDAL::DataType::GetTypeId

(

)

const [inline]

Gets the id associated with this datatype.

void dtDAL::DataType::SetTypeId

(

unsigned char

newId

)

[inline]

Sets the id of a datatype.

---

Member Data Documentation

DataType dtDAL::DataType::UNKNOWN [static]

Data type used to represent an unknown type.

For example, the GenericActorProperty returns identifies its datatype as unknown. It does this because the GenericActorProperty can be any type.

See also:

GenericActorProperty

DataType dtDAL::DataType::CHAR [static]

Standard 8-bit signed char value.

DataType dtDAL::DataType::UCHAR [static]

Standard 8-bit unsigned char value.

DataType dtDAL::DataType::FLOAT [static]

Standard 32-bit floating point value.

DataType dtDAL::DataType::DOUBLE [static]

Standard 64-bit precision decimal number.

DataType dtDAL::DataType::INT [static]

Standard 32-bit signed integer value.

DataType dtDAL::DataType::UINT [static]

Standard 32-bit unsigned integer value.

DataType dtDAL::DataType::LONGINT [static]

Similar to the long datatype.

DataType dtDAL::DataType::ULONGINT [static]

Similar to the unsigned long datatype.

DataType dtDAL::DataType::SHORTINT [static]

Similar to the short datatype.

DataType dtDAL::DataType::USHORTINT [static]

Similar to the unsigned short datatype.

DataType dtDAL::DataType::STRING [static]

String data type.

DataType dtDAL::DataType::BOOLEAN [static]

Boolean data type.

DataType dtDAL::DataType::VEC4 [static]

A vector of 4 values.

DataType dtDAL::DataType::VEC3 [static]

A vector of 3 values.

DataType dtDAL::DataType::VEC2 [static]

A vector of 2 values.

DataType dtDAL::DataType::VEC4F [static]

A vector of 4 values.

DataType dtDAL::DataType::VEC3F [static]

A vector of 3 values.

DataType dtDAL::DataType::VEC2F [static]

A vector of 2 values.

DataType dtDAL::DataType::VEC4D [static]

A vector of 4 values.

DataType dtDAL::DataType::VEC3D [static]

A vector of 3 values.

DataType dtDAL::DataType::VEC2D [static]

A vector of 2 values.

DataType dtDAL::DataType::RGBCOLOR [static]

A color data type with 3 values, Red, Green, and Blue.

DataType dtDAL::DataType::RGBACOLOR [static]

A color data type with 4 values, Red, Green, Blue, and Alpha.

DataType dtDAL::DataType::GROUP [static]

A group.

DataType dtDAL::DataType::ACTOR [static]

An actor.

DataType dtDAL::DataType::ENUMERATION [static]

Datatype which represents an enumeration.

See also:

dtDAL::Enumeration

DataType dtDAL::DataType::GAME_EVENT [static]

Game event data type.

DataType dtDAL::DataType::STATIC_MESH [static]

A static mesh resource.

DataType dtDAL::DataType::SKELETAL_MESH [static]

A Skeletal Mesh.

DataType dtDAL::DataType::TEXTURE [static]

A texture resource.

DataType dtDAL::DataType::CHARACTER [static]

A replicant body character.

DataType dtDAL::DataType::TERRAIN [static]

Geometry, textures, etc that together should be used as a terrain.

DataType dtDAL::DataType::SOUND [static]

A Sound resource.

DataType dtDAL::DataType::PARTICLE_SYSTEM [static]

A Particle System resource.

---