Class Plane

Class defining a plane in three-dimensional euclidean space.

Inheritance

Object

Plane

Implements

IGeometricallyEquatable<Plane>

Namespace: BRIDGES.Geometry.Euclidean3D

Assembly: BRIDGES.dll

Syntax

public sealed class Plane : IEquatable<Plane>, IGeometricallyEquatable<Plane>

Constructors

| Improve this Doc View Source

Plane()

Initialises a new instance of the Plane class.

Declaration

public Plane()

| Improve this Doc View Source

Plane(Plane)

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

Declaration

public Plane(Plane plane)

Parameters

Type	Name	Description
Plane	plane	Plane to copy.

| Improve this Doc View Source

Plane(Point, Vector, Vector, Vector)

Initialises a new instance of the Plane class by defining its origin, two linearly independent in-plane Vector and a normal Vector orthogonal to the previous ones.

Declaration

public Plane(Point origin, Vector uAxis, Vector vAxis, Vector normal)

Parameters

Type	Name	Description
Point	origin	Origin Point of the Plane.
Vector	uAxis	First Vector in-plane axis of the Plane.
Vector	vAxis	Second Vector in-plane axis of the Plane.
Vector	normal	Normal Vector of the Plane.

| Improve this Doc View Source

Plane(Point, Vector, Vector)

Initialises a new instance of the Plane class by defining its origin and two linearly independent in-plane Vector.

Declaration

public Plane(Point origin, Vector uAxis, Vector vAxis)

Parameters

Type	Name	Description
Point	origin	Origin Point of the Plane.
Vector	uAxis	First Vector in-plane axis of the Plane.
Vector	vAxis	Second Vector in-plane axis of the Plane.

| Improve this Doc View Source

Plane(Point, Vector)

Initialises a new instance of the Plane class by defining its origin and normal vector.

Declaration

public Plane(Point origin, Vector normal)

Parameters

Type	Name	Description
Point	origin	Origin Point of the Plane.
Vector	normal	Normal Vector of the Plane.

Properties

| Improve this Doc View Source

Normal

Gets or sets the normal axis of the current Plane.

Declaration

public Vector Normal { get; set; }

Property Value

Type	Description
Vector

Remarks

Checks and eventual updates are performed to ensure that the in-plane axis are not parallel and that the normal vector is orthogonal to them.

| Improve this Doc View Source

Origin

Gets the origin of the current Plane.

Declaration

public Point Origin { get; set; }

Property Value

Type	Description
Point

| Improve this Doc View Source

UAxis

Gets or sets the u-axis, the first in-plane axis of the current Plane.

Declaration

public Vector UAxis { get; set; }

Property Value

Type	Description
Vector

Remarks

Checks and eventual updates are performed to ensure that the in-plane axis are not parallel and that the normal vector is orthogonal to them.

| Improve this Doc View Source

VAxis

Gets or sets the v-axis, the second in-plane axis of the current Plane.

Declaration

public Vector VAxis { get; set; }

Property Value

Type	Description
Vector

Remarks

Checks and eventual updates are performed to ensure that the in-plane axis are not parallel and that the normal vector is orthogonal to them.

| Improve this Doc View Source

WorldXY

Gets the Plane centered in (0.0, 0.0, 0.0) with WorldZ as its normal axis.

Declaration

public static Plane WorldXY { get; }

Property Value

Type	Description
Plane

| Improve this Doc View Source

WorldYZ

Gets the Plane centered in (0.0, 0.0, 0.0) with WorldX as its normal axis.

Declaration

public static Plane WorldYZ { get; }

Property Value

Type	Description
Plane

| Improve this Doc View Source

WorldZX

Gets the Plane centered in (0.0, 0.0, 0.0) with WorldY as its normal axis.

Declaration

public static Plane WorldZX { get; }

Property Value

Type	Description
Plane

Methods

| Improve this Doc View Source

ClosestPoint(Point)

Computes the orthogonal projection of the given Point on the current Plane.

Declaration

public Point ClosestPoint(Point point)

Parameters

Type	Name	Description
Point	point	Point to project.

Returns

Type	Description
Point	The closest Point on the Plane.

| Improve this Doc View Source

Equals(Plane)

Evaluates whether the current Plane is memberwise equal to another Plane.

Declaration

public bool Equals(Plane other)

Parameters

Type	Name	Description
Plane	other	Plane to compare with.

Returns

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

| Improve this Doc View Source

Equals(Object)

Class defining a plane in three-dimensional euclidean space.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

| Improve this Doc View Source

GeometricallyEquals(Plane)

Evaluates whether the current object is geometrically equal to the given T.

Declaration

public bool GeometricallyEquals(Plane other)

Parameters

Type	Name	Description
Plane	other

Returns

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

| Improve this Doc View Source

GetHashCode()

Class defining a plane in three-dimensional euclidean space.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

| Improve this Doc View Source

ToString()

Class defining a plane in three-dimensional euclidean space.

Declaration

public override string ToString()

Returns

Type	Description
String

Implements

IGeometricallyEquatable<T>