Struct Frame2D

Represents a geometric 2D 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 Frame2D

Remarks

This structure is available since v7.6.

Constructors

Frame2D(Point2D, Direction2D, Direction2D)

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

Declaration

public Frame2D(Point2D inOrigin, Direction2D inXDirection, Direction2D inYDirection)

Parameters

Type	Name	Description
Point2D	inOrigin	Frame origin.
Direction2D	inXDirection	Frame X direction.
Direction2D	inYDirection	Frame Y direction, orthogonal to inXDirection.

Fields

Origin

Frame origin.

Declaration

public Point2D Origin

Field Value

Type	Description
Point2D

OXY

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

Declaration

public static readonly Frame2D OXY

Field Value

Type	Description
Frame2D

XDirection

Frame X direction.

Declaration

public Direction2D XDirection

Field Value

Type	Description
Direction2D

YDirection

Frame Y direction, orthogonal to XDirection.

Declaration

public Direction2D YDirection

Field Value

Type	Description
Direction2D

Methods

ToAbsolute(Axis2D)

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

Declaration

public Axis2D ToAbsolute(Axis2D inAxis)

Parameters

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

Returns

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

ToAbsolute(Direction2D)

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

Declaration

public Direction2D ToAbsolute(Direction2D inDirection)

Parameters

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

Returns

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

ToAbsolute(Frame2D)

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

Declaration

public Frame2D ToAbsolute(Frame2D inFrame)

Parameters

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

Returns

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

ToAbsolute(Point2D)

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

Declaration

public Point2D ToAbsolute(Point2D inPoint)

Parameters

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

Returns

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

ToAbsolute(Vector2D)

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

Declaration

public Vector2D ToAbsolute(Vector2D inVector)

Parameters

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

Returns

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

ToRelative(Axis2D)

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

Declaration

public Axis2D ToRelative(Axis2D inAxis)

Parameters

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

Returns

Type	Description
Axis2D	Axis with coordinates expressed in this frame.

ToRelative(Direction2D)

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

Declaration

public Direction2D ToRelative(Direction2D inDirection)

Parameters

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

Returns

Type	Description
Direction2D	Direction with coordinates expressed in this frame.

ToRelative(Frame2D)

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

Declaration

public Frame2D ToRelative(Frame2D inFrame)

Parameters

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

Returns

Type	Description
Frame2D	Frame with coordinates expressed in this frame.

ToRelative(Point2D)

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

Declaration

public Point2D ToRelative(Point2D inPoint)

Parameters

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

Returns

Type	Description
Point2D	Point with coordinates expressed in this frame.

ToRelative(Vector2D)

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

Declaration

public Vector2D ToRelative(Vector2D inVector)

Parameters

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

Returns

Type	Description
Vector2D	Vector with coordinates expressed in this frame.