Public Types | Public Member Functions

IPFSystem Class Reference

Search for all occurrences

#include <IPFSystem.h>

Inheritance diagram for IPFSystem:
Inheritance graph
[legend]

List of all members.

Public Types

enum   {
  kGetMultiplier, kGetBornAllowance, kHasEmitter, kGetEmitterType,
  kGetEmitterDimensions, kGetEmitterGeometry, kIsEmitterGeometryAnimated, kSetRenderState,
  kIsRenderState, kGetIntegrationStep, kGetUpdateType, kNumParticlesSelected,
  kGetSelectedParticleID, kIsParticleSelected, kNumActionListsSelected, kGetSelectedActionList,
  kIsActionListSelected, kIsRunningScript
}
enum   {
  kEmitterType_none = -1, kEmitterType_rectangle = 0, kEmitterType_circle, kEmitterType_box,
  kEmitterType_sphere, kEmitterType_mesh
}
enum   { kPFUpdateType_complete, kPFUpdateType_forward }

Public Member Functions

BEGIN_FUNCTION_MAP  FN_1 (kGetMultiplier, TYPE_FLOAT, GetMultiplier, TYPE_TIMEVALUE)
  FN_0 (kGetBornAllowance, TYPE_INT, GetBornAllowance)
  FN_0 (kHasEmitter, TYPE_bool, HasEmitter)
  FN_1 (kGetEmitterType, TYPE_INT, GetEmitterType, TYPE_TIMEVALUE)
  VFN_2 (kGetEmitterDimensions, GetEmitterDimensions, TYPE_TIMEVALUE, TYPE_FLOAT_TAB_BR)
  FN_1 (kGetEmitterGeometry, TYPE_MESH, GetEmitterGeometry, TYPE_TIMEVALUE)
  FN_0 (kIsEmitterGeometryAnimated, TYPE_bool, IsEmitterGeometryAnimated)
  VFN_1 (kSetRenderState, SetRenderState, TYPE_bool)
  FN_0 (kIsRenderState, TYPE_bool, IsRenderState)
  FN_0 (kGetIntegrationStep, TYPE_TIMEVALUE, GetIntegrationStep)
  FN_0 (kGetUpdateType, TYPE_INT, GetUpdateType)
  FN_0 (kNumParticlesSelected, TYPE_INT, NumParticlesSelected)
  FN_1 (kGetSelectedParticleID, TYPE_INDEX, GetSelectedParticleID, TYPE_INDEX)
  FN_1 (kIsParticleSelected, TYPE_bool, IsParticleSelected, TYPE_INDEX)
  FN_0 (kNumActionListsSelected, TYPE_INT, NumActionListsSelected)
  FN_1 (kGetSelectedActionList, TYPE_INODE, GetSelectedActionList, TYPE_INDEX)
  FN_1 (kIsActionListSelected, TYPE_bool, IsActionListSelected, TYPE_INODE)
  FN_0 (kIsRunningScript, TYPE_bool, IsRunningScript)
virtual float  GetMultiplier (TimeValue time)=0
  Returns multiplier coefficient to generate particles.
virtual int  GetBornAllowance ()=0
  Returns number of particles allowed to be generated at current time.
virtual bool  HasEmitter ()
  PF System has an icon that can be used as an emitter for particles.
virtual int  GetEmitterType (TimeValue time)
virtual void  GetEmitterDimensions (TimeValue time, Tab< float > &dimensions)
  Returns spacial dimensions of the emitter icon.
virtual Mesh GetEmitterGeometry (TimeValue time)
  Returns emitter geometry in form of mesh.
virtual bool  IsEmitterGeometryAnimated ()
  If the emitter mesh is geometry-animated, return "true" in the following method.
virtual void  SetRenderState (bool renderState=true)=0
  PF System has two states: render and viewport.
virtual bool  IsRenderState () const =0
  Works with SetRenderState.
virtual TimeValue  GetIntegrationStep () const =0
  PF System has an integration step parameter that defines granularity in proceeding particles in time.
virtual int  GetUpdateType () const
  PF system has different modes for update.
virtual int  NumParticlesSelected () const
  PF system may select sub-components.
virtual int  GetSelectedParticleID (int i) const
  Returns born ID of the i-th selected particle.
virtual bool  IsParticleSelected (int id) const
  Verifies if a particle with the given born ID is selected or not.
virtual int  NumActionListsSelected () const
  Returns amount of selected action lists.
virtual INode GetSelectedActionList (int i) const
  Returns node of the i-th selected action list.
virtual bool  IsActionListSelected (INode *inode) const
  Verifies if an action list is selected or not.
virtual bool  IsRunningScript () const
  Returns true if the particle system is in the process of runnint Every Step or Final Step scripts.
virtual bool  IsCopyClone () const
  For internal use.
virtual void  ResetCopyClone ()
  Works with IsCopyClone.
FPInterfaceDesc GetDesc ()

Member Enumeration Documentation

anonymous enum

Member Function Documentation

BEGIN_FUNCTION_MAP FN_1 ( kGetMultiplier  ,
TYPE_FLOAT  ,
GetMultiplier  ,
TYPE_TIMEVALUE   
)
FN_0 ( kGetBornAllowance  ,
TYPE_INT  ,
GetBornAllowance   
)
FN_0 ( kHasEmitter  ,
TYPE_bool  ,
HasEmitter   
)
FN_1 ( kGetEmitterType  ,
TYPE_INT  ,
GetEmitterType  ,
TYPE_TIMEVALUE   
)
VFN_2 ( kGetEmitterDimensions  ,
GetEmitterDimensions  ,
TYPE_TIMEVALUE  ,
TYPE_FLOAT_TAB_BR   
)
FN_1 ( kGetEmitterGeometry  ,
TYPE_MESH  ,
GetEmitterGeometry  ,
TYPE_TIMEVALUE   
)
FN_0 ( kIsEmitterGeometryAnimated  ,
TYPE_bool  ,
IsEmitterGeometryAnimated   
)
VFN_1 ( kSetRenderState  ,
SetRenderState  ,
TYPE_bool   
)
FN_0 ( kIsRenderState  ,
TYPE_bool  ,
IsRenderState   
)
FN_0 ( kGetIntegrationStep  ,
TYPE_TIMEVALUE  ,
GetIntegrationStep   
)
FN_0 ( kGetUpdateType  ,
TYPE_INT  ,
GetUpdateType   
)
FN_0 ( kNumParticlesSelected  ,
TYPE_INT  ,
NumParticlesSelected   
)
FN_1 ( kGetSelectedParticleID  ,
TYPE_INDEX  ,
GetSelectedParticleID  ,
TYPE_INDEX   
)
FN_1 ( kIsParticleSelected  ,
TYPE_bool  ,
IsParticleSelected  ,
TYPE_INDEX   
)
FN_0 ( kNumActionListsSelected  ,
TYPE_INT  ,
NumActionListsSelected   
)
FN_1 ( kGetSelectedActionList  ,
TYPE_INODE  ,
GetSelectedActionList  ,
TYPE_INDEX   
)
FN_1 ( kIsActionListSelected  ,
TYPE_bool  ,
IsActionListSelected  ,
TYPE_INODE   
)
FN_0 ( kIsRunningScript  ,
TYPE_bool  ,
IsRunningScript   
)

IPFSystem IPFSystem IPFSystem IPFSystem IPFSystem IPFSystem IPFSystem IPFSystem IPFSystem IPFSystem
IPFSystem IPFSystem IPFSystem IPFSystem IPFSystem IPFSystem IPFSystem IPFSystem IPFSystem IPFSystem