This is the base class for all rendering groups. More...

#include <Group.h>

Inheritance diagram for Ocean::Rendering::Group:

Public Member Functions
virtual void	addChild (const NodeRef &node)
	Adds a new child node to this group.

virtual void	registerLight (const LightSourceRef &light)
	Registers a light lighting all childs of this group node.

virtual unsigned int	numberChildren () const
	Returns the number of child nodes connected to this group.

virtual NodeRef	child (const unsigned int index) const
	Returns a specific child node defined by it's index.

virtual void	removeChild (const NodeRef &node)
	Removes a child node connected to this group.

virtual void	unregisterLight (const LightSourceRef &light)
	Unregisters a light.

virtual void	clear ()
	Removes all child nodes connected to this group.

ObjectType	type () const override
	Returns the type of this object.

Public Member Functions inherited from Ocean::Rendering::Node
ObjectType	type () const override
	Returns the type of this object.

virtual bool	visible () const
	Returns whether the node is visible.

virtual BoundingBox	boundingBox (const bool involveLocalTransformation=true) const
	Returns the bounding box of this node.

virtual BoundingSphere	boundingSphere (const bool involveLocalTransformation=true) const
	Returns the bounding sphere of this node.

virtual HomogenousMatrix4	worldTransformation () const
	Returns the first possible transformation transforming this node into world coordinates.

virtual HomogenousMatrices4	worldTransformations () const
	Returns all possible transformations transforming this node into world coordinates.

virtual void	setVisible (const bool visible)
	Sets whether the node is visible.

Public Member Functions inherited from Ocean::Rendering::Object
ObjectId	id () const
	Returns the unique object id of this object.

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

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

virtual const std::string &	engineName () const =0
	Returns the name of the owner engine.

ObjectRefs	parentObjects () const
	Returns all parent objects.

ObjectRefSet	parentNodes () const
	Returns all parent nodes.

virtual std::string	descriptiveInformation () const
	Returns descriptive information about the object as string.

Protected Types
typedef std::vector< NodeRef >	Nodes
	Definition of a vector holding node objects.

typedef std::set< LightSourceRef >	LightSet
	Definition of a set holding light objects.

Protected Member Functions
	Group ()
	Creates a new group object.

	~Group () override
	Destructs a group object.

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

	~Node () override
	Destructs a node.

Protected Member Functions inherited from Ocean::Rendering::Object
	Object ()
	Creates a new object.

	Object (const Object &object)=delete
	Disabled copy constructor.

virtual	~Object ()
	Destructs an object.

Engine &	engine () const
	Returns the render engine which is owner of this object.

void	registerParent (const ObjectId parentId)
	Registers a parent node for this (child) node.

void	unregisterParent (const ObjectId parentId)
	Unregisters a parent node for this (child) node.

void	registerThisObjectAsParent (const ObjectRef &child)
	Registers this object at a child as parent object.

void	unregisterThisObjectAsParent (const ObjectRef &child)
	Unregisters this object from a child as parent.

Object &	operator= (const Object &object)=delete
	Disabled copy operator.

Protected Attributes
Nodes	groupNodes
	Child nodes connected to this group.

LightSet	groupLights
	Set holding all lights lighting object in this group.

Protected Attributes inherited from Ocean::Rendering::Object
Lock	objectLock
	Lock for the object.

Additional Inherited Members
Public Types inherited from Ocean::Rendering::Object
enum	ObjectType { TYPE_UNKNOWN , TYPE_ABSOLUTE_TRANSFORM , TYPE_ATTRIBUTE , TYPE_ATTRIBUTE_SET , TYPE_BACKGROUND , TYPE_BILLBOARD , TYPE_BITMAP_FRAMEBUFFER , TYPE_BLEND_ATTRIBUTE , TYPE_BOX , TYPE_CONE , TYPE_CYLINDER , TYPE_DEPTH_ATTRIBUTE , TYPE_DIRECTIONAL_LIGHT , TYPE_FRAMEBUFFER , TYPE_FRAME_TEXTURE_2D , TYPE_GEOMETRY , TYPE_GROUP , TYPE_INDEPENDENT_PRIMITIVE , TYPE_LIGHT_SOURCE , TYPE_LINES , TYPE_LINE_STRIPS , TYPE_LOD , TYPE_MATERIAL , TYPE_NODE , TYPE_OBJECT , TYPE_PARALLEL_VIEW , TYPE_PERSPECTIVE_VIEW , TYPE_PHANTOM_ATTRIBUTE , TYPE_POINT_LIGHT , TYPE_POINTS , TYPE_PRIMITIVE , TYPE_PRIMITIVE_ATTRIBUTE , TYPE_QUAD_STRIPS , TYPE_QUADS , TYPE_RENDERABLE , TYPE_SCENE , TYPE_SHADER_PROGRAM , TYPE_SHAPE , TYPE_SKY_BACKGROUND , TYPE_SPHERE , TYPE_SPOT_LIGHT , TYPE_STEREO_ATTRIBUTE , TYPE_STEREO_VIEW , TYPE_STRIP_PRIMITIVE , TYPE_SWITCH , TYPE_TEXT , TYPE_TEXTURE , TYPE_TEXTURE_2D , TYPE_MEDIA_TEXTURE_2D , TYPE_TEXTURE_FRAMEBUFFER , TYPE_TEXTURES , TYPE_TRANSFORM , TYPE_TRIANGLE_FANS , TYPE_TRIANGLES , TYPE_TRIANGLE_STRIPS , TYPE_UNDISTORTED_BACKGROUND , TYPE_VERTEX_SET , TYPE_VIEW , TYPE_WINDOW_FRAMEBUFFER }
	Definition of different object type. More...

