DigitalSpaces Namespace Reference

Data Structures
struct	_DUID
	DigitalSpaces Unique ID. More...
struct	DIObjectBase
	Base Interface for all inter-module objects. More...
struct	DIObjectBaseList1
	A collection of unknown interfaces, that can be iterated through. More...
struct	DIStringList1
	A collection of strings that can be iterated through. More...
struct	DIDUIDList1
	A collection of IDs that can be iterated through. More...
struct	DIStringPairList
	A collection of string pairs that can be iterated through. More...
struct	DIXMLNode1
	The basic XML interface, contains all the functionality common to the XML system. More...
struct	DIXMLElement1
	Additional functionality that is supported by an XML Element. More...
union	out_Vector3f
	Standard 3 value vector. More...
union	out_Vector3d
	A higher precision version of out_Vector3f. More...
union	out_Vector4f
	Standard 4 value vector. More...
union	out_Vector4d
	A higher precision version of out_Vector4f. More...
union	out_Pairf
	Standard two value pair. More...
struct	out_PositionOrientationf
	Convenience structure used when dealing with both a position and orientation. More...
struct	out_PositionOrientationd
	Convenience structure used when dealing with both a position and orientation. More...
struct	DIVariant
	An interface used to pass around data of indertimate type. More...
struct	DISettingMap
	Used to pass a key:value map between components. More...
struct	DIComponentInfo
	This is the interface passed to any components GetComponentInfo function. More...
struct	DIAgent1
	The DInterface for working abstractly with an Agent Implementation. More...
struct	DIAgentManager1
	A centralized management point for Agent implementations. More...
struct	DIUser1
	This interface should be implemented by any object that has a representation of the "user". More...
struct	DIUserActionFilter1
	Any object that implements DIUser should check for all implementations of DIUserActionFilter. More...
struct	DI3DVisualsEntity1
struct	DI3DVisualsNode1
struct	DI3DVisuals1
struct	DIUserInput1
	DInterface for polling input based events by name. More...
struct	strctKeyEvent
	Used for passing DIUserInputKeyboard1 events between modules. More...
struct	DIUserInputKeyboard1
	An enhancement on DIUserInput1, allows checking for specific keys and keypress events, without the need to map a signal. More...
struct	DIUserInput2DPointer1
	Allows control over the representation of a 2d pointing device, such as a mouse. More...
struct	DIHapticDevice1
	Available when a device supports force feedback. More...
struct	DIEventSubscriber1
	Used as a call-back from modules that create events. More...
struct	DIEventProvider1
	Implemented by components/objects that create events. More...
struct	DISimulationControl1
	Don't know what this interface will be for, or if it will even be kept. More...
struct	DIWin32Window1
	Lets components get information about an application window. More...
struct	DI3DVisualsGUIElement1
	Basic base class for all GUI elements. More...
struct	DI3DVisualsGUI1
	"Factory" interface that is exposed by a module. More...
struct	DI3DVisualsGUIStaticText1
	Empty interface for future use. More...
struct	DI3DVisualsGUIScrollBar1
	Interface to a scrollbar GUI element. More...
struct	DI3DVisualsGUIComboBox1
	Interface for a combo box (a drop down selection list that allows typing values into the element). More...
struct	DI3DVisualsGUIMultiColumnList1
	Interface for a multi coloumn list GUI element. More...
struct	DI3DVisualsGUICheckbox1
	Interface for a on/off GUI element. More...
struct	DI3DVisualsGUIButton1
	Interface for a clickable button. More...
struct	DI3DAudioEntity1
	Interface for control of a single sound source. More...
struct	DI3DAudio1
	"Factory" interface that is exposed by a module. More...
struct	DIAcceptConfiguration1
	DInterface used for configuring an implementation in a generic manner. More...
struct	DISGBase
	The base functionality common to all scene-graph objects. More...
struct	DISGBaseRepr
	Common functionality of SG Object Representations. More...
struct	DIPhysicsBodyMovementListener
	Designed to be called after physics processing, to allow interested components to react to physics based movement. More...
struct	DIPhysicsShapeCollisionListener
	Allows an implementation to gather information about collisions as they occur, and to customize the simulations reaction to the collision. More...
struct	DIPhysicsWorldStepListener
	Designed to be called before and after the physics processing, to allow interested components to control the simulation. More...
struct	DIPhysicsRay
	Wraps the implementation of a ray collision test. More...
struct	DIPhysics
	Factory for Physics Worlds. More...
struct	DIPhysicsBase
	A common functionality class implemented by all Physics objects (except DIPhysics). More...
struct	DIPhysicsBody
	Interface to a physics body. More...
struct	DIPhysicsCollision
	This interface contains information about a collision, and access to the DIPhysicsMaterial to change how the simulation will respond to the collision. More...
struct	DIPhysicsJoint
	Interface for interacting with a physics simulated joint. More...
struct	DIPhysicsMaterial
	Contact properties for a collision. More...
struct	DIPhysicsShape
	DInterface representing physics shapes. More...
struct	DIPhysicsBodyIterator
	Interface for an object that wishes to inspect or act apon every body in a physics world. More...
struct	DIPhysicsWorld
	Interface for a phyiscs world. More...
struct	DICEGUIWindow
	{AAB065FE-7BB6-4db1-A4CB-D1E1A639B69F} More...
struct	DICEGUIFont
struct	DICEGUIImage
struct	DICEGUITooltip
struct	DICEGUIRenderCache
	This DInterface purposely left blank. More...
