GH_Component Methods |
The GH_Component type exposes the following members.
Name | Description | |
---|---|---|
![]() | AddedToDocument |
Overrides the AddedToDocument method and delegates the call to all parameters.
(Overrides GH_DocumentObjectAddedToDocument(GH_Document).) |
![]() | AddRuntimeMessage |
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 GH_ActiveObject.) |
![]() | AfterSolveInstance |
Override this method if you want to be called
after the last call to SolveInstance.
|
![]() | AppendAdditionalComponentMenuItems |
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.
|
![]() | AppendAdditionalMenuItems |
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
(Overrides GH_ActiveObjectAppendAdditionalMenuItems(ToolStripDropDown).) |
![]() | AppendMenuItems |
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.
(Inherited from GH_ActiveObject.) |
![]() | AssignInitCodeToInputParameter |
Utility function for parsing and assigning init codes. This only works for standard parameter types.
|
![]() | BakeGeometry(RhinoDoc, ListGuid) | |
![]() | BakeGeometry(RhinoDoc, ObjectAttributes, ListGuid) | |
![]() | BeforeSolveInstance |
Override this method if you want to be called
before the first call to SolveInstance.
|
![]() | ClearData |
Clear the data inside this component and all output parameters.
(Overrides GH_ActiveObjectClearData.) |
![]() | ClearRuntimeMessages |
Clears all runtime messages in me and my parameters
(Overrides GH_ActiveObjectClearRuntimeMessages.) |
![]() | CollectData |
Calls CollectData on all input parameters and makes sure the
Component and all associated parameters are left in a valid state.
(Overrides GH_ActiveObjectCollectData.) |
![]() | ComputeData |
Compute all data and fill out all output parameters.
(Overrides GH_ActiveObjectComputeData.) |
![]() | CopyFrom |
Copy all fields (except the instance ID) from another instance description.
(Inherited from GH_InstanceDescription.) |
![]() | CreateAttributes |
Create new attributes.
(Overrides GH_DocumentObjectCreateAttributes.) |
![]() | DependsOn |
Returns True is any one of my input parameters depends on the source.
(Overrides GH_ActiveObjectDependsOn(IGH_ActiveObject).) |
![]() | DestroyIconCache |
Call this method to erase the existing icon cache.
You must call this if you want to change the display icon of an object.
(Inherited from GH_DocumentObject.) |
![]() ![]() | DocumentAngleTolerance |
Gets the Angle tolerance (in radians) for the currently active Rhino document.
|
![]() | DocumentContextChanged |
Overrides the DocumentContextChanged method and delegates the call to all parameters.
(Overrides GH_DocumentObjectDocumentContextChanged(GH_Document, GH_DocumentContext).) |
![]() ![]() | DocumentTolerance |
Gets the Absolute tolerance for the currently active Rhino document.
|
![]() | DrawViewportMeshes |
Draw preview meshes for this component and all associated parameters.
|
![]() | DrawViewportWires |
Draw preview wires for this component and all associated parameters.
|
![]() | ExpireDownStreamObjects |
Expire all objects that depend on any of the output parameters.
(Overrides GH_ActiveObjectExpireDownStreamObjects.) |
![]() | ExpirePreview |
Call this function when you suspect that the preview has expired for this object.
This will cause the display cache to be eradicated.
(Inherited from GH_DocumentObject.) |
![]() | ExpireSolution |
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.
(Inherited from GH_ActiveObject.) |
![]() | GenerateDefaultHTML |
Creates the default component help topic, including all parameter lists.
|
![]() | GenerateParameterHelp |
Create an HTML string that lists names and descriptions for input and output parameters.
|
![]() | GenerateParameterHelp(IGH_Param) |
Generate HTML string for a single parameter.
|
![]() | GetValue(String, Boolean) |
Get a boolean value from the component value table.
(Inherited from GH_DocumentObject.) |
![]() | GetValue(String, Double) |
Get a double value from the component value table.
(Inherited from GH_DocumentObject.) |
![]() | GetValue(String, Color) |
Get a color value from the component value table.
(Inherited from GH_DocumentObject.) |
![]() | GetValue(String, Int32) |
Get an integer value from the component value table.
(Inherited from GH_DocumentObject.) |
![]() | GetValue(String, String) |
Get a string value from the component value table.
(Inherited from GH_DocumentObject.) |
![]() | HtmlHelp_Source |
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
(Overrides GH_DocumentObjectHtmlHelp_Source.) |
![]() | IsolateObject |
Sever the connections of all input and output parameters.
(Overrides GH_DocumentObjectIsolateObject.) |
![]() | Menu_AppendBakeItem |
Append the default Bake menu item.
(Inherited from GH_ActiveObject.) |
![]() | Menu_AppendEnableItem |
Append the default Enable/Disable menu item.
(Inherited from GH_ActiveObject.) |
![]() | Menu_AppendObjectHelp |
Appends the default object Help menu item.
(Inherited from GH_DocumentObject.) |
![]() | Menu_AppendObjectName |
Appends the old-fashioned object name menu item. If you also want the
Display mode toggle then use Menu_AppendObjectNameEx()
(Inherited from GH_DocumentObject.) |
![]() | Menu_AppendObjectNameEx |
Appends the default object name + display mode menu item.
(Inherited from GH_DocumentObject.) |
![]() | Menu_AppendPreviewItem |
Append the default Show/Hide preview menu item.
(Inherited from GH_ActiveObject.) |
![]() | Menu_AppendPublish |
Appends the default item for publishing to RCP.
This menu will only appear if the current class implement IRcpAwareObject
(Inherited from GH_DocumentObject.) |
![]() | Menu_AppendRuntimeMessages |
Append the default warnings and errors menu items.
(Inherited from GH_ActiveObject.) |
![]() | MovedBetweenDocuments |
Overrides the MovedBetweenDocuments method and delegates the call to all parameters.
(Overrides GH_DocumentObjectMovedBetweenDocuments(GH_Document, GH_Document).) |
![]() | NewInstanceGuid |
Generate a new random instance GUID
(Inherited from GH_InstanceDescription.) |
![]() | NewInstanceGuid(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.
(Inherited from GH_InstanceDescription.) |
![]() | OnAttributesChanged |
Raises the AttributesChanged event on the toplevel object.
(Inherited from GH_DocumentObject.) |
![]() | OnDisplayExpired |
Raises the DisplayExpired event on the toplevel object.
(Inherited from GH_DocumentObject.) |
![]() | OnObjectChanged(GH_ObjectChangedEventArgs) | (Inherited from GH_DocumentObject.) |
![]() | OnObjectChanged(GH_ObjectEventType) | (Inherited from GH_DocumentObject.) |
![]() | OnObjectChanged(String) | (Inherited from GH_DocumentObject.) |
![]() | OnObjectChanged(GH_ObjectEventType, Object) | (Inherited from GH_DocumentObject.) |
![]() | OnObjectChanged(String, Object) | (Inherited from GH_DocumentObject.) |
![]() | OnPingDocument |
Raise the PingDocument Event on the toplevel object and try to find
the document which owns this object.
(Inherited from GH_DocumentObject.) |
![]() | OnPreviewExpired |
Raises the PreviewExpired event on the toplevel object.
(Inherited from GH_DocumentObject.) |
![]() | OnSolutionExpired |
Raises the SolutionExpired event on the toplevel object.
You probably want to call ExpireSolution() instead of this method directly.
(Inherited from GH_DocumentObject.) |
![]() | PostConstructor |
The PostConstructor is called from within each constructor.
DO NOT OVERRIDE THIS unless you know what you are doing.
|
![]() | Read |
Read all required data for deserialization from an IO archive.
(Overrides GH_ActiveObjectRead(GH_IReader).) |
![]() | ReadFull |
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.
(Inherited from GH_InstanceDescription.) |
![]() | RecordUndoEvent(GH_UndoRecord) |
Record an entire undo record.
(Inherited from GH_DocumentObject.) |
![]() | RecordUndoEvent(String) |
Record a generic object change undo event.
(Inherited from GH_DocumentObject.) |
![]() | RecordUndoEvent(String, IGH_UndoAction) |
Record a specific object change undo event.
(Inherited from GH_DocumentObject.) |
![]() | RegisterInputParams |
Declare all your input parameters here.
|
![]() | RegisterOutputParams |
Declare all your output parameters here.
|
![]() | RegisterRemoteIDs |
Registers all my input parameters with the UUID_LookUpTable
(Overrides GH_ActiveObjectRegisterRemoteIDs(GH_GuidTable).) |
![]() | RemovedFromDocument |
Overrides the RemovedFromDocument method and delegates the call to all parameters.
(Overrides GH_DocumentObjectRemovedFromDocument(GH_Document).) |
![]() | RuntimeMessages |
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.
(Overrides GH_ActiveObjectRuntimeMessages(GH_RuntimeMessageLevel).) |
![]() | SDKCompliancy |
Test whether this object is compliant with a given Rhino version.
(Inherited from GH_ActiveObject.) |
![]() | SetIconOverride |
Set a new custom icon override for this object.
(Inherited from GH_DocumentObject.) |
![]() | SetValue(String, Boolean) |
Set a named value. This value will be serialized with the component.
(Inherited from GH_DocumentObject.) |
![]() | SetValue(String, Double) |
Set a named value. This value will be serialized with the component.
(Inherited from GH_DocumentObject.) |
![]() | SetValue(String, Color) |
Set a named value. This value will be serialized with the component.
(Inherited from GH_DocumentObject.) |
![]() | SetValue(String, Int32) |
Set a named value. This value will be serialized with the component.
(Inherited from GH_DocumentObject.) |
![]() | SetValue(String, String) |
Set a named value. This value will be serialized with the component.
(Inherited from GH_DocumentObject.) |
![]() | SolveInstance |
This function will be called (successively) from within the
ComputeData method of this component.
|
![]() | TriggerAutoSave |
Triggers the AutoSave function on the owner document with the object_changed flag.
(Inherited from GH_DocumentObject.) |
![]() | TriggerAutoSave(GH_AutoSaveTrigger) |
Triggers the AutoSave function on the owner document with a custom flag.
(Inherited from GH_DocumentObject.) |
![]() | TriggerAutoSave(Guid) |
Triggers the AutoSave function on the owner document with the object_changed flag.
(Inherited from GH_DocumentObject.) |
![]() | TriggerAutoSave(GH_AutoSaveTrigger, Guid) |
Triggers the AutoSave function on the owner document with a custom flag.
(Inherited from GH_DocumentObject.) |
![]() | ValuesChanged |
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.
(Inherited from GH_DocumentObject.) |
![]() | Write |
Write all required data for deserialization to an IO archive.
(Overrides GH_ActiveObjectWrite(GH_IWriter).) |
![]() | WriteFull |
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.
(Inherited from GH_InstanceDescription.) |