Properties
BoundingBox
#Category
Gets or sets the Category in which this object belongs. If HasCategory() returns false, this field has no meaning.
Description
Gets or sets the description of the object. This field typically remains fixed during the lifetime of an object.
GraphicsPath
#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.
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.
Name
Gets or sets the name of the object. This field typically remains fixed during the lifetime of an object.
NickName
Gets or sets the nickname of the object. This field can be changed by the user.
SubCategory
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
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
This method is called whenever the instance is required to deserialize itself.
Parameters:
| reader (GH_IReader) | Reader object to deserialize from. |
Returns: True on success, false on failure.
Write
This method is called whenever the instance is required to serialize itself.
Parameters:
| writer (GH_IWriter) | Writer object to serialize with. |
Returns: True on success, false on failure.