IGH_InstanceDescription
Base interface for all objects that participate in the Grasshopper GUI.
Namespace: Grasshopper.Kernel
Assembly: Grasshopper (in Grasshopper.dll)
Syntax
public interface IGH_InstanceDescription : GH_ISerializableThe IGH_InstanceDescription type exposes the following members.
Properties
Name
Description
Public Property
Category
Gets or sets the Category in which this object belongs. If HasCategory() returns false, this field has no meaning.
Public Property
Description
Gets or sets the description of the object. This field typically remains fixed during the lifetime of an object.
Public Property
HasCategory
Gets whether or not the Category field has been set.
Public Property
HasSubCategory
Gets whether or not the SubCategory field has been set.
Public Property
InstanceDescription
Gets a description of the current state of the object. This field is usually the same as the Description() field, but it might be variable when overridden.
Public Property
InstanceGuid
Gets the ID of this runtime instance.
Public Property
Keywords
Gets a list of additional keywords that describe the object. Typically this list is empty but you can override this property to aid in object searches.
Public Property
Name
Gets or sets the name of the object. This field typically remains fixed during the lifetime of an object.
Public Property
NickName
Gets or sets the nickname of the object. This field can be changed by the user.
Public Property
SubCategory
Gets or sets the SubCategory in which this object belongs. If HasSubCategory() returns false, this field has no meaning.
Methods
Name
Description
Public Method
NewInstanceGuid.
Generate a new random instance GUID
Public Method
NewInstanceGuid(Guid)
Set the instance ID to be a specific GUID. This is very dangerous, only use this function if you’re 6”4’ and called David.
Public Method
Read
This method is called whenever the instance is required to deserialize itself.
(Inherited from GH_ISerializable.)
Public Method
Write
This method is called whenever the instance is required to serialize itself.
(Inherited from GH_ISerializable.)