Class GuiManager

Inheritance

object

GuiManager

Implements

IFontFamilyProvider

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Ritchie.Toolbox

Assembly: Ritchie.Toolbox.dll

Syntax

public sealed class GuiManager : IFontFamilyProvider

Constructors

GuiManager(IGuiContext, IVisualStyle?)

Declaration

public GuiManager(IGuiContext context, IVisualStyle? globalStyle = null)

Parameters

Type	Name	Description
IGuiContext	context
IVisualStyle	globalStyle

Properties

Current

Declaration

public static GuiManager? Current { get; }

Property Value

Type	Description
GuiManager

GuiScale

Declaration

public Vector2 GuiScale { get; }

Property Value

Type	Description
Vector2

IsRendering

Declaration

public bool IsRendering { get; }

Property Value

Type	Description
bool

ReferenceHeight

Declaration

public int ReferenceHeight { get; set; }

Property Value

Type	Description
int

ReferenceWidth

Declaration

public int ReferenceWidth { get; set; }

Property Value

Type	Description
int

ScaleMode

Declaration

public GuiScaleMode ScaleMode { get; set; }

Property Value

Type	Description
GuiScaleMode

ScreenHeight

Declaration

public int ScreenHeight { get; }

Property Value

Type	Description
int

ScreenWidth

Declaration

public int ScreenWidth { get; }

Property Value

Type	Description
int

TopLevels

Declaration

public IOrderedCollection<Widget> TopLevels { get; }

Property Value

Type	Description
IOrderedCollection<Widget>

ViewportScaleRatio

Declaration

public float ViewportScaleRatio { get; set; }

Property Value

Type	Description
float

Methods

FindWidget(Point, bool, bool)

Find a widget under the specified position on the canvas.

Declaration

public Widget? FindWidget(Point position, bool includeDisabled = false, bool includeHidden = false)

Parameters

Type	Name	Description
Point	position	The position, in canvas units, to find a widget under.
bool	includeDisabled	Whether or not disabled widgets should be counted.
bool	includeHidden	Whether or not visyally-hidden widgets should be counted.

Returns

Type	Description
Widget	An instance of Widget representing the found widget, or null if none was found.

FindWidget<T>(Point, bool, bool)

Find a widget of the specified type under the specified position on the canvas.

Declaration

public T? FindWidget<T>(Point position, bool includeDisabled = false, bool includeHidden = false)

Parameters

Type	Name	Description
Point	position	The position, in canvas units, to find a widget under.
bool	includeDisabled	Whether or not disabled widgets should be counted.
bool	includeHidden	Whether or not visyally-hidden widgets should be counted.

Returns

Type	Description
T	An instance of T representing the found widget, or null if none was found.

Type Parameters

Name	Description
T	The type of widget to find, or an interface it should implement.

GetFont(PresetFontFamily)

Declaration

public IFontFamily GetFont(PresetFontFamily family)

Parameters

Type	Name	Description
PresetFontFamily	family

Returns

Type	Description
IFontFamily

GetVisualStyle()

Declaration

[Obsolete("Please use the new StyleManager API instead.")]
public IVisualStyle GetVisualStyle()

Returns

Type	Description
IVisualStyle

InvalidateAllGeometry()

Invalidates the geometry of all interface elements recursively. Use this when changing a global UI setting that affects how all widgets render. Note: This is expensive. That should be obvious. So do not call it every frame.

Declaration

public void InvalidateAllGeometry()

IsFocused(Widget)

Declaration

public bool IsFocused(Widget widget)

Parameters

Type	Name	Description
Widget	widget

Returns

Type	Description
bool

Render()

Declaration

public void Render()

SendCharacter(Keys, char)

Declaration

public void SendCharacter(Keys key, char character)

Parameters

Type	Name	Description
Keys	key
char	character

SendKey(Keys, ButtonState)

Declaration

public void SendKey(Keys key, ButtonState state)

Parameters

Type	Name	Description
Keys	key
ButtonState	state

SendMouseButton(MouseButtonEventArgs)

Declaration

public void SendMouseButton(MouseButtonEventArgs e)

Parameters

Type	Name	Description
MouseButtonEventArgs	e

SetFocusedWidget(Widget?)

Declaration

public void SetFocusedWidget(Widget? widgetToFocus)

Parameters

Type	Name	Description
Widget	widgetToFocus

SetMouseState(MouseState)

Declaration

public void SetMouseState(MouseState state)

Parameters

Type	Name	Description
MouseState	state

Update(float)

Declaration

public void Update(float deltaTime)

Parameters

Type	Name	Description
float	deltaTime

UpdateLayout()

Declaration

public void UpdateLayout()

Events

MouseClicked

Declaration

public event Action<MouseButtonEvent>? MouseClicked

Event Type

Type	Description
Action<MouseButtonEvent>

MouseDown

Declaration

public event Action<MouseButtonEvent>? MouseDown

Event Type

Type	Description
Action<MouseButtonEvent>

MouseUp

Declaration

public event Action<MouseButtonEvent>? MouseUp

Event Type

Type	Description
Action<MouseButtonEvent>

Implements

IFontFamilyProvider