RhinoCommon API
Material Class |
[Missing <summary> documentation for "T:Rhino.DocObjects.Material"]

Namespace: Rhino.DocObjects
Assembly: RhinoCommon (in RhinoCommon.dll)

The Material type exposes the following members.

Name | Description | |
---|---|---|
![]() | Material | Initializes a new instance of the Material class |
![]() | Material(Material) | Initializes a new instance of the Material class |
![]() | Material(SerializationInfo, StreamingContext) | Initializes a new instance of the Material class |

Name | Description | |
---|---|---|
![]() | AlphaTransparency | |
![]() | AmbientColor | |
![]() | ComponentStatus |
Gets or sets the component status of the model component.
(Inherited from ModelComponent.) |
![]() | ComponentType |
Returns RenderMaterial.
(Overrides ModelComponentComponentType.) |
![]() ![]() | DefaultMaterial | |
![]() | DeletedName |
Gets the name of a component that is deleted.
(Inherited from ModelComponent.) |
![]() | DiffuseColor | |
![]() | DisableLighting | |
![]() | Disposed |
Indicates if this object has been disposed or the
document it originally belonged to has been disposed.
(Inherited from CommonObject.) |
![]() | EmissionColor | |
![]() | FresnelIndexOfRefraction |
Gets or sets the Fresnel index of refraction of the material,
default is 1.56
|
![]() | FresnelReflections |
Gets or sets if fresnel reflections are used.
|
![]() | HasId |
Returns a value indicating whether the component has an ID.
(Inherited from ModelComponent.) |
![]() | HasIndex |
Returns a value indicating whether the component has an Index.
(Inherited from ModelComponent.) |
![]() | HasName |
Returns a value indicating whether the component has a Name.
(Inherited from ModelComponent.) |
![]() | HasUserData |
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.) |
![]() | Id | Gets or sets the ID of this material. In Rhino for Windows 6.8, this member is inherited from ModelComponentId. |
![]() | IdIsLocked |
Returns a value indicating whether the component ID is already locked.
(Inherited from ModelComponent.) |
![]() | Index |
Gets or sets the model component index attribute.
(Inherited from ModelComponent.) |
![]() | IndexIsLocked |
Returns a value indicating whether the component Index is already locked.
(Inherited from ModelComponent.) |
![]() | IndexOfRefraction |
Gets or sets the index of refraction of the material, generally
>= 1.0 (speed of light in vacuum)/(speed of light in material)
|
![]() | IsComponentStatusLocked |
The component status itself can be locked. This returns an indication.
(Inherited from ModelComponent.) |
![]() | IsDefaultMaterial |
By default Rhino layers and objects are assigned the default rendering material.
|
![]() | 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.
|
![]() | 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 CommonObjectIsDocumentControlled.) |
![]() | IsReference |
Rhino allows multiple files to be viewed simultaneously. Materials in the
document are "normal" or "reference". Reference materials are not saved.
|
![]() | IsSystemComponent |
True if this model component is a system constant.
(Inherited from ModelComponent.)An incomplete list of system constant model components is below:
|
![]() | IsValid | Tests an object to see if it is valid. (Inherited from CommonObject.) |
![]() | MaterialIndex | |
![]() ![]() | MaxShine | |
![]() | Name | |
![]() | NameIsLocked |
Returns a value indicating whether the component Name is already locked.
(Inherited from ModelComponent.) |
![]() | PreviewColor |
Very simple preview color function for GUIs.
|
![]() | ReflectionColor | |
![]() | ReflectionGlossiness |
Gets or sets the reflection glossiness.
|
![]() | Reflectivity |
Gets or sets how reflective a material is, 0f is no reflection
1f is 100% reflective.
|
![]() | RefractionGlossiness |
Gets or sets the refraction glossiness.
|
![]() | RenderMaterial |
Get the RenderMaterial related to this Material.
Will create a new RenderMaterial if none exists. This can happen for older
documents.
|
![]() | RenderMaterialInstanceId | |
![]() | RenderPlugInId |
The Id of the RenderPlugIn that is associated with this material.
|
![]() | Shine |
Gets or sets the shine factor of the material.
|
![]() | SpecularColor | |
![]() | Transparency |
Gets or sets the transparency of the material (0.0 = opaque to 1.0 = transparent)
|
![]() | TransparentColor | |
![]() | UseCount |
Number of objects and layers that use this material.
|
![]() | UserData |
List of custom information that is attached to this class.
(Inherited from CommonObject.) |
![]() | UserDictionary |
Dictionary of custom information attached to this class. The dictionary is actually user
data provided as an easy to use sharable set of information.
(Inherited from CommonObject.) |
![]() | UserStringCount |

