Class GradientEditor.StopControl

The stop control type.

System.Object
Control
GradientEditor.StopControl
System.IComparable
Namespace: FlaxEditor.GUI.Timeline.GUI
Assembly: FlaxEngine.CSharp.dll
Syntax
public class StopControl : Control, IComparable, IDrawable

Constructors

StopControl()

Declaration
public StopControl()

Fields

Gradient

The gradient editor reference.

Declaration
public GradientEditor Gradient
Field Value
GradientEditor

Index

The gradient stop index.

Declaration
public int Index
Field Value
System.Int32

Methods

Draw()

Draw control

Declaration
public override void Draw()
Overrides

OnDestroy()

Method called when managed instance should be destroyed

Declaration
public override void OnDestroy()
Overrides

OnEndMouseCapture()

When mouse goes up/down not over the control but it has user focus so remove that focus from it (used by scroll bars, sliders etc.)

Declaration
public override void OnEndMouseCapture()
Overrides

OnMouseDoubleClick(Float2, MouseButton)

When mouse double clicks over control's area

Declaration
public override bool OnMouseDoubleClick(Float2 location, MouseButton button)
Parameters
Float2 location

Mouse location in Control Space
MouseButton button

Mouse buttons state (flags)
Returns
System.Boolean

True if event has been handled, otherwise false
Overrides

OnMouseDown(Float2, MouseButton)

When mouse goes down over control's area

Declaration
public override bool OnMouseDown(Float2 location, MouseButton button)
Parameters
Float2 location

Mouse location in Control Space
MouseButton button

Mouse buttons state (flags)
Returns
System.Boolean

True if event has been handled, otherwise false
Overrides

OnMouseMove(Float2)

When mouse moves over control's area

Declaration
public override void OnMouseMove(Float2 location)
Parameters
Float2 location

Mouse location in Control Space
Overrides

OnMouseUp(Float2, MouseButton)

When mouse goes up over control's area

Declaration
public override bool OnMouseUp(Float2 location, MouseButton button)
Parameters
Float2 location

Mouse location in Control Space
MouseButton button

Mouse buttons state (flags)
Returns
System.Boolean

True if event has been handled, otherwise false
Overrides

OnShowTooltip(out String, out Float2, out Rectangle)

Called when tooltip wants to be shown. Allows modifying its appearance.

Declaration
public override bool OnShowTooltip(out string text, out Float2 location, out Rectangle area)
Parameters
System.String text

The tooltip text to show.
Float2 location

The popup start location (in this control local space).
Rectangle area

The allowed area of mouse movement to show tooltip (in this control local space).
Returns
System.Boolean

True if can show tooltip, otherwise false to skip.
Overrides

OnTestTooltipOverControl(ref Float2)

Called when tooltip is visible and tests if the given mouse location (in control space) is valid (is over the content).

Declaration
public override bool OnTestTooltipOverControl(ref Float2 location)
Parameters
Float2 location

The location.
Returns
System.Boolean

True if tooltip can be still visible, otherwise false.
Overrides

Extension Methods

See Also