PLScene::SHKdTreeNode Class Reference

Kd tree scene hierarchy node class. More...

#include <SHKdTree.h>

Inheritance diagram for PLScene::SHKdTreeNode:

List of all members.

Public Member Functions
virtual PLS_API void	Touch (bool bRecursive=false) override
	Touches the scene hierarchy scene node.
virtual PLS_API PLCore::uint32	GetNumOfNodes () const override
	Returns the number of child scene hierarchy nodes.
virtual PLS_API SceneHierarchyNode *	GetNode (PLCore::uint32 nIndex) const override
	Returns a child scene hierarchy node.

---

Detailed Description

Kd tree scene hierarchy node class.

---

Member Function Documentation

virtual PLS_API void PLScene::SHKdTreeNode::Touch

(

bool

bRecursive = false

)

[override, virtual]

Touches the scene hierarchy scene node.

Parameters:

[in]

bRecursive

Touch recursive?

Remarks:

Scene node distribution (splitt/merge) within the scene hierarchy is only performed if this function is called. If during for instance a visibility determination a scene hierarchy node is used the first time during this process, one should call this 'touch' function to inform the scene hierarchy that this scene hierarchy node is going to be used. This function will split a scene hierarchy node if certain conditions like a maximum number of items per scene hierarchy node are given. If other conditions are given a merge operation is performed which 'combines' scene hierarchy nodes instead of splitting them. As result of this function, normally only the scene hierarchy parts which are currently used will be updated. ("lazy evaluation" :) If 'bRecursive' is set to true, all child nodes are touched to - but this may only be useful for instance when initializing the scene hierarchy.

Implements PLScene::SceneHierarchyNode.

virtual PLS_API PLCore::uint32 PLScene::SHKdTreeNode::GetNumOfNodes

(

)

const [override, virtual]

Returns the number of child scene hierarchy nodes.

Returns:

The number of child scene hierarchy nodes

Implements PLScene::SceneHierarchyNode.

virtual PLS_API SceneHierarchyNode* PLScene::SHKdTreeNode::GetNode

(

PLCore::uint32

nIndex

)

const [override, virtual]

Returns a child scene hierarchy node.

Parameters:

[in]

nIndex

Index of the requested child scene hierarchy node

Returns:

The requested child scene hierarchy node, a null pointer on error

Implements PLScene::SceneHierarchyNode.

---

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

• SHKdTree.h