Class Basis

Class defining a basis in three-dimensional euclidean space.

Inheritance

Object

Basis

Namespace: BRIDGES.Geometry.Euclidean3D

Assembly: BRIDGES.dll

Syntax

public class Basis : IEquatable<Basis>

Remarks

For a basis placed at an origin Point, refer to Frame.

Constructors

Basis(Basis)

Initialises a new instance of the Basis class from another Basis.

Declaration

public Basis(Basis basis)

Parameters

Type	Name	Description
Basis	basis	Basis to copy.

Remarks

For a basis placed at an origin Point, refer to Frame.

Basis(Vector, Vector, Vector)

Initialises a new instance of the Basis class by defining its three linearly independent axes.

Declaration

public Basis(Vector xAxis, Vector yAxis, Vector zAxis)

Parameters

Type	Name	Description
Vector	xAxis	First axis of the Basis.
Vector	yAxis	Second axis of the Basis.
Vector	zAxis	Third axis of the Basis.

Remarks

For a basis placed at an origin Point, refer to Frame.

Basis(Vector[])

Initialises a new instance of the Basis class by defining its axes.

Declaration

public Basis(Vector[] axes)

Parameters

Type	Name	Description
Vector[]	axes	Set of axes.

Remarks

For a basis placed at an origin Point, refer to Frame.

Properties

Dimension

Gets the number of axes of the current Basis.

Declaration

public int Dimension { get; }

Property Value

Type	Description
Int32

Remarks

For a basis placed at an origin Point, refer to Frame.

Item[Int32]

Gets the axis of the current Basis at the given index.

Declaration

public Vector this[int index] { get; }

Parameters

Type	Name	Description
Int32	index	Index of the axis to retrieve.

Property Value

Type	Description
Vector	The axis at the given index.

Remarks

For a basis placed at an origin Point, refer to Frame.

XAxis

Gets the first axis of the current Basis.

Declaration

public Vector XAxis { get; }

Property Value

Type	Description
Vector

Remarks

For a basis placed at an origin Point, refer to Frame.

YAxis

Gets the second axis of the current Basis.

Declaration

public Vector YAxis { get; }

Property Value

Type	Description
Vector

Remarks

For a basis placed at an origin Point, refer to Frame.

ZAxis

Gets the third axis of the current Basis.

Declaration

public Vector ZAxis { get; }

Property Value

Type	Description
Vector

Remarks

For a basis placed at an origin Point, refer to Frame.

Methods

Equals(Basis)

Evaluates whether the current Basis is equal to another Basis.

Declaration

public bool Equals(Basis other)

Parameters

Type	Name	Description
Basis	other	Basis to compare with.

Returns

Type	Description
Boolean	true if the two Basis are equal, false otherwise.

Remarks

Two Basis are equal if their corresponding Vector axes are equal.

Equals(Object)

Class defining a basis in three-dimensional euclidean space.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Remarks

For a basis placed at an origin Point, refer to Frame.

GetHashCode()

Class defining a basis in three-dimensional euclidean space.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Remarks

For a basis placed at an origin Point, refer to Frame.

IsOrthogonal(Basis)

Evaluates whether a the axis of a basis are orthogonal to one another.

Declaration

public static bool IsOrthogonal(Basis basis)

Parameters

Type	Name	Description
Basis	basis	Basis to evaluate.

Returns

Type	Description
Boolean	true if the axes are orthogonal, false otherwise.

Remarks

For a basis placed at an origin Point, refer to Frame.

ToString()

Class defining a basis in three-dimensional euclidean space.

Declaration

public override string ToString()

Returns

Type	Description
String

Remarks

For a basis placed at an origin Point, refer to Frame.