Material

Public Class

Inheritance Hierarchy

System.Object
Rhino.Runtime.CommonObject
Rhino.DocObjects.ModelComponent
Rhino.DocObjects.Material

Namespace: Rhino.DocObjects

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

[SerializableAttribute]
public sealed class Material : ModelComponent

The Material type exposes the following members.

Constructors

Name

Description

---

Public Method

Material.

Initializes a new instance of the Material class

---

Public Method

Material(Material)

Initializes a new instance of the Material class

---

Properties

Name

Description

---

Public Property

AlphaTransparency

---

Public Property

AmbientColor

---

Public Property

ComponentStatus

Gets or sets the component status of the model component.

(Inherited from ModelComponent.)

---

Public Property

ComponentType

Returns RenderMaterial.

(Overrides

ModelComponent.ComponentType

.)

---

Public Property
Static Member

DefaultMaterial

---

Public Property

DeletedName

Gets the name of a component that is deleted.

(Inherited from ModelComponent.)

---

Public Property

DiffuseColor

---

Public Property

DisableLighting

---

Public Property

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.

(Inherited from CommonObject.)

---

Public Property

EmissionColor

---

Public Property

FresnelIndexOfRefraction

Gets or sets the Fresnel index of refraction of the material, default is 1.56

---

Public Property

FresnelReflections

Gets or sets if Fresnel reflections are used.

---

Public Property

HasId

Returns a value indicating whether the component has an ID.

(Inherited from ModelComponent.)

---

Public Property

HasIndex

Returns a value indicating whether the component has an Index.

(Inherited from ModelComponent.)

---

Public Property

HasName

Returns a value indicating whether the component has a Name.

(Inherited from ModelComponent.)

---

Public Property

HasUserData

Gets true if this class has any custom information attached to it through UserData.

(Inherited from CommonObject.)

---

Public Property

Id

Gets or sets the ID of the current instance.

(Inherited from ModelComponent.)

---

Public Property

IdIsLocked

Returns a value indicating whether the component ID is already locked.

(Inherited from ModelComponent.)

---

Public Property

Index

Gets or sets the model component index attribute.

(Inherited from ModelComponent.)

---

Public Property

IndexIsLocked

Returns a value indicating whether the component Index is already locked.

(Inherited from ModelComponent.)

---

Public Property

IndexOfRefraction

Gets or sets the index of refraction of the material, generally >= 1.0 (speed of light in vacuum)/(speed of light in material)

---

Public Property
InstanceDefinitionModelSerialNumber

When a component is in a model as part of the information required for a linked instance definition, this value identifies the linked instance definition reference model.

(Inherited from ModelComponent.)

---

Public Property

IsComponentStatusLocked

The component status itself can be locked. This returns an indication.

(Inherited from ModelComponent.)

---

Public Property

IsDefaultMaterial

By default Rhino layers and objects are assigned the default rendering material.

---

Public Property

IsDeleted

Deleted materials are kept in the runtime material table so that undo will work with materials. Call IsDeleted to determine to determine if a material is deleted.

(Overrides

ModelComponent.IsDeleted

.)

---

Public Property

IsDocumentControlled

If true this object may not be modified. Any properties or functions that attempt to modify this object when it is set to “IsReadOnly” will throw a NotSupportedException.

(Overrides

CommonObject.IsDocumentControlled

.)

---

Public Property

IsPhysicallyBased

---

Public Property

IsReference

Rhino allows multiple files to be viewed simultaneously. Materials in the document are “normal” or “reference”. Reference materials are not saved.

(Overrides

ModelComponent.IsReference

.)

---

Public Property

IsSystemComponent

True if this model component is a system constant.

An incomplete list of system constant model components is below:

• ON_ModelComponent::Unset

• ON_InstanceDefinition::Empty

• ON_Linetype::Unset

• ON_Linetype::Continuous

• ON_Linetype::ByLayer

• ON_Linetype::ByParent

• ON_Layer::Unset

• ON_Layer::Default

• ON_TextStyle::Unset

• ON_TextStyle::Default

• ON_TextStyle::ByLayer

• ON_TextStyle::ByParent

• ON_DimStyle::Unset

• ON_DimStyle::Default

• ON_DimStyle::DefaultInchDecimal

• ON_DimStyle::DefaultInchFractional

• ON_DimStyle::DefaultFootInchArchitecture

• ON_DimStyle::DefaultMillimeterSmall

• ON_DimStyle::DefaultMillimeterLarge

• ON_DimStyle::DefaultMillimeterArchitecture

(Inherited from ModelComponent.)

---

Public Property

IsValid

Tests an object to see if it is valid.

(Inherited from CommonObject.)

---

Public Property
Static Member

MaxShine

---

Public Property
ModelSerialNumber

A value identifying the model that manages this component.

(Inherited from ModelComponent.)

