Param_ModelStandardViewport Methods

This method will be called when an object is added to a document. Override this method if you want to handle such events.

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.

Append a new Source parameter to the end of the Sources list. Sources provide this parameter with data at runtime.

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

Inserts an item of volatile data into the data structure.

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.

Remove all proxy sources without attempting to relink them.

Destroy all warning and error lists

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

Convert all proper source parameters into proxy sources.

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

Call this function when you suspect that the preview has expired for this object. This will cause the display cache to be eradicated.

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.

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

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.

Generate a new random instance 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.

Raises the AttributesChanged event on the toplevel object.

Raises the DisplayExpired event on the toplevel object.

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

Raises the PreviewExpired event on the toplevel object.

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

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.

Record an entire undo record.

Record a generic object change undo event.

Record a specific object change undo event.

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.

Remove all sources from this parameter.

This method will be called when an object is removed from a document. Override this method if you want to handle such events.

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

Remove the specified source from this parameter.

Remove the specified source from this parameter.

Replace an existing source with a new one. If the old_source does not exist in this parameter, nothing happens.

Replace an existing source with a new one. If the old_source does not exist in this parameter, nothing happens.

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

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

Set a new custom icon override for this object.

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.

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.

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.

Add a collection of values to the persistent data.

Set the principal parameter state.

Triggers the AutoSave function on the owner document with the object_changed flag.

Triggers the AutoSave function on the owner document with a custom flag.

Triggers the AutoSave function on the owner document with the object_changed flag.

Triggers the AutoSave function on the owner document with a custom flag.

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.