Material Class |
[Missing <summary> documentation for "T:Rhino.DocObjects.Material"]
Namespace: Rhino.DocObjects
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 |
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 the current instance.
(Inherited from ModelComponent.) |
![]() | 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)
|
![]() | 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.) |
![]() | 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.
(Overrides ModelComponentIsDeleted.) |
![]() | 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.) |
![]() | IsPhysicallyBased | |
![]() | IsReference |
Rhino allows multiple files to be viewed simultaneously. Materials in the
document are "normal" or "reference". Reference materials are not saved.
(Overrides ModelComponentIsReference.) |
![]() | 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.) |
![]() ![]() | MaxShine | |
![]() | ModelSerialNumber |
A value identifying the model that manages this component.
(Inherited from ModelComponent.) |
![]() | Name | (Overrides ModelComponentName.) |
![]() | NameIsLocked |
Returns a value indicating whether the component Name is already locked.
(Inherited from ModelComponent.) |
![]() | PhysicallyBased | |
![]() | PreviewColor |
Very simple preview color function for GUIs.
|
![]() | RDKMaterialID |
Gets the RDK material ID.
|
![]() | ReferenceModelSerialNumber |
When a component is in a model for reference, this value identifies the reference model.
(Inherited from ModelComponent.) |
![]() | 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 shareable 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.) |
![]() | ClearMaterialChannels |
Removes all material channels
|
![]() | ClearName |
Resets the HasName property of the model component to false, if possible.
(Inherited from ModelComponent.) |
![]() | CommitChanges | |
![]() | 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.) |
![]() | 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 | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | GetBitmapTexture | |
![]() | GetBumpTexture |
Gets the bump texture of this material.
|
![]() | GetEnvironmentTexture | |
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetObjectData |
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.) |
![]() | GetTexture |
Get the texture that corresponds with the specified texture type for this material.
|
![]() | GetTextures |
Get array of textures that this material uses
|
![]() | GetTransparencyTexture | |
![]() | GetType | Gets the Type of the current instance. (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.) |
![]() | MaterialChannelIdFromIndex |
Finds id of the material channel at given index.
|
![]() | 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.
|
![]() | SetBitmapTexture(String) | |
![]() | SetBitmapTexture(Texture) | |
![]() | SetBumpTexture(String) | |
![]() | SetBumpTexture(Texture) | |
![]() | SetEnvironmentTexture(String) | |
![]() | SetEnvironmentTexture(Texture) | |
![]() | SetTexture |
Set the texture that corresponds with the specified texture type for this material.
|
![]() | SetTransparencyTexture(String) | |
![]() | SetTransparencyTexture(Texture) | |
![]() | SetUserString |
Attach a user string (key,value combination) to this geometry.
|
![]() | ToJSON |
Create a JSON string representation of this object
(Inherited from CommonObject.) |
![]() | ToPhysicallyBased | |
![]() | ToString |
Returns the name of the model component type, and then its name and index.
(Inherited from ModelComponent.) |