PLScene::SNCamera Class Reference

PixelLight standard camera scene node. More...

#include <SNCamera.h>

Inheritance diagram for PLScene::SNCamera:

List of all members.

Public Types
enum	EFlags { FlipY = 1<<10, InvCullMode = 1<<11, NoZFar = 1<<12 }
	Scene node flags (SceneNode flags extension) More...
Public Member Functions
	pl_enum (EFlags) pl_enum_base(SceneNode
	Scene node debug flags (SceneNode debug flags extension)
PLS_API float	GetAspect () const
PLS_API void	SetAspect (float fValue)
PLS_API float	GetZNear () const
PLS_API void	SetZNear (float fValue)
PLS_API float	GetZFar () const
PLS_API void	SetZFar (float fValue)
PLS_API PLCore::String	GetSceneRendererFilename () const
PLS_API void	SetSceneRendererFilename (const PLCore::String &sValue)
virtual PLS_API void	SetFlags (PLCore::uint32 nValue)
PLS_API	SNCamera ()
	Default constructor.
virtual PLS_API	~SNCamera ()
	Destructor.
PLS_API SceneRenderer *	GetSceneRenderer () const
	Returns the used scene renderer.
PLS_API bool	SetCamera (PLRenderer::Renderer &cRenderer, bool bSetProjection=true, bool bSetView=true)
	Sets the camera.
PLS_API bool	GetAutoUpdate () const
	Returns whether the camera projection and view matrix and the frustum are updated automatically.
PLS_API void	SetAutoUpdate (bool bAutoUpdate=true)
	Sets whether the camera projection and view matrix and the frustum are updated automatically.
PLS_API PLMath::Matrix4x4 &	GetProjectionMatrix (const PLMath::Rectangle &cViewport)
	Returns the projection matrix.
PLS_API const PLMath::Quaternion &	GetViewRotationOffset () const
	Returns the view rotation offset.
PLS_API void	SetViewRotationOffset (const PLMath::Quaternion &qViewRotationOffset)
	Sets the view rotation offset.
PLS_API PLMath::Matrix3x4 &	GetViewMatrix ()
	Returns the view matrix.
PLS_API PLMath::Frustum &	GetFrustum (const PLMath::Rectangle &cViewport)
	Returns the camera frustum.
PLS_API const PLCore::Array < PLMath::Vector3 > &	GetFrustumVertices (const PLMath::Rectangle &cViewport)
	Returns the 8 camera frustum vertices.
PLS_API bool	GetViewportCorners (PLMath::Vector3 &vUpperRight, PLMath::Vector3 &vLowerRight, PLMath::Vector3 &vLowerLeft, PLMath::Vector3 &vUpperLeft, bool bContainerSpace, float fDistance)
	Gets the current camera viewport corners.
virtual PLS_API void	DrawDebug (PLRenderer::Renderer &cRenderer, const VisNode *pVisNode=nullptr) override
	This function is called when the debug parts of the scene are drawn.
Static Public Member Functions
static PLS_API SNCamera *	GetCamera ()
	Returns the current set camera.
static PLS_API void	SetCamera (SNCamera *pCamera, PLRenderer::Renderer *pRenderer)
	Sets the current set camera.
Protected Types
enum	EInternalCameraFlags { RecalculateProjectionMatrix = 1<<0, RecalculateViewMatrix = 1<<1, RecalculateFrustum = 1<<2, RecalculateFrustumVertices = 1<<3 }
	Flags which hold internal camera information. More...
Protected Member Functions
virtual PLS_API void	UpdateAABoundingBox () override
	Updates the axis align bounding box in 'scene node space'.

---

Detailed Description

PixelLight standard camera scene node.

Remarks:

PixelLight is using a right-handed coordinate system like OpenGL does, therefore the camera usually looks along the negative z-axis. While this fact may be ok in 'low level' functionality, it makes cameras less comfortable within the scene graph because this 'look along negative z' doesn't go along with universal features like 'look at this point'. So, we decided to 'break' the right-handed coordinate system convention within the camera scene node when it's coming to 'look along negative z'. Instead we 'look along positive z' and we profit from an universal behavior and don't need to care about flipping axis - although it's still possible to flip axis.

Note:

• Scene node scale is ignored

---

Member Enumeration Documentation

enum PLScene::SNCamera::EFlags

Scene node flags (SceneNode flags extension)

Enumerator:

FlipY	Flip y axis
InvCullMode	Invert cull mode
NoZFar	Do not use the far clipping plane

Reimplemented from PLScene::SceneNode.

enum PLScene::SNCamera::EInternalCameraFlags [protected]

Flags which hold internal camera information.

Enumerator:

RecalculateProjectionMatrix	Recalculation of projection matrix required
RecalculateViewMatrix	Recalculation of view matrix required
RecalculateFrustum	Recalculation of frustum required
RecalculateFrustumVertices	Recalculation of frustum vertices required

---

Constructor & Destructor Documentation

PLS_API PLScene::SNCamera::SNCamera

(

)

Default constructor.

virtual PLS_API PLScene::SNCamera::~SNCamera

(

)

[virtual]

Destructor.

---

Member Function Documentation

PLScene::SNCamera::pl_enum

(

EFlags

)

[inline]

Scene node debug flags (SceneNode debug flags extension)

< Do not draw the (green) frustum

< Draw the (green) frustum vertices

Reimplemented from PLScene::SceneNode.

PLS_API float PLScene::SNCamera::GetAspect

(

)

const

PLS_API void PLScene::SNCamera::SetAspect

(

float

fValue

)

PLS_API float PLScene::SNCamera::GetZNear

(

)

const

PLS_API void PLScene::SNCamera::SetZNear

(

float

fValue

)

PLS_API float PLScene::SNCamera::GetZFar

(

)

const

PLS_API void PLScene::SNCamera::SetZFar

(

float

fValue

)

PLS_API PLCore::String PLScene::SNCamera::GetSceneRendererFilename

(

)

const

PLS_API void PLScene::SNCamera::SetSceneRendererFilename

(

const PLCore::String &

sValue

)

virtual PLS_API void PLScene::SNCamera::SetFlags

(

PLCore::uint32

nValue

)

[virtual]

Reimplemented from PLScene::SceneNode.

static PLS_API SNCamera* PLScene::SNCamera::GetCamera

(

)

[static]

Returns the current set camera.

Returns:

The current set camera, a null pointer if no camera is currently set

static PLS_API void PLScene::SNCamera::SetCamera	(	SNCamera *	pCamera,
		PLRenderer::Renderer *	pRenderer
	)		[static]

Sets the current set camera.

Parameters:

[in]	pCamera	The current set camera, a null pointer if no camera is currently set
[in]	pRenderer	Renderer to use, if a null pointer nothing happens

PLS_API SceneRenderer* PLScene::SNCamera::GetSceneRenderer

(

)

const

Returns the used scene renderer.

Returns:

The used scene renderer, can be a null pointer

PLS_API bool PLScene::SNCamera::SetCamera	(	PLRenderer::Renderer &	cRenderer,
		bool	bSetProjection = true,
		bool	bSetView = true
	)

Sets the camera.

Parameters:

[in]	cRenderer	Renderer to use
[in]	bSetProjection	Set projection matrix?
[in]	bSetView	Set view matrix?

Returns:

'true' if all went fine, else 'false'

Note:

• The projection and view matrix will be set using the camera settings

PLS_API bool PLScene::SNCamera::GetAutoUpdate

(

)

const

Returns whether the camera projection and view matrix and the frustum are updated automatically.

Returns:

'true' if the camera projection and view matrix and the frustum are updated automatically, else 'false'

Note:

• If this is 'true', the mentioned things will be updated within 'SetCamera()'

PLS_API void PLScene::SNCamera::SetAutoUpdate

(

bool

bAutoUpdate = true

)

Sets whether the camera projection and view matrix and the frustum are updated automatically.

Parameters:

[in]

bAutoUpdate

'true' if the camera projection and view matrix and the frustum are updated automatically, else 'false'

See also:

• GetAutoUpdate()

PLS_API PLMath::Matrix4x4& PLScene::SNCamera::GetProjectionMatrix

(

const PLMath::Rectangle &

cViewport

)

Returns the projection matrix.

Parameters:

[in]

cViewport

Viewport to use

Returns:

Projection matrix

See also:

• GetAutoUpdate()

PLS_API const PLMath::Quaternion& PLScene::SNCamera::GetViewRotationOffset

(

)

const

Returns the view rotation offset.

Returns:

View rotation offset

Remarks:

By using the view rotation offset, a camera can be rotated towards one direction while viewing towards another one. This view rotation offset can for example be controlled by a head tracker system.

PLS_API void PLScene::SNCamera::SetViewRotationOffset

(

const PLMath::Quaternion &

qViewRotationOffset

)

Sets the view rotation offset.

Parameters:

[in]

qViewRotationOffset

New view rotation offset to set

See also:

• GetViewRotationOffset()

PLS_API PLMath::Matrix3x4& PLScene::SNCamera::GetViewMatrix

(

)

Returns the view matrix.

Returns:

View matrix

Remarks:

PixelLight is using a right-handed coordinate system like OpenGL does, therefore the view matrix 'looks' along the negative z-axis. (unlike the camera scene node itself, have a look into the class documentation)

See also:

• GetAutoUpdate()

PLS_API PLMath::Frustum& PLScene::SNCamera::GetFrustum

(

const PLMath::Rectangle &

cViewport

)

Returns the camera frustum.

Parameters:

[in]

cViewport

Viewport to use

Returns:

Camera frustum in 'scene container space'

See also:

• GetAutoUpdate()

PLS_API const PLCore::Array<PLMath::Vector3>& PLScene::SNCamera::GetFrustumVertices

(

const PLMath::Rectangle &

cViewport

)

Returns the 8 camera frustum vertices.

Parameters:

[in]

cViewport

Viewport to use

Returns:

8 camera vertices in 'scene container space'

Note:

• This vertices can for instance be used to check the camera frustum visibility

PLS_API bool PLScene::SNCamera::GetViewportCorners	(	PLMath::Vector3 &	vUpperRight,
		PLMath::Vector3 &	vLowerRight,
		PLMath::Vector3 &	vLowerLeft,
		PLMath::Vector3 &	vUpperLeft,
		bool	bContainerSpace,
		float	fDistance
	)

Gets the current camera viewport corners.

Parameters:

[out]	vUpperRight	Will receive the upper/right corner
[out]	vLowerRight	Will receive the lower/right corner
[out]	vLowerLeft	Will receive the lower/left corner
[out]	vUpperLeft	Will receive the upper/left corner
[in]	bContainerSpace	Transform corners into container space? (else they are within local scene node space)
[in]	fDistance	Distance from 0, use for example GetNearPlane() to get the viewport corners on the near plane

Returns:

'true' if all went fine, else 'false' (maybe no camera is set?)

virtual PLS_API void PLScene::SNCamera::DrawDebug	(	PLRenderer::Renderer &	cRenderer,
		const VisNode *	pVisNode = nullptr
	)		[override, virtual]

This function is called when the debug parts of the scene are drawn.

Parameters:

[in]	cRenderer	The used renderer
[in]	pVisNode	The current visibility node of this scene node, can be a null pointer

Note:

• Should only be called if the 'UseDrawDebug' draw flag and the 'DebugEnabled' debug flag is set

• Beside drawing scene node stuff, the default implementation emits the SignalDrawDebug signal

See also:

• DrawPre()

Reimplemented from PLScene::SceneNode.

virtual PLS_API void PLScene::SNCamera::UpdateAABoundingBox

(

)

[override, protected, virtual]

Updates the axis align bounding box in 'scene node space'.

Remarks:

This function is called when the axis align bounding box needs to be calculated. One can overwrite the default implementation to calculate the axis align bounding box in another way. The default implementation is empty. (current set axis align bounding box is still used)

Note:

• We recommend to use 'SetAABoundingBox()' inside your own implementation to set the new axis align bounding box, this function will take care of all other required updates

Reimplemented from PLScene::SceneNode.

---

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

• SNCamera.h