Name | Description | |
---|---|---|
![]() | ClearId |
Resets the HasId property of the model component to false, if possible.
(Inherited from ModelComponent.) |
![]() | ClearIndex |
Resets the HasIndex property of the model component to false, if possible.
(Inherited from ModelComponent.) |
![]() | ClearName |
Resets the HasName property of the model component to false, if possible.
(Inherited from ModelComponent.) |
![]() | CommitChanges | |
![]() | ConstructConstObject |
Assigns a parent object and a subobject index to this.
(Inherited from CommonObject.) |
![]() | CopyFrom | |
![]() | DataCRC |
Increments the Cyclic Redundancy Check value by this instance.
(Inherited from ModelComponent.) |
![]() | Default |
Set material to default settings.
|
![]() | Dispose |
Actively reclaims unmanaged resources that this instance uses.
(Inherited from CommonObject.) |
![]() | Dispose(Boolean) |
For derived class implementers.
(Inherited from CommonObject.)This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method. You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true. Also, you must call the base virtual method within your overriding 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.) |
![]() | Equals | (Inherited from Object.) |
![]() | Finalize |
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Inherited from CommonObject.) |
![]() | GetBitmapTexture | |
![]() | GetBumpTexture |
Gets the bump texture of this material.
|
![]() | GetEnvironmentTexture | |
![]() | GetHashCode | (Inherited from Object.) |
![]() | GetObjectData |
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.) |
![]() | GetTextures |
Get array of textures that this material uses
|
![]() | GetTransparencyTexture | |
![]() | GetType | (Inherited from Object.) |
![]() | GetUserString |
Gets a user string.
|
![]() | GetUserStrings |
Gets an independent copy of the collection of (user text key, user text value) pairs attached to this object.
|
![]() | IsValidWithLog |
Determines if an object is valid. Also provides a report on errors if this
object happens not to be valid.
(Inherited from CommonObject.) |
![]() | LockId |
Locks the component Id property.
(Inherited from ModelComponent.) |
![]() | LockIndex |
Locks the component Index property.
(Inherited from ModelComponent.) |
![]() | LockName |
Locks the component Name property.
(Inherited from ModelComponent.) |
![]() | MemberwiseClone | (Inherited from Object.) |
![]() | NonConstOperation |
For derived classes implementers.
(Inherited from CommonObject.)Defines the necessary implementation to free the instance from being const. |
![]() | OnSwitchToNonConst | (Overrides CommonObjectOnSwitchToNonConst.) |
![]() | SetBitmapTexture(String) | |
![]() | SetBitmapTexture(Texture) | |
![]() | SetBumpTexture(String) | |
![]() | SetBumpTexture(Texture) | |
![]() | SetEnvironmentTexture(String) | |
![]() | SetEnvironmentTexture(Texture) | |
![]() | SetTransparencyTexture(String) | |
![]() | SetTransparencyTexture(Texture) | |
![]() | SetUserString |
Attach a user string (key,value combination) to this geometry.
|
![]() | ToString | (Inherited from Object.) |
![]() | ToString |
Returns the name of the model component type, and then its name and index.
(Inherited from ModelComponent.) |

Rhino for Mac
Supported in: 5.4Rhino for Windows
Supported in: 6.8