This class is the base class for all perspective views. More...

#include <PerspectiveView.h>

Inheritance diagram for Ocean::Rendering::PerspectiveView:

Public Member Functions
virtual Scalar	fovX () const
	Returns the horizontal field of view in radian.

virtual bool	setFovX (const Scalar fovx)
	Sets the horizontal field of view in radian.

virtual Scalar	idealFovX (bool *validCamera=nullptr) const
	Calculates the ideal field of view matching to the current background.

virtual void	updateToIdealFovX ()
	Updates the view's field of view to the ideal field of view matching with the current background.

virtual void	setProjectionMatrix (const SquareMatrix4 &clip_T_view)
	Sets the projection matrix explicitly.

void	fitCamera (const NodeRef &node=NodeRef()) override
	Fits the camera to a given node.

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

Public Member Functions inherited from Ocean::Rendering::View
virtual Scalar	aspectRatio () const
	Returns the aspect ratio of this view.

virtual Scalar	nearDistance () const
	Returns the distance to the near clipping plane.

virtual Scalar	farDistance () const
	Returns the distance to the far clipping plane.

virtual HomogenousMatrix4	transformation () const
	Returns the transformation between view and world (the extrinsic camera data, the inverse of the known View Matrix).

virtual SquareMatrix4	projectionMatrix () const
	Returns the projection matrix of this view.

virtual RGBAColor	backgroundColor () const
	Returns the background color of the view.

virtual BackgroundRef	background () const
	Returns the currently used background of the view.

virtual Backgrounds	backgrounds () const
	Returns all defined background objects.

virtual bool	useHeadlight () const
	Returns whether the head light is enabled.

virtual PhantomAttribute::PhantomMode	phantomMode () const
	Returns the phantom mode of this view.

virtual Line3	viewingRay (const Scalar x, const Scalar y, const unsigned int width, const unsigned int height) const
	Returns a viewing ray into the scene.

virtual bool	setAspectRatio (const Scalar aspectRatio)
	Sets the aspect ratio of this view.

virtual bool	setNearDistance (const Scalar distance)
	Sets the distance to the near clipping plane.

virtual bool	setFarDistance (const Scalar distance)
	Sets the distance to the far clipping plane.

virtual bool	setNearFarDistance (const Scalar nearDistance, const Scalar farDistance)
	Sets the distance to the near and far clipping plane.

virtual void	setTransformation (const HomogenousMatrix4 &world_T_view)
	Sets the position and orientation of the view in world coordinates (the extrinsic camera data, the inverse of the known View Matrix).

virtual bool	setBackgroundColor (const RGBAColor &color)
	Sets the background color of the view.

virtual void	addBackground (const BackgroundRef &background)
	Adds a new background object to the background stack of the view.

virtual void	removeBackground (const BackgroundRef &background)
	Removes a background object from the background stack of this view.

virtual void	setUseHeadlight (const bool state)
	Sets whether the headlight should be activated.

virtual bool	setPhantomMode (const PhantomAttribute::PhantomMode mode)
	Sets the phantom mode of this view.

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
	PerspectiveView ()
	Creates a new perspective view object.

	~PerspectiveView () override
	Destructs a perspective view object.

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

	~View () override
	Destructs a view 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
Public Types inherited from Ocean::Rendering::View
using	Backgrounds = std::vector< BackgroundRef >
	Definition of a vector holding background objects.

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::Object
static std::string	translateObjectType (const ObjectType objectType)
	Translates an object type to a readable string.

Protected Attributes inherited from Ocean::Rendering::View
Backgrounds	backgrounds_
	The view's background objects.

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

Detailed Description

This class is the base class for all perspective views.

Constructor & Destructor Documentation

◆ PerspectiveView()

Ocean::Rendering::PerspectiveView::PerspectiveView ( )

protected

Creates a new perspective view object.

◆ ~PerspectiveView()

Ocean::Rendering::PerspectiveView::~PerspectiveView ( )

overrideprotected

Destructs a perspective view object.

Member Function Documentation

◆ fitCamera()

void Ocean::Rendering::PerspectiveView::fitCamera ( const NodeRef & node = NodeRef() )

overridevirtual

Fits the camera to a given node.

See also: View::fitCamera().

Reimplemented from Ocean::Rendering::View.

◆ fovX()

virtual Scalar Ocean::Rendering::PerspectiveView::fovX ( ) const

virtual

Returns the horizontal field of view in radian.

Returns: Horizontal field of view in radian, with range (0, PI)

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESPerspectiveView, and Ocean::Rendering::GlobalIllumination::GIPerspectiveView.

◆ idealFovX()

virtual Scalar Ocean::Rendering::PerspectiveView::idealFovX ( bool * validCamera = nullptr ) const

virtual

Calculates the ideal field of view matching to the current background.

If the background holds a medium and no valid frame has been provided by this medium jet this function will return the view's field of view.

Parameters

validCamera Optional resulting state determining whether the background had a valid camera object

Returns: Resulting field of view in radian

◆ setFovX()

virtual bool Ocean::Rendering::PerspectiveView::setFovX ( const Scalar fovx )

virtual

Sets the horizontal field of view in radian.

Parameters

fovx	Horizontal field of view in radian, with range (0, PI)

Returns: True, if the value is valid and could be set

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESPerspectiveView, and Ocean::Rendering::GlobalIllumination::GIPerspectiveView.

◆ setProjectionMatrix()

virtual void Ocean::Rendering::PerspectiveView::setProjectionMatrix ( const SquareMatrix4 & clip_T_view )

virtual

Sets the projection matrix explicitly.

Parameters

clip_T_view The projection matrix to set

Exceptions

NotSupportedException Is thrown if this function is not supported

Reimplemented in Ocean::Rendering::GLESceneGraph::GLESPerspectiveView.

◆ type()

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

overridevirtual

Returns the type of this object.

See also: Object::type().

Reimplemented from Ocean::Rendering::Object.

Reimplemented in Ocean::Rendering::StereoView.

◆ updateToIdealFovX()

virtual void Ocean::Rendering::PerspectiveView::updateToIdealFovX ( )

virtual

Updates the view's field of view to the ideal field of view matching with the current background.

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

PerspectiveView.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PerspectiveView()

◆ ~PerspectiveView()

Member Function Documentation

◆ fitCamera()

◆ fovX()

◆ idealFovX()

◆ setFovX()

◆ setProjectionMatrix()

◆ type()

◆ updateToIdealFovX()