Ocean::SceneDescription::SDLNode Class Reference

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

#include <SDLNode.h>

Inheritance diagram for Ocean::SceneDescription::SDLNode:

Public Member Functions
DescriptionType	descriptionType () const override
	Returns the scene description type of this node.
virtual Rendering::ObjectRef	apply (const Rendering::EngineRef &engine, const SDLScene &scene, SDLNode &parentDescription, const Rendering::ObjectRef &parentRendering)=0
	Applies this node to the rendering engine.
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.

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
typedef std::map< std::string, Field * >	FieldMap
	Definition of a map mapping field names to fields.
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.
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::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 scene description nodes.

Member Function Documentation

apply()

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

pure virtual

Applies this node to the rendering engine.

Parameters

engine	Rendering engine to apply to
scene	Scene object holding all nodes
parentDescription	Parent scene description node
parentRendering	Parent rendering node

Returns

Resulting rendering object

Implemented in Ocean::SceneDescription::SDLScene.

descriptionType()

DescriptionType Ocean::SceneDescription::SDLNode::descriptionType ( ) const

overridevirtual

Returns the scene description type of this node.

See also

Node::descriptionType().

Implements Ocean::SceneDescription::Node.

---

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

• SDLNode.h