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

#include <Scene.h>

Inheritance diagram for Ocean::Rendering::Scene:

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

virtual bool	useHeadlight () const
	Returns whether this scene is lit with the view's headlight in case the view's headlight is active.

virtual void	setUseHeadlight (const bool state)
	Sets whether this scene is lit with the view's headlight in case the view's headlight is active.

Public Member Functions inherited from Ocean::Rendering::Transform
virtual HomogenousMatrix4	transformation () const =0
	Returns the transformation of this node relative to the parent node.

virtual SharedTransformModifier	transformModifier () const =0
	Returns the TransformModifier object of this transform.

virtual void	setTransformation (const HomogenousMatrix4 &parent_T_transform)=0
	Sets the transformation of this node relative to the parent node.

virtual void	setTransformModifier (SharedTransformModifier transformModifier)=0
	Sets the TransformModifier object for this transformation.

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

Public Member Functions inherited from Ocean::Rendering::Group
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.

Public Member Functions inherited from Ocean::Rendering::Node
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 Member Functions
	Scene ()
	Creates a new scene object.

	~Scene () override
	Destructs a scene object.

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

	~Transform () override
	Destructs a transform node.

Protected Member Functions inherited from Ocean::Rendering::Group
	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
bool	useViewHeadlight_ = true
	True, to light this scene with the view's headlight in case the view's headlight is active; False; to not use the view's headlight in any case.

Protected Attributes inherited from Ocean::Rendering::Group
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::Transform
using	SharedTransformModifier = std::shared_ptr< TransformModifier >
	Definition of a shared pointer holding a TransformModifier object.

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...

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

Static Public Member Functions inherited from Ocean::Rendering::Transform
static SharedTransformModifier	createTransformModifier ()
	Creates a TransformModifier object.

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

Protected Types inherited from Ocean::Rendering::Group
using	Nodes = std::vector< NodeRef >
	Definition of a vector holding node objects.

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

Detailed Description

This is the base class for all rendering scenes.

A once created scene can be added to a framebuffer to render the defined scene with all child nodes.

See also: Framebuffer

Constructor & Destructor Documentation

◆ Scene()

Ocean::Rendering::Scene::Scene ( )

protected

Creates a new scene object.

◆ ~Scene()

Ocean::Rendering::Scene::~Scene ( )

overrideprotected

Destructs a scene object.

Member Function Documentation

◆ setUseHeadlight()

virtual void Ocean::Rendering::Scene::setUseHeadlight ( const bool state )

virtual

Sets whether this scene is lit with the view's headlight in case the view's headlight is active.

Parameters

state True, to light this scene with the view's headlight in case the view's headlight is active; False; to not use the view's headlight in any case

Reimplemented in Ocean::Rendering::GlobalIllumination::GIScene.

◆ type()

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

overridevirtual

Returns the type of this object.

See also: Object::type().

Reimplemented from Ocean::Rendering::Group.

◆ useHeadlight()

virtual bool Ocean::Rendering::Scene::useHeadlight ( ) const

virtual

Returns whether this scene is lit with the view's headlight in case the view's headlight is active.

Returns: True, if so; True, by default

Field Documentation

◆ useViewHeadlight_

bool Ocean::Rendering::Scene::useViewHeadlight_ = true

protected

True, to light this scene with the view's headlight in case the view's headlight is active; False; to not use the view's headlight in any case.

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

rendering/Scene.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members