PLScene::SceneHierarchyNodeItem Class Reference

Scene hierarchy node item class. More...

#include <SceneHierarchyNodeItem.h>

List of all members.

Public Member Functions
PLS_API SceneNode *	GetSceneNode () const
	Returns the scene node this scene hierarchy node item is linked to.
PLS_API SceneHierarchyNode *	GetHierarchyNode () const
	Returns the scene hierarchy node this scene hierarchy node item is attached to.
PLS_API SceneHierarchyNodeItem *	GetPreviousItem () const
	Returns the previous scene hierarchy node item.
PLS_API SceneHierarchyNodeItem *	GetNextItem () const
	Returns the next scene hierarchy node item.
PLS_API	SceneHierarchyNodeItem ()
	Constructor.
PLS_API	~SceneHierarchyNodeItem ()
	Destructor.
PLS_API bool	Link (SceneNode &cSceneNode)
	Links this scene hierarchy node item with a scene node.
PLS_API bool	Unlink ()
	Unlinks this scene hierarchy node item from the scene node.
PLS_API bool	Attach (SceneHierarchyNode &cSceneHierarchyNode)
	Attaches this scene hierarchy node item to a scene hierarchy node.
PLS_API bool	Detach ()
	Detaches this scene hierarchy node item from it's scene hierarchy node.
PLS_API SceneHierarchyNodeItem &	Clone () const
	Returns a clone of this scene hierarchy node item.

---

Detailed Description

Scene hierarchy node item class.

Remarks:

A scene hierarchy node item connects scene nodes and hierarchy nodes. One scene node can have multiple hierarchy node items linking them to different hierarchy nodes and one hierarchy node can have multiple hierarchy node items within it linking to different scene nodes.

---

Constructor & Destructor Documentation

PLS_API PLScene::SceneHierarchyNodeItem::SceneHierarchyNodeItem

(

)

Constructor.

PLS_API PLScene::SceneHierarchyNodeItem::~SceneHierarchyNodeItem

(

)

Destructor.

---

Member Function Documentation

PLS_API SceneNode* PLScene::SceneHierarchyNodeItem::GetSceneNode

(

)

const

Returns the scene node this scene hierarchy node item is linked to.

Returns:

The scene node this scene hierarchy node item is linked to, a null pointer on error (currently not linked to a scene node?)

PLS_API SceneHierarchyNode* PLScene::SceneHierarchyNodeItem::GetHierarchyNode

(

)

const

Returns the scene hierarchy node this scene hierarchy node item is attached to.

Returns:

The scene hierarchy node this scene hierarchy node item is attached to, a null pointer on error (currently not attached to a scene hierarchy node?)

PLS_API SceneHierarchyNodeItem* PLScene::SceneHierarchyNodeItem::GetPreviousItem

(

)

const

Returns the previous scene hierarchy node item.

Returns:

The previous scene hierarchy node item, a null pointer if there's no previous item

PLS_API SceneHierarchyNodeItem* PLScene::SceneHierarchyNodeItem::GetNextItem

(

)

const

Returns the next scene hierarchy node item.

Returns:

The next scene hierarchy node item, a null pointer if there's no next item

PLS_API bool PLScene::SceneHierarchyNodeItem::Link

(

SceneNode &

cSceneNode

)

Links this scene hierarchy node item with a scene node.

Parameters:

[in]

cSceneNode

Scene node where link this scene hierarchy node item to

Returns:

'true' if all went fine, else 'false' (currently already linked?)

PLS_API bool PLScene::SceneHierarchyNodeItem::Unlink

(

)

Unlinks this scene hierarchy node item from the scene node.

Returns:

'true' if all went fine, else 'false' (currently not linked?)

PLS_API bool PLScene::SceneHierarchyNodeItem::Attach

(

SceneHierarchyNode &

cSceneHierarchyNode

)

Attaches this scene hierarchy node item to a scene hierarchy node.

Parameters:

[in]

cSceneHierarchyNode

Scene hierarchy node where to attach this scene hierarchy node item

Returns:

'true' if all went fine, else 'false' (currently already attached?)

PLS_API bool PLScene::SceneHierarchyNodeItem::Detach

(

)

Detaches this scene hierarchy node item from it's scene hierarchy node.

Returns:

'true' if all went fine, else 'false' (currently not attached?)

PLS_API SceneHierarchyNodeItem& PLScene::SceneHierarchyNodeItem::Clone

(

)

const

Returns a clone of this scene hierarchy node item.

Returns:

A clone of this scene hierarchy node item

Note:

• The clone is already linked to the same scene node, but not attached to any scene hierarchy node

---

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

• SceneHierarchyNodeItem.h