|
GH_SwitcherComponentAttributes Class |
Switcher component grasshopper attributes.
Inheritance HierarchySystemObject
GH_AttributesIGH_Component
GH_ComponentAttributes
Karamba.GHopper.Utilities.UIWidgetsGH_SwitcherComponentAttributes
GH_AttributesIGH_Component
GH_ComponentAttributes
Karamba.GHopper.Utilities.UIWidgetsGH_SwitcherComponentAttributes
Namespace: Karamba.GHopper.Utilities.UIWidgets
Assembly: karambaGH (in karambaGH.dll) Version: 1.15.0.0 (1.15.0.0)
SyntaxThe GH_SwitcherComponentAttributes type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GH_SwitcherComponentAttributes |
Create a new switcher attribute.
|
Properties| Name | Description | |
|---|---|---|
 | AllowMessageBalloon |
Gets a value indicating whether these attributes allow warning and
error balloons to be drawn on top of them.
(Inherited from GH_AttributesIGH_Component.) |
| Bounds |
Gets the rectangle that contains the active content of the attributes.
Typically the Contents determine the active area for menus, tooltips etc.
Attributes are not supposed to draw objects beyond the Bounds.
(Inherited from GH_AttributesIGH_Component.) |
| ContentBox |
Gets the bounds of the component area of the attributes.
(Inherited from GH_ComponentAttributes.) |
| DocObject |
Gets the owner object of these attributes.
(Inherited from GH_AttributesIGH_Component.) |
| GetTopLevel |
Gets the top-level attributes of the attribute stack these attributes belong to.
(Inherited from GH_AttributesIGH_Component.) |
| HasInputGrip | (Inherited from GH_ComponentAttributes.) |
| HasOutputGrip | (Inherited from GH_ComponentAttributes.) |
| InputGrip |
Gets the input grip location for these attributes.
If HasInputGrip equals False, this point is meaningless.
(Inherited from GH_AttributesIGH_Component.) |
| InstanceGuid |
Gets the instance ID of the document object that owns these attributes.
(Inherited from GH_AttributesIGH_Component.) |
| IsTopLevel |
Gets whether these attributes are top_level (i.e. no Parent attributes)
(Inherited from GH_AttributesIGH_Component.) |
| MinWidth |
Minimum attribute width.
|
| OutputGrip |
Gets the output grip location for these attributes.
If HasOutputGrip equals False, this point is meaningless.
(Inherited from GH_AttributesIGH_Component.) |
| Owner |
Gets the type-safe owner object of these attributes. This property is identical to
the DocObject property.
(Inherited from GH_AttributesIGH_Component.) |
| Parent |
Gets or sets the parent attributes.
Top level attributes do not have parents.
(Inherited from GH_AttributesIGH_Component.) |
| PathName | (Inherited from GH_ComponentAttributes.) |
| Pivot |
Gets or sets the pivot for these attributes. The pivot controls the general placement
of the attributes. If you want to move the attributes, change the pivot location.
(Inherited from GH_AttributesIGH_Component.) |
| Selected |
Gets or sets the selected state of the top-level attributes.
(Inherited from GH_AttributesIGH_Component.) |
| TooltipEnabled |
Gets the tooltip enabled value. If False, no further tooltip functions will be called.
(Inherited from GH_AttributesIGH_Component.) |
Methods| Name | Description | |
|---|---|---|
| AddMenu |
Add menu to attribue.
|
| AppendToAttributeTree | (Inherited from GH_ComponentAttributes.) |
 | CreateUnitDropDown |