---

Public Property

Name

(Overrides

ModelComponent.Name

.)

---

Public Property

NameIsLocked

Returns a value indicating whether the component Name is already locked.

(Inherited from ModelComponent.)

---

Public Property

PhysicallyBased

---

Public Property

PreviewColor

Very simple preview color function for GUIs.

---

Public Property
RDKMaterialID

Gets the RDK material ID.

---

Public Property
ReferenceModelSerialNumber

When a component is in a model for reference, this value identifies the reference model.

(Inherited from ModelComponent.)

---

Public Property

ReflectionColor

---

Public Property

ReflectionGlossiness

Gets or sets the reflection glossiness.

---

Public Property

Reflectivity

Gets or sets how reflective a material is, 0f is no reflection 1f is 100% reflective.

---

Public Property

RefractionGlossiness

Gets or sets the refraction glossiness.

---

Public Property

RenderMaterial

Get the RenderMaterial related to this Material. Will create a new RenderMaterial if none exists. This can happen for older documents.

---

Public Property

RenderMaterialInstanceId

---

Public Property

RenderPlugInId

The Id of the RenderPlugIn that is associated with this material.

---

Public Property

Shine

Gets or sets the shine factor of the material.

---

Public Property

SpecularColor

---

Public Property

Transparency

Gets or sets the transparency of the material (0.0 = opaque to 1.0 = transparent)

---

Public Property

TransparentColor

---

Public Property

UseCount

Number of objects and layers that use this material.

---

Public Property

UserData

List of custom information that is attached to this class.

(Inherited from CommonObject.)

---

Public Property

UserDictionary

Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.

(Inherited from CommonObject.)

---

Public Property

UserStringCount

---

Methods

Name

Description

---

Public Method

ClearId

Resets the HasId property of the model component to false, if possible.

(Inherited from ModelComponent.)

---

Public Method

ClearIndex

Resets the HasIndex property of the model component to false, if possible.

(Inherited from ModelComponent.)

---

Public Method

ClearMaterialChannels

Removes all material channels

---

Public Method

ClearName

Resets the HasName property of the model component to false, if possible.

(Inherited from ModelComponent.)

---

Public Method

CommitChanges

---

Public Method

CopyFrom

---

Public Method

DataCRC

Increments the Cyclic Redundancy Check value by this instance.

(Inherited from ModelComponent.)

---

Public Method

Default

Set material to default settings.

---

Public Method

Dispose.

Actively reclaims unmanaged resources that this instance uses.

(Inherited from CommonObject.)

---

Public Method

EnsurePrivateCopy

If you want to keep a copy of this class around by holding onto it in a variable after a command completes, call EnsurePrivateCopy to make sure that this class is not tied to the document. You can call this function as many times as you want.

(Inherited from CommonObject.)

---

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

---

Public Method

GetBitmapTexture

---

Public Method

GetBumpTexture

Gets the bump texture of this material.

---

Public Method

GetEnvironmentTexture

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetObjectData

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

(Inherited from CommonObject.)

---

Public Method

GetTexture

Get the texture that corresponds with the specified texture type for this material.

---

Public Method

GetTextures

Get array of textures that this material uses

---

Public Method

GetTransparencyTexture

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Public Method

GetUserString

Gets a user string.

---

Public Method

GetUserStrings

Gets an independent copy of the collection of (user text key, user text value) pairs attached to this object.

---

Public Method

IsValidWithLog

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.

(Inherited from CommonObject.)

---

Public Method

LockId

Locks the component Id property.

(Inherited from ModelComponent.)

---

Public Method

LockIndex

Locks the component Index property.

(Inherited from ModelComponent.)

---

Public Method

LockName

Locks the component Name property.

(Inherited from ModelComponent.)

---

Public Method

MaterialChannelIdFromIndex

Finds id of the material channel at given index.

---

Public Method

MaterialChannelIndexFromId

Finds index of the material channel that refers to a material channel with the given id. Optionally adds channel if one is not found.

---

Public Method

SetBitmapTexture(String)

---

Public Method

SetBitmapTexture(Texture)

---

Public Method

SetBumpTexture(String)

---

Public Method

SetBumpTexture(Texture)

---

Public Method

SetEnvironmentTexture(String)

---

Public Method

SetEnvironmentTexture(Texture)

---

Public Method

SetTexture

Set the texture that corresponds with the specified texture type for this material.

---

Public Method

SetTransparencyTexture(String)

---

Public Method

SetTransparencyTexture(Texture)

---

Public Method

SetUserString

Attach a user string (key,value combination) to this geometry.

---

Public Method

ToJSON

Create a JSON string representation of this object

(Inherited from CommonObject.)

---

Public Method

ToPhysicallyBased

---

Public Method
ToString

Returns the name of the model component type, and then its name and index.

(Inherited from ModelComponent.)

---