ModelDataParam.T.

Public Class

Inheritance Hierarchy

Namespace: Grasshopper.Rhinoceros.Params

Assembly: Grasshopper (in Grasshopper.dll)

Syntax

public abstract class ModelDataParam<T> : GH_Param<T>
where T : class, IGH_ModelData

The ModelDataParam.T. type exposes the following members.

Constructors

Name

Description

Protected method

ModelDataParam.T.

Initializes a new instance of the ModelDataParam.T. class

Properties

Name

Description

Public Property

Access

Gets or sets the Access level for this parameter.

(Inherited from GH_Param.T..)

Public Property

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.)

Public Property

Methods

Name

Description

Public Method

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.)

Public Method

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.)

Public Method

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_Param.T..)

Public Method

AddSource(IGH_Param, Int32)

Insert a new Source parameter into the Sources list. Sources provide this parameter with data at runtime.

(Inherited from GH_Param.T..)

Public Method

AddVolatileData(GH_Path, Int32, Object)

Inserts an item of volatile data into the data structure.

(Inherited from GH_Param.T..)

Public Method

AddVolatileDataList(GH_Path, List.T.)

(Inherited from GH_Param.T..)

Public Method

AddVolatileDataList(GH_Path, IEnumerable)

(Inherited from GH_Param.T..)

Public Method

AddVolatileDataTree(GH_Structure.T.)

(Inherited from GH_Param.T..)

Public Method

AddVolatileDataTree(IGH_Structure)

(Inherited from GH_Param.T..)

Public Method

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

(Inherited from GH_Param.T..)

Public Method

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.)

Protected method

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_Param.T..)

Public Method

ClearData

(Inherited from GH_Param.T..)

Public Method

ClearProxySources

Remove all proxy sources without attempting to relink them.

(Inherited from GH_Param.T..)

Public Method

ClearRuntimeMessages

Destroy all warning and error lists

(Inherited from GH_ActiveObject.)

Public Method

CollectData

(Inherited from GH_Param.T..)

Protected method

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.

(Inherited from GH_Param.T..)

Protected method

CollectVolatileData_FromSources

This method collects volatile data from all the source parameters.

(Inherited from GH_Param.T..)

Public Method

ComputeData

(Inherited from GH_Param.T..)

Protected method

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_Param.T..)

Public Method

CopyFrom

Copy all fields (except the instance ID) from another instance description.

(Inherited from GH_InstanceDescription.)

Public Method

CreateAttributes

(Inherited from GH_Param.T..)

Public Method

CreateProxySources

Convert all proper source parameters into proxy sources.

(Inherited from GH_Param.T..)

Public Method

DependsOn

(Inherited from GH_Param.T..)

Protected method

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.)

Public Method

DocumentContextChanged

This method will be called when the document that owns this object moves into a different context.

(Inherited from GH_DocumentObject.)

Protected method

ExpireDownStreamObjects

(Inherited from GH_Param.T..)

Public Method

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.)

Public Method

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.)

Public Method

ExpireSolutionTopLevel

Invoke the Expiresolution(bool) method on the toplevel object.

(Inherited from GH_Param.T..)

Protected method

Format

Returns “Null” if the data is a null reference, otherwise calls ToString() on the Data instance.

(Inherited from GH_Param.T..)

Protected method

GetValue(String, Boolean)

Get a boolean value from the component value table.

(Inherited from GH_DocumentObject.)

Protected method

GetValue(String, Double)

Get a double value from the component value table.

(Inherited from GH_DocumentObject.)

Protected method

GetValue(String, Color)

Get a color value from the component value table.

(Inherited from GH_DocumentObject.)

Protected method

GetValue(String, Int32)

Get an integer value from the component value table.

(Inherited from GH_DocumentObject.)

Protected method

GetValue(String, String)

Get a string value from the component value table.

(Inherited from GH_DocumentObject.)

Protected method

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.)

Protected method

InstantiateT

(Overrides GH_Param.T..InstantiateT..)

Public Method

IsolateObject

(Inherited from GH_Param.T..)

Protected method

Menu_AppendBakeItem

Append the default Bake menu item.

(Inherited from GH_ActiveObject.)

Protected method

Menu_AppendDisconnectWires

(Inherited from GH_Param.T..)

Protected method

Menu_AppendEnableItem

Append the default Enable/Disable menu item.

(Inherited from GH_ActiveObject.)

Protected method

Menu_AppendFlattenParameter

(Inherited from GH_Param.T..)

Protected method

Menu_AppendGraftParameter

(Inherited from GH_Param.T..)

Protected method

Menu_AppendObjectHelp