struct	DICEGUIDragContainer
struct	DICEGUIWindowRenderer
	This DInterface purposely left blank. More...
struct	DICEGUIListboxItem
struct	DICEGUIListHeaderSegment
struct	DICEGUIListbox
struct	DICEGUIMultiColumnList
	{7927AD95-33E2-41e6-9C69-B76CD8F21C46} More...
struct	DICEGUIButton
	{22CB998B-1B54-4c16-9E98-4139C3DFA028} More...
struct	DICEGUIScrollbar
struct	DICEGUIListHeader
struct	DICEGUICheckbox
	{2AEC8629-CED4-46df-976A-99D0F277E423} More...
struct	DICEGUISlider
	{0B65289A-3358-4113-AE2A-FFBF1913A01E} More...
struct	DICEGUIThumb
struct	DICEGUIRadioButton
struct	DICEGUITabButton
struct	DICEGUICombobox
struct	DICEGUIEditbox
struct	DICEGUIFrameWindow
struct	DICEGUIItemEntry
struct	DICEGUIMenuItem
struct	DICEGUIItemListBase
struct	DICEGUIMenuBase
struct	DICEGUIPopupMenu
struct	DICEGUIScrolledItemListBase
struct	DICEGUIItemListbox
struct	DICEGUIComboDropList
struct	DICEGUIMultiLineEditbox
struct	DICEGUIProgressBar
struct	DICEGUIScrollablePane
struct	DICEGUISpinner
struct	DICEGUITabControl
struct	DICEGUITitlebar
struct	DICEGUIImageset
struct	DICEGUI1
struct	DI3DVisualsOgre1
	It is used for communicating with the CEGUI implementation. More...
struct	OGREVertexBoneAssignment
struct	OGREMeshLodUsage
struct	DIOGREAxisAlignedBox
struct	DIOGRETechnique
struct	DIOGREPass
struct	DIOGREGpuProgram
struct	DIOGREViewport
struct	DIOGREFrustum
	this was initially implemented by DIOGRECamera as it was the only frustum we used More...
struct	DIOGRECamera
struct	DIOGRERenderable
struct	DIOGRENode
struct	DIOGRESceneNode
struct	DIOGREMovableObject
struct	DIOGRELight
struct	DIOGREShadowCaster
struct	DIOGREBone
struct	DIOGRETagPoint
	Has no additional implementation. More...
struct	DIOGREMaterial
struct	DIOGREEntity
struct	DIOGRENodeAnimationTrack
struct	DIOGREAnimation
struct	DIOGRESkeleton
struct	DIOGRESkeletonInstance
struct	DIOGRESubEntity
struct	DIOGREMesh
struct	DIOGRESubMesh
struct	DIOGREVertexElement
struct	DIOGREVertexDeclaration
struct	DIOGREVertexBufferBinding
struct	DIOGREHardwareBuffer
struct	DIOGREHardwareVertexBuffer
	It can safely be assumed that any object implementing this interface will also implement DIOGREHardwareBuffer. More...
struct	DIOGREVertexData
struct	DIOGREHardwareIndexBuffer
struct	DIOGREIndexData
struct	DIOGREBillboard
struct	DIOGREBillboardSet
struct	DIOGREParticleEmitter
struct	DIOGREParticleAffector
struct	DIOGREParticle
struct	DIOGREParticleSystem
struct	DIOGREAnimationState
struct	DIOGRESceneQuery
struct	DIOGREAxisAlignedBoxSceneQuery
struct	DIOGRESphereSceneQuery
struct	DIOGREPlaneBoundedVolumeListSceneQuery
struct	DIOGREPlaneBoundedVolumeList
struct	DIOGRERaySceneQuery
struct	DIOGRERay
struct	DIOGREIntersectionSceneQuery
struct	DIOGREStaticGeometry
struct	DIOGRELayerBlendModeEx
	Needs filling out. More...
struct	DIOGRETextureUnitState
struct	DIOGRESceneManager
	The concern about virtual functions does not apply to the Scene Manager. More...
struct	DIOGREPixelBox
struct	DIOGREResource
struct	DIOGREHardwarePixelBuffer
struct	DIOGRETexture
struct	DIOGREResourceManager
struct	DIOGRETextureManager
class	DIList1
	Customisable implementation for transporting a list of interfaces. More...
class	DIStringList1Impl
	Implements DIStringList1. More...
class	DIDUIDList1Impl
	Implements DISUIDList1, a list of DUID's. More...
class	DIStringPairListImpl
	Implements DIStringPairList, a list of string pairs. More...
class	DIComponentInfoImpl
	Implements DIComponentInfo, as filled in by a component in GetComponentInfo. More...
class	Variant
	Class to pass the Variant_Impl structure across component boundaries (as a DInterface). More...
class	SettingMap
	Implements a flexible key-to-value map collection, using strings for keys and Variant for values. More...
class	DataResourceStreambuf
	Provides a buffer between DIDataResource and the DataResourceIStream. More...
class	DataResourceIStream
	Class that wraps a DIDataResource to make it usable as a STL istream. More...
typedef struct DigitalSpaces::_DUID	DUID
	DigitalSpaces Unique ID.
bool	operator< (const DUID &aUUID, const DUID &bUUID)
	Operator to allow use in std::map's.
bool	operator== (const DUID &aUUID, const DUID &bUUID)
	Operator to allow use in std::map's.
Typedefs
typedef const out_Vector3f	in_Vector3f
	Const version of out_Vector3f, used when passing data into a function that won't need to return data.
