GH_ParamT Methods |
The GH_ParamT generic type exposes the following members.
Name | Description | |
---|---|---|
AddedToDocument |
This method will be called when an object is added to a document.
Override this method if you want to handle such events.
(Inherited from GH_DocumentObject.) | |
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.) | |
AddSource(IGH_Param) |
Append a new Source parameter to the end of the Sources list.
Sources provide this parameter with data at runtime.
| |
AddSource(IGH_Param, Int32) |
Insert a new Source parameter into the Sources list.
Sources provide this parameter with data at runtime.
| |
AddVolatileData(GH_Path, Int32, T) | ||
AddVolatileData(GH_Path, Int32, Object) |
Inserts an item of volatile data into the data structure.
| |
AddVolatileDataList(GH_Path, ListT) | ||
AddVolatileDataList(GH_Path, IEnumerable) | ||
AddVolatileDataTree(GH_StructureT) | ||
AddVolatileDataTree(IGH_Structure) | ||
AppendAdditionalMenuItems |
Override this function if you want to add specific items to the object context menu
Default items already included in the menu toolstrip are:
1. Name
2. Preview
3. Warnings
4. Errors
(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.) | |
Cast_Object |
Attempts to convert the Object reference into an instance of T.
This method will perform a direct cast if possible or it will call Casting functions on T or Data if they exist.
Data will not be duplicated unless a type conversion is required.
| |
ClearData | (Overrides GH_ActiveObjectClearData.) | |
ClearProxySources |
Remove all proxy sources without attempting to relink them.
| |
ClearRuntimeMessages |
Destroy all warning and error lists
(Inherited from GH_ActiveObject.) | |
CollectData | (Overrides GH_ActiveObjectCollectData.) | |
CollectVolatileData_Custom |
If a parameter has no sources, the CollectVolatileData_Custom() method is called.
The basic implementation does nothing, but you can override this method to provide
special data instantiation logic.
| |
CollectVolatileData_FromSources |
This method collects volatile data from all the source parameters.
| |
ComputeData | (Overrides GH_ActiveObjectComputeData.) | |
ConversionCallback |
This method is called whenever a successful conversion takes
place from some source data into local target data.
Override it if you wish to keep tabs on conversions.
| |
CopyFrom |
Copy all fields (except the instance ID) from another instance description.
(Inherited from GH_InstanceDescription.) | |
CreateAttributes | (Overrides GH_DocumentObjectCreateAttributes.) | |
CreateProxySources |
Convert all proper source parameters into proxy sources.
| |
DependsOn | (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.) | |
DocumentContextChanged |
This method will be called when the document that owns this object moves into a different context.
(Inherited from GH_DocumentObject.) | |
ExpireDownStreamObjects | (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.) | |
ExpireSolutionTopLevel |
Invoke the Expiresolution(bool) method on the toplevel object.
| |
Format |
Returns "Null" if the data is a null reference, otherwise calls ToString() on the Data instance.
| |
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_DocumentObject.) | |
InstantiateT |
Attempts to instantiate a new instance of T.
| |
IsolateObject | (Overrides GH_DocumentObjectIsolateObject.) | |
Menu_AppendBakeItem |
Append the default Bake menu item.
(Inherited from GH_ActiveObject.) | |
Menu_AppendDisconnectWires | ||
Menu_AppendEnableItem |
Append the default Enable/Disable menu item.
(Inherited from GH_ActiveObject.) | |
Menu_AppendFlattenParameter | ||
Menu_AppendGraftParameter | ||
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_AppendPrincipalParameter | ||
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_AppendReverseParameter | ||
Menu_AppendRuntimeMessages |
Append the default warnings and errors menu items.
(Inherited from GH_ActiveObject.) | |
Menu_AppendSimplifyParameter | ||
Menu_AppendWireDisplay | ||
MovedBetweenDocuments |
This method will be called when an object is moved from one document to another.
Override this method if you want to handle such events.
(Inherited from GH_DocumentObject.) | |
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.) | |
OnVolatileDataCollected |
Once volatile data has been collected this method will be calles. The basic
implementation does nothing, but you can add code here to post-process or
analyze the volatile data.
| |
PreferredCast |
Implement this function if you're certain that you'll be confronted with very common casts.
For example, GH_Point has a preferred cast from Rhino.Geometry.Point3d and GH_Number
has a preferred cast from System.Double.
| |
Preview_ComputeClippingBox |
This function can be used to iterate over all items in the Volatile data tree
and collect the union clipping box of all non-null items that implement
Preview.IGH_PreviewData. This function requires a lot of TypeOf and DirectCasting,
so if you're worried about performance you should consider doing this yourself.
| |
Preview_DrawMeshes |
This function can be used to iterate over all items in the Volatile data tree
and call DrawViewportWires on each item that implements Preview.IGH_PreviewData.
This function requires a lot of TypeOf and DirectCasting,
so if you're worried about performance you should consider doing this yourself.
| |
Preview_DrawWires |
This function can be used to iterate over all items in the Volatile data tree
and call DrawViewportWires on each item that implements Preview.IGH_PreviewData.
This function requires a lot of TypeOf and DirectCasting,
so if you're worried about performance you should consider doing this yourself.
| |
Read | (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.) | |
RegisterRemoteIDs |
Override this function if you want object changes in the Rhino document to trigger a new solution.
(Inherited from GH_ActiveObject.) | |
RegisterRemoteIDsUtil |
Utility function which treats all data in the Volatile cache as IGH_GeometricGoo
and registers all referenced objects. Call this function from within RegisterRemoteIDs()
if you are absolutely sure that all the items in volatiledata implement IGH_GeometricGoo.
| |
RelinkProxySources |
Attempt to replace all proxy sources with real sources.
Proxy sources are used during file IO, when actual sources might not be available yet.
Once an IO operation has been completed there should be no more proxy sources.
| |
RemoveAllSources |
Remove all sources from this parameter.
| |
RemovedFromDocument |
This method will be called when an object is removed from a document.
Override this method if you want to handle such events.
(Inherited from GH_DocumentObject.) | |
RemoveEffects |
Remove all post-process effects. Note to implementors,
you must call the base method if you override this function.
| |
RemoveSource(Guid) |
Remove the specified source from this parameter.
| |
RemoveSource(IGH_Param) |
Remove the specified source from this parameter.
| |
Render_AppendGeometry | Obsolete.
This function has been emptied because it is Obsolete.
| |
ReplaceSource(Guid, IGH_Param) |
Replace an existing source with a new one. If the old_source
does not exist in this parameter, nothing happens.
| |
ReplaceSource(IGH_Param, IGH_Param) |
Replace an existing source with a new one. If the old_source
does not exist in this parameter, nothing happens.
| |
RuntimeMessages |
Gets the list of cached runtime messages that were recorded during solver-time processes.
(Inherited from GH_ActiveObject.) | |
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.) | |
SetPrincipal |
Set the principal parameter state.
| |
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.) | |
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.) | |
VolatileDataDescription |
This method is called to populate the Tooltip data description field.
| |
Write | (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.) |