IPFActionListMaterialHolder Class Reference
 
 
 
IPFActionListMaterialHolder Class Reference

This reference page is linked to from the following overview topics: New Classes and Methods.


#include <IPFActionListMaterialHolder.h>

Inheritance diagram for IPFActionListMaterialHolder:
FPMixinInterface FPInterface BaseInterface InterfaceServer MaxHeapOperators

Public Types

enum   {
  kIsMaterialHolder, kInheritsMaterial, kGetMaterial, kSetMaterial,
  kGetMaterialPriority, kGetStreamDepth, kSetStreamDepth, kUpdateMaterial,
  kUpdateMaterials, kUpdateMaterialsDownstream
}

Public Member Functions

BEGIN_FUNCTION_MAP  FN_0 (kIsMaterialHolder, TYPE_bool, IsMaterialHolder)
  FN_0 (kInheritsMaterial, TYPE_bool, InheritsMaterial)
  FN_0 (kGetMaterial, TYPE_MTL, GetMaterial)
  FN_1 (kSetMaterial, TYPE_bool, SetMaterial, TYPE_MTL)
  FN_0 (kGetMaterialPriority, TYPE_INT, GetMaterialPriority)
  FN_0 (kGetStreamDepth, TYPE_INT, GetStreamDepth)
  VFN_1 (kSetStreamDepth, SetStreamDepth, TYPE_INT)
  FN_1 (kUpdateMaterial, TYPE_bool, UpdateMaterial, TYPE_bool)
  FN_1 (kUpdateMaterials, TYPE_INT, UpdateMaterials, TYPE_bool)
  FN_1 (kUpdateMaterialsDownstream, TYPE_INT, UpdateMaterialsDownstream, TYPE_bool)
virtual bool  IsMaterialHolder () const
  If the ActionList has an associated material (either via material inheritance or from any actions at the action list, then return true.
virtual bool  InheritsMaterial () const
  Defines whether this action list depends on the upstream action lists to generate its material.
virtual bool  GenerateInheritedMaterial (void)
  Generates material as defined by inheritance.
virtual Mtl GetMaterial ()
  Returns a material for particles.
virtual bool  SetMaterial (Mtl *mtl)
  Return true if material was set successfully.
virtual int  GetMaterialPriority (void) const
  Returns material priority number.
virtual int  GetStreamDepth (void) const
  Returns stream depth index - shortest distance to pf source up stream.
virtual void  SetStreamDepth (int streamDepth)
  Sets stream depth index - shortest distance to pf source up stream.
virtual INodeTab UpStreamActionLists (void)=0
  Returns Tab of up-stream action list nodes (for read and write)
virtual INodeTab UpStreamMaterialActionLists (void)=0
  Returns Tab of up-stream action list nodes that are relevant for material inheritance re-generation (for read and write)
virtual void  SetVisited (bool visited)
  The method is used to implemented Visitor pattern in the actionList graph.
virtual bool  IsVisited (void) const
  The method is used to implemented Visitor pattern in the actionList graph.
virtual void  SetSortOrder (int index)
  The method is used to sort action lists to resolve material dependency for inheritance.
virtual int  GetSortOrder (void) const
  The method is used to sort action lists to resolve material dependency for inheritance.
virtual bool  UpdateMaterial (bool doReport)
  Returns whether the event material was updated.
virtual int  UpdateMaterials (bool doReport)
  Returns number of actionLists/events with materials updated.
virtual int  UpdateMaterialsDownstream (bool doReport)
  Returns number of actionLists/events with materials updated.
FPInterfaceDesc GetDesc ()

Member Enumeration Documentation


Member Function Documentation

BEGIN_FUNCTION_MAP FN_0 ( kIsMaterialHolder  ,
TYPE_bool  ,
IsMaterialHolder   
)
FN_0 ( kInheritsMaterial  ,
TYPE_bool  ,
InheritsMaterial   
)
FN_0 ( kGetMaterial  ,
TYPE_MTL  ,
GetMaterial   
)
FN_1 ( kSetMaterial  ,
TYPE_bool  ,
SetMaterial  ,
TYPE_MTL   
)
FN_0 ( kGetMaterialPriority  ,
TYPE_INT  ,
GetMaterialPriority   
)
FN_0 ( kGetStreamDepth  ,
TYPE_INT  ,
GetStreamDepth   
)
VFN_1 ( kSetStreamDepth  ,
SetStreamDepth  ,
TYPE_INT   
)
FN_1 ( kUpdateMaterial  ,
TYPE_bool  ,
UpdateMaterial  ,
TYPE_bool   
)
FN_1 ( kUpdateMaterials  ,
TYPE_INT  ,
UpdateMaterials  ,
TYPE_bool   
)
FN_1 ( kUpdateMaterialsDownstream  ,
TYPE_INT  ,
UpdateMaterialsDownstream  ,
TYPE_bool   
)