typedef const out_Vector3d	in_Vector3d
	Const version of out_Vector3d, used when passing data into a function that won't need to return data.
typedef const out_Vector4f	in_Vector4f
	Const version of out_Vector4f, used when passing data into a function that won't need to return data.
typedef const out_Vector4d	in_Vector4d
	Const version of out_Vector4d, used when passing data into a function that won't need to return data.
typedef const out_Pairf	in_Pairf
	Const version of out_Pairf, used when passing data into a function that won't need to return data.
typedef out_Vector4f	out_Quaternionf
	Standard Quaternion container.
typedef out_Vector4d	out_Quaterniond
	Higher precision quaternion container.
typedef const out_Quaternionf	in_Quaternionf
	Const version of out_Quaternionf, used when passing data into a function that won't need to return data.
typedef const out_Quaterniond	in_Quaterniond
	Const version of out_Quaterniond, used when passing data into a function that won't need to return data.
typedef const out_PositionOrientationf	in_PositionOrientationf
	Const version of out_PositionOrientationf, used when passing data into a function that won't need to return data.
typedef const out_PositionOrientationd	in_PositionOrientationd
	Const version of out_PositionOrientationd, used when passing data into a function that won't need to return data.
typedef out_Vector3f	out_Matrix3f [3]
	Matrix (3x3) data structure.
typedef const out_Vector3f	in_Matrix3f [3]
	Const version of out_Vector3f, used when passing data into a function that won't need to return data.
typedef out_Vector4f	out_Matrix4f [4]
	Matrix (4x4) data structure.
typedef const out_Matrix4f	in_Matrix4f
	Const version of out_Matrix4f, used when passing data into a function that won't need to return data.
typedef DIList1 < DIObjectBaseList1, DIObjectBase >	DIObjectBaseList1Impl
	Implements DIObjectBaseList1, a list of DIObjectBase interfaces.
typedef boost::variant < boost::blank, DIObjectBase *, bool, int, unsigned int, double, std::string, Wml::Vector3f, Wml::Quaternionf, Wml::Vector4f, boost::recursive_wrapper < SettingMap > >	Variant_Impl
	A data wrapper for common DSS types.
Enumerations
enum	XMLNodeType {   DOCUMENT, ELEMENT, COMMENT, UNKNOWN,   TEXT, DECLARATION, TYPECOUNT }
	Enumeration of the XML node types supported. More...
enum	CEGUIVerticalAlignment { VA_TOP, VA_CENTRE, VA_BOTTOM }
enum	CEGUIHorizontalAlignment { HA_LEFT, HA_CENTRE, HA_RIGHT }
	Enumerated type used when specifying horizontal alignments. More...
enum	CEGUIMouseCursorImage { BlankMouseCursor = 0, DefaultMouseCursor = -1 }
	Enumeration of special values used for mouse cursor settings in Window objects. More...
enum	CEGUITextFormatting {   LeftAligned, RightAligned, Centred, Justified,   WordWrapLeftAligned, WordWrapRightAligned, WordWrapCentred, WordWrapJustified }
	Enumerated type that contains valid formatting types that can be specified when rendering text into a Rect area (the formatting Rect). More...
enum	CEGUIListHeaderSegmentSortDirection { None, Ascending, Descending }
	Enumeration of possible values for sorting direction used with ListHeaderSegment classes. More...
enum	CEGUIMultiColumnListSelectionMode {   RowSingle, RowMultiple, CellSingle, CellMultiple,   NominatedColumnSingle, NominatedColumnMultiple, ColumnSingle, ColumnMultiple,   NominatedRowSingle, NominatedRowMultiple }
	Enumerated values for the selection modes possible with a Multi-column list. More...
enum	CEGUIItemListBaseSortMode { ItemListBase_Ascending, ItemListBase_Descending, ItemListBase_UserSort }
	Sort modes for ItemListBase Changed the names (Added ItemListBase_) to Distinguish from ListHeaderSegment SortDirection. More...
enum	CEGUITextInputMode { FloatingPoint, Integer, Hexadecimal, Octal }
	Enumerated type specifying possible input and/or display modes for the spinner. More...
enum	CEGUITabPanePosition { Top, Bottom }
enum	OGREProjectionType { PT_ORTHOGRAPHIC, PT_PERSPECTIVE }
	Specifies perspective (realistic) or orthographic (architectural) projection. More...
enum	OGREFrustumPlane {   FRUSTUM_PLANE_NEAR = 0, FRUSTUM_PLANE_FAR = 1, FRUSTUM_PLANE_LEFT = 2, FRUSTUM_PLANE_RIGHT = 3,   FRUSTUM_PLANE_TOP = 4, FRUSTUM_PLANE_BOTTOM = 5 }
	Worldspace clipping planes. More...
