Public Types | Public Member Functions | Static Public Member Functions

IPFActionList Class Reference

Search for all occurrences

#include <IPFActionList.h>

Inheritance diagram for IPFActionList:
Inheritance graph
[legend]

List of all members.

Public Types

enum   {
  kGetNumActions, kGetAction, kAppendAction, kInsertAction,
  kRemoveAction, kHasAction, kIsAction, kIsOperator,
  kIsTest, kIsActivated, kActivate, kIsActionActive,
  kActivateAction, kGetPViewLocation, kSetPViewLocation, kGetPViewZOrder,
  kSetPViewZOrder, kGetListWidth, kSetListWidth, kGetPViewRightBoundary,
  kIsCollapsed, kCollapse, kExpand, kHasUpStream,
  kGetSelected, kSetSelected, kAcceptFertile
}
enum   { kListWidth = 180 }

Public Member Functions

BEGIN_FUNCTION_MAP  FN_0 (kGetNumActions, TYPE_INT, NumActions)
  FN_1 (kGetAction, TYPE_INODE, GetAction, TYPE_INDEX)
  FN_1 (kAppendAction, TYPE_bool, AppendAction, TYPE_INODE)
  FN_2 (kInsertAction, TYPE_bool, InsertAction, TYPE_INODE, TYPE_INDEX)
  FN_1 (kRemoveAction, TYPE_bool, RemoveAction, TYPE_INDEX)
  FN_2 (kHasAction, TYPE_bool, HasAction, TYPE_INODE, TYPE_INDEX_BR)
  FN_1 (kIsAction, TYPE_bool, IsAction, TYPE_INODE)
  FN_1 (kIsOperator, TYPE_bool, IsOperator, TYPE_INODE)
  FN_1 (kIsTest, TYPE_bool, IsTest, TYPE_INODE)
  FN_0 (kIsActivated, TYPE_bool, IsActivated)
  VFN_1 (kActivate, Activate, TYPE_bool)
  FN_1 (kIsActionActive, TYPE_INT, IsActionActive, TYPE_INDEX)
  VFN_2 (kActivateAction, ActivateAction, TYPE_INDEX, TYPE_INT)
  VFN_2 (kGetPViewLocation, GetPViewLocation, TYPE_INT_BR, TYPE_INT_BR)
  VFN_2 (kSetPViewLocation, SetPViewLocation, TYPE_INT, TYPE_INT)
  FN_0 (kGetPViewZOrder, TYPE_INT, GetPViewZOrder)
  VFN_1 (kSetPViewZOrder, SetPViewZOrder, TYPE_INT)
  FN_0 (kGetListWidth, TYPE_INT, GetListWidth)
  VFN_1 (kSetListWidth, SetListWidth, TYPE_INT)
  FN_0 (kGetPViewRightBoundary, TYPE_INT, GetPViewRightBoundary)
  FN_0 (kIsCollapsed, TYPE_bool, IsCollapsed)
  VFN_0 (kCollapse, Collapse)
  VFN_0 (kExpand, Expand)
  FN_0 (kHasUpStream, TYPE_bool, HasUpStream)
  FN_0 (kGetSelected, TYPE_INT, GetSelected)
  VFN_1 (kSetSelected, SetSelected, TYPE_INT)
  FN_0 (kAcceptFertile, TYPE_bool, AcceptFertile)
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
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.

Static Public Member Functions

static PFExport bool  IsAction (INode *action)
static PFExport bool  IsOperator (INode *action)
static PFExport bool  IsTest (INode *action)

Member Enumeration Documentation

anonymous enum
Enumerator:
kGetNumActions 
kGetAction 
kAppendAction 
kInsertAction 
kRemoveAction 
kHasAction 
kIsAction 
kIsOperator 
kIsTest 
kIsActivated 
kActivate 
kIsActionActive 
kActivateAction 
kGetPViewLocation 
kSetPViewLocation 
kGetPViewZOrder 
kSetPViewZOrder 
kGetListWidth 
kSetListWidth 
kGetPViewRightBoundary 
kIsCollapsed 
kCollapse 
kExpand 
kHasUpStream 
kGetSelected 
kSetSelected 
kAcceptFertile 

Member Function Documentation

BEGIN_FUNCTION_MAP FN_0 ( kGetNumActions  ,
TYPE_INT  ,
NumActions   
)
FN_1 ( kGetAction  ,
TYPE_INODE  ,
GetAction  ,
TYPE_INDEX   
)
FN_1 ( kAppendAction  ,
TYPE_bool  ,
AppendAction  ,
TYPE_INODE   
)
FN_2 ( kInsertAction  ,
TYPE_bool  ,
InsertAction  ,
TYPE_INODE  ,
TYPE_INDEX   
)
FN_1 ( kRemoveAction  ,
TYPE_bool  ,
RemoveAction  ,
TYPE_INDEX   
)
FN_2 ( kHasAction  ,
TYPE_bool  ,
HasAction  ,
TYPE_INODE  ,
TYPE_INDEX_BR   
)
FN_1 ( kIsAction  ,
TYPE_bool  ,
IsAction  ,
TYPE_INODE   
)
FN_1 ( kIsOperator  ,
TYPE_bool  ,
IsOperator  ,
TYPE_INODE   
)
FN_1 ( kIsTest  ,
TYPE_bool  ,
IsTest  ,
TYPE_INODE   
)
FN_0 ( kIsActivated  ,
TYPE_bool  ,
IsActivated   
)
VFN_1 ( kActivate  ,
Activate  ,
TYPE_bool   
)
FN_1 ( kIsActionActive  ,
TYPE_INT  ,
IsActionActive  ,
TYPE_INDEX   
)
VFN_2 ( kActivateAction  ,
ActivateAction  ,
TYPE_INDEX  ,
TYPE_INT   
)
VFN_2 ( kGetPViewLocation  ,
GetPViewLocation  ,
TYPE_INT_BR  ,
TYPE_INT_BR   
)
VFN_2 ( kSetPViewLocation  ,
SetPViewLocation  ,
TYPE_INT  ,
TYPE_INT   
)
FN_0 ( kGetPViewZOrder  ,
TYPE_INT  ,
GetPViewZOrder   
)
VFN_1 ( kSetPViewZOrder  ,
SetPViewZOrder  ,
TYPE_INT   
)
FN_0 ( kGetListWidth  ,
TYPE_INT  ,
GetListWidth   
)
VFN_1 ( kSetListWidth  ,
SetListWidth  ,
TYPE_INT   
)
FN_0 ( kGetPViewRightBoundary  ,
TYPE_INT  ,
GetPViewRightBoundary   
)
FN_0 ( kIsCollapsed  ,
TYPE_bool  ,
IsCollapsed   
)
VFN_0 ( kCollapse  ,
Collapse   
)
VFN_0 ( kExpand  ,
Expand   
)
FN_0 ( kHasUpStream  ,
TYPE_bool  ,
HasUpStream   
)
FN_0 ( kGetSelected  ,
TYPE_INT  ,
GetSelected   
)
VFN_1 ( kSetSelected  ,
SetSelected  ,
TYPE_INT   
)
FN_0 ( kAcceptFertile  ,
TYPE_bool  ,
AcceptFertile   
)

IPFActionList IPFActionList IPFActionList IPFActionList IPFActionList IPFActionList IPFActionList IPFActionList IPFActionList IPFActionList
IPFActionList IPFActionList IPFActionList IPFActionList IPFActionList IPFActionList IPFActionList IPFActionList IPFActionList IPFActionList