Struct Frame3D

Represents a geometric 3D frame.

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 Frame3D

Remarks

This structure is available since v7.6.

Constructors

Frame3D(Point3D, Direction3D, Direction3D, Direction3D)

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

Declaration

public Frame3D(Point3D inOrigin, Direction3D inXDirection, Direction3D inYDirection, Direction3D inZDirection)

Parameters

Type	Name	Description
Point3D	inOrigin	Frame origin.
Direction3D	inXDirection	Frame X direction.
Direction3D	inYDirection	Frame Y direction, orthogonal to inXDirection.
Direction3D	inZDirection	Frame Z direction, equal to inXDirection ^ inYDirection.

Fields

Origin

Frame origin.

Declaration

public Point3D Origin

Field Value

Type	Description
Point3D

OXYZ

(O,+X,+Y,+Z) absolute frame.

Declaration

public static readonly Frame3D OXYZ

Field Value

Type	Description
Frame3D

XDirection

Frame X direction.

Declaration

public Direction3D XDirection

Field Value

Type	Description
Direction3D

YDirection

Frame Y direction, orthogonal to XDirection.

Declaration

public Direction3D YDirection

Field Value

Type	Description
Direction3D

ZDirection

Frame Z direction, equal to XDirection ^ YDirection.

Declaration

public Direction3D ZDirection

Field Value

Type	Description
Direction3D

Methods

ToAbsolute(Axis3D)

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

Declaration

public Axis3D ToAbsolute(Axis3D inAxis)

Parameters

Type	Name	Description
Axis3D	inAxis	Axis with coordinates expressed in this frame.

Returns

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

ToAbsolute(Direction3D)

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

Declaration

public Direction3D ToAbsolute(Direction3D inDirection)

Parameters

Type	Name	Description
Direction3D	inDirection	Direction with coordinates expressed in this frame.

Returns

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

ToAbsolute(Frame3D)

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

Declaration

public Frame3D ToAbsolute(Frame3D inFrame)

Parameters

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

Returns

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

ToAbsolute(Plane3D)

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

Declaration

public Plane3D ToAbsolute(Plane3D inPlane)

Parameters

Type	Name	Description
Plane3D	inPlane	Plane with coordinates expressed in this frame.

Returns

Type	Description
Plane3D	Plane with coordinates expressed in the absolute frame.

ToAbsolute(Point3D)

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

Declaration

public Point3D ToAbsolute(Point3D inPoint)

Parameters

Type	Name	Description
Point3D	inPoint	Point with coordinates expressed in this frame.

Returns

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

ToAbsolute(Vector3D)

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

Declaration

public Vector3D ToAbsolute(Vector3D inVector)

Parameters

Type	Name	Description
Vector3D	inVector	Vector with coordinates expressed in this frame.

Returns

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

ToRelative(Axis3D)

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

Declaration

public Axis3D ToRelative(Axis3D inAxis)

Parameters

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

Returns

Type	Description
Axis3D	Axis with coordinates expressed in this frame.

ToRelative(Direction3D)

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

Declaration

public Direction3D ToRelative(Direction3D inDirection)

Parameters

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

Returns

Type	Description
Direction3D	Direction with coordinates expressed in this frame.

ToRelative(Frame3D)

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

Declaration

public Frame3D ToRelative(Frame3D inFrame)

Parameters

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

Returns

Type	Description
Frame3D	Frame with coordinates expressed in this frame.

ToRelative(Plane3D)

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

Declaration

public Plane3D ToRelative(Plane3D inPlane)

Parameters

Type	Name	Description
Plane3D	inPlane	Plane with coordinates expressed in the absolute frame.

Returns

Type	Description
Plane3D	Plane with coordinates expressed in this frame.

ToRelative(Point3D)

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

Declaration

public Point3D ToRelative(Point3D inPoint)

Parameters

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

Returns

Type	Description
Point3D	Point with coordinates expressed in this frame.

ToRelative(Vector3D)

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

Declaration

public Vector3D ToRelative(Vector3D inVector)

Parameters

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

Returns

Type	Description
Vector3D	Vector with coordinates expressed in this frame.