Method FrameOf

Namespace

GeometryHelper.Core

Assembly

GeometryHelper.dll

FrameOf(GeoPolygon3)

Gets the frame of a polygon: its plane, with the origin at the first vertex and the first axis along the first edge that has a direction, so the frame turns with the polygon.

public static GeoCoordinateSystem3 FrameOf(GeoPolygon3 polygon)

Parameters

polygon GeoPolygon3

The polygon.

Returns

GeoCoordinateSystem3

The frame, with its Z axis along the polygon normal.

Exceptions

ArgumentNullException

Thrown when the polygon is null.

FrameOf(GeoFace3)

Gets the frame of a face: the frame of its boundary, so its holes are laid out with it.

public static GeoCoordinateSystem3 FrameOf(GeoFace3 face)

Parameters

face GeoFace3

The face.

Returns

GeoCoordinateSystem3

The frame, with its Z axis along the face normal.

Exceptions

ArgumentNullException

Thrown when the face is null.

FrameOf(GeoPlane3)

Gets a frame of a plane, with the origin at the plane origin and the axes the plane itself fixes.

public static GeoCoordinateSystem3 FrameOf(GeoPlane3 plane)

Parameters

plane GeoPlane3

The plane.

Returns

GeoCoordinateSystem3

The frame, with its Z axis along the plane normal.

Remarks

A plane does not say which way its first axis runs, so this frame does not turn with any shape lying in it. It is what to use when several shapes have to share one set of local coordinates.