All Frameworks  Object Hierarchy  This Framework  Indexes

Materials (Collection)

A collection of all the Material objects.
This collection is currently managed by a MaterialFamily object.

Method Index

Add
Adds a new material to the material collection.
Item
Returns a material from its index in the Material collection.
Remove
Removes a material from the materials collection.
SortedItem
Returns a material from its index in the sorted Material collection.

Methods


o Func Add() As
Adds a new material to the material collection.
o Func Item( iIndex) As
Returns a material from its index in the Material collection.
Parameters:
iIndex
The index of the material to retrieve in the collection of materials. Compared with other collections, you cannot use the name of the material as argument.
Returns:
The retrieved material
Example:
The following example returns in MyMaterial the sixth material in a material collection. 
 Dim MyMaterial As Material
 Set MyMaterial = Materials.Item(6)
o Sub Remove( iIndex)
Removes a material from the materials collection.
o Func SortedItem( iIndex,
iMode) As
Returns a material from its index in the sorted Material collection.
Parameters:
iIndex
The index of the material to retrieve in the sorted collection of materials. Compared with other collections, you cannot use the name of the material as argument.
iMode
The sorted mode of material collection
    Possible mode values are:
  • 0: Alphabetical order
  • 1: Inverse alphabetical order
Returns:
The retrieved material

Copyright © 2003, Dassault Systèmes. All rights reserved.