nw::gfx::SceneNode Class

Syntax

class SceneNode : public nw::gfx::SceneObject

Description

Class acting as the type of node from which the scene tree is built. Can have multiple children.

Classes

nw::gfx::SceneNode::DynamicBuilder Class for building scene nodes dynamically.

Structures

nw::gfx::SceneNode::Description Content to configure.

Enumerated Types

TraversalResults Definition of the bit flag indicating the traversal results.

typedef Definitions

UpdateSignal Definition of a callback signal that is called during updates.
UpdateSlot Definition of a callback slot that is called during updates.

Member Constants

S DEFAULT_MAX_CHILDREN const int Maximum number of children when a fixed amount of memory is used.(Derived from SceneObject.)
S DEFAULT_MAX_CALLBACKS const int Maximum number of callbacks when a fixed amount of memory is used.(Derived from SceneObject.)
S MAX_NAME_LENGTH const int Limit on names of scene objects.(Derived from SceneObject.)

Member Variables

NW_UT_RUNTIME_TYPEINFO
protected m_Children SceneNodeChildren Child nodes.
protected m_AnimBinding GfxPtr< AnimBinding > Animation binding.
protected m_BranchVisible bool Visibility of a branch and descendants.

Member Functions

Create/Destroy
S Create Generates a scene node.
S GetMemorySize Gets the memory size required at time of creation.
DestroyBranch Destroys all nodes on the current branch, including the current node.
Destroy Destroys an object.(Derived from GfxObject.)
Resources
GetResSceneNode Gets the scene node resource.
GetResSceneObject Gets the scene object resource.(Derived from SceneObject.)
GetName Gets the name from the resource.(Derived from SceneObject.)
Transforms
V UpdateTransform Updates transform information.
Scene Trees
AttachChild Attaches a child.
DetachChild Removes a child.
GetChildBegin Gets the beginning of a child.
GetChildEnd Gets the end of a child.
DetachAllChildren Removes all children.
V Accept Accepts visitors.
V TrackbackWorldMatrix Tracks back to the parent node and gets the world matrix.
V TrackbackWorldTransform Tracks back to the parent node and gets the world transform.
V TrackbackLocalTransform Tracks back to the parent node and gets the local transform.
Callbacks
PreUpdateSignal Gets the signal before the scene node is updated.
Animation
GetAnimBinding Gets the animation binding.
SetAnimBinding Sets the animation binding.
UpdateFrame Updates the frames for all configured animation objects.
Traverses
GetTraversalResults Gets the results of a traversal.
SetTraversalResults Sets the results of a traversal.
IsEnabledResults Gets a value indicating whether a given traversal result is enabled.
EnableTraversalResults Enables the results of a traversal.
DisableTraversalResults Disables the results of a traversal.
ResetTraversalResults Copies the result of traversal from a node.
CopyTraversalResults Copies the result of traversal from a node.
V InheritTraversalResults Inherits conversion information from the parent node.
SetBranchVisible Sets the flag used to render the node and descendants.
IsBranchVisible Gets the flag used to render the node and descendants.
Constructors and Destructors
protected SceneNode Constructor.
protected V ~SceneNode Destructor.
Other
protected IsCircularReference Returns true if there is a circular reference.
protected AcceptChildren Makes all nodes accept visitors.
protected V Initialize Allocates memory for and initializes members.

Class Hierarchy

nw::gfx::GfxObject
  nw::gfx::SceneObject
    nw::gfx::SceneNode

CONFIDENTIAL