This class implements a stereo attribute specifying the stereo behavior for associated objects. More...

#include <StereoAttribute.h>

Inheritance diagram for Ocean::Rendering::StereoAttribute:

Public Types
enum	StereoVisibility { SV_NONE = 0 , SV_LEFT = 1 , SV_RIGHT = 2 , SV_LEFT_AND_RIGHT = SV_LEFT \| SV_RIGHT }
	Definition of different stereo visibilities. More...

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.

Public Member Functions
virtual StereoVisibility	stereoVisibility () const
	Returns the stereo visibility property.

virtual void	setStereoVisibility (const StereoVisibility stereoVisibility)
	Sets the stereo visibility property.

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

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
	StereoAttribute ()
	Creates a new stereo attribute object.

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

	~Attribute () override
	Destructs an attribute object.

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.

Additional Inherited Members
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 Attributes inherited from Ocean::Rendering::Object
Lock	objectLock
	Lock for the object.

Detailed Description

This class implements a stereo attribute specifying the stereo behavior for associated objects.

Member Enumeration Documentation

◆ StereoVisibility

enum Ocean::Rendering::StereoAttribute::StereoVisibility

Definition of different stereo visibilities.

Enumerator
SV_NONE	The object is neither visible in the left nor in the right stereo view.
SV_LEFT	The object is visible in the left stereo view.
SV_RIGHT	The object is visible in the right stereo view.
SV_LEFT_AND_RIGHT	The object is visbile in left and right stereo view, this is the default property.

Constructor & Destructor Documentation

◆ StereoAttribute()

Ocean::Rendering::StereoAttribute::StereoAttribute ( )

protected

Creates a new stereo attribute object.

Member Function Documentation

◆ setStereoVisibility()

virtual void Ocean::Rendering::StereoAttribute::setStereoVisibility ( const StereoVisibility stereoVisibility )

virtual

Sets the stereo visibility property.

Parameters

stereoVisibility The stereo visibility to be set

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESStereoAttribute.

◆ stereoVisibility()

virtual StereoVisibility Ocean::Rendering::StereoAttribute::stereoVisibility ( ) const

virtual

Returns the stereo visibility property.

Returns: Stereo visibility

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESStereoAttribute.

◆ type()

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

overridevirtual

Returns the type of this object.

See also: Object::type().

Reimplemented from Ocean::Rendering::Attribute.

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

StereoAttribute.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members