GH_Component Class

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.

Gets the clipping box for all preview geometry drawn by this component and all associated parameters.

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. The default is to expose everywhere.

Gets whether or not the Category field has been set.

Gets whether or not the SubCategory field has been set.

Override this method if you want the help topic content to be more than the Component description.

Gets or sets the hidden flag for this component. Does not affect Hidden flags on parameters associated with this component.

Override this function to supply a custom icon (24x24 pixels). The result of this property is cached, so don't worry if icon retrieval is not very fast.

The icon associated with this object.

The greyscale icon of this object.

By default the NickName menu item supports the Icon Mode override toggle. If your UI is not capable of displaying icons, then override this property and return False.

Gets the current display mode of the object.

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.

Gets the ID of this runtime instance.

Components are never Data providers. Only the output parameters can be considered to be providers.

If a single parameter is PreviewCapable, so is the component. Override this property if you need special Preview flags.

Gets whether the MasterParameterIndex property identifies a valid parameter.

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 Locked state for this Component. This also sets locked states for all input and output parameters.

Gets or sets a custom message to be displayed underneath the component. This message is not serialized and should be assigned on every solution anew.

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

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. Default implementation returns true if the class name contains the string "OBSOLETE" or if this class has been decorated with the ObsoleteAttribute. You are free to override this if you want, but I suggest adding the ObsoleteAttribute instead.

Gets the parameter manager object for this component.

Gets or sets the solution phase this object is currenly in.

Gets or sets the principal parameter index override. Negative indices or indices larger than or equal to the input parameter count will be ignored and regular principal parameter detection will kick in.

Gets the total processor time (profiler) spend by this component and all input parameters.

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.

Returns the worst case runtime warning level of me and all my parameters

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

Overrides the AddedToDocument method and delegates the call to all parameters.

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.

Override this method if you want to be called after the last call to SolveInstance.

Override this function if you want to insert some custom menu items in your derived Component class. Items will be added between List Matching items and parameter menus.

Adds typical component type items to the context menu: 1. Data comparison types 2. Custom (overridden) items 3. Nested input parameter context menu items 4. Nested output parameter context menu items

This function is called when a context menu is about to be displayed. Override it to set custom items. GH_ActiveObject will already populate the menu with default items, if you merely wish to insert object-specific menu item, consider overriding AppendAdditionalMenuItems instead.

Utility function for parsing and assigning init codes. This only works for standard parameter types.

Override this method if you want to be called before the first call to SolveInstance.

Clear the data inside this component and all output parameters.

Clears all runtime messages in me and my parameters

Calls CollectData on all input parameters and makes sure the Component and all associated parameters are left in a valid state.

Compute all data and fill out all output parameters.

Copy all fields (except the instance ID) from another instance description.

Create new attributes.

Returns True is any one of my input parameters depends on the source.

Call this method to erase the existing icon cache. You must call this if you want to change the display icon of an object.

Gets the Angle tolerance (in radians) for the currently active Rhino document.

Overrides the DocumentContextChanged method and delegates the call to all parameters.

Gets the Absolute tolerance for the currently active Rhino document.

Draw preview meshes for this component and all associated parameters.

Draw preview wires for this component and all associated parameters.

Expire all objects that depend on any of the output parameters.

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

Informs the document that owns this object that the solution has expired. The current object will be set to BLANK as a result. This method is recursive, it will also expire any and all objects which depend on this object. If you want a less destructive expiration, consider using ClearData(). If this object is already Blank, you should consider not expiring it.

Creates the default component help topic, including all parameter lists.

Create an HTML string that lists names and descriptions for input and output parameters.

Generate HTML string for a single parameter.

Get a boolean value from the component value table.

Get a double value from the component value table.

Get a color value from the component value table.

Get an integer value from the component value table.

Get a string value from the component value table.

Return a String which contains HTML formatted source for the help topic. If you want to pass a URL that points to a remote page, then prefix the URL with a GOTO: tag, like so: GOTO:http://www.YourWebAddressHere.com

Sever the connections of all input and output parameters.

Append the default Bake menu item.

Append the default Enable/Disable menu item.

Appends the default object Help menu item.

Appends the old-fashioned object name menu item. If you also want the Display mode toggle then use Menu_AppendObjectNameEx()

Appends the default object name + display mode menu item.

Append the default Show/Hide preview menu item.

Appends the default item for publishing to RCP. This menu will only appear if the current class implement IRcpAwareObject

Append the default warnings and errors menu items.

Overrides the MovedBetweenDocuments method and delegates the call to all parameters.

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 your first name is David.

Raises the AttributesChanged event on the toplevel object.

Raises the DisplayExpired event on the toplevel 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. You probably want to call ExpireSolution() instead of this method directly.

The PostConstructor is called from within each constructor. DO NOT OVERRIDE THIS unless you know what you are doing.

Read all required data for deserialization from an IO archive.

GH_InstanceDescription does not by default serialize all fields. Use this function to read all fields from the archive. This method is compatible with the default Write()/Read() operations.

Record an entire undo record.

Record a generic object change undo event.

Record a specific object change undo event.

Declare all your input parameters here.

Declare all your output parameters here.

Registers all my input parameters with the UUID_LookUpTable

Overrides the RemovedFromDocument method and delegates the call to all parameters.

Gets the list of cached runtime messages that were recorded during solver-time processes. For components, the set of runtime messages also includes input and output parameters.

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

Set a new custom icon override for this object.

Set a named value. This value will be serialized with the component.

Set a named value. This value will be serialized with the component.

Set a named value. This value will be serialized with the component.

Set a named value. This value will be serialized with the component.

Set a named value. This value will be serialized with the component.

This function will be called (successively) from within the ComputeData method of this component.

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.

Override this method if you want to respond to changes to the value table. The base implementation is empty, so you don't have to call it.

Write all required data for deserialization to an IO archive.

GH_InstanceDescription does not by default serialize all fields. Use this function to write all fields to the archive. This method is compatible with the default Write()/Read() operations.

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 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.