Enumerations | Enumerator | Functions

IPFActionList.h

Enumerations

enum   { kListWidth = 180 }

Functions

FPInterfaceDesc GetDesc ()
  Must implement GetDescByID method.
virtual int  NumActions () const =0
virtual INode GetAction (int index) const =0
virtual bool  AppendAction (INode *action)=0
virtual bool  InsertAction (INode *action, int indexAt)=0
virtual bool  RemoveAction (int index)=0
virtual bool  HasAction (INode *action, int &index) const =0
static PFExport bool  IsAction (INode *action)
static PFExport bool  IsOperator (INode *action)
static PFExport bool  IsTest (INode *action)
virtual bool  IsActivated () const =0
virtual void  Activate (bool active)=0
  Activate/deactivate all the actions in the list.
virtual int  IsActionActive (int index) const =0
  Activate/deactivate all the actions in the list.
virtual void  ActivateAction (int index, int active=1)=0
  Activate/deactivate all the actions in the list.
virtual void  GetPViewLocation (int &x, int &y)=0
virtual void  SetPViewLocation (int x, int y)
virtual int  GetPViewZOrder ()
virtual void  SetPViewZOrder (int z)
virtual int  GetListWidth ()
virtual void  SetListWidth (int w)
PFExport int  GetPViewRightBoundary ()
  Returns x-coord of the right side of the action list.
virtual bool  IsCollapsed ()
  Action list may be shown in a "collapsed" state in ParticleView.
virtual void  Collapse ()
  Action list may be shown in a "collapsed" state in ParticleView.
virtual void  Expand ()
  Action list may be shown in a "collapsed" state in ParticleView.
virtual bool  HasUpStream ()
  Indicates if there are PFSystems or ActionLists that direct particle flow in this action list.
virtual int  GetSelected () const
  ActionList has its own methods for selecting.
virtual void  SetSelected (int onOff)
  See virtual int GetSelected().
virtual bool  AcceptFertile ()
  ActionList has some restrictions on whether it is able to add a "fertile" action.
virtual void  UpdateMaterial ()
  The method is used to initiate material update in the associated particle group.

Enumeration Type Documentation

anonymous enum [inherited]
Enumerator:
kListWidth 
{   kListWidth=180 }; // default actionList width

Function Documentation

FPInterfaceDesc * GetDesc ( ) [inline, virtual, inherited]

Must implement GetDescByID method.

Implements FPInterface.

{ return GetDescByID(PFACTIONLIST_INTERFACE); }
int NumActions ( ) const [pure virtual, inherited]
INode * GetAction ( int  index ) const [pure virtual, inherited]
bool AppendAction ( INode action ) [pure virtual, inherited]
bool InsertAction ( INode action,
int  indexAt 
) [pure virtual, inherited]
bool RemoveAction ( int  index ) [pure virtual, inherited]
bool HasAction ( INode action,
int &  index 
) const [pure virtual, inherited]
PFExport static bool IsAction ( INode action ) [static, inherited]
PFExport static bool IsOperator ( INode action ) [static, inherited]
PFExport static bool IsTest ( INode action ) [static, inherited]
bool IsActivated ( ) const [pure virtual, inherited]
void Activate ( bool  active ) [pure virtual, inherited]

Activate/deactivate all the actions in the list.

int IsActionActive ( int  index ) const [pure virtual, inherited]

Activate/deactivate all the actions in the list.

1: active; 0: non-active for operators and "always false" for tests; -1: "always true" for tests

void ActivateAction ( int  index,
int  active = 1 
) [pure virtual, inherited]

Activate/deactivate all the actions in the list.

void GetPViewLocation ( int &  x,
int &  y 
) [pure virtual, inherited]
void SetPViewLocation ( int  x,
int  y 
) [inline, virtual, inherited]
int GetPViewZOrder ( ) [inline, virtual, inherited]
void SetPViewZOrder ( int  z ) [inline, virtual, inherited]
int GetListWidth ( ) [inline, virtual, inherited]
void SetListWidth ( int  w ) [inline, virtual, inherited]
PFExport int GetPViewRightBoundary ( ) [inherited]

Returns x-coord of the right side of the action list.

bool IsCollapsed ( ) [inline, virtual, inherited]

Action list may be shown in a "collapsed" state in ParticleView.

{ return false; }
void Collapse ( ) [inline, virtual, inherited]

Action list may be shown in a "collapsed" state in ParticleView.

{ ; }
void Expand ( ) [inline, virtual, inherited]

Action list may be shown in a "collapsed" state in ParticleView.

{ ; }
virtual bool HasUpStream ( ) [inline, virtual, inherited]

Indicates if there are PFSystems or ActionLists that direct particle flow in this action list.

If returns false then the action list won't produce particles.

{ return false; }
int GetSelected ( ) const [inline, virtual, inherited]

ActionList has its own methods for selecting.

Selected ActionList has a white boundary in the ParticleView. If the corresponding particle system has Event-Based Selection ON, the the corresponding particles are shown as selected.

{ return 0; }
void SetSelected ( int  onOff ) [inline, virtual, inherited]

See virtual int GetSelected().

{ ; }
bool AcceptFertile ( ) [inline, virtual, inherited]

ActionList has some restrictions on whether it is able to add a "fertile" action.

ActionList may have only single "fertile" action in the list of actions. Also, ActionList may have a "fertile" action only if no test uses this actionList as a next event.

{ return false; }
void UpdateMaterial ( ) [inline, virtual, inherited]

The method is used to initiate material update in the associated particle group.

{ ; }