typedef std::unordered_map< ObjectId, unsigned int >	ObjectIdMap
	Definition of a map holding object ids to reference counters.

Static Public Member Functions inherited from Ocean::Rendering::Object
static std::string	translateObjectType (const ObjectType objectType)
	Translates an object type to a readable string.

Detailed Description

This is the base class for all rendering groups.

Member Typedef Documentation

◆ LightSet

typedef std::set<LightSourceRef> Ocean::Rendering::Group::LightSet

protected

Definition of a set holding light objects.

◆ Nodes

typedef std::vector<NodeRef> Ocean::Rendering::Group::Nodes

protected

Definition of a vector holding node objects.

Constructor & Destructor Documentation

◆ Group()

Ocean::Rendering::Group::Group ( )

protected

Creates a new group object.

◆ ~Group()

Ocean::Rendering::Group::~Group ( )

overrideprotected

Destructs a group object.

Member Function Documentation

◆ addChild()

virtual void Ocean::Rendering::Group::addChild ( const NodeRef & node )

virtual

Adds a new child node to this group.

Parameters

node	New child node to add

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESGroup, and Ocean::Rendering::GlobalIllumination::GIGroup.

◆ child()

virtual NodeRef Ocean::Rendering::Group::child ( const unsigned int index ) const

virtual

Returns a specific child node defined by it's index.

Parameters

index Index of the child node inside this group

Returns: Child node

◆ clear()

virtual void Ocean::Rendering::Group::clear ( )

virtual

Removes all child nodes connected to this group.

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESGroup, and Ocean::Rendering::GlobalIllumination::GIGroup.

◆ numberChildren()

virtual unsigned int Ocean::Rendering::Group::numberChildren ( ) const

virtual

Returns the number of child nodes connected to this group.

Returns: Number of child nodes

◆ registerLight()

virtual void Ocean::Rendering::Group::registerLight ( const LightSourceRef & light )

virtual

Registers a light lighting all childs of this group node.

Parameters

light Light to register

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESGroup, and Ocean::Rendering::GlobalIllumination::GIGroup.

◆ removeChild()

virtual void Ocean::Rendering::Group::removeChild ( const NodeRef & node )

virtual

Removes a child node connected to this group.

Parameters

node	Child node to remove

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESGroup, and Ocean::Rendering::GlobalIllumination::GIGroup.

◆ type()

ObjectType Ocean::Rendering::Group::type ( ) const

overridevirtual

Returns the type of this object.

See also: Object::type().

Reimplemented from Ocean::Rendering::Object.

Reimplemented in Ocean::Rendering::LOD, Ocean::Rendering::Scene, Ocean::Rendering::Switch, and Ocean::Rendering::Transform.

◆ unregisterLight()

virtual void Ocean::Rendering::Group::unregisterLight ( const LightSourceRef & light )

virtual

Unregisters a light.

Parameters

light Light to unregister

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESGroup, and Ocean::Rendering::GlobalIllumination::GIGroup.

Field Documentation

◆ groupLights

LightSet Ocean::Rendering::Group::groupLights

protected

Set holding all lights lighting object in this group.

◆ groupNodes

Nodes Ocean::Rendering::Group::groupNodes

protected

Child nodes connected to this group.

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

rendering/Group.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ LightSet

◆ Nodes

Constructor & Destructor Documentation

◆ Group()

◆ ~Group()

Member Function Documentation

◆ addChild()

◆ child()

◆ clear()

◆ numberChildren()

◆ registerLight()

◆ removeChild()

◆ type()

◆ unregisterLight()

Field Documentation

◆ groupLights

◆ groupNodes