Otter  0.9.88
2d Game Development Framework based on SFML.Net
 All Classes Namespaces Functions Variables Enumerations Properties
Otter.UI.UIElement Class Reference

OTTER UI IS NOT SUPPORTED YET. ACTIVELY IN DEVELOPMENT, USE AT YOUR OWN RISK! Core UI element. All other UI elements extend this. Currently very early work in progress. More...

Inherited by Otter.UI.UIMenu.

Public Member Functions

void Highlight ()
 
void Dim ()
 
void Summon ()
 
void Dismiss ()
 
void Trigger ()
 
void Cancel ()
 
Graphic AddGraphic (Graphic g)
 
List< GraphicAddGraphics (params Graphic[] graphics)
 
AddElement< T > (T uielement)
 
List< UIElementAddElements (params UIElement[] uielements)
 
RemoveElement< T > (T uielement)
 
virtual void Triggered ()
 
virtual void Canceled ()
 
virtual void Highlighted ()
 
virtual void Dimmed ()
 
virtual void Enabled ()
 
virtual void Disabled ()
 
virtual void Dismissed ()
 
virtual void Summoned ()
 
virtual void Activated ()
 
virtual void Deactivated ()
 
virtual void Enable ()
 
virtual void Disable ()
 
virtual void Update ()
 
virtual void HandleInput (UIManager manager)
 Handle input from a manager if this element is active. More...
 
virtual void Render ()
 

Public Attributes

int InputStartUp = 0
 How many frames to wait before accepting input. Use this to prevent accidental double inputs. More...
 
List< UIElementElements = new List<UIElement>()
 
bool Visible = true
 
bool UseMouse = false
 
Action OnTrigger
 
int Width = 0
 
bool InheritHighlight = false
 

Properties

UIManager Manager [get, set]
 
UIElement Parent [get, set]
 
virtual float X [get, set]
 
virtual float Y [get, set]
 
int UIDepth [get, set]
 
bool IsEnabled [get, set]
 

Detailed Description

OTTER UI IS NOT SUPPORTED YET. ACTIVELY IN DEVELOPMENT, USE AT YOUR OWN RISK! Core UI element. All other UI elements extend this. Currently very early work in progress.

Member Function Documentation

virtual void Otter.UI.UIElement.HandleInput ( UIManager  manager)
virtual

Handle input from a manager if this element is active.

Parameters
manager

Reimplemented in Otter.UI.UIInputMenu, Otter.UI.UIListMenu, Otter.UI.UIGridMenu, and Otter.UI.UIValueMenu.

Member Data Documentation

int Otter.UI.UIElement.InputStartUp = 0

How many frames to wait before accepting input. Use this to prevent accidental double inputs.

Action Otter.UI.UIElement.OnTrigger
Initial value:
= () => { },
OnHighlight = () => { },
OnDim = () => { },
OnUpdate = () => { },
OnEnable = () => { },
OnDisable = () => { },
OnDismiss = () => { },
OnSummon = () => { },
OnCancel = () => { },
OnActivate = () => { },
OnDeactivate = () => { }

The documentation for this class was generated from the following file: