Class AClickableElementUI

Base class for any UI element in the scenario editor. It handles mouse events and selection.

Inheritance

object

CallbackEventHandler

Focusable

VisualElement

ABaseScenarioElementUI

AClickableElementUI

ABaseArcUI

AMovableElementUI

Inherited Members

ABaseScenarioElementUI.Position

Namespace: Xareus.Scenarios.Unity.Edition.UI

Assembly: Xareus.Scenarios.Unity.Edition.dll

Syntax

public abstract class AClickableElementUI : ABaseScenarioElementUI

Constructors

AClickableElementUI(CanvasUI)

Declaration

protected AClickableElementUI(CanvasUI canvas)

Parameters

Type	Name	Description
CanvasUI	canvas

Fields

canvas

Declaration

protected CanvasUI canvas

Field Value

Type	Description
CanvasUI

clickCount

Declaration

protected float clickCount

Field Value

Type	Description
float

Properties

Canvas

Declaration

public CanvasUI Canvas { get; }

Property Value

Type	Description
CanvasUI

Data

The data associated with this UI element. This can be null if the element is based on other elements' data.

Declaration

public abstract object Data { get; }

Property Value

Type	Description
object

IsSelected

Declaration

public bool IsSelected { get; set; }

Property Value

Type	Description
bool

Label

Declaration

public string Label { get; set; }

Property Value

Type	Description
string

Methods

DeleteUIElement()

Declaration

public abstract void DeleteUIElement()

DoDeleteGuiElement()

Declaration

protected void DoDeleteGuiElement()

DrawLabel()

Declaration

protected virtual void DrawLabel()

HandleOnDeselected()

Declaration

protected virtual void HandleOnDeselected()

HandleOnSelected()

Declaration

protected virtual void HandleOnSelected()

IsSelectedByElement(VisualElement)

Check if the movable element is selected by the given visual element. A movable element is selected if any part of the visual element overlaps with the movable element content rect

Declaration

public virtual bool IsSelectedByElement(VisualElement selectionElement)

Parameters

Type	Name	Description
VisualElement	selectionElement

Returns

Type	Description
bool

Exceptions

Type	Condition
ArgumentNullException

OnDoubleClick(AClickableElementUI)

Declaration

protected virtual void OnDoubleClick(AClickableElementUI args)

Parameters

Type	Name	Description
AClickableElementUI	args

OnGeometryChanged(GeometryChangedEvent)

Declaration

protected virtual void OnGeometryChanged(GeometryChangedEvent evt)

Parameters

Type	Name	Description
GeometryChangedEvent	evt

OnLabelGet()

Declaration

protected abstract string OnLabelGet()

Returns

Type	Description
string

OnLeftClick(ClickEvent)

Declaration

protected virtual void OnLeftClick(ClickEvent evt)

Parameters

Type	Name	Description
ClickEvent	evt

OnMouseDown(MouseDownEvent)

Declaration

protected virtual void OnMouseDown(MouseDownEvent evt)

Parameters

Type	Name	Description
MouseDownEvent	evt

OnMouseUp(MouseUpEvent)

Declaration

protected virtual void OnMouseUp(MouseUpEvent evt)

Parameters

Type	Name	Description
MouseUpEvent	evt

OnRightClick()

Declaration

protected virtual void OnRightClick()

OnSimpleClick()

Declaration

protected virtual void OnSimpleClick()

OpenContextMenu(ContextualMenuPopulateEvent)

Declaration

protected virtual void OpenContextMenu(ContextualMenuPopulateEvent evt)

Parameters

Type	Name	Description
ContextualMenuPopulateEvent	evt

SetLabel(string)

Declaration

protected abstract void SetLabel(string label)

Parameters

Type	Name	Description
string	label

UpdatePosition()

Declaration

protected virtual void UpdatePosition()

UpdateUI()

Declaration

public virtual void UpdateUI()

Events

Delete

Declaration

public event EventHandler<AClickableElementUI> Delete

Event Type

Type	Description
EventHandler<AClickableElementUI>

DoubleClick

Declaration

public event EventHandler<AClickableElementUI> DoubleClick

Event Type

Type	Description
EventHandler<AClickableElementUI>

RightClick

Declaration

public event EventHandler<AClickableElementUI> RightClick

Event Type

Type	Description
EventHandler<AClickableElementUI>

SimpleClick

Declaration

public event EventHandler<AClickableElementUI> SimpleClick

Event Type

Type	Description
EventHandler<AClickableElementUI>