Node of the visibility tree. More...

#include <VisNode.h>

Inheritance diagram for PLScene::VisNode:

Public Member Functions
PLS_API const VisContainer *	GetVisRootContainer () const
	Returns the visibility root container.
PLS_API const VisNode *	GetParent () const
	Returns the parent visibility node.
PLS_API SceneNode *	GetSceneNode () const
	Returns the scene node this visibility node links to.
PLS_API const PLMath::Matrix4x4 &	GetProjectionMatrix () const
	Returns the used projection matrix.
PLS_API const PLMath::Matrix4x4 &	GetViewMatrix () const
	Returns the used view matrix.
PLS_API const PLMath::Matrix4x4 &	GetViewProjectionMatrix () const
	Returns the used view projection matrix.
PLS_API const PLMath::Matrix3x4 &	GetWorldMatrix () const
	Returns the absolute world matrix of the scene node.
void	SetWorldMatrix (const PLMath::Matrix3x4 &mWorld)
PLS_API const PLMath::Matrix3x4 &	GetInverseWorldMatrix () const
	Returns the absolute inverse world matrix of the scene node.
PLS_API const PLMath::Matrix4x4 &	GetWorldViewMatrix () const
	Returns the absolute world view matrix of the scene node.
PLS_API const PLMath::Matrix4x4 &	GetWorldViewProjectionMatrix () const
	Returns the absolute world view projection matrix of the scene node.
PLS_API float	GetSquaredDistanceToCamera () const
	Returns the squared distance to the camera.
virtual PLS_API bool	IsContainer () const
	Returns whether or not this is a container visibility node (VisContainer, links to a SceneContainer scene node)
virtual PLS_API bool	IsCell () const
	Returns whether or not this is a cell visibility node (VisContainer, links to a SNCell scene node)
virtual PLS_API bool	IsPortal () const
	Returns whether or not this is a portal visibility node (VisPortal, links to a SNCellPortal scene node)
Protected Member Functions
	VisNode (VisNode *pParent=nullptr)
	Constructor.
virtual	~VisNode ()
	Destructor.

Detailed Description

Node of the visibility tree.

Constructor & Destructor Documentation

PLScene::VisNode::VisNode ( VisNode * pParent = nullptr ) [protected]

Constructor.

Parameters:

[in] pParent The parent visibility node, a null pointer if this is the root

virtual PLScene::VisNode::~VisNode ( ) [protected, virtual]

Destructor.

Member Function Documentation

PLS_API const VisContainer* PLScene::VisNode::GetVisRootContainer ( ) const

Returns the visibility root container.

Returns:: The visibility root container, a null pointer on error

PLS_API const VisNode* PLScene::VisNode::GetParent ( ) const

Returns the parent visibility node.

Returns:: The parent visibility node, a null pointer if this is the root

Remarks:: The parent visibility node can be a VisContainer or a VisPortal. If the parent is a portal, this visibility node is the cell it links to.

PLS_API SceneNode* PLScene::VisNode::GetSceneNode ( ) const

Returns the scene node this visibility node links to.

Returns:: The scene node this visibility node links to, a null pointer if there's no scene node linked to this visibility node (maybe the scene node this visibility node was linked to was killed?)

PLS_API const PLMath::Matrix4x4& PLScene::VisNode::GetProjectionMatrix ( ) const

Returns the used projection matrix.

Returns:: The used projection matrix

PLS_API const PLMath::Matrix4x4& PLScene::VisNode::GetViewMatrix ( ) const

Returns the used view matrix.

Returns:: The used view matrix

PLS_API const PLMath::Matrix4x4& PLScene::VisNode::GetViewProjectionMatrix ( ) const

Returns the used view projection matrix.

Returns:: The used view projection matrix

PLS_API const PLMath::Matrix3x4& PLScene::VisNode::GetWorldMatrix ( ) const

Returns the absolute world matrix of the scene node.

Returns:: The absolute world matrix of the scene node

Remarks:: If the camera is within a container, this world matrix is relative to the container the camera is in.

void PLScene::VisNode::SetWorldMatrix ( const PLMath::Matrix3x4 & mWorld )

PLS_API const PLMath::Matrix3x4& PLScene::VisNode::GetInverseWorldMatrix ( ) const

Returns the absolute inverse world matrix of the scene node.

Returns:: The absolute inverse world matrix of the scene node

Remarks:: If the camera is within a container, this world matrix is relative to the container the camera is in.

PLS_API const PLMath::Matrix4x4& PLScene::VisNode::GetWorldViewMatrix ( ) const

Returns the absolute world view matrix of the scene node.

Returns:: The absolute world view matrix of the scene node

Remarks:: You can use for example Matrix4x4 mWorldViewProjection(cRenderer.GetTransformState(Transform::View)); mWorldViewProjection *= pVisNode->GetWorldMatrix(); to calculate the matrix by yourself. But for instance a advanced per pixel lighting scene renderer may need this final matrix of the node multiple times per frame, so, it's recommended to use this precalculated one.

PLS_API const PLMath::Matrix4x4& PLScene::VisNode::GetWorldViewProjectionMatrix ( ) const

Returns the absolute world view projection matrix of the scene node.

Returns:: The absolute world view projection matrix of the scene node

Remarks:: You can use for example Matrix4x4 mWorldViewProjection(cRenderer.GetTransformState(Transform::Projection)); mWorldViewProjection *= cRenderer.GetTransformState(Transform::View); mWorldViewProjection *= pVisNode->GetWorldMatrix(); to calculate the matrix by yourself. But for instance a advanced per pixel lighting scene renderer may need this final matrix of the node multiple times per frame, so, it's recommended to use this precalculated one.

PLS_API float PLScene::VisNode::GetSquaredDistanceToCamera ( ) const

Returns the squared distance to the camera.