Param_ModelLineWidth
Inheritance Hierarchy
System.Object
Grasshopper.Kernel.GH_InstanceDescription
Grasshopper.Kernel.GH_DocumentObject
Grasshopper.Kernel.GH_ActiveObject
Grasshopper.Kernel.GH_Param. ModelLineWidth.
Grasshopper.Kernel.GH_PersistentParam. ModelLineWidth.
Grasshopper.Rhinoceros.Drafting.Params.Param_ModelLineWidth
Namespace: Grasshopper.Rhinoceros.Drafting.Params
Assembly: Grasshopper (in Grasshopper.dll)
Syntax
public sealed class Param_ModelLineWidth : GH_PersistentParam<ModelLineWidth>The Param_ModelLineWidth type exposes the following members.
Constructors
Name
Description
Public Method
Param_ModelLineWidth
Initializes a new instance of the Param_ModelLineWidth 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
Category
Gets or sets the Category in which this object belongs. If HasCategory() returns false, this field has no meaning.
(Inherited from GH_InstanceDescription.)
Public Property
ComponentGuid
(Overrides
GH_DocumentObject.ComponentGuid
.)Public Property
DataMapping
Gets or sets the data mapping of this Parameter.
(Inherited from GH_Param.T..)
Public Property
DataType
Gets the type of data stored in this parameter.
(Inherited from GH_PersistentParam.T..)
Public Property
Description
Gets or sets the description of the object. This field typically remains fixed during the lifetime of an object.
(Inherited from GH_InstanceDescription.)
Public Property
Exposure
(Overrides
GH_DocumentObject.Exposure
.)Public Property
HasCategory
Gets whether or not the Category field has been set.
(Inherited from GH_InstanceDescription.)
Public Property
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_Param.T..)
Public Property
HasSubCategory
Gets whether or not the SubCategory field has been set.
(Inherited from GH_InstanceDescription.)
Public Property
Icon_24x24
The icon associated with this object.
(Inherited from GH_DocumentObject.)
Public Property
Icon_24x24_Locked
The greyscale icon of this object.
(Inherited from GH_DocumentObject.)
Public Property
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.)
Public Property
IconDisplayMode
Gets the current display mode of the object.
(Inherited from GH_DocumentObject.)
Public Property
InstanceDescription
Gets the description of this instance. The default description is about the amount and source of the local values.
(Inherited from GH_Param.T..)
Public Property
InstanceGuid
Gets the ID of this runtime instance.
(Inherited from GH_InstanceDescription.)
Public Property
IsDataProvider
(Inherited from GH_Param.T..)
Public Property
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_Param.T..)
Public Property
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.)
Public Property
Kind
Gets the parameter kind. The kind is evaluated lazily and cached.
(Inherited from GH_Param.T..)
Public Property
Locked
Gets or sets the enabled flag of this object. Disabled objects are ignored during solutions.
(Inherited from GH_ActiveObject.)
Public Property
MutableNickName
Gets or sets a value that enables Nick name changes through the menu. The default is TRUE.
(Inherited from GH_ActiveObject.)
Public Property
Name
Gets or sets the name of the object. This field typically remains fixed during the lifetime of an object.
(Inherited from GH_InstanceDescription.)
Public Property
NickName
Gets or sets the nickname of the object. This field can be changed by the user.
(Inherited from GH_InstanceDescription.)
Public Property
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.)
Public Property
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_Param.T..)
Public Property
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_PersistentParam.T..)
Public Property
PersistentDataCount
Gets the number of persistent data items stored in this parameter.
(Inherited from GH_PersistentParam.T..)
Public Property
Phase
Gets or sets the solution phase this object is currenly in.
(Inherited from GH_ActiveObject.)
Public Property
ProcessorTime
(Inherited from GH_Param.T..)
Public Property
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_Param.T..)
Public Property
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_Param.T..)
Public Property
Reverse
Gets or sets the data reverse modifier of this parameter.
(Inherited from GH_Param.T..)
Public Property
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.)
Public Property
Simplify
Gets or sets the simplify modifier for this parameter.
(Inherited from GH_Param.T..)
Public Property
SourceCount
Gets the number of sources for this parameter.
(Inherited from GH_Param.T..)
Public Property
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_Param.T..)
Public Property
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_Param.T..)
Public Property
SubCategory
Gets or sets the SubCategory in which this object belongs. If HasSubCategory() returns false, this field has no meaning.
(Inherited from GH_InstanceDescription.)
Public Property
Type
Gets the Framework Type descriptor for the stored Data.
(Inherited from GH_Param.T..)
Public Property
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_Param.T..)
Public Property
VolatileData
(Inherited from GH_Param.T..)
Public Property
VolatileDataCount
(Inherited from GH_Param.T..)
Public Property
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_Param.T..)
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, T)
(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
(Inherited from GH_PersistentParam.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.)
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..)
Public Method
ComputeData
(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..)
Public Method
DocumentContextChanged
This method will be called when the document that owns this object moves into a different context.
(Inherited from GH_DocumentObject.)
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..)
Public Method
IsolateObject
(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.)
Public Method
Read
(Inherited from GH_PersistentParam.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.)
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..)
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
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_PersistentParam.T..)
Public Method
SetPersistentData(GH_Structure.T.)
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_PersistentParam.T..)
Public Method
SetPersistentData(IEnumerable.T.)
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_PersistentParam.T..)
Public Method
SetPersistentData(.Object.)
Add a collection of values to the persistent data.
(Inherited from GH_PersistentParam.T..)
Public Method
SetPrincipal
Set the principal parameter state.
(Inherited from GH_Param.T..)
Public Method
TriggerAutoSave.
Triggers the AutoSave function on the owner document with the object_changed flag.
(Inherited from GH_DocumentObject.)
Public Method
TriggerAutoSave(GH_AutoSaveTrigger)
Triggers the AutoSave function on the owner document with a custom flag.
(Inherited from GH_DocumentObject.)
Public Method
TriggerAutoSave(Guid)
Triggers the AutoSave function on the owner document with the object_changed flag.
(Inherited from GH_DocumentObject.)
Public Method
TriggerAutoSave(GH_AutoSaveTrigger, Guid)
Triggers the AutoSave function on the owner document with a custom flag.
(Inherited from GH_DocumentObject.)
Public Method
Write
(Inherited from GH_PersistentParam.T..)
Public Method
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
Name
Description
Public Event
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.)
Public Event
DisplayExpired
Raised whenever the display (on the Canvas) of a certain object becomes invalid.
(Inherited from GH_DocumentObject.)
Public Event
ObjectChanged
(Inherited from GH_DocumentObject.)
Public Event
PingDocument
Raised whenever an object needs to know which GH_Document it belongs to.
(Inherited from GH_DocumentObject.)
Public Event
PreviewExpired
Raised whenever the display (in the Rhino viewports) of a certain object becomes invalid.
(Inherited from GH_DocumentObject.)
Public Event
SolutionExpired
Raised whenever the solution of a certain object becomes invalid.
(Inherited from GH_DocumentObject.)