Karamba3D API Reference
Param_
Grasshopper wrapper class for karamba cross sections.
Definition
Namespace: Karamba.GHopper.CrossSections
Assembly: karamba (in karamba.dll) Version: 1.0.0+eb23a7103f0eca0b6d808121e15fec6899194e15
Assembly: karamba (in karamba.dll) Version: 1.0.0+eb23a7103f0eca0b6d808121e15fec6899194e15
C#
public class Param_CrossSection : GH_PersistentParam<GH_CrossSection>VB
Public Class Param_CrossSection
Inherits GH_PersistentParam(Of GH_CrossSection)C++
public ref class Param_CrossSection : public GH_PersistentParam<GH_CrossSection^>F#
type Param_CrossSection =
class
inherit GH_PersistentParam<GH_CrossSection>
end- Inheritance
- Object GH_InstanceDescription GH_DocumentObject GH_ActiveObject GH_ParamGH_CrossSection GH_PersistentParamGH_CrossSection Param_CrossSection
Constructors
| Param_CrossSection | Initializes a new instance of the Param_CrossSection class. |
Properties
| Access |
Gets or sets the Access level for this parameter.
(Inherited from GH_ParamGH_CrossSection) |
| Attributes |
Gets or sets the attributes that are associated with this object.
Only set custom attributes if you know what you are doing.
(Inherited from GH_DocumentObject) |
| Category |
Gets or sets the Category in which this object belongs. If HasCategory() returns false, this field has no meaning.
(Inherited from GH_InstanceDescription) |
| ComponentGuid |
Returns a consistent ID for this object type. Every object must supply a unique and unchanging
ID that is used to identify objects of the same type.
(Overrides GH_DocumentObject.ComponentGuid) |
| DataMapping |
Gets or sets the data mapping of this Parameter.
(Inherited from GH_ParamGH_CrossSection) |
| DataType |
Gets the type of data stored in this parameter.
(Inherited from GH_PersistentParamGH_CrossSection) |
| Description |
Gets or sets the description of the object. This field typically remains fixed during the lifetime of an object.
(Inherited from GH_InstanceDescription) |
| Exposure |
Gets the exposure of this object in the Graphical User Interface.
The default is to expose everywhere.
(Overrides GH_DocumentObject.Exposure) |
| HasCategory |
Gets whether or not the Category field has been set.
(Inherited from GH_InstanceDescription) |
| HasProxySources |
Gets a value indicating whether or not this parameter maintains proxy 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_ParamGH_CrossSection) |
| HasSubCategory |
Gets whether or not the SubCategory field has been set.
(Inherited from GH_InstanceDescription) |
| Icon |
Override this function to supply a custom icon (24x24 pixels). The result of this property is cached,
so don't worry if icon retrieval is not very fast.
(Overrides GH_DocumentObject.Icon) |
| Icon_24x24 |
The icon associated with this object.
(Inherited from GH_DocumentObject) |
| Icon_24x24_Locked |
The greyscale icon of this object.
(Inherited from GH_DocumentObject) |
| IconCapableUI |
By default the NickName menu item supports the Icon Mode override toggle.
If your UI is not capable of displaying icons, then override this property
and return False.
(Inherited from GH_ActiveObject) |
| IconDisplayMode |
Gets the current display mode of the object.
(Inherited from GH_DocumentObject) |
| InstanceDescription |
Gets the description of this instance. The default description is about the amount and source of the local values.
(Inherited from GH_ParamGH_CrossSection) |
| InstanceGuid |
Gets the ID of this runtime instance.
(Inherited from GH_InstanceDescription) |
| IsDataProvider |
(Inherited from GH_ParamGH_CrossSection) |
| IsPrincipal |
Gets whether this parameter is a principal parameter.
Principal parameters are maintained by components and are not part of the IGH_Param interface.
(Inherited from GH_ParamGH_CrossSection) |
| Keywords |
Gets a list of additional keywords that describe the object. Typically this list is empty but you
can override this property to aid in object searches.
(Inherited from GH_InstanceDescription) |
| Kind |
Gets the parameter kind. The kind is evaluated lazily and cached.
(Inherited from GH_ParamGH_CrossSection) |
| Locked |
Gets or sets the enabled flag of this object. Disabled objects are ignored during solutions.
(Inherited from GH_ActiveObject) |
| MutableNickName |
Gets or sets a value that enables Nick name changes through the menu.
The default is TRUE.
(Inherited from GH_ActiveObject) |
| Name |
Gets or sets the name of the object. This field typically remains fixed during the lifetime of an object.
(Inherited from GH_InstanceDescription) |
| NickName |
Gets or sets the nickname of the object. This field can be changed by the user.
(Inherited from GH_InstanceDescription) |
| Obsolete |
Gets whether this object is obsolete. Default implementation returns true if
the class name contains the string "OBSOLETE" or if this class has been decorated with the
ObsoleteAttribute.
You are free to override this if you want, but I suggest adding the ObsoleteAttribute instead.
(Inherited from GH_DocumentObject) |
| Optional |
Gets or sets whether or not this parameter is considered optional by the owner component.
Empty, non-optional parameters prevent the component from being solved.
(Inherited from GH_ParamGH_CrossSection) |
| PersistentData |
Gets the persistent data stored in this parameter.
If you modify the persistent data, be sure to call the:
OnObjectChanged(GH_ObjectEventType.PersistentData)
event.
(Inherited from GH_PersistentParamGH_CrossSection) |
| PersistentDataCount |
Gets the number of persistent data items stored in this parameter.
(Inherited from GH_PersistentParamGH_CrossSection) |
| Phase |
Gets or sets the solution phase this object is currenly in.
(Inherited from GH_ActiveObject) |
| ProcessorTime |
(Inherited from GH_ParamGH_CrossSection) |
| ProxySourceCount |
Gets the number of proxy sources for this parameter.
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_ParamGH_CrossSection) |
| Recipients |
Gets a list of all the recipients of this parameter.
I.e. a recipient has this parameter as one of the sources.
The Recipient list is maintained by the parameter,
do not modify it yourself.
(Inherited from GH_ParamGH_CrossSection) |
| Reverse |
Gets or sets the data reverse modifier of this parameter.
(Inherited from GH_ParamGH_CrossSection) |
| RuntimeMessageLevel |
Returns the worst case flag for the current object
If the object contains at least 1 error, the result is Error. If the object contains at least 1 warning, the result is Warning. If the object contains at least 1 message, the result is Remark. If the object contains no errors, no warnings and no messages, the result is Blank. (Inherited from GH_ActiveObject) |
| Simplify |
Gets or sets the simplify modifier for this parameter.
(Inherited from GH_ParamGH_CrossSection) |
| SourceCount |
Gets the number of sources for this parameter.
(Inherited from GH_ParamGH_CrossSection) |
| Sources |
Gets a list of source parameters. Do not modify this list,
if you wish to add or remove sources, use dedicated functions
like AddSource() and RemoveSource() instead.
(Inherited from GH_ParamGH_CrossSection) |
| StateTags |
Gets all the StateTags that are associated with this parameter.
A state tag is a visual feedback icon that represents specific internal settings.
(Inherited from GH_ParamGH_CrossSection) |
| SubCategory |
Gets or sets the SubCategory in which this object belongs. If HasSubCategory() returns false, this field has no meaning.
(Inherited from GH_InstanceDescription) |
| Type |
Gets the Framework Type descriptor for the stored Data.
(Inherited from GH_ParamGH_CrossSection) |
| TypeName |
Calls TypeName() on the first instance of T it can find.
This is either an item in the volatile list, or a newly constructed instance.
(Inherited from GH_ParamGH_CrossSection) |
| VolatileData |
(Inherited from GH_ParamGH_CrossSection) |
| VolatileDataCount |
(Inherited from GH_ParamGH_CrossSection) |
| WireDisplay |
Gets or sets the wire display style for this parameter.
Wire display only affects the wires connected to the parameter input.
(Inherited from GH_ParamGH_CrossSection) |
Methods
| 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_ParamGH_CrossSection) |
| AddSource(IGH_Param, Int32) |
Insert a new Source parameter into the Sources list.
Sources provide this parameter with data at runtime.
(Inherited from GH_ParamGH_CrossSection) |
| AddVolatileData(GH_Path, Int32, UTP) |
(Inherited from GH_ParamGH_CrossSection) |
| AddVolatileData(GH_Path, Int32, Object) |
Inserts an item of volatile data into the data structure.
(Inherited from GH_ParamGH_CrossSection) |
| AddVolatileDataList(GH_Path, ListUTP) |
(Inherited from GH_ParamGH_CrossSection) |
| AddVolatileDataList(GH_Path, IEnumerable) |
(Inherited from GH_ParamGH_CrossSection) |
| AddVolatileDataTree(GH_StructureUTP) |
(Inherited from GH_ParamGH_CrossSection) |
| AddVolatileDataTree(IGH_Structure) |
(Inherited from GH_ParamGH_CrossSection) |
| AppendAdditionalMenuItems |
(Inherited from GH_PersistentParamGH_CrossSection) |
| 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.
(Inherited from GH_ParamGH_CrossSection) |
| ClearData |
(Inherited from GH_ParamGH_CrossSection) |
| ClearProxySources |
Remove all proxy sources without attempting to relink them.
(Inherited from GH_ParamGH_CrossSection) |
| ClearRuntimeMessages |
Destroy all warning and error lists
(Inherited from GH_ActiveObject) |
| CollectData |
(Inherited from GH_ParamGH_CrossSection) |
| CollectVolatileData_Custom |
(Inherited from GH_PersistentParamGH_CrossSection) |
| CollectVolatileData_FromSources |
This method collects volatile data from all the source parameters.
(Inherited from GH_ParamGH_CrossSection) |
| ComputeData |
(Inherited from GH_ParamGH_CrossSection) |
| 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.
(Inherited from GH_ParamGH_CrossSection) |
| CopyFrom |
Copy all fields (except the instance ID) from another instance description.
(Inherited from GH_InstanceDescription) |
| CreateAttributes |
(Inherited from GH_ParamGH_CrossSection) |
| CreateProxySources |
Convert all proper source parameters into proxy sources.
(Inherited from GH_ParamGH_CrossSection) |
| DependsOn |
(Inherited from GH_ParamGH_CrossSection) |
| 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) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExpireDownStreamObjects |
(Inherited from GH_ParamGH_CrossSection) |
| 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.
(Inherited from GH_ParamGH_CrossSection) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| Format |
Returns "Null" if the data is a null reference, otherwise calls ToString() on the Data instance.
(Inherited from GH_ParamGH_CrossSection) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| 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_DocumentObject.HtmlHelp_Source) |
| InstantiateT |
Attempts to instantiate a new instance of T.
(Overrides GH_Param.InstantiateT) |
| IsolateObject |
(Inherited from GH_ParamGH_CrossSection) |
| 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_AppendDestroyPersistent |
(Inherited from GH_PersistentParamGH_CrossSection) |
| Menu_AppendDisconnectWires |
(Inherited from GH_ParamGH_CrossSection) |
| Menu_AppendEnableItem |
Append the default Enable/Disable menu item.
(Inherited from GH_ActiveObject) |
| Menu_AppendExtractParameter |
(Inherited from GH_PersistentParamGH_CrossSection) |
| Menu_AppendFlattenParameter |
(Inherited from GH_ParamGH_CrossSection) |
| Menu_AppendGraftParameter |
(Inherited from GH_ParamGH_CrossSection) |
| Menu_AppendInternaliseData |
(Inherited from GH_PersistentParamGH_CrossSection) |
| Menu_AppendManageCollection |
(Inherited from GH_PersistentParamGH_CrossSection) |
| 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_ParamGH_CrossSection) |
| Menu_AppendPromptMore |
(Inherited from GH_PersistentParamGH_CrossSection) |
| Menu_AppendPromptOne |
(Inherited from GH_PersistentParamGH_CrossSection) |
| 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_ParamGH_CrossSection) |
| Menu_AppendRuntimeMessages |
Append the default warnings and errors menu items.
(Inherited from GH_ActiveObject) |
| Menu_AppendSimplifyParameter |
(Inherited from GH_ParamGH_CrossSection) |
| Menu_AppendWireDisplay |
(Inherited from GH_ParamGH_CrossSection) |
| 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_PersistentParamGH_CrossSection) |
| Menu_CustomMultiValueItem |
(Inherited from GH_PersistentParamGH_CrossSection) |
| Menu_CustomSingleValueItem |
(Inherited from GH_PersistentParamGH_CrossSection) |
| 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.
(Inherited from GH_ParamGH_CrossSection) |
| 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.
(Overrides GH_Param.PreferredCast(Object)) |
| PrepareForPrompt |
(Inherited from GH_PersistentParamGH_CrossSection) |
| 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_ParamGH_CrossSection) |
| 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_ParamGH_CrossSection) |
| 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_ParamGH_CrossSection) |
| Prompt_ManageCollection |
(Inherited from GH_PersistentParamGH_CrossSection) |
| Prompt_Plural |
Prompts for multiple values.
(Overrides GH_PersistentParam.Prompt_Plural(ListUTP)) |
| Prompt_Singular |
Prompts for single values.
(Overrides GH_PersistentParam.Prompt_Singular(UTP)) |
| Read |
(Inherited from GH_PersistentParamGH_CrossSection) |
| 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_PersistentParamGH_CrossSection) |
| 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_PersistentParamGH_CrossSection) |
| 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.
(Inherited from GH_ParamGH_CrossSection) |
| 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_ParamGH_CrossSection) |
| RemoveAllSources |
Remove all sources from this parameter.
(Inherited from GH_ParamGH_CrossSection) |
| 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_ParamGH_CrossSection) |
| RemoveSource(Guid) |
Remove the specified source from this parameter.
(Inherited from GH_ParamGH_CrossSection) |
| RemoveSource(IGH_Param) |
Remove the specified source from this parameter.
(Inherited from GH_ParamGH_CrossSection) |
| Render_AppendGeometry |
This function has been emptied because it is Obsolete.
(Inherited from GH_ParamGH_CrossSection) 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.
(Inherited from GH_ParamGH_CrossSection) |
| 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_ParamGH_CrossSection) |
| 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(UTP) |
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_PersistentParamGH_CrossSection) |
| SetPersistentData(GH_StructureUTP) |
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_PersistentParamGH_CrossSection) |
| SetPersistentData(IEnumerableUTP) |
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_PersistentParamGH_CrossSection) |
| SetPersistentData(Object) |
Add a collection of values to the persistent data.
(Inherited from GH_PersistentParamGH_CrossSection) |
| SetPrincipal |
Set the principal parameter state.
(Inherited from GH_ParamGH_CrossSection) |
| 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) |
| 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) |
| VolatileDataDescription |
This method is called to populate the Tooltip data description field.
(Inherited from GH_ParamGH_CrossSection) |
| Write |
(Inherited from GH_PersistentParamGH_CrossSection) |
| 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) |
Events
| AttributesChanged |
Raised whenever the number or kind of attributes changes. This event is handled
by GH_Documents who subsequently wipe their attribute caches.
(Inherited from GH_DocumentObject) |
| DisplayExpired |
Raised whenever the display (on the Canvas) of a certain object becomes invalid.
(Inherited from GH_DocumentObject) |
| ObjectChanged |
(Inherited from GH_DocumentObject) |
| PingDocument |
Raised whenever an object needs to know which GH_Document it belongs to.
(Inherited from GH_DocumentObject) |
| PreviewExpired |
Raised whenever the display (in the Rhino viewports) of a certain object becomes invalid.
(Inherited from GH_DocumentObject) |
| SolutionExpired |
Raised whenever the solution of a certain object becomes invalid.
(Inherited from GH_DocumentObject) |
Fields
| m_attributes |
(Inherited from GH_DocumentObject) |
| m_data |
Contains the runtime data for this parameter, also known as "Volatile" data.
(Inherited from GH_ParamGH_CrossSection) |
Extension Methods
| ContainerType |
test if object is (a container like) a list or an array.
(Defined by MiniUtil) |