Click or drag to resize

IGH_Component Methods

The IGH_Component type exposes the following members.

Methods
  NameDescription
Public methodAddRuntimeMessage
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.
(Inherited from IGH_ActiveObject.)
Public methodBakeGeometry(RhinoDoc, ListGuid)
Bake all the goemetry in this object in the given Rhino document.
(Inherited from IGH_BakeAwareObject.)
Public methodBakeGeometry(RhinoDoc, ObjectAttributes, ListGuid)
Bake all the goemetry in this object in the given Rhino document.
(Inherited from IGH_BakeAwareObject.)
Public methodClearData
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
(Inherited from IGH_ActiveObject.)
Public methodClearRuntimeMessages
Clear all message lists.
(Inherited from IGH_ActiveObject.)
Public methodCollectData
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
(Inherited from IGH_ActiveObject.)
Public methodComputeData
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.
(Inherited from IGH_ActiveObject.)
Public methodDependsOn
Solve the inheritance relationship between this object and a potential parental object.
(Inherited from IGH_ActiveObject.)
Public methodDrawViewportMeshes
Implement this function to draw all shaded meshes. If the viewport does not support shading, this function will not be called.
(Inherited from IGH_PreviewObject.)
Public methodDrawViewportWires
Implement this function to draw all wire and point geometry previews.
(Inherited from IGH_PreviewObject.)
Public methodRegisterRemoteIDs
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.
(Inherited from IGH_ActiveObject.)
Public methodRuntimeMessages
Gets the list of cached runtime messages that were recorded during solver-time processes.
(Inherited from IGH_ActiveObject.)
Public methodSDKCompliancy
Test whether this object is compliant with a given Rhino version.
(Inherited from IGH_ActiveObject.)
Top
See Also