Class LayerUI
Contains graphical objects for a scenario Layer (i.e. a ComplexSequence)
Events : The layer subscribes to the events of the UI elements it contains. theses are mostly transmitted to the canvas directly
Inheritance
Focusable
LayerUI
Assembly: Xareus.Scenarios.Unity.Edition.dll
Syntax
public class LayerUI : Layer
Constructors
LayerUI(CanvasUI, string)
Declaration
public LayerUI(CanvasUI canvas, string complexSequenceId)
Parameters
Properties
Canvas
Declaration
public CanvasUI Canvas { get; }
Property Value
ComplexSequenceId
Declaration
public string ComplexSequenceId { get; }
Property Value
ComplexSequencePathId
Declaration
public string ComplexSequencePathId { get; }
Property Value
ElementsUI
Declaration
public IEnumerable<AClickableElementUI> ElementsUI { get; }
Property Value
MovableElements
Declaration
public IEnumerable<AMovableElementUI> MovableElements { get; }
Property Value
Sequence
Declaration
public ComplexSequence Sequence { get; }
Property Value
Methods
AddArc(SequenceUI, TransitionUI)
Declaration
public void AddArc(SequenceUI sourceNodeUI, TransitionUI destinationNodeUI)
Parameters
AddArc(TransitionUI, SequenceUI)
Declaration
public void AddArc(TransitionUI sourceNodeUI, SequenceUI destinationNodeUI)
Parameters
Declaration
public void AddCommentUI(CommentUI commentUI)
Parameters
AddSectionUI(SectionUI)
Declaration
public void AddSectionUI(SectionUI sectionUI)
Parameters
AddSequenceUI(SequenceUI)
Adds a graphical element corresponding to a logical sequence into the graphical structure
Declaration
public void AddSequenceUI(SequenceUI sequenceUI)
Parameters
AddTransitionUI(TransitionUI)
Adds a graphical element corresponding to a logical transition into the graphical structure
Declaration
public void AddTransitionUI(TransitionUI uiTransition)
Parameters
BuildScenarioUI(bool)
Loads all Layers from SEVEN Datas
Declaration
protected void BuildScenarioUI(bool reload = false)
Parameters
| Type |
Name |
Description |
| bool |
reload |
|
ContainsArc(string, string, bool)
Returns true if the sequence contains an arc corresponding to given constraints
Declaration
public bool ContainsArc(string seqId, string trId, bool isSequenceToTransition)
Parameters
Returns
GetArcUI(string, string, bool)
Declaration
public ArcUI GetArcUI(string trId, string seqId, bool isSequenceToTransition)
Parameters
Returns
Fetches an element using his id. Returns null if there is no corresponding element.
Declaration
public CommentUI GetCommentUI(string commentId)
Parameters
| Type |
Name |
Description |
| string |
commentId |
|
Returns
GetElementsUIInside(VisualElement)
Gets the UI Elements in the given element
Declaration
public IEnumerable<AClickableElementUI> GetElementsUIInside(VisualElement selectionElement)
Parameters
Returns
GetMovableElementUI(string)
Declaration
public AMovableElementUI GetMovableElementUI(string elementId)
Parameters
| Type |
Name |
Description |
| string |
elementId |
|
Returns
GetNodesFromIdentifiable(IEnumerable<Identifiable>)
Gets the nodes corresponding to the given identifiables
Declaration
public IEnumerable<NodeUI> GetNodesFromIdentifiable(IEnumerable<Identifiable> identifiables)
Parameters
Returns
GetSectionUI(string)
Fetches an element using his id. Returns null if there is no corresponding element.
Declaration
public SectionUI GetSectionUI(string sectionId)
Parameters
| Type |
Name |
Description |
| string |
sectionId |
|
Returns
GetSequenceUI(string)
Fetches an element using his id. Returns null if there is no corresponding element.
Declaration
public SequenceUI GetSequenceUI(string nodeId)
Parameters
| Type |
Name |
Description |
| string |
nodeId |
|
Returns
GetTransitionUI(string)
Fetches an element using his id. Returns null if there is no corresponding element.
Declaration
public TransitionUI GetTransitionUI(string nodeId)
Parameters
| Type |
Name |
Description |
| string |
nodeId |
|
Returns
HasVisibleNode()
Checks if the rect contains at least one of the nodes.
The rect must be expressed within business coordinates.
Declaration
public bool HasVisibleNode()
Returns
Declaration
public void OpenContextMenu(ContextualMenuPopulateEvent evt)
Parameters
Reload()
Declaration
RemoveArcUI(ArcUI)
Declaration
public bool RemoveArcUI(ArcUI arcUI)
Parameters
| Type |
Name |
Description |
| ArcUI |
arcUI |
|
Returns
Declaration
public bool RemoveCommentUI(string commentId)
Parameters
| Type |
Name |
Description |
| string |
commentId |
|
Returns
RemoveMovableElementUI(AMovableElementUI)
Declaration
public bool RemoveMovableElementUI(AMovableElementUI movableElementUI)
Parameters
Returns
RemoveSEArc(string, string, bool)
Declaration
public bool RemoveSEArc(string idTransition, string idSequence, bool isSourceSequence)
Parameters
| Type |
Name |
Description |
| string |
idTransition |
|
| string |
idSequence |
|
| bool |
isSourceSequence |
|
Returns
RemoveSectionUI(string)
Declaration
public bool RemoveSectionUI(string sectionId)
Parameters
| Type |
Name |
Description |
| string |
sectionId |
|
Returns
RemoveSequenceUI(string)
Declaration
public bool RemoveSequenceUI(string idSeq)
Parameters
| Type |
Name |
Description |
| string |
idSeq |
|
Returns
RemoveTransitionUI(string)
Declaration
public bool RemoveTransitionUI(string transitionID)
Parameters
| Type |
Name |
Description |
| string |
transitionID |
|
Returns
SubscribeToSECanvas(CanvasUI)
Subscribes the canvas to a list of events from the UI Sequence
Declaration
public void SubscribeToSECanvas(CanvasUI canvas)
Parameters
UpdateUI(bool)
Declaration
public void UpdateUI(bool updateElementsUI = false)
Parameters
| Type |
Name |
Description |
| bool |
updateElementsUI |
|
Zoom(float, Vector2)
Declaration
public void Zoom(float newZoom, Vector2 zoomPosition)
Parameters
Events
ElementUIDelete
Signal emitted when a UI Element wants to be deleted
Declaration
public event EventHandler<AClickableElementUI> ElementUIDelete
Event Type
ElementUIDoubleClick
Signal emitted when a UI Element has been clicked twice
Declaration
public event EventHandler<AClickableElementUI> ElementUIDoubleClick
Event Type
ElementUIRightClick
Signal emitted when a UI Element has been right clicked
Declaration
public event EventHandler<AClickableElementUI> ElementUIRightClick
Event Type
ElementUISimpleClick
Signal emitted when a UI Element has been clicked once
Declaration
public event EventHandler<AClickableElementUI> ElementUISimpleClick
Event Type
MovableElementEndMove
Signal emitted when a Movable Element has been moved
Declaration
public event EventHandler<AMovableElementUI.MovableElementUIMoved> MovableElementEndMove
Event Type
MovableElementMoved
Signal emitted when a Movable Element is being moved
Declaration
public event EventHandler<AMovableElementUI.MovableElementUIMoved> MovableElementMoved
Event Type
MovableElementStartMove
Signal emitted when a Movable Element is move is starting
Declaration
public event EventHandler<AMovableElementUI.MovableElementUIMoved> MovableElementStartMove
Event Type