IGH_ActiveObject Interface

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

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 the exposure of this object in the Graphical User Interface.

The icon associated with this object.

The greyscale icon of this object.

Gets the current display mode of the object.

Gets whether or not this object is capable of emitting data.

Gets or sets the locked flag of this object. Locked objects are ignored during solutions.

Gets or sets a value that enables Nick name changes through the menu. The default is TRUE.

Gets whether this object is Obsolete.

Gets the solution phase in which this object is currently stuck.

Gets the most recent measured processor time.

Gets the worst-case level of all messages. I.e. if only warnings have been recorded, the level will be ::warning. If even a single error exists, the level will be ::error.

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

Add a new message to this object. Valid message type flags are Warning and Error. If the Message string is empty or zero-length no message is added.

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

This function is called whenever the object needs to clear all solution data. This usually amounts to wiping volatile caches and messages. This function will not affect any other objects, but it will set the Phase flag to Blank

Clear all message lists.

This function is called whenever the object is required to collect all data. Either from Persistent records, from source params or whatever. This step is only performed if the phase flag is Blank or Failed. Upon completion, the phase flag will be set to Collected

This function is called whenever the object is required to generate new data. This step is only performed by some objects and only when the Phase flag is Collected. Upon completion, the Phase will be Computed. If this object throws exceptions, it is the responsibility of the caller to set the Phase flag to Failed.

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

Solve the inheritance relationship between this object and a potential parental object.

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.

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.

If this object depends on Rhino Objects, you must register the UUIDs of those objects. Failure to do so will result in faulty event handling.

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

Gets the list of cached runtime messages that were recorded during solver-time processes.

Test whether this object is compliant with a given Rhino version.

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.