Struct Plane3D

Represents a geometric 3D plane.

Inherited Members

System.ValueType.Equals(System.Object)

System.ValueType.GetHashCode()

System.ValueType.ToString()

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

Namespace: TopSolid.Kernel.Automating

Assembly: cs.temp.dll.dll

Syntax

[AvailableSinceVersion(7, 6, 0, 0)]
public struct Plane3D

Remarks

This structure is available since v7.6.

Constructors

Plane3D(Point3D, Direction3D, Direction3D)

Initializes a new instance of the Plane3D structure with a specified origin and directions.

Declaration

public Plane3D(Point3D inOrigin, Direction3D inXDirection, Direction3D inYDirection)

Parameters

Type	Name	Description
Point3D	inOrigin	Plane origin.
Direction3D	inXDirection	Plane X direction.
Direction3D	inYDirection	Plane Y direction, orthogonal to inXDirection.

Fields

Origin

Plane origin.

Declaration

public Point3D Origin

Field Value

Type	Description
Point3D

OXY

(O,+X,+Y) absolute plane.

Declaration

public static readonly Plane3D OXY

Field Value

Type	Description
Plane3D

OXZ

(O,+X,+Z) absolute plane.

Declaration

public static readonly Plane3D OXZ

Field Value

Type	Description
Plane3D

OYX

(O,+Y,+X) absolute plane.

Declaration

public static readonly Plane3D OYX

Field Value

Type	Description
Plane3D

OYZ

(O,+Y,+Z) absolute plane.

Declaration

public static readonly Plane3D OYZ

Field Value

Type	Description
Plane3D

OZX

(O,+Z,+X) absolute plane.

Declaration

public static readonly Plane3D OZX

Field Value

Type	Description
Plane3D

OZY

(O,+Z,+Y) absolute plane.

Declaration

public static readonly Plane3D OZY

Field Value

Type	Description
Plane3D

XDirection

Plane X direction.

Declaration

public Direction3D XDirection

Field Value

Type	Description
Direction3D

YDirection

Plane Y direction, orthogonal to XDirection.

Declaration

public Direction3D YDirection

Field Value

Type	Description
Direction3D

Properties

Normal

Gets the plane normal direction.

Declaration

public readonly Direction3D Normal { get; }

Property Value

Type	Description
Direction3D

Remarks

The plane normal direction is equal to the cross product of the plane X and Y directions.

Methods

ToAbsolute(Axis2D)

Converts an axis with coordinates expressed in this plane into the same axis with coordinates expressed in the absolute frame.

Declaration

public Axis3D ToAbsolute(Axis2D inAxis)

Parameters

Type	Name	Description
Axis2D	inAxis	Axis with coordinates expressed in this plane.

Returns

Type	Description
Axis3D	Axis with coordinates expressed in the absolute frame.

ToAbsolute(Direction2D)

Converts a direction with coordinates expressed in this plane into the same direction with coordinates expressed in the absolute frame.

Declaration

public Direction3D ToAbsolute(Direction2D inDirection)

Parameters

Type	Name	Description
Direction2D	inDirection	Direction with coordinates expressed in this plane.

Returns

Type	Description
Direction3D	Direction with coordinates expressed in the absolute frame.

ToAbsolute(Frame2D)

Converts a frame with coordinates expressed in this plane into the same frame with coordinates expressed in the absolute frame.

Declaration

public Frame3D ToAbsolute(Frame2D inFrame)

Parameters

Type	Name	Description
Frame2D	inFrame	Frame with coordinates expressed in this frame.

Returns

Type	Description
Frame3D	Frame with coordinates expressed in the absolute frame.

ToAbsolute(Point2D)

Converts a point with coordinates expressed in this plane into the same point with coordinates expressed in the absolute frame.

Declaration

public Point3D ToAbsolute(Point2D inPoint)

Parameters

Type	Name	Description
Point2D	inPoint	Point with coordinates expressed in this plane.

Returns

Type	Description
Point3D	Point with coordinates expressed in the absolute frame.

ToAbsolute(Vector2D)

Converts a vector with coordinates expressed in this plane into the same vector with coordinates expressed in the absolute frame.

Declaration

public Vector3D ToAbsolute(Vector2D inVector)

Parameters

Type	Name	Description
Vector2D	inVector	Vector with coordinates expressed in this plane.

Returns

Type	Description
Vector3D	Vector with coordinates expressed in the absolute frame.