Click or drag to resize

IGH_Component Properties

The IGH_Component type exposes the following members.

Properties
  NameDescription
Public propertyClippingBox
Gets the clipping box for this object. The clipping box is typically the union of the boundingboxes of all the geometry that is drawn by this object.
(Inherited from IGH_PreviewObject.)
Public propertyHidden
Gets or sets a value indicating whether or not this object is currently drawing preview flags.
(Inherited from IGH_PreviewObject.)
Public propertyInConstructor
Gets the constructor flag for this instance. If InConstructor = True, it means the component is still registering parameters and the layout is not yet complete.
Public propertyIsBakeCapable
Gets a value indicating whether or not the object can potentially Bake data in its current state.
(Inherited from IGH_BakeAwareObject.)
Public propertyIsDataProvider
Gets whether or not this object is capable of emitting data.
(Inherited from IGH_ActiveObject.)
Public propertyIsPreviewCapable
Gets a value indicating whether or not this object (in its current state) can draw geometric previews at all.
(Inherited from IGH_PreviewObject.)
Public propertyIsValidMasterParameterIndex
Gets whether the MasterParameterIndex property identifies a valid parameter.
Public propertyLocked
Gets or sets the locked flag of this object. Locked objects are ignored during solutions.
(Inherited from IGH_ActiveObject.)
Public propertyMasterParameterIndex
Gets or sets the master parameter index override. Negative indices or indices larger than or equal to the input parameter count will be ignored and regular master parameter detection will kick in.
Public propertyMessage
Gets or sets a custom message to be displayed underneath the component.
Public propertyMutableNickName
Gets or sets a value that enables Nick name changes through the menu. The default is TRUE.
(Inherited from IGH_ActiveObject.)
Public propertyParams
Gets the Params object that managed input and output parameters.
Public propertyPhase
Gets the solution phase in which this object is currently stuck.
(Inherited from IGH_ActiveObject.)
Public propertyProcessorTime
Gets the most recent measured processor time.
(Inherited from IGH_ActiveObject.)
Public propertyRunCount
Gets a value indicating how many times the SolveInstance method was called on this component during the last solution. This property will return -1 if no valid runcount is available.
Public propertyRuntimeMessageLevel
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.
(Inherited from IGH_ActiveObject.)
Top
See Also