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.

Detailed Description

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kListWidth

{   kListWidth=180 }; // default actionList width

Function Documentation

GetDesc()

FPInterfaceDesc * GetDesc ( )

inlinevirtual

Must implement GetDescByID method.

Implements FPInterface.

{ return GetDescByID(PFACTIONLIST_INTERFACE); }

NumActions()

int NumActions ( ) const

pure virtual

GetAction()

INode * GetAction ( int  index ) const

pure virtual

AppendAction()

bool AppendAction ( INode *  action )

pure virtual

InsertAction()

bool InsertAction ( INode *  action, int  indexAt  )

pure virtual

RemoveAction()

bool RemoveAction ( int  index )

pure virtual

HasAction()

bool HasAction ( INode *  action, int &  index  ) const

pure virtual

IsAction()

PFExport static bool IsAction ( INode *  action )

static

IsOperator()

PFExport static bool IsOperator ( INode *  action )

static

IsTest()

PFExport static bool IsTest ( INode *  action )

static

IsActivated()

bool IsActivated ( ) const

pure virtual

Activate()

void Activate ( bool  active )

pure virtual

Activate/deactivate all the actions in the list.

IsActionActive()

int IsActionActive ( int  index ) const

pure virtual

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

ActivateAction()

void ActivateAction ( int  index, int  active = 1  )

pure virtual

Activate/deactivate all the actions in the list.

GetPViewLocation()

void GetPViewLocation ( int &  x, int &  y  )

pure virtual

SetPViewLocation()

void SetPViewLocation ( int  x, int  y  )

inlinevirtual

{ ; }

GetPViewZOrder()

int GetPViewZOrder ( )

inlinevirtual

{ return 0; }

SetPViewZOrder()

void SetPViewZOrder ( int  z )

inlinevirtual

{ ; }

GetListWidth()

int GetListWidth ( )

inlinevirtual

{ return kListWidth; }

SetListWidth()

void SetListWidth ( int  w )

inlinevirtual

{ ; }

GetPViewRightBoundary()

PFExport int GetPViewRightBoundary

(

)

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

IsCollapsed()

bool IsCollapsed ( )

inlinevirtual

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

{ return false; }

Collapse()

void Collapse ( )

inlinevirtual

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

{ ; }

Expand()

void Expand ( )

inlinevirtual

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

{ ; }

HasUpStream()

bool HasUpStream ( )

inlinevirtual

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; }

GetSelected()

int GetSelected ( ) const

inlinevirtual

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; }

SetSelected()

void SetSelected ( int  onOff )

inlinevirtual

See virtual int GetSelected().

{ ; }

AcceptFertile()

bool AcceptFertile ( )

inlinevirtual

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; }

UpdateMaterial()

void UpdateMaterial ( )

inlinevirtual

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

{ ; }