Class SectionUI

This class is responsible of sections within the UI. A section allows the user to delimit part of the scenario for readability

Inheritance
object
CallbackEventHandler
Focusable
VisualElement
ABaseScenarioElementUI
AClickableElementUI
AMovableElementUI
SectionUI
Inherited Members
Namespace: Xareus.Scenarios.Unity.Edition.UI
Assembly: Xareus.Scenarios.Unity.Edition.dll
Syntax
public class SectionUI : AMovableElementUI

Constructors

SectionUI(CanvasUI, Section)

Declaration
public SectionUI(CanvasUI canvas, Section section)
Parameters
Type Name Description
CanvasUI canvas
Section section

Properties

Data

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

Declaration
public override object Data { get; }
Property Value
Type Description
object
Overrides

Id

Id. Cannot be modified after initialization

Declaration
public override string Id { get; }
Property Value
Type Description
string
Overrides

Position

Position in the business space

Declaration
public override Vector2 Position { get; set; }
Property Value
Type Description
Vector2
Overrides

Section

Business object

Declaration
public Section Section { get; }
Property Value
Type Description
Section

Methods

DeleteUIElement()

Declaration
public override void DeleteUIElement()
Overrides

IsSelectedByElement(VisualElement)

Check if the section is selected by the given element. Sections are selected if all the sections bounds are inside the element.

Declaration
public override bool IsSelectedByElement(VisualElement selectionElement)
Parameters
Type Name Description
VisualElement selectionElement
Returns
Type Description
bool
Overrides
Exceptions
Type Condition
ArgumentNullException

OnLabelGet()

Declaration
protected override string OnLabelGet()
Returns
Type Description
string
Overrides

OnMouseDown(MouseDownEvent)

Declaration
protected override void OnMouseDown(MouseDownEvent evt)
Parameters
Type Name Description
MouseDownEvent evt
Overrides

OnMouseDownResize(MouseDownEvent)

Declaration
protected void OnMouseDownResize(MouseDownEvent evt)
Parameters
Type Name Description
MouseDownEvent evt

OnMouseMoveResize(MouseMoveEvent)

Declaration
protected void OnMouseMoveResize(MouseMoveEvent evt)
Parameters
Type Name Description
MouseMoveEvent evt

OnMouseUp(MouseUpEvent)

Declaration
protected override void OnMouseUp(MouseUpEvent evt)
Parameters
Type Name Description
MouseUpEvent evt
Overrides

OnMouseUpResize(MouseUpEvent)

Declaration
protected void OnMouseUpResize(MouseUpEvent evt)
Parameters
Type Name Description
MouseUpEvent evt

OpenContextMenu(ContextualMenuPopulateEvent)

Declaration
protected override void OpenContextMenu(ContextualMenuPopulateEvent evt)
Parameters
Type Name Description
ContextualMenuPopulateEvent evt
Overrides

SetLabel(string)

Emits a label changed command. Is triggered when the comment label is changed.

Declaration
protected override void SetLabel(string label)
Parameters
Type Name Description
string label
Overrides

UpdatePosition()

Declaration
protected override void UpdatePosition()
Overrides