This class is the base class for all backgrounds. More...

Inheritance diagram for Ocean::Rendering::Background:

Public Member Functions
virtual Scalar	distance () const
	Returns the distance between the world coordinate system and the background object. More...

virtual Vector3	position () const
	Returns the position used for this background. More...

virtual Quaternion	orientation () const
	Returns the orientation used for this background. More...

virtual bool	setDistance (const Scalar distance)
	Sets the distance between world coordinate system and the background object. More...

virtual void	setPosition (const Vector3 &position)
	Sets the position used for this background. More...

virtual void	setOrientation (const Quaternion &orientation)
	Sets the orientation used for this background. More...

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

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

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

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

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

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

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

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

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

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

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

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

ObjectRefs	parentObjects () const
	Returns all parent objects. More...

ObjectRefSet	parentNodes () const
	Returns all parent nodes. More...

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

Protected Member Functions
	Background ()
	Creates a new background object. More...

	~Background () override
	Destructs a background object. More...

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

	~Node () override
	Destructs a node. More...

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

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

virtual	~Object ()
	Destructs an object. More...

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

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

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

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

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

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

Protected Attributes
Scalar	backgroundDistance
	Background distance;. More...

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

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

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

Detailed Description

This class is the base class for all backgrounds.

Constructor & Destructor Documentation

◆ Background()

Ocean::Rendering::Background::Background ( )

protected

Creates a new background object.

◆ ~Background()

Ocean::Rendering::Background::~Background ( )

overrideprotected

Destructs a background object.

Member Function Documentation

◆ distance()

virtual Scalar Ocean::Rendering::Background::distance ( ) const

virtual

Returns the distance between the world coordinate system and the background object.

The default value is 1000.

Returns: Background distance

See also: setDistance().

◆ orientation()

virtual Quaternion Ocean::Rendering::Background::orientation ( ) const

virtual

Returns the orientation used for this background.

Returns: Background orientation

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESBackground.

◆ position()

virtual Vector3 Ocean::Rendering::Background::position ( ) const

virtual

Returns the position used for this background.

The position is defined in relation to the center of projection.

Returns: Background position

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESBackground.

◆ setDistance()

virtual bool Ocean::Rendering::Background::setDistance ( const Scalar distance )

virtual

Sets the distance between world coordinate system and the background object.

Parameters

distance Distance to set, must be positive

Returns: True, if succeeded

See also: distance().

Reimplemented in Ocean::Rendering::UndistortedBackground.

◆ setOrientation()

virtual void Ocean::Rendering::Background::setOrientation ( const Quaternion & orientation )

virtual

Sets the orientation used for this background.

Parameters

orientation Background orientation to set

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESBackground.

◆ setPosition()

virtual void Ocean::Rendering::Background::setPosition ( const Vector3 & position )

virtual

Sets the position used for this background.

The position is defined in relation to the center of projection.

Parameters

position Background position to set

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESBackground.

◆ type()

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

overridevirtual

Returns the type of this object.

See also: Object::type().

Reimplemented from Ocean::Rendering::Object.

Reimplemented in Ocean::Rendering::UndistortedBackground, and Ocean::Rendering::SkyBackground.

Field Documentation

◆ backgroundDistance

Scalar Ocean::Rendering::Background::backgroundDistance

protected

Background distance;.

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

rendering/Background.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Background()

◆ ~Background()

Member Function Documentation

◆ distance()

◆ orientation()

◆ position()

◆ setDistance()

◆ setOrientation()

◆ setPosition()

◆ type()

Field Documentation

◆ backgroundDistance