Create evaluation unit drop down menu.
The Menu will be created iff the the number of evaluation units is > 1
or |units| == 1 AND the component can be unitless. Otherwise, the menu
has no functionality.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| ExpireLayout | (Inherited from GH_ComponentAttributes.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| FixLayout | |
| GetActiveTooltip | |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeUnitParameters |
Initialize switcher's parameters.
This method creates new linked_parameter_attributes for all parameters
which do not already have one.
|
| InvalidateCanvas |
The canvas must be invalidated when the mouse is near enough and
this component has variable parameters.
(Inherited from GH_ComponentAttributes.) |
| IsMenuRegion |
Determines whether a point is available for context menu popups.
By default, IsMenuRegion calls IsPickRegion(PointF).
(Inherited from GH_AttributesIGH_Component.) |
| IsPickRegion(PointF) |
Determines whether a point is within the pickable region for this object.
By default, any point inside the Bounds is treated as pickable.
(Inherited from GH_AttributesIGH_Component.) |
| IsPickRegion(RectangleF, GH_PickBox) |
Determines whether a rectangle is a valid pick region for this object.
By default, the picking rectangle is intersected with the Bounds rectangle.
(Inherited from GH_AttributesIGH_Component.) |
| IsTooltipRegion | (Overrides GH_Attributes.IsTooltipRegion(PointF).) |
| Layout | (Overrides GH_ComponentAttributes.Layout.) |
| LayoutBaseComponent |
Layout base component.
|
| LayoutBounds2 | |
| LayoutComponentBox2 | |
| LayoutExtBounds | |
| LayoutInputParams2 |
Layout input parameters.
|
| LayoutMenu | |
| LayoutMenuInputs | |
| LayoutMenuOutputs | |
| LayoutOutputParams2 | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| NewInstanceGuid |
Generate a new instance GUID for the owner object.
(Inherited from GH_AttributesIGH_Component.) |
| NewInstanceGuid(Guid) |
Generate a new instance GUID for the owner object. Do not use this overload
unless you're > 1.95m and called David.
(Inherited from GH_AttributesIGH_Component.) |
| OnSwitchUnit |
Is called when the owner component's evaluation context has changed.
|
| PerformLayout |
Recompute the layout for these attributes. This function is automatically called during
Drawing operations, so you typically don't have to.
(Inherited from GH_AttributesIGH_Component.) |
| PrepareForRender |
Prepare attribute for rendering.
(Overrides GH_Attributes.PrepareForRender(GH_Canvas).) |
| Read |
Read attributes.
(Overrides GH_Attributes.Read(GH_IReader).) |
| Render |
Render widget flag.
(Overrides GH_ComponentAttributes.Render(GH_Canvas, Graphics, GH_CanvasChannel).) |
| RenderComponentCapsule(GH_Canvas, Graphics) |
Utility function, draws the complete component capsule including all parameter data.
(Inherited from GH_ComponentAttributes.) |
| RenderComponentCapsule(GH_Canvas, Graphics, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean) |
Utility function, draws the component capsule including all specified elements.
(Inherited from GH_ComponentAttributes.) |
| RenderComponentCapsule2(GH_Canvas, Graphics) | |
| RenderComponentCapsule2(GH_Canvas, Graphics, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean) | |
 | RenderComponentParameters2 | |
| RenderIncomingWires(GH_Painter, IEnumerableIGH_Param, GH_ParamWireDisplay) |
Utility function for derived classes. This method draws all the wires going into the
left side of the attributes.
(Inherited from GH_AttributesIGH_Component.) |
| RenderIncomingWires(GH_Painter, IEnumerableIGH_Param, IEnumerablePen) |
Utility function for derived classes. This method draws all the wires going into the
left side of the attributes.
(Inherited from GH_AttributesIGH_Component.) |
| RenderToCanvas |
Render these attributes into a Canvas control. This function places calls to
PrepareForRender() and Render(), you should override those.
(Inherited from GH_AttributesIGH_Component.) |
| RenderVariableParameterUI | (Inherited from GH_ComponentAttributes.) |
| RespondToKeyDown | (Overrides GH_Attributes.RespondToKeyDown(GH_Canvas, KeyEventArgs).) |
| RespondToKeyUp | (Inherited from GH_AttributesIGH_Component.) |
| RespondToMouseDoubleClick | (Overrides GH_Attributes.RespondToMouseDoubleClick(GH_Canvas, GH_CanvasMouseEvent).) |
| RespondToMouseDown | (Overrides GH_ComponentAttributes.RespondToMouseDown(GH_Canvas, GH_CanvasMouseEvent).) |
| RespondToMouseMove | (Overrides GH_Attributes.RespondToMouseMove(GH_Canvas, GH_CanvasMouseEvent).) |
| RespondToMouseUp | (Overrides GH_Attributes.RespondToMouseUp(GH_Canvas, GH_CanvasMouseEvent).) |
| SetupTooltip | (Overrides GH_ComponentAttributes.SetupTooltip(PointF, GH_TooltipDisplayEventArgs).) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Write |
Write attributes.
(Overrides GH_Attributes.Write(GH_IWriter).) |
Fields| Name | Description | |
|---|---|---|
 | collection |
Default menu collection. Will be shared by all evaluation units.
|
| m_innerBounds |
Represents the Rectangle that contains the component black box.
(Inherited from GH_ComponentAttributes.) |
| unitMenuCollection |
Unit dropdown menu.
|
See Also