RenderMaterialProps Interface
Properties that define a RenderMaterialElement.
@see RenderMaterial for the representation used by the display system.
Extends
Properties
| Name | Type | Description | |
|---|---|---|---|
| description | string | undefined | An optional description of the material. | |
| jsonProperties | { materialAssets?: { renderMaterial?: RenderMaterialAssetProps } } | undefined | Optional json properties of this element. | |
| paletteName | string | The name of a palette that can be used to categorize multiple materials. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| classFullName Inherited | string | DefinitionElementProps | The full name of the ECClass for this entity, in the form "Schema:ClassName" |
| code Inherited | CodeProps | DefinitionElementProps | The Code for this element |
| federationGuid Inherited | string | undefined | DefinitionElementProps | A FederationGuid assigned to this element. |
| id Inherited | string | undefined | DefinitionElementProps | The Id of the entity. |
| isInstanceOfEntity Readonly Inherited | undefined | undefined | DefinitionElementProps | A non-existent property used to discriminate between EntityProps and Entity. |
| isPrivate Inherited | boolean | undefined | DefinitionElementProps | |
| model Inherited | string | DefinitionElementProps | The Id of the Model containing this element |
| parent Inherited | RelatedElementProps | undefined | DefinitionElementProps | The Parent of this element, if defined. |
| userLabel Inherited | string | undefined | DefinitionElementProps | A user-assigned label for this element. |
Defined in
- core/common/src/MaterialProps.ts Line 191
Last Updated: 14 November, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.