IGH_ObjectProxy

References

public interface IGH_ObjectProxy

Provides proxy data for all Grasshopper components and parameters.

Properties

Desc

IGH_InstanceDescription Desc { get; }

Gets the Instance Description associated with this proxy.

Exposure

GH_Exposure Exposure { get; set; }

Gets or sets the Exposure of the target object. Only set the exposure if you know what you are doing.

Guid

Guid Guid { get; }

Gets the Guid of the target object. In the case of Compiled Objects, the Guid represents the ComponentID, in the case of User Objects, the Guid is a hash of the file path.

Icon

Bitmap Icon { get; }

Gets the icon for this object.

Kind

GH_ObjectType Kind { get; }

Gets the kind of the Proxy target object.

LibraryGuid

Guid LibraryGuid { get; }

Gets the ID of the library (GHA file) that defines this object.

Location

string Location { get; }

Gets the location of the target object. If the proxy represents a Compiled Object, the location refers to the file path of the assembly, in the case of User Objects, the location refers to the object file.

Obsolete

bool Obsolete { get; }

Gets whether this proxy represents an obsolete object.

SDKCompliant

bool SDKCompliant { get; }

Gets whether this object is compliant with the current Rhino version.

Type

Type Type { get; }

Gets the Type for the target object. If the proxy references a User Object, the Type member will be null.

Methods

CreateInstance

IGH_DocumentObject CreateInstance()

Create a new instance from the target object.

Returns: An IGH_DocumentObject instance on success or null on failure.

DuplicateProxy

IGH_ObjectProxy DuplicateProxy()

Create a duplicate of this proxy.