Table of Contents

Struct ColliderTransform

Namespace
Vintagestory.API.Common
Assembly
VintagestoryAPI.dll

An immutable rigid transform for collider-local geometry.

public readonly struct ColliderTransform : IEquatable<ColliderTransform>
Implements
Inherited Members
Extension Methods

Constructors

ColliderTransform(double, double, double)

public ColliderTransform(double x, double y, double z)

Parameters

x double
y double
z double

ColliderTransform(double, double, double, double, double, double, double)

public ColliderTransform(double x, double y, double z, double quaternionX, double quaternionY, double quaternionZ, double quaternionW)

Parameters

x double
y double
z double
quaternionX double
quaternionY double
quaternionZ double
quaternionW double

ColliderTransform(EntityPos)

public ColliderTransform(EntityPos position)

Parameters

position EntityPos

ColliderTransform(EntityPos, double[])

public ColliderTransform(EntityPos position, double[] quaternion)

Parameters

position EntityPos
quaternion double[]

Properties

IsValid

Whether this transform contains a finite position and a nonzero finite quaternion.

public bool IsValid { get; }

Property Value

bool

QuaternionW

public double QuaternionW { get; }

Property Value

double

QuaternionX

public double QuaternionX { get; }

Property Value

double

QuaternionY

public double QuaternionY { get; }

Property Value

double

QuaternionZ

public double QuaternionZ { get; }

Property Value

double

X

public double X { get; }

Property Value

double

Y

public double Y { get; }

Property Value

double

Z

public double Z { get; }

Property Value

double

Methods

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.

Equals(ColliderTransform)

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

public bool Equals(ColliderTransform other)

Parameters

other ColliderTransform

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; 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.

GetRotationQuaternion()

Returns the normalized rotation quaternion as a new array.

public double[] GetRotationQuaternion()

Returns

double[]

InverseTransformDirection(double, double, double, out double, out double, out double)

Rotates a dimension-local world direction into collider-local coordinates.

public void InverseTransformDirection(double x, double y, double z, out double localX, out double localY, out double localZ)

Parameters

x double
y double
z double
localX double
localY double
localZ double

InverseTransformDirection(FastVec3d, out FastVec3d)

public void InverseTransformDirection(FastVec3d direction, out FastVec3d localDirection)

Parameters

direction FastVec3d
localDirection FastVec3d

InverseTransformDirection(Vec3d, Vec3d)

public void InverseTransformDirection(Vec3d direction, Vec3d localDirection)

Parameters

direction Vec3d
localDirection Vec3d

InverseTransformPoint(double, double, double, out double, out double, out double)

Transforms a dimension-local world point into collider-local coordinates.

public void InverseTransformPoint(double x, double y, double z, out double localX, out double localY, out double localZ)

Parameters

x double
y double
z double
localX double
localY double
localZ double

InverseTransformPoint(double, double, double, out FastVec3d)

public void InverseTransformPoint(double x, double y, double z, out FastVec3d localPoint)

Parameters

x double
y double
z double
localPoint FastVec3d

InverseTransformPoint(FastVec3d, out double, out double, out double)

public void InverseTransformPoint(FastVec3d point, out double localX, out double localY, out double localZ)

Parameters

point FastVec3d
localX double
localY double
localZ double

InverseTransformPoint(FastVec3d, out FastVec3d)

public void InverseTransformPoint(FastVec3d point, out FastVec3d localPoint)

Parameters

point FastVec3d
localPoint FastVec3d

InverseTransformPoint(Vec3d, Vec3d)

public void InverseTransformPoint(Vec3d point, Vec3d localPoint)

Parameters

point Vec3d
localPoint Vec3d

TransformDirection(double, double, double, out double, out double, out double)

Rotates a collider-local direction into dimension-local world coordinates.

public void TransformDirection(double x, double y, double z, out double worldX, out double worldY, out double worldZ)

Parameters

x double
y double
z double
worldX double
worldY double
worldZ double

TransformDirection(FastVec3d, out FastVec3d)

public void TransformDirection(FastVec3d direction, out FastVec3d worldDirection)

Parameters

direction FastVec3d
worldDirection FastVec3d

TransformDirection(Vec3d, Vec3d)

public void TransformDirection(Vec3d direction, Vec3d worldDirection)

Parameters

direction Vec3d
worldDirection Vec3d

TransformPoint(double, double, double, out double, out double, out double)

Transforms a collider-local point into dimension-local world coordinates.

public void TransformPoint(double x, double y, double z, out double worldX, out double worldY, out double worldZ)

Parameters

x double
y double
z double
worldX double
worldY double
worldZ double

TransformPoint(double, double, double, out FastVec3d)

public void TransformPoint(double x, double y, double z, out FastVec3d worldPoint)

Parameters

x double
y double
z double
worldPoint FastVec3d

TransformPoint(FastVec3d, out double, out double, out double)

public void TransformPoint(FastVec3d point, out double worldX, out double worldY, out double worldZ)

Parameters

point FastVec3d
worldX double
worldY double
worldZ double

TransformPoint(FastVec3d, out FastVec3d)

public void TransformPoint(FastVec3d point, out FastVec3d worldPoint)

Parameters

point FastVec3d
worldPoint FastVec3d

TransformPoint(Vec3d, Vec3d)

public void TransformPoint(Vec3d point, Vec3d worldPoint)

Parameters

point Vec3d
worldPoint Vec3d