nw::gfx::ParticleEmitter Class

Syntax

class ParticleEmitter : public nw::gfx::TransformNode

Description

Class that represents particle emitters.

Structures

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

Enumerated Types

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

typedef Definitions

CalculateMatrixSignal Definition of a callback signal that is called during matrix calculation.(Derived from TransformNode.)
CalculateMatrixSlot Definition of a callback slot that is called during matrix calculation.(Derived from TransformNode.)
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 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.(Derived from SceneNode.)
protected m_AnimBinding GfxPtr< AnimBinding > Animation binding.(Derived from SceneNode.)
protected m_BranchVisible bool Visibility of a branch and descendants.(Derived from SceneNode.)

Member Functions

Creation/Destruction
S Create Creates ParticleEmitter nodes from resources.
S GetMemorySize 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.)
Updating
V Accept Accepts visitors.
UpdateParticleFrame Updates frames.
Reset Resets an emitter to its initial state.
Set/Get
GetEmissionCount Calculates the emission volume.
GetResParticleEmitter Gets the resource.
SetParticleSet Sets the ParticleSet into which emitted particles are passed.

Note: This corresponds to the value of the "Emit to" field in CreativeStudio.
GetParticleSet Gets the ParticleSet into which emitted particles are passed.

Note: This corresponds to the value of the "Emit to" field in CreativeStudio.
ParticleAnimFrameController Gets the animation frame control information.
GetResParticleEmitterParameterCopy Gets resource for emitter parameters.
GetResParticleFormCopy Gets shape (form) resource.
IsAlive Checks whether the particle's emission time has ended.
Emission
Emission Performs emission-related operations.
Resources
GetResTransformNode Gets the transform node resource.(Derived from TransformNode.)
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.)
Transforms
Transform Gets the transformation info.(Derived from TransformNode.)
WorldMatrix Gets the world matrix.(Derived from TransformNode.)
WorldTransform Gets the detailed transformation info after WorldMatrix calculation.(Derived from TransformNode.)
InverseWorldMatrix Gets the inverse matrix of the world matrix. Uses a cache the second time it is called and thereafter.(Derived from TransformNode.)
InvalidateInverseWorldMatrix Invalidates the cache used for the inverse matrix of the world matrix. (Call this when updating the world matrix.)(Derived from TransformNode.)
V UpdateDirection Updates direction information.
V UpdateTransform Updates transform information.
SetResourceBasedTransform Sets a transform based on a resource's transform information.(Derived from TransformNode.)
SetResourceScaledTransform Sets a transform based on a resource's transform information.(Derived from TransformNode.)
Scene Trees
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.
V InheritTraversalResults Inherits transform information from the parent node.
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.)
Callbacks
PostCalculateWorldMatrixSignal Gets the signal after world matrix calculation.(Derived from TransformNode.)
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.)
Traverses
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.)
SetBranchVisible Sets the flag used to render the node and descendants.(Derived from SceneNode.)
IsBranchVisible Gets the flag used to render the node and descendants.(Derived from SceneNode.)
Constructors and Destructors
protected ParticleEmitter Constructor.
protected V ~ParticleEmitter Destructor.
protected V Initialize Allocates memory for and initialized members.
Other
protected CalcInheritingDiretion Calculates direction inherited from parent node conversion information.(Derived from TransformNode.)
protected IsCircularReference Returns true if there is a circular reference.(Derived from SceneNode.)
protected AcceptChildren Makes all nodes accept visitors.(Derived from SceneNode.)

Class Hierarchy

nw::gfx::GfxObject
  nw::gfx::SceneObject
    nw::gfx::SceneNode
      nw::gfx::TransformNode
        nw::gfx::ParticleEmitter

CONFIDENTIAL