Class LemonUI::Tools::SafeZone

ClassList > LemonUI > Tools > SafeZone

Tools for changing, resetting and retrieving the Safe Zone of the game.

Public Static Properties

Type	Name
property PointF	BottomLeft The bottom left corner after the safe zone.
property PointF	BottomRight The bottom right corner after the safe zone.
property float	Size The size of the safe zone.
property PointF	TopLeft The top left corner after the safe zone.
property PointF	TopRight The top right corner after the safe zone.

Public Static Functions

Type	Name
PointF	GetPositionAt (PointF position, Alignment horizontal, GFXAlignment vertical) Gets the specified position with the specified safe zone alignment.
PointF	GetPositionAt (PointF position, GFXAlignment horizontal, GFXAlignment vertical) Gets the specified position with the specified safe zone alignment.
PointF	GetSafePosition (PointF og) Converts the specified position into one that is aware of the safe zone.
PointF	GetSafePosition (float x, float y) Converts the specified position into one that is aware of SetAlignment(GFXAlignment, GFXAlignment).
void	ResetAlignment () Resets the alignment of the safe zone.
void	SetAlignment (Alignment horizontal, GFXAlignment vertical) Sets the alignment for the safe zone.
void	SetAlignment (GFXAlignment horizontal, GFXAlignment vertical) Sets the alignment for the safe zone.

Public Static Properties Documentation

property BottomLeft

PointF LemonUI.Tools.SafeZone.BottomLeft;

property BottomRight

PointF LemonUI.Tools.SafeZone.BottomRight;

property Size

The size of the safe zone.

float LemonUI.Tools.SafeZone.Size;

This property should not be used to manually calculate the safe zone. Use GetPositionAt(System.Drawing.PointF,LemonUI.GFXAlignment,LemonUI.GFXAlignment) to get the safe zone size.

property TopLeft

PointF LemonUI.Tools.SafeZone.TopLeft;

property TopRight

PointF LemonUI.Tools.SafeZone.TopRight;

Public Static Functions Documentation

function GetPositionAt [1/2]

Gets the specified position with the specified safe zone alignment.

static PointF LemonUI::Tools::SafeZone::GetPositionAt (
    PointF position,
    Alignment horizontal,
    GFXAlignment vertical
)

Parameters:

position The position to get.
horizontal The horizontal alignment.
vertical The vertical alignment.

Returns:

The safe zone alignment.

function GetPositionAt [2/2]

Gets the specified position with the specified safe zone alignment.

static inline PointF LemonUI::Tools::SafeZone::GetPositionAt (
    PointF position,
    GFXAlignment horizontal,
    GFXAlignment vertical
)

Parameters:

position The position to get.
horizontal The horizontal alignment.
vertical The vertical alignment.

Returns:

The scaled safe zone alignment.

function GetSafePosition [1/2]

Converts the specified position into one that is aware of the safe zone.

static PointF LemonUI::Tools::SafeZone::GetSafePosition (
    PointF og
)

Parameters:

og The original 1080p based position.

Returns:

A new 1080p based position that is aware of the the Alignment.

function GetSafePosition [2/2]

Converts the specified position into one that is aware of SetAlignment(GFXAlignment, GFXAlignment).

static inline PointF LemonUI::Tools::SafeZone::GetSafePosition (
    float x,
    float y
)

Parameters:

x The 1080p based X position.
y The 1080p based Y position.

Returns:

A new 1080p based position that is aware of the the Alignment.

function ResetAlignment

static inline void LemonUI::Tools::SafeZone::ResetAlignment ()

function SetAlignment [1/2]

Sets the alignment for the safe zone.

static void LemonUI::Tools::SafeZone::SetAlignment (
    Alignment horizontal,
    GFXAlignment vertical
)

Parameters:

horizontal The Horizontal alignment of the items.
vertical The vertical alignment of the items.

function SetAlignment [2/2]

Sets the alignment for the safe zone.

static inline void LemonUI::Tools::SafeZone::SetAlignment (
    GFXAlignment horizontal,
    GFXAlignment vertical
)

Parameters:

horizontal The Horizontal alignment of the items.
vertical The vertical alignment of the items.

The documentation for this class was generated from the following file repos/LemonUI/LemonUI/Tools/SafeZone.cs