enum	OGRECompareFunction {   CMPF_ALWAYS_FAIL, CMPF_ALWAYS_PASS, CMPF_LESS, CMPF_LESS_EQUAL,   CMPF_EQUAL, CMPF_NOT_EQUAL, CMPF_GREATER_EQUAL, CMPF_GREATER }
enum	OGRECullingMode { CULL_NONE = 1, CULL_CLOCKWISE = 2, CULL_ANTICLOCKWISE = 3 }
enum	OGREManualCullingMode { MANUAL_CULL_NONE = 1, MANUAL_CULL_BACK = 2, MANUAL_CULL_FRONT = 3 }
enum	OGREShadeOptions { SO_FLAT, SO_GOURAUD, SO_PHONG }
enum	OGREFogMode { FOG_NONE, FOG_EXP, FOG_EXP2, FOG_LINEAR }
enum	OGREShadowTechnique {   SHADOWTYPE_NONE = 0x00, SHADOWDETAILTYPE_ADDITIVE = 0x01, SHADOWDETAILTYPE_MODULATIVE = 0x02, SHADOWDETAILTYPE_INTEGRATED = 0x04,   SHADOWDETAILTYPE_STENCIL = 0x10, SHADOWDETAILTYPE_TEXTURE = 0x20, SHADOWTYPE_STENCIL_MODULATIVE = 0x12, SHADOWTYPE_STENCIL_ADDITIVE = 0x11,   SHADOWTYPE_TEXTURE_MODULATIVE = 0x22, SHADOWTYPE_TEXTURE_ADDITIVE = 0x21, SHADOWTYPE_TEXTURE_ADDITIVE_INTEGRATED = 0x25, SHADOWTYPE_TEXTURE_MODULATIVE_INTEGRATED = 0x26 }
enum	OGRETextureFilterOptions { TFO_NONE, TFO_BILINEAR, TFO_TRILINEAR, TFO_ANISOTROPIC }
enum	OGRESceneBlendType {   SBT_TRANSPARENT_ALPHA, SBT_TRANSPARENT_COLOUR, SBT_ADD, SBT_MODULATE,   SBT_REPLACE }
enum	OGRESceneBlendFactor {   SBF_ONE, SBF_ZERO, SBF_DEST_COLOUR, SBF_SOURCE_COLOUR,   SBF_ONE_MINUS_DEST_COLOUR, SBF_ONE_MINUS_SOURCE_COLOUR, SBF_DEST_ALPHA, SBF_SOURCE_ALPHA,   SBF_ONE_MINUS_DEST_ALPHA, SBF_ONE_MINUS_SOURCE_ALPHA }
enum	OGRELightTypes { LT_POINT, LT_DIRECTIONAL, LT_SPOTLIGHT }
enum	OGREPolygonMode { PM_POINTS = 1, PM_WIREFRAME = 2, PM_SOLID = 3 }
enum	OGREHardwareBufferUsage {   HBU_STATIC = 1, HBU_DYNAMIC = 2, HBU_WRITE_ONLY = 4, HBU_DISCARDABLE = 8,   HBU_STATIC_WRITE_ONLY = 5, HBU_DYNAMIC_WRITE_ONLY = 6, HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE = 14 }
enum	OGREVertexElementType {   VET_FLOAT1 = 0, VET_FLOAT2 = 1, VET_FLOAT3 = 2, VET_FLOAT4 = 3,   VET_COLOUR = 4, VET_SHORT1 = 5, VET_SHORT2 = 6, VET_SHORT3 = 7,   VET_SHORT4 = 8, VET_UBYTE4 = 9, VET_COLOUR_ARGB = 10, VET_COLOUR_ABGR = 11 }
	Vertex element type, used to identify the base types of the vertex contents. More...
enum	OGREVertexElementSemantic {   VES_POSITION = 1, VES_BLEND_WEIGHTS = 2, VES_BLEND_INDICES = 3, VES_NORMAL = 4,   VES_DIFFUSE = 5, VES_SPECULAR = 6, VES_TEXTURE_COORDINATES = 7, VES_BINORMAL = 8,   VES_TANGENT = 9 }
	Vertex element semantics, used to identify the meaning of vertex buffer contents. More...
enum	OGRELockOptions { HBL_NORMAL, HBL_DISCARD, HBL_READ_ONLY, HBL_NO_OVERWRITE }
	Locking options. More...
enum	OGREIndexType { IT_16BIT, IT_32BIT }
enum	OGREBillboardOrigin {   BBO_TOP_LEFT, BBO_TOP_CENTER, BBO_TOP_RIGHT, BBO_CENTER_LEFT,   BBO_CENTER, BBO_CENTER_RIGHT, BBO_BOTTOM_LEFT, BBO_BOTTOM_CENTER,   BBO_BOTTOM_RIGHT }
	Enum covering what exactly a billboard's position means (center, top-left etc). More...
enum	OGREBillboardType {   BBT_POINT, BBT_ORIENTED_COMMON, BBT_ORIENTED_SELF, BBT_PERPENDICULAR_COMMON,   BBT_PERPENDICULAR_SELF }
	The type of billboard to use. More...
enum	OGREInterpolationMode { IM_LINEAR, IM_SPLINE }
	The types of animation interpolation available. More...
enum	OGRERotationInterpolationMode { RIM_LINEAR, RIM_SPHERICAL }
	The types of rotational interpolation available. More...
enum	OGRESkeletonAnimationBlendMode { ANIMBLEND_AVERAGE, ANIMBLEND_CUMULATIVE }
enum	OGRETextureEffectType {   ET_ENVIRONMENT_MAP, ET_PROJECTIVE_TEXTURE, ET_UVSCROLL, ET_USCROLL,   ET_VSCROLL, ET_ROTATE, ET_TRANSFORM }
	Definition of the broad types of texture effect you can apply to a texture unit. More...
enum	OGREEnvMapType { ENV_PLANAR, ENV_CURVED, ENV_REFLECTION, ENV_NORMAL }
	Enumeration to specify type of envmap. More...
enum	OGRETextureTransformType {   TT_TRANSLATE_U, TT_TRANSLATE_V, TT_SCALE_U, TT_SCALE_V,   TT_ROTATE }
	Useful enumeration when dealing with procedural transforms. More...
