RhinoCommon documentation has a new look. The old site can still be found here.

/

Rhino.DocObjects.Tables

/

MaterialTable

MaterialTable class

Inheritence: Rhino.FileIO.CommonComponentTable<T>RhinoDocCommonTable<Material>MaterialTable
Derived Classes:

Namespace: Rhino.DocObjects.Tables
MaterialTable: references

Properties (7)

ComponentType

ComponentType

Returns the actual component type of a table.

Count

Returns the count of all items, including deleted ones.

CurrentMaterialIndex

At all times, there is a "current" material. Unless otherwise specified, new objects are assigned to the current material. The current material is never locked, hidden, or deleted.

CurrentMaterialSource

Gets or sets the current material source.

Document

Document that owns this table.

Item

Conceptually, the material table is an array of materials. The operator[] can be used to get individual materials. A material is either active or deleted and this state is reported by Material.IsDeleted.

Methods (15)

Add()

Adds a new material to the table based on the default material.

Add(Material material, bool reference)

Adds a new material to the table based on a given material.

Add(Material material)

Adds a new material to the table based on a given material.

Clear()

Marks all items as deleted.

Delete(Material item)

Delete(T item)

Deletes an item. Items that are deleted are still keeping their space, but the 'IsDeleted' flag is checked.

DeleteAt(int materialIndex)

Removes a material at a specific position from this material table.

Find(Material material, bool ignoreDeletedMaterials)

Finds a material index.

Find(string materialName, bool ignoreDeletedMaterials)

Finds a material with a given name.

Find(Guid materialId, bool ignoreDeletedMaterials)

Finds a material with a matching id.

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.

FindIndex(int index)

Retrieves a Material object based on Index. This search type of search is discouraged. We are moving towards using only IDs for all tables.

GetEnumerator()

Returns the enumerator that yields all items.

Modify(Material newSettings, int materialIndex, bool quiet)

Modify material settings.

ResetMaterial(int materialIndex)

Nothing found