Appends the default object Help menu item.

(Inherited from GH_DocumentObject.)

Protected method

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.)

Protected method

Menu_AppendObjectNameEx

Appends the default object name + display mode menu item.

(Inherited from GH_DocumentObject.)

Protected method

Menu_AppendPreviewItem

Append the default Show/Hide preview menu item.

(Inherited from GH_ActiveObject.)

Protected method

Menu_AppendPrincipalParameter

(Inherited from GH_Param.T..)

Protected method

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.)

Protected method

Menu_AppendReverseParameter

(Inherited from GH_Param.T..)

Protected method

Menu_AppendRuntimeMessages

Append the default warnings and errors menu items.

(Inherited from GH_ActiveObject.)

Protected method

Menu_AppendSimplifyParameter

(Inherited from GH_Param.T..)

Protected method

Menu_AppendWireDisplay

(Inherited from GH_Param.T..)

Public Method

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.)

Public Method

NewInstanceGuid.

Generate a new random instance GUID

(Inherited from GH_InstanceDescription.)

Public Method

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.)

Public Method

OnAttributesChanged

Raises the AttributesChanged event on the toplevel object.

(Inherited from GH_DocumentObject.)

Public Method

OnDisplayExpired

Raises the DisplayExpired event on the toplevel object.

(Inherited from GH_DocumentObject.)

Public Method

OnObjectChanged(GH_ObjectChangedEventArgs)

(Inherited from GH_DocumentObject.)

Public Method

OnObjectChanged(GH_ObjectEventType)

(Inherited from GH_DocumentObject.)

Public Method

OnObjectChanged(String)

(Inherited from GH_DocumentObject.)

Public Method

OnObjectChanged(GH_ObjectEventType, Object)

(Inherited from GH_DocumentObject.)

Public Method

OnObjectChanged(String, Object)

(Inherited from GH_DocumentObject.)

Public Method

OnPingDocument

Raise the PingDocument Event on the toplevel object and try to find the document which owns this object.

(Inherited from GH_DocumentObject.)

Public Method

OnPreviewExpired

Raises the PreviewExpired event on the toplevel object.

(Inherited from GH_DocumentObject.)

Public Method

OnSolutionExpired

Raises the SolutionExpired event on the toplevel object. You probably want to call ExpireSolution() instead of this method directly.

(Inherited from GH_DocumentObject.)

Protected method

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_Param.T..)

Protected method

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.

(Inherited from GH_Param.T..)

Protected method

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_Param.T..)

Protected method

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_Param.T..)

Protected method

Preview_DrawWires

(Inherited from GH_Param.T..)

Public Method

Read

(Inherited from GH_Param.T..)

Public Method

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.)

Public Method

RecordUndoEvent(GH_UndoRecord)

Record an entire undo record.

(Inherited from GH_DocumentObject.)

Public Method

RecordUndoEvent(String)

Record a generic object change undo event.

(Inherited from GH_DocumentObject.)

Public Method

RecordUndoEvent(String, IGH_UndoAction)

Record a specific object change undo event.

(Inherited from GH_DocumentObject.)

Public Method

RegisterRemoteIDs

Override this function if you want object changes in the Rhino document to trigger a new solution.

(Inherited from GH_ActiveObject.)

Protected method

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_Param.T..)

Public Method

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_Param.T..)

Public Method

RemoveAllSources

Remove all sources from this parameter.

(Inherited from GH_Param.T..)

Public Method

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.)

Public Method

RemoveEffects

Remove all post-process effects. Note to implementors, you must call the base method if you override this function.

(Inherited from GH_Param.T..)

Public Method

RemoveSource(Guid)

Remove the specified source from this parameter.

(Inherited from GH_Param.T..)

Public Method

RemoveSource(IGH_Param)

Remove the specified source from this parameter.

(Inherited from GH_Param.T..)

Protected method

Render_AppendGeometry

Obsolete.

This function has been emptied because it is Obsolete.

(Inherited from GH_Param.T..)

Public Method

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_Param.T..)

Public Method

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_Param.T..)

Public Method

RuntimeMessages

Gets the list of cached runtime messages that were recorded during solver-time processes.

(Inherited from GH_ActiveObject.)

Public Method

SDKCompliancy

Test whether this object is compliant with a given Rhino version.

(Inherited from GH_ActiveObject.)

Public Method

SetIconOverride

Set a new custom icon override for this object.

(Inherited from GH_DocumentObject.)

Public Method

SetPrincipal

Set the principal parameter state.

(Inherited from GH_Param.T..)

Protected method

SetValue(String, Boolean)