Namespace of the SceneDescription library. More...

Namespaces
namespace	SDL

namespace	SDX

Data Structures
class	DynamicNode
	This class is the base class for all nodes able to handle fields loaded during runtime. More...

class	Field
	This class is the base class for all scene description fields. More...

class	Field0D
	This class implements all 0D fields (fields holding a single value only). More...

class	Field1D
	This class implements all 1D fields (fields holding an array of single values). More...

class	Library
	This class is the base class for all scene description libraries. More...

class	Manager
	This class implements the manager for all scene descriptions. More...

class	Node
	This class is the base class for all scene description nodes. More...

class	NodeRefManager
	This class implements a scene description node reference manager. More...

class	Scene
	This class implements the base class for all scene objects providing access to all elements of a scene. More...

class	SDLNode
	This class implements the base class for all scene description nodes. More...

class	SDLScene
	This class implements the base class for all sdl scene object providing access to all elements of a scene. More...

class	SDXDynamicNode
	This class implements the base class for all dynamic SDX scene description nodes. More...

class	SDXEventNode
	This class implements the base class for all nodes receiving event calls regularly. More...

class	SDXNode
	This class implements the base class for all SDX scene description nodes. More...

class	SDXScene
	This class implements the base class for all sdx scene object providing access to all elements of a scene. More...

class	SDXUpdateNode
	This class implements the base class for all nodes needing update calls regularly. More...

class	TypeMapper
	Class providing mapping between scalar field types and real types. More...

Typedefs
using	DynamicNodeRef = SmartObjectRef< DynamicNode, Node >
	Definition of a smart object reference for X scene description nodes.

using	SingleBool = Field0D< bool >
	Definition of a single field with boolean value.

using	SingleColor = Field0D< RGBAColor >
	Definition of a single field with color value.

using	SingleFloat = Field0D< Scalar >
	Definition of a single field with float value.

using	SingleInt = Field0D< int >
	Definition of a single field with integer value.

using	SingleNode = Field0D< NodeRef >
	Definition of a single field with node value.

using	SingleMatrix3 = Field0D< SquareMatrix3 >
	Definition of a single field with 3x3 matrix value.

using	SingleMatrix4 = Field0D< SquareMatrix4 >
	Definition of a single field with 4x4 matrix value.

using	SingleRotation = Field0D< Rotation >
	Definition of a single field with rotation value.

using	SingleString = Field0D< std::string >
	Definition of a single field with string value.

using	SingleTime = Field0D< Timestamp >
	Definition of a single field with time value.

using	SingleVector2 = Field0D< Vector2 >
	Definition of a single field with 2D vector value.

using	SingleVector3 = Field0D< Vector3 >
	Definition of a single field with 3D vector value.

using	SingleVector4 = Field0D< Vector4 >
	Definition of a single field with 4D vector value.

using	MultiBool = Field1D< bool >
	Definition of a multi field with boolean values.

using	MultiColor = Field1D< RGBAColor >
	Definition of a multi field with color values.

using	MultiFloat = Field1D< Scalar >
	Definition of a multi field with float values.

using	MultiInt = Field1D< int >
	Definition of a multi field with integer values.

using	MultiNode = Field1D< NodeRef >
	Definition of a multi field with node values.

using	MultiMatrix3 = Field1D< SquareMatrix3 >
	Definition of a multi field with 3x3 matrix values.

using	MultiMatrix4 = Field1D< SquareMatrix4 >
	Definition of a multi field with 4x4 matrix values.

using	MultiRotation = Field1D< Rotation >
	Definition of a multi field with rotation values.

using	MultiString = Field1D< std::string >
	Definition of a multi field with string values.

using	MultiTime = Field1D< Timestamp >
	Definition of a multi field with time values.

using	MultiVector2 = Field1D< Vector2 >
	Definition of a multi field with 2D vector values.

using	MultiVector3 = Field1D< Vector3 >
	Definition of a multi field with 3D vector values.

using	MultiVector4 = Field1D< Vector4 >
	Definition of a multi field with 4D vector values.

using	LibraryRef = ObjectRef< Library >
	Definition of a object reference holding a library object.

using	NodeRef = Ocean::ObjectRef< Node >
	Definition of a scene description node reference with an internal reference counter.

using	NodeRefs = std::vector< NodeRef >
	Definition of a vector holding scene description node references.

using	SceneRef = SmartObjectRef< Scene, Node >
	Definition of a smart object reference for scene desciption scenes.

using	NodeId = size_t
	Definition of a object id.

using	SceneId = size_t
	Definition of a unique scene id.

using	SDLNodeRef = SmartObjectRef< SDLNode, Node >
	Definition of a smart object reference for loader scene description nodes.

using	SDLSceneRef = SmartObjectRef< SDLScene, Node >
	Definition of a smart object reference for scene desciption loader scenes.

using	SDXDynamicNodeRef = SmartObjectRef< SDXDynamicNode, Node >
	Definition of a smart object reference for SDX dynamic scene description nodes.

using	SDXNodeRef = SmartObjectRef< SDXNode, Node >
	Definition of a smart object reference for SDX scene description nodes.

using	SDXNodeSet = std::set< SDXNodeRef >
	Definition of a set holding SDX node references.

using	SDXSceneRef = SmartObjectRef< SDXScene, Node >
	Definition of a smart object reference for scene desciption X scenes.

Enumerations
enum	DescriptionType : uint32_t { TYPE_TRANSIENT = 1u , TYPE_PERMANENT = 2u }
	Definition of different scene description types. More...

enum	ButtonType { BUTTON_NONE , BUTTON_LEFT , BUTTON_MIDDLE , BUTTON_RIGHT }
	Definition of different button types. More...

enum	ButtonEvent { EVENT_PRESS , EVENT_HOLD , EVENT_RELEASE }
	Definition of different device events. More...

Variables
constexpr NodeId	invalidNodeId = NodeId(-1)
	Definition of an invalid object id.

constexpr SceneId	invalidSceneId = SceneId(-1)
	Definition of an invalid scene id.

Detailed Description

Namespace of the SceneDescription library.

The Namespace Ocean::SceneDescription is used in the entire Ocean SceneDescription Library.

Typedef Documentation

◆ SceneId

using Ocean::SceneDescription::SceneId = typedef size_t

Definition of a unique scene id.

Variable Documentation

◆ invalidSceneId

constexpr SceneId Ocean::SceneDescription::invalidSceneId = SceneId(-1)

constexpr

Definition of an invalid scene id.

Namespaces

Data Structures

Typedefs

Enumerations

Variables

Detailed Description

Typedef Documentation

◆ SceneId

Variable Documentation

◆ invalidSceneId