Class SafeZone

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

Inheritance

object

SafeZone

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: LemonUI.Tools

Assembly: LemonUI.SHVDN3.dll

Syntax

public static class SafeZone

Properties

BottomLeft

The bottom left corner after the safe zone.

Declaration

public static PointF BottomLeft { get; }

Property Value

Type	Description
PointF

BottomRight

The bottom right corner after the safe zone.

Declaration

public static PointF BottomRight { get; }

Property Value

Type	Description
PointF

Size

The size of the safe zone.

Declaration

public static float Size { get; }

Property Value

Type	Description
float

Remarks

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

TopLeft

The top left corner after the safe zone.

Declaration

public static PointF TopLeft { get; }

Property Value

Type	Description
PointF

TopRight

The top right corner after the safe zone.

Declaration

public static PointF TopRight { get; }

Property Value

Type	Description
PointF

Methods

GetPositionAt(PointF, Alignment, GFXAlignment)

Gets the specified position with the specified safe zone alignment.

Declaration

public static PointF GetPositionAt(PointF position, Alignment horizontal, GFXAlignment vertical)

Parameters

Type	Name	Description
PointF	position	The position to get.
Alignment	horizontal	The horizontal alignment.
GFXAlignment	vertical	The vertical alignment.

Returns

Type	Description
PointF	The safe zone alignment.

GetPositionAt(PointF, Alignment, GFXAlignment)

Gets the specified position with the specified safe zone alignment.

Declaration

public static PointF GetPositionAt(PointF position, Alignment horizontal, GFXAlignment vertical)

Parameters

Type	Name	Description
PointF	position	The position to get.
Alignment	horizontal	The horizontal alignment.
GFXAlignment	vertical	The vertical alignment.

Returns

Type	Description
PointF	The safe zone alignment.

GetPositionAt(PointF, Alignment, GFXAlignment)

Gets the specified position with the specified safe zone alignment.

Declaration

public static PointF GetPositionAt(PointF position, Alignment horizontal, GFXAlignment vertical)

Parameters

Type	Name	Description
PointF	position	The position to get.
Alignment	horizontal	The horizontal alignment.
GFXAlignment	vertical	The vertical alignment.

Returns

Type	Description
PointF	The safe zone alignment.

GetPositionAt(PointF, GFXAlignment, GFXAlignment)

Gets the specified position with the specified safe zone alignment.

Declaration

public static PointF GetPositionAt(PointF position, GFXAlignment horizontal, GFXAlignment vertical)

Parameters

Type	Name	Description
PointF	position	The position to get.
GFXAlignment	horizontal	The horizontal alignment.
GFXAlignment	vertical	The vertical alignment.

Returns

Type	Description
PointF	The scaled safe zone alignment.

GetPositionAt(PointF, Alignment, GFXAlignment)

Gets the specified position with the specified safe zone alignment.

Declaration

public static PointF GetPositionAt(PointF position, Alignment horizontal, GFXAlignment vertical)

Parameters

Type	Name	Description
PointF	position	The position to get.
Alignment	horizontal	The horizontal alignment.
GFXAlignment	vertical	The vertical alignment.

Returns

Type	Description
PointF	The safe zone alignment.

GetSafePosition(PointF)

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

Declaration

public static PointF GetSafePosition(PointF og)

Parameters

Type	Name	Description
PointF	og	The original 1080p based position.

Returns

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

GetSafePosition(float, float)

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

Declaration

public static PointF GetSafePosition(float x, float y)

Parameters

Type	Name	Description
float	x	The 1080p based X position.
float	y	The 1080p based Y position.

Returns

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

ResetAlignment()

Resets the alignment of the safe zone.

Declaration

public static void ResetAlignment()

SetAlignment(Alignment, GFXAlignment)

Sets the alignment for the safe zone.

Declaration

public static void SetAlignment(Alignment horizontal, GFXAlignment vertical)

Parameters

Type	Name	Description
Alignment	horizontal	The Horizontal alignment of the items.
GFXAlignment	vertical	The vertical alignment of the items.

SetAlignment(Alignment, GFXAlignment)

Sets the alignment for the safe zone.

Declaration

public static void SetAlignment(Alignment horizontal, GFXAlignment vertical)

Parameters

Type	Name	Description
Alignment	horizontal	The Horizontal alignment of the items.
GFXAlignment	vertical	The vertical alignment of the items.

SetAlignment(Alignment, GFXAlignment)

Sets the alignment for the safe zone.

Declaration

public static void SetAlignment(Alignment horizontal, GFXAlignment vertical)

Parameters

Type	Name	Description
Alignment	horizontal	The Horizontal alignment of the items.
GFXAlignment	vertical	The vertical alignment of the items.

SetAlignment(GFXAlignment, GFXAlignment)

Sets the alignment for the safe zone.

Declaration

public static void SetAlignment(GFXAlignment horizontal, GFXAlignment vertical)

Parameters

Type	Name	Description
GFXAlignment	horizontal	The Horizontal alignment of the items.
GFXAlignment	vertical	The vertical alignment of the items.

SetAlignment(Alignment, GFXAlignment)

Sets the alignment for the safe zone.

Declaration

public static void SetAlignment(Alignment horizontal, GFXAlignment vertical)

Parameters

Type	Name	Description
Alignment	horizontal	The Horizontal alignment of the items.
GFXAlignment	vertical	The vertical alignment of the items.