All Frameworks Class Hierarchy This Framework Next Indexes
CATMatInterfaces Interface CATIFamilyFeature
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIFamilyFeature
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIFamilyFeature
Interface to manage a family of material objects.
Role: A family of material objects enables you to sort
material objects according to their types (for example wood, metal or
stone are material families).
Using this interface allows you to get or add material objects in a material family.
- See also:
- CATIMaterialDocument, CATILibraryFeature, CATIMaterialFeature
Method Index
- o
GetLabel()
- Returns the label of a family.
- o
GetMaterial(int)
- Retrieves a material in the family using its index.
- o
GetMaterialCount()
- Returns the count of materials in the family.
- o
SetMaterial(CATIMaterialFeature*,int)
- Adds a new material in the family.
Methods
o GetLabel
-
Returns the label of a family.
o GetMaterial
-
Retrieves a material in the family using its index.
- Parameters:
-
- iIndex
- The index of the material. This value ranges from 1 to
GetMaterialCount()
- Returns:
- The material object if iIndex is valid, and NULL otherwise .
o GetMaterialCount
public virtual int GetMaterialCount( | )const = 0 |
-
Returns the count of materials in the family.
- Returns:
- An integer value.
A family can be empty and this value can therefore be 0.
o SetMaterial
-
Adds a new material in the family.
Note: The material should be created previously, using
CreateNewMaterial
- Parameters:
-
- iMaterial
- The new material to add
- iIndex
- This value is the position of the material in the family.
Legal Values:
- if iIndex is 0, the default value, the material is added in the end of the family
- if IIndex ranges from 1 to
GetMaterialCount(), iMaterial replaces a material.
- otherwise, it's an error
This object is included in the file: CATIFamilyFeature.h
If needed, your Imakefile.mk should include the module: CATMatInterfaces