Class ViewportRubberBandSelector

Class for adding viewport rubber band selection.

System.Object
ViewportRubberBandSelector
Namespace: FlaxEngine.Gizmo
Assembly: FlaxEngine.CSharp.dll
Syntax
public sealed class ViewportRubberBandSelector : Object

Constructors

ViewportRubberBandSelector(IGizmoOwner)

Constructs a rubber band selector with a designated gizmo owner.

Declaration
public ViewportRubberBandSelector(IGizmoOwner owner)
Parameters
FlaxEditor.Gizmo.IGizmoOwner owner

The gizmo owner.

Methods

Draw()

Draws the ruber band during owner viewport UI drawing.

Declaration
public void Draw()

ReleaseRubberBandSelection()

Release the rubber band selection.

Declaration
public bool ReleaseRubberBandSelection()
Returns
System.Boolean

Returns true if rubber band is currently spanning

StopRubberBand()

Immediately stops the rubber band.

Declaration
public bool StopRubberBand()
Returns
System.Boolean

True if rubber band was active before stopping.

TryCreateRubberBand(Boolean, Float2)

Tries to create a rubber band selection.

Declaration
public void TryCreateRubberBand(bool canStart, Float2 mousePosition)
Parameters
System.Boolean canStart

Whether the creation can start.
Float2 mousePosition

The current mouse position.

TryStartingRubberBandSelection()

Triggers the start of a rubber band selection.

Declaration
public bool TryStartingRubberBandSelection()
Returns
System.Boolean

True if selection started, otherwise false.

Extension Methods