The Ocean SceneDescription Library is the base library and organizer of all scene description libraries. More...

Collaboration diagram for Ocean SceneDescription Abstraction Library:

Modules
	Ocean SceneDescription SDL Assimp Library
	The Ocean SceneDescription SDL Assimp Library implements a scene description interface for assimp-supported files.

	Ocean SceneDescription SDL OBJ Library
	The Ocean SceneDescription SDL OBJ Library implements a scene description interface for obj files.

	Ocean SceneDescription SDX X3D Library
	The Ocean SceneDescription SDX X3D Library implements a scene description interface for X3D files.

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

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

class	Ocean::SceneDescription::Field0D< T >
	This class implements all 0D fields (fields holding a single value only). More...

class	Ocean::SceneDescription::Field1D< T >
	This class implements all 1D fields (fields holding an array of single values). More...

class	Ocean::SceneDescription::TypeMapper< T >
	Class providing mapping between scalar field types and real types. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

using	Ocean::SceneDescription::NodeId = size_t
	Definition of a object id.

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

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

using	Ocean::SceneDescription::SDX::X3D::X3DNodeRef = SmartObjectRef< X3DNode, Node >
	Definition of a smart object reference for abstract X3D nodes.

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

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

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

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

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

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

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

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

Detailed Description

The Ocean SceneDescription Library is the base library and organizer of all scene description libraries.

Several different scene description libraries can be registered and managed at the same time.
Each library may support a different types of scene description files / specifications.
The Manager object manages all registered libraries and hides the internal complexity.
The library is platform independent.

See also: Manager, Scene

Typedef Documentation

◆ DynamicNodeRef

using Ocean::SceneDescription::DynamicNodeRef = typedef SmartObjectRef<DynamicNode, Node>

Definition of a smart object reference for X scene description nodes.

See also: DynamicNode, Node.

◆ MultiBool

using Ocean::SceneDescription::MultiBool = typedef Field1D<bool>

Definition of a multi field with boolean values.

◆ MultiColor

using Ocean::SceneDescription::MultiColor = typedef Field1D<RGBAColor>

Definition of a multi field with color values.

◆ MultiFloat

using Ocean::SceneDescription::MultiFloat = typedef Field1D<Scalar>

Definition of a multi field with float values.

◆ MultiInt

using Ocean::SceneDescription::MultiInt = typedef Field1D<int>

Definition of a multi field with integer values.

◆ MultiMatrix3

using Ocean::SceneDescription::MultiMatrix3 = typedef Field1D<SquareMatrix3>

Definition of a multi field with 3x3 matrix values.

◆ MultiMatrix4

using Ocean::SceneDescription::MultiMatrix4 = typedef Field1D<SquareMatrix4>

Definition of a multi field with 4x4 matrix values.

◆ MultiNode

using Ocean::SceneDescription::MultiNode = typedef Field1D<NodeRef>

Definition of a multi field with node values.

◆ MultiRotation

using Ocean::SceneDescription::MultiRotation = typedef Field1D<Rotation>

Definition of a multi field with rotation values.

◆ MultiString

using Ocean::SceneDescription::MultiString = typedef Field1D<std::string>

Definition of a multi field with string values.

◆ MultiTime

using Ocean::SceneDescription::MultiTime = typedef Field1D<Timestamp>

Definition of a multi field with time values.

◆ MultiVector2

using Ocean::SceneDescription::MultiVector2 = typedef Field1D<Vector2>

Definition of a multi field with 2D vector values.

◆ MultiVector3

using Ocean::SceneDescription::MultiVector3 = typedef Field1D<Vector3>

Definition of a multi field with 3D vector values.

◆ MultiVector4

using Ocean::SceneDescription::MultiVector4 = typedef Field1D<Vector4>

Definition of a multi field with 4D vector values.

◆ NodeId

using Ocean::SceneDescription::NodeId = typedef size_t

Definition of a object id.

◆ NodeRef

using Ocean::SceneDescription::NodeRef = typedef Ocean::ObjectRef<Node>

Definition of a scene description node reference with an internal reference counter.

See also: Node.

◆ NodeRefs

using Ocean::SceneDescription::NodeRefs = typedef std::vector<NodeRef>

Definition of a vector holding scene description node references.

◆ SceneRef

using Ocean::SceneDescription::SceneRef = typedef SmartObjectRef<Scene, Node>

Definition of a smart object reference for scene desciption scenes.

See also: Scene, Node.

◆ SDLNodeRef

using Ocean::SceneDescription::SDLNodeRef = typedef SmartObjectRef<SDLNode, Node>

