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 fromGH_Attributes<T>

Implements: Bounds

ContentBox

public RectangleF ContentBox { get; }

Gets the bounds of the component area of the attributes.

inherited fromGH_ComponentAttributes

DocObject

public IGH_DocumentObject DocObject { get; }

Gets the owner object of these attributes.

inherited fromGH_Attributes<T>

Implements: DocObject

GetTopLevel

public IGH_Attributes GetTopLevel { get; }

Gets the top-level attributes of the attribute stack these attributes belong to.

inherited fromGH_Attributes<T>

Implements: GetTopLevel

HasInputGrip

public override bool HasInputGrip { get; }

inherited fromGH_ComponentAttributes

Overrides: GH_Attributes<T>.HasInputGrip

HasOutputGrip

public override bool HasOutputGrip { get; }

inherited fromGH_ComponentAttributes

Overrides: GH_Attributes<T>.HasOutputGrip

InputGrip

public virtual PointF InputGrip { get; }

Gets the input grip location for these attributes. If HasInputGrip equals False, this point is meaningless.

inherited fromGH_Attributes<T>

Implements: InputGrip

InstanceGuid

public Guid InstanceGuid { get; }

Gets the instance ID of the document object that owns these attributes.

inherited fromGH_Attributes<T>

Implements: InstanceGuid

IsTopLevel

public bool IsTopLevel { get; }

Gets whether these attributes are top_level (i.e. no Parent attributes)

inherited fromGH_Attributes<T>

Implements: IsTopLevel

OutputGrip

public virtual PointF OutputGrip { get; }

Gets the output grip location for these attributes. If HasOutputGrip equals False, this point is meaningless.

inherited fromGH_Attributes<T>

Implements: OutputGrip

Owner

public T Owner { get; }

Gets the type-safe owner object of these attributes. This property is identical to the DocObject property.

inherited fromGH_Attributes<T>

Parent

public IGH_Attributes Parent { get; set; }

Gets or sets the parent attributes. Top level attributes do not have parents.

inherited fromGH_Attributes<T>

Implements: Parent

PathName

public override string PathName { get; }

inherited fromGH_ComponentAttributes

Overrides: GH_Attributes<T>.PathName

Pivot

public virtual PointF Pivot { get; set; }

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 fromGH_Attributes<T>

Implements: Pivot

Selected

public virtual bool Selected { get; set; }

Gets or sets the selected state of the top-level attributes.

inherited fromGH_Attributes<T>

Implements: Selected

TooltipEnabled

public virtual bool TooltipEnabled { get; }

Gets the tooltip enabled value. If False, no further tooltip functions will be called.

inherited fromGH_Attributes<T>

Implements: TooltipEnabled

Methods

AppendToAttributeTree

public override void AppendToAttributeTree(List<IGH_Attributes> attributes)

inherited fromGH_ComponentAttributes

Parameters:

attributes (List<IGH_Attributes>)

Overrides: GH_Attributes<T>.AppendToAttributeTree

ExpireLayout

public override void ExpireLayout()

inherited fromGH_ComponentAttributes

Overrides: GH_Attributes<T>.ExpireLayout

InvalidateCanvas

public override bool InvalidateCanvas(GH_Canvas canvas, GH_CanvasMouseEvent e)

The canvas must be invalidated when the mouse is near enough and this component has variable parameters.

inherited fromGH_ComponentAttributes

Parameters:

canvas (GH_Canvas)
e (GH_CanvasMouseEvent)

Overrides: GH_Attributes<T>.InvalidateCanvas

IsMenuRegion

public virtual bool IsMenuRegion(PointF point)

Determines whether a point is available for context menu popups. By default, IsMenuRegion calls IsPickRegion(PointF).

inherited fromGH_Attributes<T>

Parameters:

point (PointF)

Point location to test.

Implements: IsMenuRegion

IsPickRegion

public override bool IsPickRegion(PointF point)

inherited fromGH_ComponentAttributes

Parameters:

point (PointF)

Overrides: GH_Attributes<T>.IsPickRegion

IsPickRegion

public virtual bool IsPickRegion(RectangleF box, GH_PickBox method)

Determines whether a rectangle is a valid pick region for this object. By default, the picking rectangle is intersected with the Bounds rectangle.

inherited fromGH_Attributes<T>

Parameters:

box (RectangleF)	Selection box.
method (GH_PickBox)	Selection method.

Implements: IsPickRegion

IsTooltipRegion

public virtual bool IsTooltipRegion(PointF point)

Determines whether a point is available for tooltip popups. By default, IsMenuRegion calls IsTooltipRegion(PointF).

inherited fromGH_Attributes<T>

Parameters:

point (PointF)

Point location to test.

Implements: IsTooltipRegion

Layout

protected override void Layout()

Overrides: GH_ComponentAttributes.Layout

NewInstanceGuid

public void NewInstanceGuid()

Generate a new instance GUID for the owner object.

inherited fromGH_Attributes<T>

Implements: NewInstanceGuid

NewInstanceGuid

public void NewInstanceGuid(Guid newId)

Generate a new instance GUID for the owner object. Do not use this overload unless you're > 1.95m and called David.

inherited fromGH_Attributes<T>

Parameters:

newId (Guid)

Implements: NewInstanceGuid

PerformLayout

public void PerformLayout()

Recompute the layout for these attributes. This function is automatically called during Drawing operations, so you typically don't have to.

inherited fromGH_Attributes<T>

Implements: PerformLayout

PrepareForRender

protected virtual void PrepareForRender(GH_Canvas canvas)

This method will always be called exactly once prior to Render(). This would be a good place to make sure all the necessary GUI data is up and running.

inherited fromGH_Attributes<T>

Parameters:

canvas (GH_Canvas)

