3ds Max C++ API Reference
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
IPFActionListMaterialHolder.h

Functions

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 MtlGetMaterial ()
 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 INodeTabUpStreamActionLists (void)=0
 Returns Tab of up-stream action list nodes (for read and write)
 
virtual INodeTabUpStreamMaterialActionLists (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.
 
FPInterfaceDescGetDesc ()
 

Detailed Description

Function Documentation

◆ IsMaterialHolder()

virtual bool IsMaterialHolder ( ) const
inlinevirtual

If the ActionList has an associated material (either via material inheritance or from any actions at the action list, then return true.

65{ return false; }

◆ InheritsMaterial()

virtual bool InheritsMaterial ( ) const
inlinevirtual

Defines whether this action list depends on the upstream action lists to generate its material.

If the action list has an operator with a material, and it does not inherit material then it returns false

71{ return false; }

◆ GenerateInheritedMaterial()

virtual bool GenerateInheritedMaterial ( void  )
inlinevirtual

Generates material as defined by inheritance.

75{ return false; }

◆ GetMaterial()

virtual Mtl * GetMaterial ( )
inlinevirtual

Returns a material for particles.

80{ return NULL; }
#define NULL
Definition: autoptr.h:18

◆ SetMaterial()

virtual bool SetMaterial ( Mtl mtl)
inlinevirtual

Return true if material was set successfully.

84{ UNUSED_PARAM(mtl); return false; }
#define UNUSED_PARAM(x)
Definition: BuildWarnings.h:13

◆ GetMaterialPriority()

virtual int GetMaterialPriority ( void  ) const
inlinevirtual

Returns material priority number.

The priority is used when defining material inheritance, for example material inheritance can be defined by inheriting material with highest (largest) priority.

90{ return 0; }

◆ GetStreamDepth()

virtual int GetStreamDepth ( void  ) const
inlinevirtual

Returns stream depth index - shortest distance to pf source up stream.

94{ return 0; }

◆ SetStreamDepth()

virtual void SetStreamDepth ( int  streamDepth)
inlinevirtual

Sets stream depth index - shortest distance to pf source up stream.

98{ UNUSED_PARAM(streamDepth); }

◆ UpStreamActionLists()

virtual INodeTab & UpStreamActionLists ( void  )
pure virtual

Returns Tab of up-stream action list nodes (for read and write)

◆ UpStreamMaterialActionLists()

virtual INodeTab & UpStreamMaterialActionLists ( void  )
pure virtual

Returns Tab of up-stream action list nodes that are relevant for material inheritance re-generation (for read and write)

◆ SetVisited()

virtual void SetVisited ( bool  visited)
inlinevirtual

The method is used to implemented Visitor pattern in the actionList graph.

112{ UNUSED_PARAM(visited); }

◆ IsVisited()

virtual bool IsVisited ( void  ) const
inlinevirtual

The method is used to implemented Visitor pattern in the actionList graph.

117{ return false; }

◆ SetSortOrder()

virtual void SetSortOrder ( int  index)
inlinevirtual

The method is used to sort action lists to resolve material dependency for inheritance.

122{ UNUSED_PARAM(index); }

◆ GetSortOrder()

virtual int GetSortOrder ( void  ) const
inlinevirtual

The method is used to sort action lists to resolve material dependency for inheritance.

127{ return 0; }

◆ UpdateMaterial()

virtual bool UpdateMaterial ( bool  doReport)
inlinevirtual

Returns whether the event material was updated.

131{ UNUSED_PARAM(doReport); return 0; }

◆ UpdateMaterials()

virtual int UpdateMaterials ( bool  doReport)
inlinevirtual

Returns number of actionLists/events with materials updated.

135{ UNUSED_PARAM(doReport); return 0; }

◆ UpdateMaterialsDownstream()

virtual int UpdateMaterialsDownstream ( bool  doReport)
inlinevirtual

Returns number of actionLists/events with materials updated.

The functions updates materials in all events in the downstream of the current event; The function does not update material in the current event; use UpdateMaterial function instead for this purpose

142{ UNUSED_PARAM(doReport); return 0; }

◆ GetDesc()

FPInterfaceDesc * GetDesc ( )
inlinevirtual
Remarks
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

#define PFACTIONLISTMATERIALHOLDER_INTERFACE
Definition: IPFActionListMaterialHolder.h:21
virtual FPInterfaceDesc * GetDescByID(Interface_ID id)
Definition: ifnpub.h:617