Click or drag to resize

Material Class

[Missing <summary> documentation for "T:Rhino.DocObjects.Material"]

Inheritance Hierarchy

Namespace:  Rhino.DocObjects
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
[SerializableAttribute]
public class Material : CommonObject

The Material type exposes the following members.

Constructors
  NameDescription
Public methodMaterial
Initializes a new instance of the Material class
Public methodMaterial(Material)
Initializes a new instance of the Material class
Protected methodMaterial(SerializationInfo, StreamingContext)
Initializes a new instance of the Material class
Top
Properties
  NameDescription
Public propertyAlphaTransparency
Public propertyAmbientColor
Public propertyComponentStatus
Gets or sets the component status of the model component.
(Inherited from ModelComponent.)
Public propertyComponentType
Returns RenderMaterial.
(Overrides ModelComponentComponentType.)
Public propertyStatic memberDefaultMaterial
Public propertyDeletedName
Gets the name of a component that is deleted.
(Inherited from ModelComponent.)
Public propertyDiffuseColor
Public propertyDisableLighting
Public propertyDisposed
Indicates if this object has been disposed or the document it originally belonged to has been disposed.
(Inherited from CommonObject.)
Public propertyEmissionColor
Public propertyFresnelIndexOfRefraction
Gets or sets the Fresnel index of refraction of the material, default is 1.56
Public propertyFresnelReflections
Gets or sets if fresnel reflections are used.
Public propertyHasId
Returns a value indicating whether the component has an ID.
(Inherited from ModelComponent.)
Public propertyHasIndex
Returns a value indicating whether the component has an Index.
(Inherited from ModelComponent.)
Public propertyHasName
Returns a value indicating whether the component has a Name.
(Inherited from ModelComponent.)
Public propertyHasUserData
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.)
Public propertyId
Gets or sets the ID of this material.


In Rhino for Windows 6.9, this member is inherited from ModelComponentId.
Public propertyIdIsLocked
Returns a value indicating whether the component ID is already locked.
(Inherited from ModelComponent.)
Public propertyIndex
Gets or sets the model component index attribute.
(Inherited from ModelComponent.)
Public propertyIndexIsLocked
Returns a value indicating whether the component Index is already locked.
(Inherited from ModelComponent.)
Public propertyIndexOfRefraction
Gets or sets the index of refraction of the material, generally >= 1.0 (speed of light in vacuum)/(speed of light in material)
Public propertyIsComponentStatusLocked
The component status itself can be locked. This returns an indication.
(Inherited from ModelComponent.)
Public propertyIsDefaultMaterial
By default Rhino layers and objects are assigned the default rendering material.
Public propertyIsDeleted
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.
Public propertyIsDocumentControlled
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.)
Public propertyIsReference
Rhino allows multiple files to be viewed simultaneously. Materials in the document are "normal" or "reference". Reference materials are not saved.
Public propertyIsSystemComponent
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 propertyIsValid
Tests an object to see if it is valid.
(Inherited from CommonObject.)
Public propertyMaterialIndex
Public propertyStatic memberMaxShine
Public propertyName
Public propertyNameIsLocked
Returns a value indicating whether the component Name is already locked.
(Inherited from ModelComponent.)
Public propertyPreviewColor
Very simple preview color function for GUIs.
Public propertyReflectionColor
Public propertyReflectionGlossiness
Gets or sets the reflection glossiness.
Public propertyReflectivity
Gets or sets how reflective a material is, 0f is no reflection 1f is 100% reflective.
Public propertyRefractionGlossiness
Gets or sets the refraction glossiness.
Public propertyRenderMaterial
Get the RenderMaterial related to this Material. Will create a new RenderMaterial if none exists. This can happen for older documents.
Public propertyRenderMaterialInstanceId
Public propertyRenderPlugInId
The Id of the RenderPlugIn that is associated with this material.
Public propertyShine
Gets or sets the shine factor of the material.
Public propertySpecularColor
Public propertyTransparency
Gets or sets the transparency of the material (0.0 = opaque to 1.0 = transparent)
Public propertyTransparentColor
Public propertyUseCount
Number of objects and layers that use this material.
Public propertyUserData
List of custom information that is attached to this class.
(Inherited from CommonObject.)
Public propertyUserDictionary
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.)
Public propertyUserStringCount
Top
Methods
  NameDescription
Public methodClearId
Resets the HasId property of the model component to false, if possible.
(Inherited from ModelComponent.)
Public methodClearIndex
Resets the HasIndex property of the model component to false, if possible.
(Inherited from ModelComponent.)
Public methodClearName
Resets the HasName property of the model component to false, if possible.
(Inherited from ModelComponent.)
Public methodCommitChanges
Protected methodConstructConstObject
Assigns a parent object and a subobject index to this.
(Inherited from CommonObject.)
Public methodCopyFrom
Public methodDataCRC
Increments the Cyclic Redundancy Check value by this instance.
(Inherited from ModelComponent.)
Public methodDefault
Set material to default settings.
Public methodDispose
Actively reclaims unmanaged resources that this instance uses.
(Inherited from CommonObject.)
Protected methodDispose(Boolean)
For derived class implementers.

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.

(Inherited from CommonObject.)
Public methodEnsurePrivateCopy
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 methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Inherited from CommonObject.)
Public methodGetBitmapTexture
Public methodGetBumpTexture
Gets the bump texture of this material.
Public methodGetEnvironmentTexture
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.)
Public methodGetTextures
Get array of textures that this material uses
Public methodGetTransparencyTexture
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUserString
Gets a user string.
Public methodGetUserStrings
Gets an independent copy of the collection of (user text key, user text value) pairs attached to this object.
Public methodIsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
(Inherited from CommonObject.)
Public methodLockId
Locks the component Id property.
(Inherited from ModelComponent.)
Public methodLockIndex
Locks the component Index property.
(Inherited from ModelComponent.)
Public methodLockName
Locks the component Name property.
(Inherited from ModelComponent.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodNonConstOperation
For derived classes implementers.

Defines the necessary implementation to free the instance from being const.

(Inherited from CommonObject.)
Protected methodOnSwitchToNonConst (Overrides CommonObjectOnSwitchToNonConst.)
Public methodSetBitmapTexture(String)
Public methodSetBitmapTexture(Texture)
Public methodSetBumpTexture(String)
Public methodSetBumpTexture(Texture)
Public methodSetEnvironmentTexture(String)
Public methodSetEnvironmentTexture(Texture)
Public methodSetTransparencyTexture(String)
Public methodSetTransparencyTexture(Texture)
Public methodSetUserString
Attach a user string (key,value combination) to this geometry.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodToString
Returns the name of the model component type, and then its name and index.
(Inherited from ModelComponent.)
Top
Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.9
See Also