Canvas that is about to render these attributes.

Read

public virtual bool Read(GH_IReader reader)

inherited fromGH_Attributes<T>

Parameters:

reader (GH_IReader)

Implements: Read

Render

protected override void Render(GH_Canvas canvas, Graphics graphics, GH_CanvasChannel channel)

Parameters:

canvas (GH_Canvas)
graphics (Graphics)
channel (GH_CanvasChannel)

Overrides: GH_ComponentAttributes.Render

RenderComponentCapsule

protected void RenderComponentCapsule(GH_Canvas canvas, Graphics graphics, bool drawComponentBaseBox, bool drawComponentNameBox, bool drawJaggedEdges, bool drawParameterGrips, bool drawParameterNames, bool drawZuiElements)

Utility function, draws the component capsule including all specified elements.

inherited fromGH_ComponentAttributes

Parameters:

canvas (GH_Canvas)	Canvas to draw into.
graphics (Graphics)	Graphics object to draw with.
drawComponentBaseBox (bool)	If true, will draw the component background box.
drawComponentNameBox (bool)	If true, will draw component nickname/icon element.
drawJaggedEdges (bool)	If true, parameterless sides will have jagged edges drawn on them.
drawParameterGrips (bool)	If true, will draw parameter grips.
drawParameterNames (bool)	If true, will draw parameter nicknames.
drawZuiElements (bool)	If true, will draw ZUI variable parameter interface.

RenderComponentCapsule

protected void RenderComponentCapsule(GH_Canvas canvas, Graphics graphics)

Utility function, draws the complete component capsule including all parameter data.

inherited fromGH_ComponentAttributes

Parameters:

canvas (GH_Canvas)	Canvas to draw into.
graphics (Graphics)	Graphics object to draw with.

RenderIncomingWires

protected void RenderIncomingWires(GH_Painter painter, IEnumerable<IGH_Param> sources, GH_ParamWireDisplay style)

Utility function for derived classes. This method draws all the wires going into the left side of the attributes.

inherited fromGH_Attributes<T>

Parameters:

painter (GH_Painter)	The graphics object to paint with
sources (IEnumerable<IGH_Param>)	A list of sources that will be connected with the input grip of this attribute
style (GH_ParamWireDisplay)	Style for wire display.

RenderIncomingWires

protected void RenderIncomingWires(GH_Painter painter, IEnumerable<IGH_Param> sources, IEnumerable<Pen> styles)

Utility function for derived classes. This method draws all the wires going into the left side of the attributes.

inherited fromGH_Attributes<T>

Parameters:

painter (GH_Painter)	The graphics object to paint with
sources (IEnumerable<IGH_Param>)	A list of sources that will be connected with the input grip of this attribute
styles (IEnumerable<Pen>)	A collection of pen objects to use for each source. If a pen is null, the default wire style will be used instead.

RenderToCanvas

public void RenderToCanvas(GH_Canvas canvas, GH_CanvasChannel channel)

Render these attributes into a Canvas control. This function places calls to PrepareForRender() and Render(), you should override those.

inherited fromGH_Attributes<T>

Parameters:

canvas (GH_Canvas)	Canvas to draw on.
channel (GH_CanvasChannel)	Current drawing channel.

Implements: RenderToCanvas

RenderVariableParameterUI

protected void RenderVariableParameterUI(GH_Canvas canvas, Graphics graphics)

inherited fromGH_ComponentAttributes

Parameters:

canvas (GH_Canvas)
graphics (Graphics)

RespondToKeyDown

public virtual GH_ObjectResponse RespondToKeyDown(GH_Canvas sender, KeyEventArgs e)

inherited fromGH_Attributes<T>

Parameters:

sender (GH_Canvas)
e (KeyEventArgs)

Implements: RespondToKeyDown

RespondToKeyUp

public virtual GH_ObjectResponse RespondToKeyUp(GH_Canvas sender, KeyEventArgs e)

inherited fromGH_Attributes<T>

Parameters:

sender (GH_Canvas)
e (KeyEventArgs)

Implements: RespondToKeyUp

RespondToMouseDoubleClick

public virtual GH_ObjectResponse RespondToMouseDoubleClick(GH_Canvas sender, GH_CanvasMouseEvent e)

inherited fromGH_Attributes<T>

Parameters:

sender (GH_Canvas)
e (GH_CanvasMouseEvent)

Implements: RespondToMouseDoubleClick

RespondToMouseDown

public override GH_ObjectResponse RespondToMouseDown(GH_Canvas sender, GH_CanvasMouseEvent e)

inherited fromGH_ComponentAttributes

Parameters:

sender (GH_Canvas)
e (GH_CanvasMouseEvent)

Overrides: GH_Attributes<T>.RespondToMouseDown

RespondToMouseMove

public override GH_ObjectResponse RespondToMouseMove(GH_Canvas sender, GH_CanvasMouseEvent e)

Parameters:

sender (GH_Canvas)
e (GH_CanvasMouseEvent)

Overrides: GH_Attributes<T>.RespondToMouseMove

RespondToMouseUp

public override GH_ObjectResponse RespondToMouseUp(GH_Canvas sender, GH_CanvasMouseEvent e)

Parameters:

sender (GH_Canvas)
e (GH_CanvasMouseEvent)

Overrides: GH_Attributes<T>.RespondToMouseUp

SetupTooltip

public override void SetupTooltip(PointF canvasPoint, GH_TooltipDisplayEventArgs e)

Parameters:

canvasPoint (PointF)
e (GH_TooltipDisplayEventArgs)

Overrides: GH_ComponentAttributes.SetupTooltip

Write

public virtual bool Write(GH_IWriter writer)

inherited fromGH_Attributes<T>

Parameters:

writer (GH_IWriter)

Implements: Write