Bexel.Api.ReadOnlyMaterialCollection Class Reference
Inheritance diagram for Bexel.Api.ReadOnlyMaterialCollection:
Public Member Functions | |
| IEnumerator< Material > | GetEnumerator () |
| Material | GetMaterialByID (MaterialID id) |
| Retrieves the material with the specified ID. More... | |
| Material | GetMaterialByID (int internalID) |
| Retrieves the material with the specified internal ID. More... | |
| Material | GetMaterialByName (string name) |
| Retrieves the material with the specified name. More... | |
| IEnumerable< Material > | GetMaterialsByName (string name) |
| Retrieves the materials with the specified name. More... | |
| bool | ContainsKey (MaterialID id) |
| Determines whether the collection contains the material with the specified ID. More... | |
| bool | ContainsKey (int internalID) |
| Determines whether the collection contains the material with the specified internal ID. More... | |
Properties | |
| abstract Project | Project [get] |
| abstract IReadOnlyDictionary< int, MaterialRef > | MaterialCollectionRef [get] |
| int | Count [get] |
| Material | this[MaterialID id] [get] |
| Material | this[int internalID] [get] |
 Properties inherited from Bexel.Api.IReadOnlyMaterialCollection | |
| Material | this[MaterialID id] [get] |
| Retrieves the material with the specified ID. More... | |
| Material | this[int internalID] [get] |
| Retrieves the material with the specified internal ID. More... | |
Detailed Description
Member Function Documentation
◆ ContainsKey() [1/2]
| bool Bexel.Api.ReadOnlyMaterialCollection.ContainsKey | ( | MaterialID | id | ) |
Determines whether the collection contains the material with the specified ID.
- Parameters
-
id ID of the material.
- Returns
- True if material with the specified ID exists, False otherwise.
Implements Bexel.Api.IReadOnlyMaterialCollection.
◆ ContainsKey() [2/2]
| bool Bexel.Api.ReadOnlyMaterialCollection.ContainsKey | ( | int | internalID | ) |
Determines whether the collection contains the material with the specified internal ID.
- Parameters
-
internalID Internal ID of the material.
- Returns
- True if material with the specified internal ID exists, False otherwise.
Implements Bexel.Api.IReadOnlyMaterialCollection.
◆ GetMaterialByID() [1/2]
| Material Bexel.Api.ReadOnlyMaterialCollection.GetMaterialByID | ( | MaterialID | id | ) |
Retrieves the material with the specified ID.
- Parameters
-
id ID of the material.
- Returns
- A material with the specified ID, null if no such material exists within the collection.
Implements Bexel.Api.IReadOnlyMaterialCollection.
◆ GetMaterialByID() [2/2]
| Material Bexel.Api.ReadOnlyMaterialCollection.GetMaterialByID | ( | int | internalID | ) |
Retrieves the material with the specified internal ID.
- Parameters
-
internalID Internal ID of the material.
- Returns
- A material with the specified internal ID, null if no such material exists within the collection.
Implements Bexel.Api.IReadOnlyMaterialCollection.
◆ GetMaterialByName()
| Material Bexel.Api.ReadOnlyMaterialCollection.GetMaterialByName | ( | string | name | ) |
Retrieves the material with the specified name.
- Parameters
-
name Name of the material.
- Returns
- A material with the specified name, null if no such material exists within the collection.
Implements Bexel.Api.IReadOnlyMaterialCollection.
◆ GetMaterialsByName()
| IEnumerable<Material> Bexel.Api.ReadOnlyMaterialCollection.GetMaterialsByName | ( | string | name | ) |
Retrieves the materials with the specified name.
- Parameters
-
name Name of the material.
- Returns
- All materials with the specified name, empty collection if no such materials exist within the collection.
Implements Bexel.Api.IReadOnlyMaterialCollection.
