Click or drag to resize

Param_InstanceReference Methods

The Param_InstanceReference type exposes the following members.

Methods
  NameDescription
Public methodAddedToDocument
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.)
Public methodAddRuntimeMessage
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.)
Public methodAddSource(IGH_Param)
Append a new Source parameter to the end of the Sources list. Sources provide this parameter with data at runtime.
(Inherited from GH_ParamT.)
Public methodAddSource(IGH_Param, Int32)
Insert a new Source parameter into the Sources list. Sources provide this parameter with data at runtime.
(Inherited from GH_ParamT.)
Public methodAddVolatileData(GH_Path, Int32, T) (Inherited from GH_ParamT.)
Public methodAddVolatileData(GH_Path, Int32, Object)
Inserts an item of volatile data into the data structure.
(Inherited from GH_ParamT.)
Public methodAddVolatileDataList(GH_Path, ListT) (Inherited from GH_ParamT.)
Public methodAddVolatileDataList(GH_Path, IEnumerable) (Inherited from GH_ParamT.)
Public methodAddVolatileDataTree(GH_StructureT) (Inherited from GH_ParamT.)
Public methodAddVolatileDataTree(IGH_Structure) (Inherited from GH_ParamT.)
Public methodAppendAdditionalMenuItems (Inherited from GH_PersistentParamT.)
Public methodAppendMenuItems
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.)
Public methodBakeGeometry(RhinoDoc, ListGuid)
Public methodBakeGeometry(RhinoDoc, ObjectAttributes, ListGuid)
Protected methodCast_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.
(Inherited from GH_ParamT.)
Public methodClearData (Inherited from GH_PersistentGeometryParamT.)
Public methodClearProxySources
Remove all proxy sources without attempting to relink them.
(Inherited from GH_ParamT.)
Public methodClearRuntimeMessages
Destroy all warning and error lists
(Inherited from GH_ActiveObject.)
Public methodCollectData (Inherited from GH_ParamT.)
Protected methodCollectVolatileData_Custom (Inherited from GH_PersistentParamT.)
Protected methodCollectVolatileData_FromSources
This method collects volatile data from all the source parameters.
(Inherited from GH_ParamT.)
Public methodComputeData (Inherited from GH_ParamT.)
Protected methodConversionCallback (Inherited from GH_PersistentGeometryParamT.)
Public methodCopyFrom
Copy all fields (except the instance ID) from another instance description.
(Inherited from GH_InstanceDescription.)
Public methodCreateAttributes (Inherited from GH_ParamT.)
Public methodCreateProxySources
Convert all proper source parameters into proxy sources.
(Inherited from GH_ParamT.)
Public methodDependsOn (Inherited from GH_ParamT.)
Protected methodDestroyIconCache
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.)
Public methodDocumentContextChanged
This method will be called when the document that owns this object moves into a different context.
(Inherited from GH_DocumentObject.)
Public methodDrawViewportMeshes
Public methodDrawViewportWires
Protected methodEraseGeometryCaches (Inherited from GH_PersistentGeometryParamT.)
Protected methodExpireDownStreamObjects (Inherited from GH_ParamT.)
Public methodExpirePreview
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.)
Public methodExpireSolution (Inherited from GH_PersistentGeometryParamT.)
Public methodExpireSolutionTopLevel
Invoke the Expiresolution(bool) method on the toplevel object.
(Inherited from GH_ParamT.)
Protected methodFormat
Returns "Null" if the data is a null reference, otherwise calls ToString() on the Data instance.
(Inherited from GH_ParamT.)
Protected methodGetValue(String, Boolean)
Get a boolean value from the component value table.
(Inherited from GH_DocumentObject.)
Protected methodGetValue(String, Double)
Get a double value from the component value table.
(Inherited from GH_DocumentObject.)
Protected methodGetValue(String, Color)
Get a color value from the component value table.
(Inherited from GH_DocumentObject.)
Protected methodGetValue(String, Int32)
Get an integer value from the component value table.
(Inherited from GH_DocumentObject.)
Protected methodGetValue(String, String)
Get a string value from the component value table.
(Inherited from GH_DocumentObject.)
Protected methodHtmlHelp_Source (Overrides GH_DocumentObjectHtmlHelp_Source.)
Protected methodInstantiateT (Overrides GH_ParamTInstantiateT.)
Public methodIsolateObject (Inherited from GH_ParamT.)
Protected methodMenu_AppendBakeItem
Append the default Bake menu item.
(Inherited from GH_ActiveObject.)
Protected methodMenu_AppendDestroyPersistent (Inherited from GH_PersistentParamT.)
Protected methodMenu_AppendDisconnectWires (Inherited from GH_ParamT.)
Protected methodMenu_AppendEnableItem
Append the default Enable/Disable menu item.
(Inherited from GH_ActiveObject.)
Protected methodMenu_AppendExtractParameter (Inherited from GH_PersistentParamT.)
Protected methodMenu_AppendFlattenParameter (Inherited from GH_ParamT.)
Protected methodMenu_AppendGraftParameter (Inherited from GH_ParamT.)
Protected methodMenu_AppendInternaliseData (Inherited from GH_PersistentParamT.)
Protected methodMenu_AppendManageCollection (Overrides GH_PersistentParamTMenu_AppendManageCollection(ToolStripDropDown).)
Protected methodMenu_AppendObjectHelp
Appends the default object Help menu item.
(Inherited from GH_DocumentObject.)
Protected methodMenu_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.)
Protected methodMenu_AppendObjectNameEx
Appends the default object name + display mode menu item.
(Inherited from GH_DocumentObject.)
Protected methodMenu_AppendPreviewItem
Append the default Show/Hide preview menu item.
(Inherited from GH_ActiveObject.)
Protected methodMenu_AppendPrincipalParameter (Inherited from GH_ParamT.)
Protected methodMenu_AppendPromptMore (Inherited from GH_PersistentParamT.)
Protected methodMenu_AppendPromptOne (Inherited from GH_PersistentParamT.)
Protected methodMenu_AppendPublish
Appends the default item for publishing to RCP. This menu will only appear if the current class implement IRcpAwareObject
(Inherited from GH_DocumentObject.)
Protected methodMenu_AppendReverseParameter (Inherited from GH_ParamT.)
Protected methodMenu_AppendRuntimeMessages
Append the default warnings and errors menu items.
(Inherited from GH_ActiveObject.)
Protected methodMenu_AppendSimplifyParameter (Inherited from GH_ParamT.)
Protected methodMenu_AppendWireDisplay (Inherited from GH_ParamT.)
Protected methodMenu_CreateMultilineTextEditItem
This function returns a ToolstripMenuItem that embeds a multi-line textbox for editing persistent data. Only call this method if you know that your parameter type supports proxies.
(Inherited from GH_PersistentParamT.)
Protected methodMenu_CustomMultiValueItem (Inherited from GH_PersistentParamT.)
Protected methodMenu_CustomSingleValueItem (Inherited from GH_PersistentParamT.)
Public methodMovedBetweenDocuments
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.)
Public methodNewInstanceGuid
Generate a new random instance GUID
(Inherited from GH_InstanceDescription.)
Public methodNewInstanceGuid(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.)
Public methodOnAttributesChanged
Raises the AttributesChanged event on the toplevel object.
(Inherited from GH_DocumentObject.)
Public methodOnDisplayExpired
Raises the DisplayExpired event on the toplevel object.
(Inherited from GH_DocumentObject.)
Public methodOnObjectChanged(GH_ObjectChangedEventArgs) (Inherited from GH_DocumentObject.)
Public methodOnObjectChanged(GH_ObjectEventType) (Inherited from GH_DocumentObject.)
Public methodOnObjectChanged(String) (Inherited from GH_DocumentObject.)
Public methodOnObjectChanged(GH_ObjectEventType, Object) (Inherited from GH_DocumentObject.)
Public methodOnObjectChanged(String, Object) (Inherited from GH_DocumentObject.)
Public methodOnPingDocument
Raise the PingDocument Event on the toplevel object and try to find the document which owns this object.
(Inherited from GH_DocumentObject.)
Public methodOnPreviewExpired
Raises the PreviewExpired event on the toplevel object.
(Inherited from GH_DocumentObject.)
Public methodOnSolutionExpired
Raises the SolutionExpired event on the toplevel object. You probably want to call ExpireSolution() instead of this method directly.
(Inherited from GH_DocumentObject.)
Protected methodOnVolatileDataCollected
This override removes all instances that fail to load their geometry.
(Inherited from GH_PersistentGeometryParamT.)
Protected methodPreferredCast (Overrides GH_ParamTPreferredCast(Object).)
Protected methodPrepareForPrompt (Inherited from GH_PersistentParamT.)
Protected methodPreview_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.
(Inherited from GH_ParamT.)
Protected methodPreview_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.
(Inherited from GH_ParamT.)
Protected methodPreview_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.
(Inherited from GH_ParamT.)
Protected methodPrompt_ManageCollection (Inherited from GH_PersistentParamT.)
Protected methodPrompt_Plural (Overrides GH_PersistentParamTPrompt_Plural(ListT).)
Protected methodPrompt_Singular (Overrides GH_PersistentParamTPrompt_Singular(T).)
Public methodRead (Overrides GH_PersistentParamTRead(GH_IReader).)
Public methodReadFull
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.)
Protected methodRecordPersistentDataEvent
Add an undo record that stores changes to persistent data.
(Inherited from GH_PersistentParamT.)
Public methodRecordUndoEvent(GH_UndoRecord)
Record an entire undo record.
(Inherited from GH_DocumentObject.)
Public methodRecordUndoEvent(String)
Record a generic object change undo event.
(Inherited from GH_DocumentObject.)
Public methodRecordUndoEvent(String, IGH_UndoAction)
Record a specific object change undo event.
(Inherited from GH_DocumentObject.)
Protected methodRecoverFromPrompt (Inherited from GH_PersistentParamT.)
Public methodRegisterRemoteIDs (Inherited from GH_PersistentGeometryParamT.)
Protected methodRegisterRemoteIdsDespiteSources
Call this method if you wish to register remote ids in the volatile data despite having one or more sources. You should only need to do this if you converted non-referenced data into volatile referenced data.
(Inherited from GH_PersistentGeometryParamT.)
Protected methodRegisterRemoteIDsUtil
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.
(Inherited from GH_ParamT.)
Public methodRelinkProxySources
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.
(Inherited from GH_ParamT.)
Public methodRemoveAllSources
Remove all sources from this parameter.
(Inherited from GH_ParamT.)
Public methodRemovedFromDocument
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.)
Public methodRemoveEffects
Remove all post-process effects. Note to implementors, you must call the base method if you override this function.
(Inherited from GH_ParamT.)
Public methodRemoveSource(Guid)
Remove the specified source from this parameter.
(Inherited from GH_ParamT.)
Public methodRemoveSource(IGH_Param)
Remove the specified source from this parameter.
(Inherited from GH_ParamT.)
Protected methodRender_AppendGeometry Obsolete.
This function has been emptied because it is Obsolete.
(Inherited from GH_ParamT.)
Public methodReplaceSource(Guid, IGH_Param)
Replace an existing source with a new one. If the old_source does not exist in this parameter, nothing happens.
(Inherited from GH_ParamT.)
Public methodReplaceSource(IGH_Param, IGH_Param)
Replace an existing source with a new one. If the old_source does not exist in this parameter, nothing happens.
(Inherited from GH_ParamT.)
Public methodRuntimeMessages
Gets the list of cached runtime messages that were recorded during solver-time processes.
(Inherited from GH_ActiveObject.)
Public methodSDKCompliancy
Test whether this object is compliant with a given Rhino version.
(Inherited from GH_ActiveObject.)
Public methodSetIconOverride
Set a new custom icon override for this object.
(Inherited from GH_DocumentObject.)
Public methodSetPersistentData(T)
Add a single item to the persistent data. This method will record an undo event, raise the OnObjectChanged event for PersistentData flags and place a call to ExpireSolution(False). If you want to add more than one piece of data, you should use the appropriate overload for this method.
(Inherited from GH_PersistentParamT.)
Public methodSetPersistentData(GH_StructureT)
Assign a tree of items to the persistent data. This method will erase any existing data, record an undo event, raise the OnObjectChanged event for PersistentData flags and place a call to ExpireSolution(False). If you want to add a tree of data, you should use the appropriate overload for this method.
(Inherited from GH_PersistentParamT.)
Public methodSetPersistentData(IEnumerableT)
Assign a list of items to the persistent data. This method will erase any existing data, record an undo event, raise the OnObjectChanged event for PersistentData flags and place a call to ExpireSolution(False). If you want to add a tree of data, you should use the appropriate overload for this method.
(Inherited from GH_PersistentParamT.)
Public methodSetPersistentData(Object)
Add a collection of values to the persistent data.
(Inherited from GH_PersistentParamT.)
Public methodSetPrincipal
Set the principal parameter state.
(Inherited from GH_ParamT.)
Protected methodSetValue(String, Boolean)
Set a named value. This value will be serialized with the component.
(Inherited from GH_DocumentObject.)
Protected methodSetValue(String, Double)
Set a named value. This value will be serialized with the component.
(Inherited from GH_DocumentObject.)
Protected methodSetValue(String, Color)
Set a named value. This value will be serialized with the component.
(Inherited from GH_DocumentObject.)
Protected methodSetValue(String, Int32)
Set a named value. This value will be serialized with the component.
(Inherited from GH_DocumentObject.)
Protected methodSetValue(String, String)
Set a named value. This value will be serialized with the component.
(Inherited from GH_DocumentObject.)
Public methodTriggerAutoSave
Triggers the AutoSave function on the owner document with the object_changed flag.
(Inherited from GH_DocumentObject.)
Public methodTriggerAutoSave(GH_AutoSaveTrigger)
Triggers the AutoSave function on the owner document with a custom flag.
(Inherited from GH_DocumentObject.)
Public methodTriggerAutoSave(Guid)
Triggers the AutoSave function on the owner document with the object_changed flag.
(Inherited from GH_DocumentObject.)
Public methodTriggerAutoSave(GH_AutoSaveTrigger, Guid)
Triggers the AutoSave function on the owner document with a custom flag.
(Inherited from GH_DocumentObject.)
Protected methodValuesChanged
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.)
Protected methodVolatileDataDescription
This method is called to populate the Tooltip data description field.
(Inherited from GH_ParamT.)
Public methodWrite (Inherited from GH_PersistentParamT.)
Public methodWriteFull
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.)
Top
See Also