Class MinimapSquare

Source of bounds for a minimap or minimap object.

Inheritance

Object

MinimapSquare

Implements

IMinimapShape

Namespace: nickmaltbie.MinimapTools.Minimap.Shape

Assembly: cs.temp.dll.dll

Syntax

public class MinimapSquare : IMinimapShape

Constructors

MinimapSquare(Vector3, Vector3, Quaternion)

Create a minimap square with a given configuration.

Declaration

public MinimapSquare(Vector3 center, Vector3 size, Quaternion rotation)

Parameters

Type	Name	Description
Vector3	center	Center of the object in world space.
Vector3	size	Size of the object in world space.
Quaternion	rotation	Rotation of the object in 3D space for the plane.

Fields

center

Center of the object in minimap space.

Declaration

public Vector3 center

Field Value

Type	Description
Vector3

lockAspectRatio

Should the aspect ratio of the size be locked.

Declaration

public bool lockAspectRatio

Field Value

Type	Description
Boolean

rotation

Rotation of the object about the vertical axis.

Declaration

public Quaternion rotation

Field Value

Type	Description
Quaternion

size

Size of the object in world space.

Declaration

public Vector2 size

Field Value

Type	Description
Vector2

Properties

Center

Get the center of this minimap shape in world space.

Declaration

public Vector3 Center { get; }

Property Value

Type	Description
Vector3	Position of the object in world space.

Size

Get the size of this minimap object in world space.

Declaration

public Vector2 Size { get; }

Property Value

Type	Description
Vector2	2D size of the object in world space (only xz axis).

Methods

ConvertToMinimapPlane(Vector3)

Get the position of an element from world space to minimap space.

Declaration

public Vector2 ConvertToMinimapPlane(Vector3 worldSpace)

Parameters

Type	Name	Description
Vector3	worldSpace	Position in world space.

Returns

Type	Description
Vector2	Position in minimap space.

GetWorldSpaceCorners(Nullable<Vector3>)

Get the corners of the minimap in world space.

Declaration

public Vector3[] GetWorldSpaceCorners(Vector3? offset)

Parameters

Type	Name	Description
Nullable<Vector3>	offset	Offset from center in world space.

Returns

Type	Description
Vector3[]	Four corners of the minimap as vector 3 in world space.

MapAxisHoriz()

Direction of the axis horizontal along the minimap plane.

Declaration

public Vector3 MapAxisHoriz()

Returns

Type	Description
Vector3	Horizontal directional vector.

MapAxisVert()

Direction of the vertical axis along the minimap plane.

Declaration

public Vector3 MapAxisVert()

Returns

Type	Description
Vector3	Vertical direction vector.

MapNormal()

Get the normal vector for the plane of this minimap.

Declaration

public Vector3 MapNormal()

Returns

Type	Description
Vector3	Vector normal to the minimap plane.

Implements

IMinimapShape