IPFActionExt.h

Module description

Functions

virtual bool InteruptUpdate (IObject *pCont) const
 The method can be used to signal the a container update for a particle group has to be interrupted on this action. More...
 
virtual void AllowUpdateInterruption (bool allow)
 defines whether is it allowed to interrupt an update for an action. More...
 
virtual bool SetFinalUpdateTime (TimeValue t)
 inform the action what would be a final time for the series of update calls More...
 
FPInterfaceDescGetDesc ()
 

Function Documentation

bool InteruptUpdate ( IObject pCont) const
inlinevirtual

The method can be used to signal the a container update for a particle group has to be interrupted on this action.

Only after all particle groups in the system are updated (with possible interruptions as well), the container update can be continued. This is done for operators that are instanced across a PFlow system to ensure the real instant snapshot of the whole system to guarantee the proper interaction between particles at the same instant moment.

59 { UNUSED_PARAM(pCont); return false; }
#define UNUSED_PARAM(x)
Definition: BuildWarnings.h:18
void AllowUpdateInterruption ( bool  allow)
inlinevirtual

defines whether is it allowed to interrupt an update for an action.

If the update interruption is not allowed then InterruptUpdate cannot return true

66 { UNUSED_PARAM(allow); }
#define UNUSED_PARAM(x)
Definition: BuildWarnings.h:18
bool SetFinalUpdateTime ( TimeValue  t)
inlinevirtual

inform the action what would be a final time for the series of update calls

71 { UNUSED_PARAM(t); return true; }
#define UNUSED_PARAM(x)
Definition: BuildWarnings.h:18
FPInterfaceDesc * GetDesc ( )
inlinevirtual
Remarks
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

#define PFACTIONEXT_INTERFACE
Definition: IPFActionExt.h:25
virtual FPInterfaceDesc * GetDescByID(Interface_ID id)
Definition: ifnpub.h:613