Param_Centermark Methods |
The Param_Centermark 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.
(Inherited from GH_ParamT.) | |
AddSource(IGH_Param, Int32) |
Insert a new Source parameter into the Sources list.
Sources provide this parameter with data at runtime.
(Inherited from GH_ParamT.) | |
AddVolatileData(GH_Path, Int32, T) | (Inherited from GH_ParamT.) | |
AddVolatileData(GH_Path, Int32, Object) |
Inserts an item of volatile data into the data structure.
(Inherited from GH_ParamT.) | |
AddVolatileDataList(GH_Path, ListT) | (Inherited from GH_ParamT.) | |
AddVolatileDataList(GH_Path, IEnumerable) | (Inherited from GH_ParamT.) | |
AddVolatileDataTree(GH_StructureT) | (Inherited from GH_ParamT.) | |
AddVolatileDataTree(IGH_Structure) | (Inherited from GH_ParamT.) | |
AppendAdditionalMenuItems | (Inherited from GH_PersistentParamT.) | |
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.) | |
BakeGeometry(RhinoDoc, ListGuid) | ||
BakeGeometry(RhinoDoc, ObjectAttributes, ListGuid) | ||
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.
(Inherited from GH_ParamT.) | |
ClearData | (Inherited from GH_PersistentGeometryParamT.) | |
ClearProxySources |
Remove all proxy sources without attempting to relink them.
(Inherited from GH_ParamT.) | |
ClearRuntimeMessages |
Destroy all warning and error lists
(Inherited from GH_ActiveObject.) | |
CollectData | (Inherited from GH_ParamT.) | |
CollectVolatileData_Custom | (Inherited from GH_PersistentParamT.) | |
CollectVolatileData_FromSources |
This method collects volatile data from all the source parameters.
(Inherited from GH_ParamT.) | |
ComputeData | (Inherited from GH_ParamT.) | |
ConversionCallback | (Inherited from GH_PersistentGeometryParamT.) | |
CopyFrom |
Copy all fields (except the instance ID) from another instance description.
(Inherited from GH_InstanceDescription.) | |
CreateAttributes | (Inherited from GH_ParamT.) | |
CreateProxySources |
Convert all proper source parameters into proxy sources.
(Inherited from GH_ParamT.) | |
DependsOn | (Inherited from GH_ParamT.) | |
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.) | |
DrawViewportMeshes | ||
DrawViewportWires | ||
EraseGeometryCaches | (Inherited from GH_PersistentGeometryParamT.) | |
ExpireDownStreamObjects | (Inherited from GH_ParamT.) | |
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 | (Inherited from GH_PersistentGeometryParamT.) | |
ExpireSolutionTopLevel |
Invoke the Expiresolution(bool) method on the toplevel object.
(Inherited from GH_ParamT.) | |
Format |
Returns "Null" if the data is a null reference, otherwise calls ToString() on the Data instance.
(Inherited from GH_ParamT.) | |
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 | (Overrides GH_DocumentObjectHtmlHelp_Source.) | |
InstantiateT | (Overrides GH_ParamTInstantiateT.) | |
IsolateObject | (Inherited from GH_ParamT.) | |
Menu_AppendBakeItem |
Append the default Bake menu item.
(Inherited from GH_ActiveObject.) | |
Menu_AppendDestroyPersistent | (Inherited from GH_PersistentParamT.) | |
Menu_AppendDisconnectWires | (Inherited from GH_ParamT.) | |
Menu_AppendEnableItem |
Append the default Enable/Disable menu item.
(Inherited from GH_ActiveObject.) | |
Menu_AppendExtractParameter | (Inherited from GH_PersistentParamT.) | |
Menu_AppendFlattenParameter | (Inherited from GH_ParamT.) | |
Menu_AppendGraftParameter | (Inherited from GH_ParamT.) | |
Menu_AppendInternaliseData | (Inherited from GH_PersistentParamT.) | |
Menu_AppendManageCollection | (Overrides GH_PersistentParamTMenu_AppendManageCollection(ToolStripDropDown).) | |
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 | (Inherited from GH_ParamT.) | |
Menu_AppendPromptMore | (Inherited from GH_PersistentParamT.) | |
Menu_AppendPromptOne | (Inherited from GH_PersistentParamT.) | |
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 | (Inherited from GH_ParamT.) | |
Menu_AppendRuntimeMessages |
Append the default warnings and errors menu items.
(Inherited from GH_ActiveObject.) | |
Menu_AppendSimplifyParameter | (Inherited from GH_ParamT.) | |
Menu_AppendWireDisplay | (Inherited from GH_ParamT.) | |
Menu_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.) | |
Menu_CustomMultiValueItem | (Inherited from GH_PersistentParamT.) | |
Menu_CustomSingleValueItem | (Inherited from GH_PersistentParamT.) | |
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 |
This override removes all instances that fail to load their geometry.
(Inherited from GH_PersistentGeometryParamT.) | |
PreferredCast | (Overrides GH_ParamTPreferredCast(Object).) | |
PrepareForPrompt | (Inherited from GH_PersistentParamT.) | |
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.
(Inherited from GH_ParamT.) | |
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.
(Inherited from GH_ParamT.) | |
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.
(Inherited from GH_ParamT.) | |
Prompt_ManageCollection | (Inherited from GH_PersistentParamT.) | |
Prompt_Plural | (Overrides GH_PersistentParamTPrompt_Plural(ListT).) | |
Prompt_Singular | (Overrides GH_PersistentParamTPrompt_Singular(T).) | |
Read | (Overrides GH_PersistentParamTRead(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.) | |
RecordPersistentDataEvent |
Add an undo record that stores changes to persistent data.
(Inherited from GH_PersistentParamT.) | |
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.) | |
RecoverFromPrompt | (Inherited from GH_PersistentParamT.) | |
RegisterRemoteIDs | (Inherited from GH_PersistentGeometryParamT.) | |
RegisterRemoteIdsDespiteSources |
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.) | |
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.
(Inherited from GH_ParamT.) | |
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.
(Inherited from GH_ParamT.) | |
RemoveAllSources |
Remove all sources from this parameter.
(Inherited from GH_ParamT.) | |
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.
(Inherited from GH_ParamT.) | |
RemoveSource(Guid) |
Remove the specified source from this parameter.
(Inherited from GH_ParamT.) | |
RemoveSource(IGH_Param) |
Remove the specified source from this parameter.
(Inherited from GH_ParamT.) | |
Render_AppendGeometry | Obsolete.
This function has been emptied because it is Obsolete.
(Inherited from GH_ParamT.) | |
ReplaceSource(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.) | |
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.
(Inherited from GH_ParamT.) | |
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.) | |
SetPersistentData(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.) | |
SetPersistentData(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.) | |
SetPersistentData(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.) | |
SetPersistentData(Object) |
Add a collection of values to the persistent data.
(Inherited from GH_PersistentParamT.) | |
SetPrincipal |
Set the principal parameter state.
(Inherited from GH_ParamT.) | |
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.
(Inherited from GH_ParamT.) | |
Write | (Inherited from GH_PersistentParamT.) | |
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.) |