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

#include <SDLScene.h>

Inheritance diagram for Ocean::SceneDescription::SDLScene:

Public Member Functions
Rendering::SceneRef	apply (const Rendering::EngineRef &engine)
	Applies the entire scene to the rendering engine.

Public Member Functions inherited from Ocean::SceneDescription::Scene
	Scene (const std::string &filename)
	Creates a new scene object.

const std::string &	filename () const
	Returns the filename of this scene.

Public Member Functions inherited from Ocean::SceneDescription::Node
NodeId	id () const
	Returns the unique node id of this node.

const std::string &	name () const
	Returns the name of this node.

const std::string &	type () const
	Returns the type of this node.

const Field &	field (const std::string &fieldName) const
	Returns the field base of a specified (standard) field.

Field &	field (const std::string &fieldName)
	Returns the field base of a specified (standard) field.

virtual const Field &	anyField (const std::string &fieldName) const
	Returns the field base of a specified standard or dynamic field.

virtual Field &	anyField (const std::string &fieldName)
	Returns the field base of a specified standard or dynamic field.

template<typename T >
const T &	field (const std::string &fieldName) const
	Returns a specified (standard) field.

template<typename T >
T &	field (const std::string &fieldName)
	Returns a specified (standard) field.

template<typename T >
const T &	anyField (const std::string &fieldName) const
	Returns a specified standard or dynamic field.

template<typename T >
T &	anyField (const std::string &fieldName)
	Returns a specified standard or dynamic field.

FieldAccessType	fieldAccessType (const std::string &fieldName) const
	Returns the access type of a specified field.

virtual void	setName (const std::string &name)
	Sets the name of this node.

bool	hasField (const std::string &fieldName) const
	Returns whether this node has a special (standard) field.

virtual bool	hasAnyField (const std::string &fieldName) const
	Returns whether this node has a special standard or dynamic field.

virtual std::string	originalFieldName (const std::string &fieldName) const
	Tries to translate an alias field name to the original field name.

Field::Type	fieldType (const std::string &fieldName) const
	Returns the type of a special field.

unsigned int	fieldDimension (const std::string &fieldName) const
	Return the dimension of a special field.

virtual bool	isDynamic () const
	Returns whether this node can hold dynamic generated field.

Public Member Functions inherited from Ocean::SceneDescription::SDLNode
DescriptionType	descriptionType () const override
	Returns the scene description type of this node.

Protected Member Functions
	SDLScene (const std::string &filename)
	Creates a new scene object.

virtual Rendering::SceneRef	internalApply (const Rendering::EngineRef &engine)=0
	Internal function to apply the entire scene to the rendering engine.

Rendering::ObjectRef	apply (const Rendering::EngineRef &engine, const SDLScene &scene, SDLNode &parentDescription, const Rendering::ObjectRef &parentRendering) override
	Applies this node to the rendering engine.

Protected Member Functions inherited from Ocean::SceneDescription::Node
	Node ()
	Creates a new node.

	Node (const Node &node)=delete
	Disabled copy constructor.

virtual	~Node ()
	Destructs a node.

virtual size_t	objectAddress () const
	Returns the address of the most derived object.

void	registerField (NodeSpecification &specification, const std::string &fieldName, const Field &field, const FieldAccessType accessType=ACCESS_GET_SET)
	Registers a new field to a specified node type.

Node &	operator= (const Node &node)=delete
	Disabled copy operator.

Additional Inherited Members
Public Types inherited from Ocean::SceneDescription::Node
enum	FieldAccessType { ACCESS_NONE = 0 , ACCESS_GET = 1 , ACCESS_SET = 2 , ACCESS_GET_SET = ACCESS_GET \| ACCESS_SET , ACCESS_EXPLICIT_NOTIFICATION = 4 }
	Definition of different field access types. More...

Protected Types inherited from Ocean::SceneDescription::Node
using	FieldMap = std::map< std::string, Field * >
	Definition of a map mapping field names to fields.

Static Protected Member Functions inherited from Ocean::SceneDescription::Node
static Lock &	nodeIdCounterLock ()
	Returns the lock for the node id counter.

Protected Attributes inherited from Ocean::SceneDescription::Scene
std::string	filename_
	Filename of this scene.

Protected Attributes inherited from Ocean::SceneDescription::Node
NodeId	nodeId_
	Unique node id.

std::string	name_
	Node name.

NodeSpecification *	specification_ = nullptr
	Pointer to the node specification, guaranteed to exist as long as the node exist.

Static Protected Attributes inherited from Ocean::SceneDescription::Node
static NodeId	nodeIdCounter_
	Unique node id counter.

Detailed Description

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

A new scene object can be created by the scene description Manager object.

Constructor & Destructor Documentation

◆ SDLScene()

Ocean::SceneDescription::SDLScene::SDLScene ( const std::string & filename )

protected

Creates a new scene object.

Parameters

filename Scene filename

Member Function Documentation

◆ apply() [1/2]

Rendering::SceneRef Ocean::SceneDescription::SDLScene::apply ( const Rendering::EngineRef & engine )

Applies the entire scene to the rendering engine.

Parameters

engine Rendering engine to use

Returns: Resulting rendering scene object

◆ apply() [2/2]

Rendering::ObjectRef Ocean::SceneDescription::SDLScene::apply	(	const Rendering::EngineRef &	engine,
		const SDLScene &	scene,
		SDLNode &	parentDescription,
		const Rendering::ObjectRef &	parentRendering
	)

overrideprotectedvirtual

Applies this node to the rendering engine.

Don't use this function for a scene, use Scene::apply(Rendering::Engine&) instead.

See also: Node::apply().

Implements Ocean::SceneDescription::SDLNode.

◆ internalApply()

virtual Rendering::SceneRef Ocean::SceneDescription::SDLScene::internalApply ( const Rendering::EngineRef & engine )

protectedpure virtual

Internal function to apply the entire scene to the rendering engine.

Parameters

engine Rendering engine to use

Returns: Resulting rendering scene object

Implemented in Ocean::SceneDescription::SDL::Assimp::AssimpScene, and Ocean::SceneDescription::SDL::OBJ::OBJScene.

The documentation for this class was generated from the following file:

SDLScene.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SDLScene()

Member Function Documentation

◆ apply() [1/2]

◆ apply() [2/2]

◆ internalApply()