MaterialTable Class |
[Missing <summary> documentation for "T:Rhino.DocObjects.Tables.MaterialTable"]
Inheritance HierarchySystemObject
Rhino.FileIOCommonComponentTableMaterial
Rhino.DocObjects.TablesRhinoDocCommonTableMaterial
Rhino.DocObjects.TablesMaterialTable
Rhino.FileIOCommonComponentTableMaterial
Rhino.DocObjects.TablesRhinoDocCommonTableMaterial
Rhino.DocObjects.TablesMaterialTable
Namespace: Rhino.DocObjects.Tables
Assembly: RhinoCommon (in RhinoCommon.dll)
SyntaxThe MaterialTable type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ComponentType | (Overrides CommonComponentTableTComponentType.) |
| Count |
Returns the count of all items, including deleted ones.
(Inherited from CommonComponentTableT.) |
| 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. (Inherited from RhinoDocCommonTableT.) |
| 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| Name | Description | |
|---|---|---|
 | Add |
Adds a new material to the table based on the default material.
|
| Add(Material) |
Adds a new material to the table based on a given material.
|
| Add(Material, Boolean) |
Adds a new material to the table based on a given material.
|
| Clear |
Marks all items as deleted.
(Inherited from CommonComponentTableT.) |
| Delete | (Overrides CommonComponentTableTDelete(T).) |
| DeleteAt |
Removes a material at a specific position from this material table.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Find(Guid, Boolean) | Finds a material with a matching id. |
| Find(Material, Boolean) |
Finds a material index.
|
| Find(String, Boolean) |
Finds a material with a given name.
|
| FindId |
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 from CommonComponentTableT.) |
| FindIndex |
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.
(Inherited from CommonComponentTableT.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Modify | Modify material settings. |
| ResetMaterial | |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also