IPFActionList Class Reference

IPFActionList Class Referenceabstract

#include <IPFActionList.h>

+ Inheritance diagram for IPFActionList:

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 Types inherited from BaseInterface
enum  LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }
 

Public Member Functions

 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)
 
FPInterfaceDescGetDesc ()
 Must implement GetDescByID method. More...
 
virtual int NumActions () const =0
 
virtual INodeGetAction (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. More...
 
virtual int IsActionActive (int index) const =0
 Activate/deactivate all the actions in the list. More...
 
virtual void ActivateAction (int index, int active=1)=0
 Activate/deactivate all the actions in the list. More...
 
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. More...
 
virtual bool IsCollapsed ()
 Action list may be shown in a "collapsed" state in ParticleView. More...
 
virtual void Collapse ()
 Action list may be shown in a "collapsed" state in ParticleView. More...
 
virtual void Expand ()
 Action list may be shown in a "collapsed" state in ParticleView. More...
 
virtual bool HasUpStream ()
 Indicates if there are PFSystems or ActionLists that direct particle flow in this action list. More...
 
virtual int GetSelected () const
 ActionList has its own methods for selecting. More...
 
virtual void SetSelected (int onOff)
 See virtual int GetSelected(). More...
 
virtual bool AcceptFertile ()
 ActionList has some restrictions on whether it is able to add a "fertile" action. More...
 
virtual void UpdateMaterial ()
 The method is used to initiate material update in the associated particle group. More...
 
- Public Member Functions inherited from FPMixinInterface
 FPMixinInterface ()
 
virtual LifetimeType LifetimeControl ()
 
virtual CoreExport bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
CoreExport ~FPMixinInterface ()
 
virtual BaseInterfaceGetInterface (Interface_ID id)
 
virtual FPInterfaceDescGetDescByID (Interface_ID id)
 
virtual Interface_ID GetID ()
 
- Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
 
virtual FPStatus Invoke (FunctionID fid, FPParams *params)
 
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
 
virtual FPStatus Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
 
virtual CoreExport FunctionID FindFn (const MCHAR *name)
 
virtual CoreExport BOOL IsEnabled (FunctionID actionID)
 
virtual CoreExport BOOL IsChecked (FunctionID actionID)
 
virtual CoreExport BOOL IsVisible (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsEnabled (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsChecked (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsVisible (FunctionID actionID)
 
virtual ActionTableGetActionTable ()
 
virtual void EnableActions (BOOL onOff)
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor. More...
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=NULL)
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor. More...
 

Static Public Member Functions

static PFExport bool IsAction (INode *action)
 
static PFExport bool IsOperator (INode *action)
 
static PFExport bool IsTest (INode *action)
 
- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e)
 Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport void operator delete (void *ptr)
 Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator. More...
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator. More...
 

Additional Inherited Members

- Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
 
- Protected Member Functions inherited from FPMixinInterface
 FPMixinInterface (const FPMixinInterface &rhs)
 
FPMixinInterfaceoperator= (const FPMixinInterface &rhs)
 
- Protected Member Functions inherited from FPInterface
virtual FPStatus _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
 
- Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > * interfaceNotifyCBs
 

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 
42  };
Definition: IPFActionList.h:32
Definition: IPFActionList.h:37
Definition: IPFActionList.h:35
Definition: IPFActionList.h:33
Definition: IPFActionList.h:36
Definition: IPFActionList.h:38
Definition: IPFActionList.h:40
Definition: IPFActionList.h:39
Definition: IPFActionList.h:40
Definition: IPFActionList.h:37
Definition: IPFActionList.h:41
Definition: IPFActionList.h:39
Definition: IPFActionList.h:35
Definition: IPFActionList.h:34
Definition: IPFActionList.h:34
Definition: IPFActionList.h:32
Definition: IPFActionList.h:35
Definition: IPFActionList.h:34
Definition: IPFActionList.h:32
Definition: IPFActionList.h:38
Definition: IPFActionList.h:39
Definition: IPFActionList.h:33
Definition: IPFActionList.h:36
Definition: IPFActionList.h:33
Definition: IPFActionList.h:36
Definition: IPFActionList.h:40
Definition: IPFActionList.h:37

Member Function Documentation

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   
)
VFN_2 ( kActivateAction  ,
ActivateAction  ,
TYPE_INDEX  ,
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 ( 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   
)