Struct NiPoint3

Namespace

SkyrimForge.Game

Assembly

SkyrimForge.dll

A three-float position or vector, matching the game's NiPoint3.

public readonly struct NiPoint3 : IEquatable<NiPoint3>

Implements

IEquatable<NiPoint3>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

NiPoint3(float, float, float)

A three-float position or vector, matching the game's NiPoint3.

public NiPoint3(float X, float Y, float Z)

Parameters

X float

Y float

Z float

Properties

X

public float X { get; init; }

Property Value

float

Y

public float Y { get; init; }

Property Value

float

Z

public float Z { get; init; }

Property Value

float

Methods

Deconstruct(out float, out float, out float)

public void Deconstruct(out float X, out float Y, out float Z)

Parameters

X float

Y float

Z float

Equals(NiPoint3)

public bool Equals(NiPoint3 other)

Parameters

other NiPoint3

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetCompassDirection(NiPoint3)

Gets the compass direction nearest the bearing from this point to other, with +Y as north and +X as east.

public CompassDirection GetCompassDirection(NiPoint3 other)

Parameters

other NiPoint3

Returns

CompassDirection

The direction, which is north for a point directly above or below this one.

GetDistance(NiPoint3)

Gets the distance to other.

public float GetDistance(NiPoint3 other)

Parameters

other NiPoint3

The other point.

Returns

float

The Euclidean distance, in game units.

GetHashCode()

public override int GetHashCode()

Returns

int

GetHorizontalDistance(NiPoint3)

Gets the distance to other across the X and Y axes, in game units.

public float GetHorizontalDistance(NiPoint3 other)

Parameters

other NiPoint3

Returns

float

GetHorizontalDistanceToSegment(NiPoint3, NiPoint3)

Gets the distance across the X and Y axes to the nearest point of the segment from start to end, in game units.

public float GetHorizontalDistanceToSegment(NiPoint3 start, NiPoint3 end)

Parameters

start NiPoint3

end NiPoint3

Returns

float

ToString()

public override string ToString()

Returns

string

Operators

operator ==(NiPoint3, NiPoint3)

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

Parameters

left NiPoint3

right NiPoint3

Returns

bool

operator !=(NiPoint3, NiPoint3)

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

Parameters

left NiPoint3

right NiPoint3

Returns

bool