Class GuiService

A major part of Socially Distant's core infrastructure, that manages everything to do with the user interface.

Inheritance
object
GameComponent
DrawableGameComponent
GuiService
Implements
IGameComponent
IUpdateable
IDrawable
Inherited Members
DrawableGameComponent.GraphicsDevice
DrawableGameComponent.DrawOrder
DrawableGameComponent.Visible
DrawableGameComponent.DrawOrderChanged
DrawableGameComponent.VisibleChanged
GameComponent.Dispose()
GameComponent.Enabled
GameComponent.UpdateOrder
GameComponent.EnabledChanged
GameComponent.UpdateOrderChanged
Namespace: SociallyDistant.Core.UI
Assembly: SociallyDistant.Framework.dll
Syntax
public sealed class GuiService : DrawableGameComponent, IGameComponent, IUpdateable, IDisposable, IDrawable, IGuiContext

Constructors

GuiService(IGameContext, IInspector, IWidgetTreeRenderer)

Creates a new instance of the GuiService class.

Declaration
public GuiService(IGameContext sociallyDistantContext, IInspector debugInspector, IWidgetTreeRenderer widgetTreeRenderer)
Parameters
Type Name Description
IGameContext sociallyDistantContext

Socially Distant's game context.
IInspector debugInspector

An implementation of IInspector to be used for GUI debugging.
IWidgetTreeRenderer widgetTreeRenderer

An implementation of IWidgetTreeRenderer used for debugging the widget tree.

Properties

CanvasHeight

Gets the height of the GUI canvas in GUI units.

Declaration
public int CanvasHeight { get; }
Property Value
Type Description
int

CanvasWidth

Gets the width of the GUI canvas in GUI units.

Declaration
public int CanvasWidth { get; }
Property Value
Type Description
int

Game

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

GuiRoot

Gets a reference to the underlying GuiManager of Ritchie's Toolbox.

Declaration
public GuiManager GuiRoot { get; }
Property Value
Type Description
GuiManager

PhysicalHeight

Gets a value indicating the physical height, in pixels, of the game window.

Declaration
public int PhysicalHeight { get; }
Property Value
Type Description
int

PhysicalWidth

Gets a value representing the physical width, in pixels, of the game window.

Declaration
public int PhysicalWidth { get; }
Property Value
Type Description
int

Methods

Draw(GameTime)

Declaration
public override void Draw(GameTime gameTime)
Parameters
Type Name Description
GameTime gameTime
Overrides
Microsoft.Xna.Framework.DrawableGameComponent.Draw(Microsoft.Xna.Framework.GameTime)

DrawClippingMesh(WidgetGeometry, RenderTarget2D, Texture2D?, Matrix, float)

Declaration
public void DrawClippingMesh(WidgetGeometry mesh, RenderTarget2D clipTarget, Texture2D? clipMaskTexture, Matrix transformMatrix, float opacity)
Parameters
Type Name Description
WidgetGeometry mesh
RenderTarget2D clipTarget
Texture2D clipMaskTexture
Matrix transformMatrix
float opacity

DrawMesh(WidgetGeometry, Texture2D?, Matrix, IEffect?, float)

Declaration
public void DrawMesh(WidgetGeometry mesh, Texture2D? clipMaskTexture, Matrix transformMatrix, IEffect? effectOverride, float opacity)
Parameters
Type Name Description
WidgetGeometry mesh
Texture2D clipMaskTexture
Matrix transformMatrix
IEffect effectOverride
float opacity

~GuiService()

Declaration
protected ~GuiService()

GetFallbackFont()

Declaration
public IFontFamily GetFallbackFont()
Returns
Type Description
IFontFamily

Grab(RenderTarget2D, Rectangle, Rectangle)

Renders the user interface to the given RenderTarget2D. Useful for certain widget rendering techniques such as background blurs.

Declaration
public void Grab(RenderTarget2D destination, Rectangle sourceArea, Rectangle destinationArea)
Parameters
Type Name Description
RenderTarget2D destination
Rectangle sourceArea
Rectangle destinationArea

Initialize()

Declaration
public override void Initialize()
Overrides
Microsoft.Xna.Framework.DrawableGameComponent.Initialize()

PrepareWidgetRender(VertexBuffer, LayoutRect?, IEffect?, float, Point)

Declaration
public void PrepareWidgetRender(VertexBuffer vertices, LayoutRect? clipRect = null, IEffect? effectOverride = null, float opacity = 1, Point positionOffset = default)
Parameters
Type Name Description
VertexBuffer vertices
LayoutRect? clipRect
IEffect effectOverride
float opacity
Point positionOffset

RefreshAllGeometry()

Forcibly invalidate all geometry caches and re-render the UI. This method will not immediately re-render the UI, but will post an event to the EventBus instructing the game to invalidate caches before rendering the next frame.

Declaration
public static void RefreshAllGeometry()

Render(VertexPositionColorTexture[], int[], Texture2D?, LayoutRect?)

Declaration
public void Render(VertexPositionColorTexture[] vertices, int[] indices, Texture2D? texture, LayoutRect? clipRect = null)
Parameters
Type Name Description
VertexPositionColorTexture[] vertices
int[] indices
Texture2D texture
LayoutRect? clipRect

RestoreRenderState()

Declaration
public void RestoreRenderState()

SetClipMaskDestination(RenderTarget2D?)

Declaration
public void SetClipMaskDestination(RenderTarget2D? clipMaskDestination)
Parameters
Type Name Description
RenderTarget2D clipMaskDestination

Update(GameTime)

Declaration
public override void Update(GameTime gameTime)
Parameters
Type Name Description
GameTime gameTime
Overrides
Microsoft.Xna.Framework.GameComponent.Update(Microsoft.Xna.Framework.GameTime)

Implements

Microsoft.Xna.Framework.IGameComponent
Microsoft.Xna.Framework.IUpdateable
Microsoft.Xna.Framework.IDrawable

Extension Methods