File3dmMaterialTable

File3dmCommonComponentTable<1>CommonComponentTable<1>References
public class File3dmMaterialTable : File3dmCommonComponentTable<Material>, IList<Material>
Provides access to materials in the 3dm file.

Properties

ComponentType

#Since v6.0
public override ModelComponentType ComponentType { get; }
Returns ModelComponentType.RenderMaterial.
Overrides: CommonComponentTable<T>.ComponentType

Count

public virtual int Count { get; }
Returns the count of all items, including deleted ones.
inherited fromCommonComponentTable<T>

Methods

Add

public virtual void Add(T item)
Adds an item.
inherited fromFile3dmCommonComponentTable<T>
Parameters:
item (T)The item to add.

AddMaterial

#Since v8.4
public int AddMaterial(Material material)
Adds a material to the model material table
Parameters:
material (Material)
Returns: The material's index (>=0) is returned. Otherwise, RhinoMath.UnsetIntIndex is returned.

Clear

public void Clear()
Marks all items as deleted.
inherited fromCommonComponentTable<T>

Delete

public override bool Delete(T item)
Flags a component as deleted.
inherited fromFile3dmCommonComponentTable<T>
Parameters:
item (T)The item to flag.
Returns: True on success.
Overrides: CommonComponentTable<T>.Delete

Delete

public virtual void Delete(int index)
Flags a component as deleted.
inherited fromFile3dmCommonComponentTable<T>
Parameters:
index (int)The index of the item to flag.
Returns: True on success.

Dump

public string Dump()
Prepares a text dump of object table.
inherited fromFile3dmCommonComponentTable<T>
Returns: A string containing the dump.

FindId

public virtual T FindId(Guid id)
Uses the guid to find a model component. Deleted objects cannot be found by id. The guid is the value that is stored in the .Id property. In a single document, no two active objects have the same guid. If an object is replaced with a new object, then the guid persists. For example, if the _Move command moves an object, then the moved object inherits its guid from the starting object. If the Copy command copies an object, then the copy gets a new guid. This guid persists through file saving/opening operations. This function will not find grip objects.
inherited fromCommonComponentTable<T>
Parameters:
id (Guid)ID of model component to search for.
Returns: Reference to the rhino object with the objectId or null if no such object could be found.
Implements: FindId

FindIndex

#Since v6.0
public Material FindIndex(int index)
Retrieves a material based on Index. This search type of search is discouraged. We are moving towards using only IDs for all tables.
Parameters:
index (int)The index to search for.
Returns: A material, or null if none was found.

GetEnumerator

public virtual IEnumerator<T> GetEnumerator()
Returns the enumerator that yields all items.
inherited fromCommonComponentTable<T>