Art provider base class which holds common elements such as Padding, Highlight colour etc... More...

Inheritance diagram for VerticesEngine.UI.vxArtProviderBase:

Public Member Functions
virtual SpriteFont	GetFont ()

	vxArtProviderBase ()
	Initializes a new instance of the T:VerticesEngine.UI.vxArtProviderBase class.

virtual void	SetBounds ()
	Many sizes and positions are set based off of screensize, although this can change if a user changes the resolution settings. Therefore, this SetBounds() method will be where the sizes will be set.

Public Attributes
Vector4	Margin
	Gets or sets the margin.

Vector2	Padding
	Gets or sets the padding.

float	Alpha
	The alpha transparency value.

bool	UseSpriteSheet = false
	This controls whether or not the control should be drawn using regions of the GUI Sprite Sheet.

Rectangle	SpriteSheetRegion
	The sprite sheet region.

Rectangle	TitleSpriteSheetRegion = new Rectangle(0, 0, 4, 4)
	The title sprite sheet region.

Texture2D	BackgroundImage
	Gets or sets the background image.

bool	DrawBackgroungImage
	Gets or sets a value indicating whether this VerticesEngine.UI.Themes.vxMenuItemArtProvider draw backgroung image.

int	BorderWidth
	Gets or sets the width of the border.

bool	DoBorder
	Gets or sets a value indicating whether this VerticesEngine.UI.vxArtProviderBase do border.

int	DefaultWidth
	Gets or sets the default width.

int	DefaultHeight
	The default height.

vxUIControlTheme	Theme
	The colour theme for this specific Art Provider.

Properties
GraphicsDevice	GraphicsDevice `[get]`
	Gets the graphics device.

Viewport	Viewport `[get]`
	Gets the viewport.

vxSpriteBatch	SpriteBatch `[get]`
	Gets the sprite batch.

float	Opacity `[get, set]`
	Gets or sets the opacity of the current GUI Item.

SpriteFont	Font `[get]`
	Text Of GUI Item.

Texture2D	DefaultTexture `[get]`
	Gets the default texture.

Detailed Description

Art provider base class which holds common elements such as Padding, Highlight colour etc...

Constructor & Destructor Documentation

◆ vxArtProviderBase()

VerticesEngine.UI.vxArtProviderBase.vxArtProviderBase ( )

Initializes a new instance of the T:VerticesEngine.UI.vxArtProviderBase class.

Parameters

Engine Engine.

Member Function Documentation

◆ SetBounds()

virtual void VerticesEngine.UI.vxArtProviderBase.SetBounds ( )

virtual

Many sizes and positions are set based off of screensize, although this can change if a user changes the resolution settings. Therefore, this SetBounds() method will be where the sizes will be set.

Reimplemented in VerticesEngine.UI.Themes.vxDialogArtProvider.

Member Data Documentation

◆ BackgroundImage

Texture2D VerticesEngine.UI.vxArtProviderBase.BackgroundImage

Gets or sets the background image.

The background image.

◆ BorderWidth

int VerticesEngine.UI.vxArtProviderBase.BorderWidth

Gets or sets the width of the border.

The width of the border.

◆ DefaultWidth

int VerticesEngine.UI.vxArtProviderBase.DefaultWidth

Gets or sets the default width.

The default width.

◆ DoBorder

bool VerticesEngine.UI.vxArtProviderBase.DoBorder

Gets or sets a value indicating whether this VerticesEngine.UI.vxArtProviderBase do border.

true if do border; otherwise, false.

◆ DrawBackgroungImage

bool VerticesEngine.UI.vxArtProviderBase.DrawBackgroungImage

Gets or sets a value indicating whether this VerticesEngine.UI.Themes.vxMenuItemArtProvider draw backgroung image.

true if draw backgroung image; otherwise, false.

◆ Margin

Vector4 VerticesEngine.UI.vxArtProviderBase.Margin

Gets or sets the margin.

The margin.

◆ Padding

Vector2 VerticesEngine.UI.vxArtProviderBase.Padding

Gets or sets the padding.

The padding.

Property Documentation

◆ DefaultTexture

Texture2D VerticesEngine.UI.vxArtProviderBase.DefaultTexture

get

Gets the default texture.

The default texture.

◆ GraphicsDevice

GraphicsDevice VerticesEngine.UI.vxArtProviderBase.GraphicsDevice

get

Gets the graphics device.

The graphics device.

◆ Opacity

float VerticesEngine.UI.vxArtProviderBase.Opacity

getset

Gets or sets the opacity of the current GUI Item.

The opacity.

◆ SpriteBatch

vxSpriteBatch VerticesEngine.UI.vxArtProviderBase.SpriteBatch

get

Gets the sprite batch.

The sprite batch.

◆ Viewport

Viewport VerticesEngine.UI.vxArtProviderBase.Viewport

get

Gets the viewport.

The viewport.

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

/github/workspace/src/VerticesEngine/src.shared/UI/Art Providers/vxArtProviderBase.cs

Public Member Functions

Public Attributes

Properties