Definition of a smart object reference for loader scene description nodes.

See also: SDLNode, Node.

◆ SDLSceneRef

using Ocean::SceneDescription::SDLSceneRef = typedef SmartObjectRef<SDLScene, Node>

Definition of a smart object reference for scene desciption loader scenes.

See also: SDLScene, Node.

◆ SDXDynamicNodeRef

using Ocean::SceneDescription::SDXDynamicNodeRef = typedef SmartObjectRef<SDXDynamicNode, Node>

Definition of a smart object reference for SDX dynamic scene description nodes.

See also: SDXDynamicNode, Node.

◆ SDXNodeRef

using Ocean::SceneDescription::SDXNodeRef = typedef SmartObjectRef<SDXNode, Node>

Definition of a smart object reference for SDX scene description nodes.

See also: SDXNode, Node.

◆ SDXNodeSet

using Ocean::SceneDescription::SDXNodeSet = typedef std::set<SDXNodeRef>

Definition of a set holding SDX node references.

◆ SDXSceneRef

using Ocean::SceneDescription::SDXSceneRef = typedef SmartObjectRef<SDXScene, Node>

Definition of a smart object reference for scene desciption X scenes.

See also: SDXScene, Node.

◆ SingleBool

using Ocean::SceneDescription::SingleBool = typedef Field0D<bool>

Definition of a single field with boolean value.

◆ SingleColor

using Ocean::SceneDescription::SingleColor = typedef Field0D<RGBAColor>

Definition of a single field with color value.

◆ SingleFloat

using Ocean::SceneDescription::SingleFloat = typedef Field0D<Scalar>

Definition of a single field with float value.

◆ SingleInt

using Ocean::SceneDescription::SingleInt = typedef Field0D<int>

Definition of a single field with integer value.

◆ SingleMatrix3

using Ocean::SceneDescription::SingleMatrix3 = typedef Field0D<SquareMatrix3>

Definition of a single field with 3x3 matrix value.

◆ SingleMatrix4

using Ocean::SceneDescription::SingleMatrix4 = typedef Field0D<SquareMatrix4>

Definition of a single field with 4x4 matrix value.

◆ SingleNode

using Ocean::SceneDescription::SingleNode = typedef Field0D<NodeRef>

Definition of a single field with node value.

◆ SingleRotation

using Ocean::SceneDescription::SingleRotation = typedef Field0D<Rotation>

Definition of a single field with rotation value.

◆ SingleString

using Ocean::SceneDescription::SingleString = typedef Field0D<std::string>

Definition of a single field with string value.

◆ SingleTime

using Ocean::SceneDescription::SingleTime = typedef Field0D<Timestamp>

Definition of a single field with time value.

◆ SingleVector2

using Ocean::SceneDescription::SingleVector2 = typedef Field0D<Vector2>

Definition of a single field with 2D vector value.

◆ SingleVector3

using Ocean::SceneDescription::SingleVector3 = typedef Field0D<Vector3>

Definition of a single field with 3D vector value.

◆ SingleVector4

using Ocean::SceneDescription::SingleVector4 = typedef Field0D<Vector4>

Definition of a single field with 4D vector value.

◆ X3DNodeRef

using Ocean::SceneDescription::SDX::X3D::X3DNodeRef = typedef SmartObjectRef<X3DNode, Node>

Definition of a smart object reference for abstract X3D nodes.

See also: X3DNode, Node.

Enumeration Type Documentation

◆ ButtonEvent

enum Ocean::SceneDescription::ButtonEvent

Definition of different device events.

Enumerator
EVENT_PRESS	Press event.
EVENT_HOLD	Hold event.
EVENT_RELEASE	Release event.

◆ ButtonType

enum Ocean::SceneDescription::ButtonType

Definition of different button types.

Enumerator
BUTTON_NONE
BUTTON_LEFT	Left button.
BUTTON_MIDDLE	Middle button.
BUTTON_RIGHT	Right button.

◆ DescriptionType

enum Ocean::SceneDescription::DescriptionType : uint32_t

Definition of different scene description types.

Enumerator
TYPE_TRANSIENT	A scene description holding a transient scene hierarchy only.
TYPE_PERMANENT	A scene description holding a permanent scene hierarchy allowing permanent access.

Variable Documentation

◆ invalidNodeId

constexpr NodeId Ocean::SceneDescription::invalidNodeId = NodeId(-1)

constexpr

Definition of an invalid object id.

Modules

Data Structures

Typedefs

Enumerations

Variables