Karamba3D API Reference
Component_
Methods
| AddedToDocument |
Overrides the AddedToDocument method and delegates the call to all parameters.
(Inherited from GH_Component) |
| 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.
(Inherited from GH_Component) |
| AppendAdditionalComponentMenuItems |
(Overrides GH_Component.AppendAdditionalComponentMenuItems(ToolStripDropDown)) |
| AppendAdditionalMenuItems |
Add evaluation units to context menu.
(Inherited from GH_SwitcherComponent) |
| 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.
(Inherited from GH_Component) |
| BakeGeometry(RhinoDoc, ListGuid) |
(Inherited from GH_Component) |
| BakeGeometry(RhinoDoc, ObjectAttributes, ListGuid) |
(Inherited from GH_Component) |
| BeforeSolveInstance |
(Overrides GH_Component.BeforeSolveInstance) |
| ClearData |
Clear the data inside this component and all output parameters.
(Inherited from GH_Component) |
| ClearRuntimeMessages |
Clears all runtime messages in me and my parameters
(Inherited from GH_Component) |
| ClearUnit |
Clear active evaluation unit.
If the component cannot exist without an active evaluation unit, this
method does nothing.
(Inherited from GH_SwitcherComponent) |
| CollectData |
Calls CollectData on all input parameters and makes sure the
Component and all associated parameters are left in a valid state.
(Inherited from GH_Component) |
| ComputeData |
Compute all data and fill out all output parameters.
(Inherited from GH_Component) |
| CopyFrom |
Copy all fields (except the instance ID) from another instance description.
(Inherited from GH_InstanceDescription) |
| CreateAttributes |
Create switcher attributes.
(Inherited from GH_SwitcherComponent) |
| DependsOn |
Returns True is any one of my input parameters depends on the source.
(Inherited from GH_Component) |
| 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) |
| DocumentContextChanged |
Overrides the DocumentContextChanged method and delegates the call to all parameters.
(Inherited from GH_Component) |
| DrawViewportMeshes |
Draw preview meshes for this component and all associated parameters.
(Inherited from GH_Component) |
| DrawViewportWires(IGH_PreviewArgs) |
DrawViewportWires override.
Invoke's an extended DrawViewportWires method that contains the active
evaluation unit.
(Inherited from GH_SwitcherComponent) |
| DrawViewportWires(IGH_PreviewArgs, EvaluationUnit) |
(Inherited from GH_SwitcherComponent) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExpireDownStreamObjects |
Expire all objects that depend on any of the output parameters.
(Inherited from GH_Component) |
| 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) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GenerateDefaultHTML |
Creates the default component help topic, including all parameter lists.
(Inherited from GH_Component) |
| GenerateParameterHelp |
Create an HTML string that lists names and descriptions for input and output parameters.
(Inherited from GH_Component) |
| GenerateParameterHelp(IGH_Param) |
Generate HTML string for a single parameter.
(Inherited from GH_Component) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetUnit |
Get evaluation unit from name.
(Inherited from GH_SwitcherComponent) |
| 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
(Inherited from GH_Component) |
| IsolateObject |
Sever the connections of all input and output parameters.
(Inherited from GH_Component) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| 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.
(Inherited from GH_Component) |
| 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) |
| OnComponentLoaded |
OnComponentLoaded is called after Component has been loaded f.eg: when
component got deserialized.
Override in derived class to initialize data wich is depending on widgets.
(Overrides GH_SwitcherComponentOnComponentLoaded) |
| OnComponentReset |
OnComponentReset is called when the components output(s) invalidate. This happens, when a
"nonoptional" input plug disconnects or the components values get cleared.
(Inherited from GH_SwitcherComponent) |
| 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.
(Inherited from GH_SwitcherComponent) |
| Read |
Read switcher component data.
(Inherited from GH_SwitcherComponent) |
| 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) |
| RegisterEvaluationUnits |
(Overrides GH_SwitcherComponentRegisterEvaluationUnits(EvaluationUnitManager)) |
| RegisterInputParams |
Declare all your input parameters here.
(Overrides GH_Component.RegisterInputParams(GH_InputParamManager)) |
| RegisterOutputParams |
Declare all your output parameters here.
(Overrides GH_Component.RegisterOutputParams(GH_OutputParamManager)) |
| RegisterRemoteIDs |
Registers all my input parameters with the UUID_LookUpTable
(Inherited from GH_Component) |
| RemovedFromDocument |
Overrides the RemovedFromDocument method and delegates the call to all parameters.
(Inherited from GH_Component) |
| 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.
(Inherited from GH_Component) |
| 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) |
| Setup |
Base method for initializing menus and other attribute depending data.
Override in derived class to initialize menus.
(Inherited from GH_SwitcherComponent) |
| 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(IGH_DataAccess) |
This function will be called (successively) from within the
ComputeData method of this component.
(Inherited from GH_SwitcherComponent) |
| SolveInstance(IGH_DataAccess, EvaluationUnit) |
Override this method to solve instance of component with given active unit.
(Overrides GH_SwitcherComponentSolveInstance(IGH_DataAccess, EvaluationUnit)) |
| SwitchUnit(EvaluationUnit, Boolean, Boolean) |
Switch to supplied unit.
(Inherited from GH_SwitcherComponent) |
| SwitchUnit(String, Boolean, Boolean) |
Switch to unit with given name.
If no unit with given name exists, nothing happens (old state remains).
(Inherited from GH_SwitcherComponent) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| 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 switcher.
(Inherited from GH_SwitcherComponent) |
| 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) |
Extension Methods
| ContainerType |
test if object is (a container like) a list or an array.
(Defined by MiniUtil) |