GH_Material

GH_Goo<1>References
public class GH_Material : GH_Goo<DisplayMaterial>
Represents a implementation of the Rhino material

Constructors

GH_Material

#
public GH_Material()

GH_Material

#
public GH_Material(Color diffuse)
Create a new material based on a colour. The colour is used to control Diffuse, Emission and Transparency. Ambient, Specular and Shine are always default.
Parameters:
diffuse (Color)The diffuse colour of the material.

GH_Material

#
public GH_Material(DisplayMaterial material)
Create a new Material.
Parameters:
material (DisplayMaterial)Material to use (an internal copy will be made).

GH_Material

#
public GH_Material(GH_Material other)
Copy another GH_Material instance.
Parameters:
other (GH_Material)Material to mimic.

GH_Material

#
public GH_Material(Guid rdkId)
Create a new Material from an RDK material ID.
Parameters:
rdkId (Guid)ID of RDK material.

GH_Material

#
public GH_Material(RenderMaterial material)
Create a new Material.
Parameters:
material (RenderMaterial)Material to use (an internal copy will be made).

GH_Material

#
public GH_Material(string rdkXml)
Create a new Material from an RDK xml string.
Parameters:
rdkXml (string)Xml of RDK material.

Fields

m_value

protected T m_value
inherited fromGH_Goo<T>

Properties

IsValid

#
public override bool IsValid { get; }
Overrides: GH_Goo<T>.IsValid

IsValidWhyNot

#
public override string IsValidWhyNot { get; }
Gets a string describing the state of "invalidness". If the instance is valid, then this property should return Nothing or String.Empty.
Overrides: GH_Goo<T>.IsValidWhyNot

RdkMaterialId

#
public Guid RdkMaterialId { get; set; }
Gets or sets the RDK material ID this material is associated with.

RdkMaterialRmtl

#
public string RdkMaterialRmtl { get; set; }
Gets or sets the RDK material RMTL file path.

RdkMaterialXml

#
public string RdkMaterialXml { get; set; }
Gets or sets the RDK material Xml string.

Type

#
public GH_Material.MaterialType Type { get; }
Gets the implied type based on what fields have been assigned.

TypeDescription

#
public override string TypeDescription { get; }
Overrides: GH_Goo<T>.TypeDescription

TypeName

#
public override string TypeName { get; }
Overrides: GH_Goo<T>.TypeName

Value

public virtual T Value { get; set; }
Gets or sets the internal data.
inherited fromGH_Goo<T>

Methods

CastFrom

#
public override bool CastFrom(object source)
Parameters:
source (object)
Overrides: GH_Goo<T>.CastFrom

CastTo<T>

#
public override bool CastTo<T>(ref T target)
Parameters:
target (ref T)
Overrides: GH_Goo<T>.CastTo

CreateRhinoMaterial

#
public static Material CreateRhinoMaterial(Color colour)
Creates a standard Rhino material from a colour.
Parameters:
colour (Color)Base colour for material.

CreateStandardMaterial

#
public static DisplayMaterial CreateStandardMaterial(Color colour)
Creates a standard Grasshopper material from a colour.
Parameters:
colour (Color)Base colour for material.

Duplicate

#
public override IGH_Goo Duplicate()
Duplicate this material.
Returns: An exact duplicate of this material.
Overrides: GH_Goo<T>.Duplicate

DuplicateMaterial

#
public GH_Material DuplicateMaterial()
Duplicate this material.
Returns: An exact duplicate of this material.

EmitProxy

#
public override IGH_GooProxy EmitProxy()
Overrides: GH_Goo<T>.EmitProxy

MaterialBestGuess

#
public RenderMaterial MaterialBestGuess()
Gets the best guess RenderMaterial for this shader.
Returns: Material which best describes this shader.

Read

#
public override bool Read(GH_IReader reader)
Parameters:
reader (GH_IReader)
Overrides: GH_Goo<T>.Read

ScriptVariable

#
public override object ScriptVariable()
Overrides: GH_Goo<T>.ScriptVariable

ToString

#
public override string ToString()
Overrides: GH_Goo<T>.ToString

Write

#
public override bool Write(GH_IWriter writer)
Parameters:
writer (GH_IWriter)
Overrides: GH_Goo<T>.Write