IPFActionExt.h
 
 
 
IPFActionExt.h

This reference page is linked to from the following overview topics: Particle Flow SDK Extensions.


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.
virtual void  AllowUpdateInterruption (bool allow)
  defines whether is it allowed to interrupt an update for an action.
virtual bool  SetFinalUpdateTime (TimeValue t)
  inform the action what would be a final time for the series of update calls
FPInterfaceDesc GetDesc ()

Function Documentation

bool InteruptUpdate ( IObject pCont ) const [inline, virtual]

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.

{  UNUSED_PARAM(pCont); return false; }
void AllowUpdateInterruption ( bool  allow ) [inline, virtual]

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

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

{  UNUSED_PARAM(allow); }
bool SetFinalUpdateTime ( TimeValue  t ) [inline, virtual]

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

{  UNUSED_PARAM(t); return true; }
FPInterfaceDesc * GetDesc ( ) [inline, virtual]
Remarks:
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.