nw::gfx::ParticleSet Class

Syntax

class ParticleSet : public nw::gfx::SceneNode

Description

Class that represents particle sets.

Structures

nw::gfx::ParticleSet::Description Content to configure.
nw::gfx::ParticleSet::Initializer Administrative info for the system initializer.
nw::gfx::ParticleSet::Updater Administrative info for the system initializer.

Enumerated Types

TraversalResults Definition of the bit flag indicating the traversal results.(Derived from SceneNode.

typedef Definitions

UpdateSignal Definition of a callback signal that is called during updates.(Derived from SceneNode.
UpdateSlot Definition of a callback slot that is called during updates.(Derived from SceneNode.

Member Constants

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

Member Variables

NW_UT_RUNTIME_TYPEINFO
protected m_Children Child node.(Derived from SceneNode.
protected m_AnimBinding Animation binding.(Derived from SceneNode.

Member Functions

Create/Destroy
S Create Creates a particle set from a resource.
S GetMemorySize Gets the memory size required at time of creation.
S GetDeviceMemorySize Gets the device memory size required at time of creation.
DestroyBranch Destroys all nodes on the current branch, including the current node.(Derived from SceneNode.
Destroy Destroys an object.(Derived from GfxObject.
Update
V Accept Accepts visitors.
Set/Get
GetResParticleSet Gets the resource.
AttachParticleCollection Sets a particle collection.
GetParticleCollection Gets a particle collection.
GetInitializers Gets an array of initializers.
GetUpdaters Gets an array of updaters.
UpdateParticles Updates particles.
ClearParticleCollection Clears a particle collection.
GetScaleOffset Gets the scale offset value.
SetScaleOffset Sets the scale offset value.
GetRotateOffset Gets the rotation offset value.
SetRotateOffset Sets the rotation offset value.
IsAscendingOrder Gets the rendering order.
Resources
GetResSceneNode Gets the scene node resource.(Derived from SceneNode.
GetResSceneObject Gets the scene object resource.(Derived from SceneObject.
GetName Gets the name from the resource.(Derived from SceneObject.
Transform
V UpdateTransform Updates conversion information.
Scene Tree
AttachChild Attaches a child.(Derived from SceneNode.
DetachChild Removes a child.(Derived from SceneNode.
GetChildBegin Gets the beginning of a child.(Derived from SceneNode.
GetChildEnd Gets the end of a child.(Derived from SceneNode.
DetachAllChildren Removes all children.(Derived from SceneNode.
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.(Derived from SceneNode.
Animation
GetAnimBinding Gets the animation binding.(Derived from SceneNode.
SetAnimBinding Sets the animation binding.(Derived from SceneNode.
UpdateFrame Updates the frames for all configured animation objects.(Derived from SceneNode.
Traverse
GetTraversalResults Gets the results of a traversal.(Derived from SceneNode.
SetTraversalResults Sets the results of a traversal.(Derived from SceneNode.
IsEnabledResults Gets a value indicating whether a given traversal result is enabled.(Derived from SceneNode.
EnableTraversalResults Enables the results of a traversal.(Derived from SceneNode.
DisableTraversalResults Disables the results of a traversal.(Derived from SceneNode.
ResetTraversalResults Copies the result of traversal from a node.(Derived from SceneNode.
CopyTraversalResults Copies the result of traversal from a node.(Derived from SceneNode.
V InheritTraversalResults Inherits conversion information from the parent node.
SetBranchVisible Sets the flag used to render below the node.(Derived from SceneNode.
IsBranchVisible Gets the flag used to render below the node.(Derived from SceneNode.
Constructors and Destructors
protected ParticleSet Constructor.
protected V ~ParticleSet Destructor.
Other
protected IsCircularReference Returns true if there is a circular reference.(Derived from SceneNode.
protected AcceptChildren Makes all nodes accept visitors.(Derived from SceneNode.
protected V Initialize Allocates memory for and initialized members.

Class Hierarchy

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

CONFIDENTIAL