enum	OGRETextureAddressingMode { TAM_WRAP, TAM_MIRROR, TAM_CLAMP, TAM_BORDER }
	Texture addressing modes - default is TAM_WRAP. More...
enum	OGRETextureCubeFace {   CUBE_FRONT = 0, CUBE_BACK = 1, CUBE_LEFT = 2, CUBE_RIGHT = 3,   CUBE_UP = 4, CUBE_DOWN = 5 }
	Enum identifying the frame indexes for faces of a cube map (not the composite 3D type. More...
enum	OGRETextureType { TEX_TYPE_1D = 1, TEX_TYPE_2D = 2, TEX_TYPE_3D = 3, TEX_TYPE_CUBE_MAP = 4 }
	Enum identifying the texture type. More...
enum	OGRELayerBlendOperation { LBO_REPLACE, LBO_ADD, LBO_MODULATE, LBO_ALPHA_BLEND }
	List of valid texture blending operations, for use with TextureUnitState::setColourOperation. More...
enum	OGREFilterType { FT_MIN, FT_MAG, FT_MIP }
enum	OGREFilterOptions { FO_NONE, FO_POINT, FO_LINEAR, FO_ANISOTROPIC }
	Filtering options for textures / mipmaps. More...
enum	OGREWaveformType {   WFT_SINE, WFT_TRIANGLE, WFT_SQUARE, WFT_SAWTOOTH,   WFT_INVERSE_SAWTOOTH, WFT_PWM }
	Enumerates the wave types usable with the Ogre engine. More...
enum	OGRELayerBlendOperationEx {   LBX_SOURCE1, LBX_SOURCE2, LBX_MODULATE, LBX_MODULATE_X2,   LBX_MODULATE_X4, LBX_ADD, LBX_ADD_SIGNED, LBX_ADD_SMOOTH,   LBX_SUBTRACT, LBX_BLEND_DIFFUSE_ALPHA, LBX_BLEND_TEXTURE_ALPHA, LBX_BLEND_CURRENT_ALPHA,   LBX_BLEND_MANUAL, LBX_DOTPRODUCT, LBX_BLEND_DIFFUSE_COLOUR }
	Expert list of valid texture blending operations, for use with TextureUnitState::setColourOperationEx and TextureUnitState::setAlphaOperation, and internally in the LayerBlendModeEx class. More...
enum	OGRELayerBlendSource {   LBS_CURRENT, LBS_TEXTURE, LBS_DIFFUSE, LBS_SPECULAR,   LBS_MANUAL }
	List of valid sources of values for blending operations used in TextureUnitState::setColourOperation and TextureUnitState::setAlphaOperation, and internally in the LayerBlendModeEx class. More...
enum	OGREPixelFormat {   PF_UNKNOWN = 0, PF_L8 = 1, PF_BYTE_L = PF_L8, PF_L16 = 2,   PF_SHORT_L = PF_L16, PF_A8 = 3, PF_BYTE_A = PF_A8, PF_A4L4 = 4,   PF_BYTE_LA = 5, PF_R5G6B5 = 6, PF_B5G6R5 = 7, PF_R3G3B2 = 31,   PF_A4R4G4B4 = 8, PF_A1R5G5B5 = 9, PF_R8G8B8 = 10, PF_B8G8R8 = 11,   PF_A8R8G8B8 = 12, PF_A8B8G8R8 = 13, PF_B8G8R8A8 = 14, PF_R8G8B8A8 = 28,   PF_X8R8G8B8 = 26, PF_X8B8G8R8 = 27, PF_BYTE_RGB = PF_B8G8R8, PF_BYTE_BGR = PF_R8G8B8,   PF_BYTE_BGRA = PF_A8R8G8B8, PF_BYTE_RGBA = PF_A8B8G8R8, PF_A2R10G10B10 = 15, PF_A2B10G10R10 = 16,   PF_DXT1 = 17, PF_DXT2 = 18, PF_DXT3 = 19, PF_DXT4 = 20,   PF_DXT5 = 21, PF_FLOAT16_R = 32, PF_FLOAT16_RGB = 22, PF_FLOAT16_RGBA = 23,   PF_FLOAT32_R = 33, PF_FLOAT32_RGB = 24, PF_FLOAT32_RGBA = 25, PF_FLOAT16_GR = 35,   PF_FLOAT32_GR = 36, PF_DEPTH = 29, PF_SHORT_RGBA = 30, PF_SHORT_GR = 34,   PF_SHORT_RGB = 37, PF_COUNT = 38 }
enum	OGRETextureUsage {   TU_STATIC = HBU_STATIC, TU_DYNAMIC = HBU_DYNAMIC, TU_WRITE_ONLY = HBU_WRITE_ONLY, TU_STATIC_WRITE_ONLY = HBU_STATIC_WRITE_ONLY,   TU_DYNAMIC_WRITE_ONLY = HBU_DYNAMIC_WRITE_ONLY, TU_DYNAMIC_WRITE_ONLY_DISCARDABLE = HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE, TU_AUTOMIPMAP = 0x100, TU_RENDERTARGET = 0x200,   TU_DEFAULT = TU_AUTOMIPMAP | TU_STATIC_WRITE_ONLY }
	Enum identifying the texture usage. More...
enum	TransformSpace { TS_LOCAL, TS_PARENT, TS_WORLD }
enum	RenderQueueGroupID {   RENDER_QUEUE_BACKGROUND = 0, RENDER_QUEUE_SKIES_EARLY = 5, RENDER_QUEUE_1 = 10, RENDER_QUEUE_2 = 20,   RENDER_QUEUE_WORLD_GEOMETRY_1 = 25, RENDER_QUEUE_3 = 30, RENDER_QUEUE_4 = 40, RENDER_QUEUE_MAIN = 50,   RENDER_QUEUE_6 = 60, RENDER_QUEUE_7 = 70, RENDER_QUEUE_WORLD_GEOMETRY_2 = 75, RENDER_QUEUE_8 = 80,   RENDER_QUEUE_9 = 90, RENDER_QUEUE_SKIES_LATE = 95, RENDER_QUEUE_OVERLAY = 100 }
Functions
long	DUIDFromString (const std::string &str, DUID *pduid)
	Converts from a {00000000–0000–0000-C000–000000000046} format string to a DUID.
long	StringFromDUID (const DUID *pduid, std::string &str)
	Converts from a DUID to a {00000000–0000–0000-C000–000000000046} format string.
	DInterfaceWithParent (DIAcceptConfiguration2, DIAcceptConfiguration1) void GetConfigurationPropertyCategories(DIStringList1 *categoryNames)
	Provide the configuration property categories names.
void	GetConfigurationPropertyNamesForCategory (const char *categoryName, DIStringList1 *propertyNames)
	May change over lifetime of Component, in response to changes to other properties.
const char *	GetConfigurationPropertyValue (const char *categoryName, const char *propertyName)
	Retreive the value of a property.
void	GetConfigurationPropertyOptions (const char *categoryName, const char *propertyName, DIStringList1 *propertyOptions)
	Retreive the possible values for a property.
void	SetConfigurationPropertyValue (const char *categoryName, const char *propertyName, const char *propertyValue)
	Set the value of a property.
	DInterfaceWithParent (DISGHeirachal, DISGBase) DISGBase *CreateChild(const char *name
	Convenience function for DISGManager::CreateSGNode(name, type, this, configuration).
DISGBase *	GetChild (const char *name)
	Retreive a child node.
bool	AttachChild (DISGBase *child)
	Add a child node.
bool	DetachChild (const char *name)
	Remove a child node.
void	GetChildNames (DIStringList1 *names)
	Retreive a list of the names of all child nodes.
template<typename T>
T *	dss_cast (DIObjectBase *src)
	Typecast function that performs QueryInterface for us.
template<class T>
std::vector< T * >	GetFactoriesWithInterface ()
	A more C++ and friendly version of GetFactoriesWithInterface( const DUID*, DIObjectBaseList1*).
template<class T>
T *	GetSingleFactoryWithInterface ()
	This is useful for the types of factory where there can only be one.
DICore1 *	GetCoreInterface ()
	Convenient version with the same functionality as GetSingleInterface< DICore1 >().
void	ProcessXMLNodeForStrings (DIXMLNode1 *rootNode, const std::map< std::string, std::string > &sourceToReplacementMap)
	Function to process through a tree of XML Nodes, look for the specified strings in text elements and attribute strings.
Variant	GetVariantFromXML (DIXMLElement1 *)
	A function that can take a DIXMLElement1 and convert it into a Variant.
SettingMap	GetSettingMapFromXML (DIXMLNode1 *)
	A function that can take an XML element, look for <setting name=""> nodes, then get Variant values for their children (using GetVariantFromXML).
void	FillInSettingNode (DIXMLNode1 *iNode, const SettingMap &settings)
	Using the value of the settings parameter, add child nodes to iNode.
Wml::Vector3f	_readVector (DigitalSpaces::DIXMLNode1 *xmlNode)
	Convenince override of _readVector( DIXMLElement1* ).
Wml::Vector3f	_readVector (DigitalSpaces::DIXMLElement1 *xmlElem)
	Extract Vector data from a xml element.
Wml::Quaternionf	_readQuaternion (DigitalSpaces::DIXMLNode1 *xmlNode)
	Convenince override of _readQuaternion( DIXMLElement1* ).
Wml::Quaternionf	_readQuaternion (DigitalSpaces::DIXMLElement1 *xmlElem)
	Extract Quaternion data from a xml element.
Wml::Vector4f	_readColour (DigitalSpaces::DIXMLNode1 *xmlNode)
	Convenince override of _readColour( DIXMLElement1* ).
Wml::Vector4f	_readColour (DigitalSpaces::DIXMLElement1 *xmlElem)
	Extract colour data from a xml element.
std::string	_readName (DigitalSpaces::DIXMLNode1 *xmlNode)
	Convenince override of _readName( DIXMLElement1* ).
std::string	_readName (DigitalSpaces::DIXMLElement1 *xmlElem)
	Reads or generates a name for an element from "name" attribute.
std::string	_autoName ()
	Create an automatically generated name.
bool	_readBool (const char *string)
	Checks if a string contains a representation of true, otherwise returns false.
Variables
const char *	type
const char DIXMLNode1 *	configuration
static const DUID	DID_PhysicsMaterial = { 0x2e83818d, 0x9109, 0x466b, { 0xbb, 0xf7, 0x56, 0x31, 0xad, 0x70, 0x8e, 0xdc } }
static const DUID	DID_PhysicsCollision = { 0xd04a5d2f, 0xaa48, 0x4417, { 0x94, 0x57, 0x56, 0x7e, 0x9, 0x51, 0xe4, 0x83 } }
static const DUID	DID_PhysicsBody = { 0xba17ae54, 0x58fb, 0x4941, { 0xa1, 0x96, 0xc1, 0xf, 0xc8, 0x85, 0xa4, 0x68 } }
static const DUID	DID_PhysicsShape = { 0x585b81ac, 0x5888, 0x49a0, { 0xa1, 0x37, 0xeb, 0xe7, 0xeb, 0xd4, 0xce, 0x0 } }
static const DUID	DID_PhysicsJoint = { 0x1cf6faf3, 0xedb9, 0x47a8, { 0xa2, 0x83, 0x98, 0x5, 0x83, 0x6c, 0x5f, 0xc5 } }
static const DUID	DID_PhysicsWorld = { 0x18d22a9b, 0x3277, 0x4894, { 0x89, 0x78, 0xb3, 0xea, 0xbe, 0xc9, 0x4b, 0x4d } }
static const DUID	DID_Physics = { 0x71ccead1, 0x37ad, 0x4572, { 0xa2, 0x67, 0x89, 0x52, 0x7, 0xb1, 0x8, 0x2c } }
static const DUID	DID_PhysicsConfig = { 0xe0899640, 0x98ba, 0x4d51, { 0xa3, 0xb5, 0x15, 0xc3, 0x24, 0x80, 0xc, 0xc5 } }
static const DigitalSpaces::DUID	DID_CEGUIConfiguration1 = { 0x8a24b303, 0x2fe1, 0x4f2c, { 0x9b, 0x3e, 0x23, 0x53, 0x4a, 0x3e, 0xc3, 0xc7 } }
static const DUID	DID_CEGUIListboxItem
	{4B02A99F-5F0D-4da4-99E8-ADFCF085E851}
static const DUID	DID_CEGUIListbox
	{7160BCE5-6754-4450-9E88-BF787F3AC4C1}
static const DUID	DID_CEGUI1
	{755C4D31-8453-4600-94C9-A7E9CDA1D391}
const DUID	DID_3DVisualsOgre1
	{3E9F93CA-B8BC-4d2b-939D-438A8479616D}
static const DUID	DID_OGREAxisAlignedBox
	{0A2F46A2-CDE8-44d1-B3E9-DDDE4BD87BF5}
static const DUID	DID_OGRETechnique
	{A57B6560-19FE-48b7-A190-3ABCBF91218C}
static const DUID	DID_OGREPass
static const DUID	DID_OGREViewport
	{464D7D7F-F3DB-4bbe-8DA7-A34A6B07BAA2}
static const DUID	DID_OGRECamera
	{7997740F-E47F-497d-A480-35880E1BFB33}
static const DUID	DID_OGRERenderable
static const DUID	DID_OGRENode
	{6C750127-28BA-4dc6-B447-88FA39D7F84E}
static const DUID	DID_OGRESceneNode
static const DUID	DID_OGREMovableObject
	{0C7F837F-2AFC-4f3f-9C13-CB7654AE4A2F}
static const DUID	DID_OGRELight
	{D82499A3-39DB-4247-AFE3-BFED8975C0B9}
static const DUID	DID_OGREShadowCaster
	{94D9AC48-1709-4e92-B8C5-05A6A9FAF28D}
static const DUID	DID_OGREBone
	{7CF9373C-B304-4283-B7BC-E77DA0D47958}
static const DUID	DID_OGREMaterial
	{4B53CB20-0BF8-4e23-B315-1DF654CCAF9B}
static const DUID	DID_OGREEntity
	{2439A732-EBFD-4f90-AD4F-89465FEAF618}
static const DUID	DID_OGRENodeAnimationTrack
	{5273B095-C465-47d7-84F1-7E157D16B0D9}
static const DUID	DID_OGREAnimation
	{4E12BE38-0870-418e-AFC7-43C2D45A25AF}
static const DUID	DID_OGRESkeleton
	{317B5C81-8EA3-4ed8-B36A-7D02CCB4CA02}
static const DUID	DID_OGRESkeletonInstance
	{20C87E5D-AC5F-4a39-A021-813A92B256F7}
static const DUID	DID_OGRESubEntity
	{48B0980C-1FDA-4699-A5A0-D6458848C0CC}
static const DUID	DID_OGREMesh
	{6FF5EC90-FC63-45e3-A605-1A74940A9865}
static const DUID	DID_OGRESubMesh
	{EAE62663-B99B-4504-B89B-DCDD350C8948}
static const DUID	DID_OGREVertexElement
	{6E3F76B0-47DB-48cc-A39C-B944F2424B1F}
static const DUID	DID_OGREVertexDeclaration
	{331580CD-91B5-4d1a-A5CB-7134C0C0D1D3}
static const DUID	DID_OGREVertexBufferBinding
	{E1E55FD3-776C-4568-8E39-C5F0FF968F48}
static const DUID	DID_OGREHardwareBuffer
	{1C0995D1-95C1-4b7c-8DD4-55A5D2D8E7EF}
static const DUID	DID_OGREHardwareVertexBuffer
	{FBFBD32B-1AEF-40b5-8856-E4489787C91F}
static const DUID	DID_OGREVertexData
	{AB986786-0E73-44b2-B285-01B220366DC5}
static const DUID	DID_OGREHardwareIndexBuffer
	{E2A73383-B786-480b-8B1C-DFC106F8AF3E}
static const DUID	DID_OGREIndexData
	{ED5BDD72-504B-484c-9EF2-A32E5FAAA722}
static const DUID	DID_OGREBillboard
	{C41A27FC-A530-4d53-831C-536EB7096CB0}
static const DUID	DID_OGREBillboardSet
	{8F421A48-B043-4b6c-8904-E01CB9B8A6C2}
static const DUID	DID_OGREParticleEmitter
	{CFAD8F56-3BB0-43d1-B940-6FB7D3B29FDE}
static const DUID	DID_OGREParticleAffector
	{92E09092-B2BF-425c-A710-327C949BD9AD}
static const DUID	DID_OGREParticle
	{13FE5E1F-B6CE-4757-B8FB-B75FAA4AE3BC}
static const DUID	DID_OGREParticleSystem
	{87DEDFBE-8744-4ef5-A9C6-8BE0B1BFA505}
static const DUID	DID_OGREAnimationState
	{12630AD5-2F79-426e-A9BB-9EAEBF099A7A}
static const DUID	DID_OGRESceneQuery
	{65848ED6-0D28-4f5b-8A88-AE03B79D9DF5}
static const DUID	DID_OGREAxisAlignedBoxSceneQuery
	{42CD0A78-99E8-490d-A593-B8A07EC730AC}
static const DUID	DID_OGRESphereSceneQuery
	{8415F32C-909C-4815-86D1-D4580E1ED63B}
static const DUID	DID_OGREPlaneBoundedVolumeListSceneQuery
	{5082FAC1-85BA-4cf4-B58B-05A0A303F460}
static const DUID	DID_OGREPlaneBoundedVolumeList
static const DUID	DID_OGRERaySceneQuery
	{62E667CF-0926-4fb4-AB3B-CBD3F2067FF1}
static const DUID	DID_OGRERay
	{2B778468-373E-4cff-B1A2-CBD133BFB93B}
static const DUID	DID_OGREIntersectionSceneQuery
static const DUID	DID_OGREStaticGeometry
	{14B0DD08-ED00-4724-91D6-C12539108766}
static const DUID	DID_OGRETextureUnitState
static const DUID	DID_OGRESceneManager
	{C9D87A41-3BCF-44ac-8888-4BD6C690FF60}

---

Typedef Documentation

typedef struct DigitalSpaces::_DUID DigitalSpaces::DUID

DigitalSpaces Unique ID.

Based off UUID from Win32 Platform SDK

---

Function Documentation

long DigitalSpaces::DUIDFromString	(	const std::string &	str,
		DUID *	pduid
	)

Converts from a {00000000–0000–0000-C000–000000000046} format string to a DUID.

This implementation is dependant on Window's OLE32 CLSID.

Todo:

Replace this with actual code, rather then linking in

Note:

Is this used anywhere except by the Core .space parser? Consider removing it from the Interfaces header and moving to the Core itself.

bool DigitalSpaces::operator<	(	const DUID &	aUUID,
		const DUID &	bUUID
	)

Operator to allow use in std::map's.

bool DigitalSpaces::operator==	(	const DUID &	aUUID,
		const DUID &	bUUID
	)

Operator to allow use in std::map's.

long DigitalSpaces::StringFromDUID	(	const DUID *	pduid,
		std::string &	str
	)

Converts from a DUID to a {00000000–0000–0000-C000–000000000046} format string.

This implementation is dependant on Window's OLE32 CLSID.

Todo:

Replace this with actual code, rather then linking in

Note:

Is this used anywhere by the Core .space parser? Consider removing it from the Interfaces header and moving to the Core itself.

---

Variable Documentation

const DigitalSpaces::DUID DigitalSpaces::DID_CEGUIConfiguration1 = { 0x8a24b303, 0x2fe1, 0x4f2c, { 0x9b, 0x3e, 0x23, 0x53, 0x4a, 0x3e, 0xc3, 0xc7 } } [static]

const DUID DigitalSpaces::DID_Physics = { 0x71ccead1, 0x37ad, 0x4572, { 0xa2, 0x67, 0x89, 0x52, 0x7, 0xb1, 0x8, 0x2c } } [static]

const DUID DigitalSpaces::DID_PhysicsBody = { 0xba17ae54, 0x58fb, 0x4941, { 0xa1, 0x96, 0xc1, 0xf, 0xc8, 0x85, 0xa4, 0x68 } } [static]

const DUID DigitalSpaces::DID_PhysicsCollision = { 0xd04a5d2f, 0xaa48, 0x4417, { 0x94, 0x57, 0x56, 0x7e, 0x9, 0x51, 0xe4, 0x83 } } [static]

const DUID DigitalSpaces::DID_PhysicsConfig = { 0xe0899640, 0x98ba, 0x4d51, { 0xa3, 0xb5, 0x15, 0xc3, 0x24, 0x80, 0xc, 0xc5 } } [static]

const DUID DigitalSpaces::DID_PhysicsJoint = { 0x1cf6faf3, 0xedb9, 0x47a8, { 0xa2, 0x83, 0x98, 0x5, 0x83, 0x6c, 0x5f, 0xc5 } } [static]

const DUID DigitalSpaces::DID_PhysicsMaterial = { 0x2e83818d, 0x9109, 0x466b, { 0xbb, 0xf7, 0x56, 0x31, 0xad, 0x70, 0x8e, 0xdc } } [static]

const DUID DigitalSpaces::DID_PhysicsShape = { 0x585b81ac, 0x5888, 0x49a0, { 0xa1, 0x37, 0xeb, 0xe7, 0xeb, 0xd4, 0xce, 0x0 } } [static]

const DUID DigitalSpaces::DID_PhysicsWorld = { 0x18d22a9b, 0x3277, 0x4894, { 0x89, 0x78, 0xb3, 0xea, 0xbe, 0xc9, 0x4b, 0x4d } } [static]