Class Frame

Class defining a frame in three-dimensional euclidean space.

Inheritance

Frame

Namespace: BRIDGES.Geometry.Euclidean3D

Assembly: BRIDGES.dll

Syntax

public class Frame : IEquatable<Frame>

Remarks

For an ordered set of linearly independent Vector without an origin, refer to Basis.

Constructors

| Improve this Doc View Source

Frame(Frame)

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

Declaration

public Frame(Frame frame)

Parameters

Type	Name	Description
Frame	frame	Frame to copy.

Remarks

For an ordered set of linearly independent Vector without an origin, refer to Basis.

| Improve this Doc View Source

Frame(Point, Vector, Vector, Vector)

Initialises a new instance of the Frame class by defining its origin and three linearly independent axes.

Declaration

public Frame(Point origin, Vector xAxis, Vector yAxis, Vector zAxis)

Parameters

Type	Name	Description
Point	origin	Origin Point of the Frame.
Vector	xAxis	First Vector axis of the Frame.
Vector	yAxis	Second Vector axis of the Frame.
Vector	zAxis	Third Vector axis of the Frame.

Remarks

For an ordered set of linearly independent Vector without an origin, refer to Basis.

| Improve this Doc View Source

Frame(Point, Vector[])

Initialises a new instance of the Frame class by defining its origin and axes.

Declaration

public Frame(Point origin, Vector[] axes)

Parameters

Type	Name	Description
Point	origin	Origin Point.
Vector[]	axes	Vector axes.

Remarks

For an ordered set of linearly independent Vector without an origin, refer to Basis.

Properties

| Improve this Doc View Source

Dimension

Gets the number of axes of the current Frame.

Declaration

public int Dimension { get; }

Property Value

Type	Description
Int32

Remarks

For an ordered set of linearly independent Vector without an origin, refer to Basis.

| Improve this Doc View Source

Item[Int32]

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

Declaration

public Vector this[int index] { get; }

Parameters

Type	Name	Description
Int32	index	Zero-based index of the axis to retrieve.

Property Value

Type	Description
Vector	The axis at the given index.

Remarks

For an ordered set of linearly independent Vector without an origin, refer to Basis.

| Improve this Doc View Source

Origin

Gets or sets the origin Point of the current Frame.

Declaration

public Point Origin { get; set; }

Property Value

Type	Description
Point

Remarks

For an ordered set of linearly independent Vector without an origin, refer to Basis.

| Improve this Doc View Source

XAxis

Gets the first axis of the current Frame.

Declaration

public Vector XAxis { get; }

Property Value

Type	Description
Vector

Remarks

For an ordered set of linearly independent Vector without an origin, refer to Basis.

| Improve this Doc View Source

YAxis

Gets the second axis of the current Frame.

Declaration

public Vector YAxis { get; }

Property Value

Type	Description
Vector

Remarks

For an ordered set of linearly independent Vector without an origin, refer to Basis.

| Improve this Doc View Source

ZAxis

Gets the third axis of the current Frame.

Declaration

public Vector ZAxis { get; }

Property Value

Type	Description
Vector

Remarks

For an ordered set of linearly independent Vector without an origin, refer to Basis.

Methods

| Improve this Doc View Source

Equals(Frame)

Evaluates whether the current Frame is equal to another Frame.

Declaration

public bool Equals(Frame other)

Parameters

Type	Name	Description
Frame	other	Frame to compare with.

Returns

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

Remarks

Two Frame are equal if their origin Point and their corresponding Vector axes are equal.

| Improve this Doc View Source

Equals(Object)

Class defining a frame in three-dimensional euclidean space.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Remarks

For an ordered set of linearly independent Vector without an origin, refer to Basis.

| Improve this Doc View Source

GetHashCode()

Class defining a frame in three-dimensional euclidean space.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Remarks

For an ordered set of linearly independent Vector without an origin, refer to Basis.

| Improve this Doc View Source

IsOrthogonal(Frame)

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

Declaration

public static bool IsOrthogonal(Frame frame)

Parameters

Type	Name	Description
Frame	frame	Frame to evaluate.

Returns

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

Remarks

For an ordered set of linearly independent Vector without an origin, refer to Basis.

| Improve this Doc View Source

ToString()

Class defining a frame in three-dimensional euclidean space.

Declaration

public override string ToString()

Returns

Type	Description
String

Remarks

For an ordered set of linearly independent Vector without an origin, refer to Basis.