Struct Position

Namespace

Gloam.Core.Primitives

Assembly

Gloam.Core.dll

Represents a position in 2D space with both discrete grid coordinates and continuous offsets for smooth movement.

public readonly struct Position : IEquatable<Position>

Implements

IEquatable<Position>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

Position(int, int, float, float)

public Position(int x, int y, float offsetX = 0, float offsetY = 0)

Parameters

x int

y int

offsetX float

offsetY float

Position(Vector2)

public Position(Vector2 vector)

Parameters

vector Vector2

Properties

OffsetX

public float OffsetX { get; }

Property Value

float

OffsetY

public float OffsetY { get; }

Property Value

float

TotalX

public float TotalX { get; }

Property Value

float

TotalY

public float TotalY { get; }

Property Value

float

X

public int X { get; }

Property Value

int

Y

public int Y { get; }

Property Value

int

Methods

AsVector2()

public Vector2 AsVector2()

Returns

Vector2

Equals(Position)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(Position other)

Parameters

other Position

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

Move(int, int)

public Position Move(int deltaX, int deltaY)

Parameters

deltaX int

deltaY int

Returns

Position

Move(Vector2)

public Position Move(Vector2 delta)

Parameters

delta Vector2

Returns

Position

Move(float, float)

public Position Move(float deltaX, float deltaY)

Parameters

deltaX float

deltaY float

Returns

Position

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.

WithGridPosition(int, int)

public Position WithGridPosition(int x, int y)

Parameters

x int

y int

Returns

Position

WithOffset(float, float)

public Position WithOffset(float offsetX, float offsetY)

Parameters

offsetX float

offsetY float

Returns

Position

Operators

operator +(Position, Vector2)

public static Position operator +(Position position, Vector2 vector)

Parameters

position Position

vector Vector2

Returns

Position

operator ==(Position, Position)

public static bool operator ==(Position left, Position right)

Parameters

left Position

right Position

Returns

bool

implicit operator Vector2(Position)

public static implicit operator Vector2(Position position)

Parameters

position Position

Returns

Vector2

implicit operator Position(Vector2)

public static implicit operator Position(Vector2 vector)

Parameters

vector Vector2

Returns

Position

operator !=(Position, Position)

public static bool operator !=(Position left, Position right)

Parameters

left Position

right Position

Returns

bool

operator -(Position, Position)

public static Vector2 operator -(Position a, Position b)

Parameters

a Position

b Position

Returns

Vector2

operator -(Position, Vector2)

public static Position operator -(Position position, Vector2 vector)

Parameters

position Position

vector Vector2

Returns

Position