IGH_InstanceDescription

References

public interface IGH_InstanceDescription : GH_ISerializable

Base interface for all objects that participate in the Grasshopper GUI.

Properties

Description

string Description { get; set; }

Gets or sets the description of the object. This field typically remains fixed during the lifetime of an object.

HasCategory

bool HasCategory { get; }

Gets whether or not the Category field has been set.

HasSubCategory

bool HasSubCategory { get; }

Gets whether or not the SubCategory field has been set.

InstanceDescription

string InstanceDescription { get; }

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.

InstanceGuid

Guid InstanceGuid { get; }

Gets the ID of this runtime instance.

Keywords

IEnumerable<string> Keywords { get; }

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.

Name

string Name { get; set; }

Gets or sets the name of the object. This field typically remains fixed during the lifetime of an object.

NickName

string NickName { get; set; }

Gets or sets the nickname of the object. This field can be changed by the user.

SubCategory

string SubCategory { get; set; }

Gets or sets the SubCategory in which this object belongs. If HasSubCategory() returns false, this field has no meaning.

Methods

NewInstanceGuid

void NewInstanceGuid()

Generate a new random instance GUID

NewInstanceGuid

void NewInstanceGuid(Guid UUID)

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.

Parameters:

UUID (Guid)

Read

bool Read(GH_IReader reader)

This method is called whenever the instance is required to deserialize itself.

inherited fromGH_ISerializable

Parameters:

reader (GH_IReader)

Reader object to deserialize from.

Returns: True on success, false on failure.

Write

bool Write(GH_IWriter writer)

This method is called whenever the instance is required to serialize itself.

inherited fromGH_ISerializable

Parameters:

writer (GH_IWriter)

Writer object to serialize with.

Returns: True on success, false on failure.