IGH_DocumentObject Interface

Gets or sets the attributes that are associated with this object. Only set custom attributes if you know what you are doing.

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

Returns a consistent ID for this object type. Every object must supply a unique and unchanging ID that is used to identify objects of the same type.

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

Gets the exposure of this object in the Graphical User Interface.

Gets whether or not the Category field has been set.

Gets whether or not the SubCategory field has been set.

The icon associated with this object.

The greyscale icon of this object.

Gets the current display mode of the object.

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.

Gets the ID of this runtime instance.

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.

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

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

Gets whether this object is Obsolete.

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

This method will be called when an object is added to a document.

This function is called when a context menu is about to be displayed. Override it to set custom items.

Create new default attributes for this object. You should only call this function when the Attributes() field is null.

This method will be called when the document that owns this object moves into a different context.

Call this function when you suspect that the preview has expired for this object. This will cause the display cache to be eradicated.

Call this function whenever you do something which expires the current solution. This will make sure all caches are erased, all downstream objects are expired and that the event is raised. The default implementation merely places a call to OnSolutionExpired(), override this function in derived classes to make sure you clear local data caches and expire downstream objects.

Destroy all connections to other objects.

This method will be called when an object is moved from one document to another.

Generate a new random instance 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.

Raises the AttributesChanged event on the toplevel object.

Raises the DisplayExpired event on the toplevel object.

Raises the ObjectChanged event on the current (!not the top level!) object.

Raises the ObjectChanged event on the current (!not the top level!) object.

Raises the ObjectChanged event on the current (!not the top level!) object.

Raises the ObjectChanged event on the current (!not the top level!) object.

Raises the ObjectChanged event on the current (!not the top level!) object.

Raise the PingDocument Event on the toplevel object and try to find the document which owns this object.

Raises the PreviewExpired event on the toplevel object.

Raises the SolutionExpired event on the toplevel object.

Record an entire undo record.

Record a generic object change undo event.

Record a specific object change undo event.

This method will be called when an object is removed from a document.

Triggers the AutoSave function on the owner document with the object_changed flag.

Triggers the AutoSave function on the owner document with a custom flag.

Triggers the AutoSave function on the owner document with the object_changed flag.

Triggers the AutoSave function on the owner document with a custom flag.

Raised whenever the number or kind of attributes changes. This event is handled by GH_Documents who subsequently wipe their attribute caches.

Raised whenever the display (on the Canvas) of a certain object becomes invalid.

Raised whenever some property of the object changes that would affect remote instances.

Raised whenever an object needs to know which GH_Document it belongs to.

Raised whenever the display (in the Rhino viewports) of a certain object becomes invalid.

Raised whenever the solution of a certain object becomes invalid.