[mxcad_3d API Document](../README. md)/Mx3dGeCSYSR

Class: Mx3dGeCSYSR

The class representing the right-handed coordinate system.

Hierarchy

• Mx3dGeObject

  ↳ Mx3dGeCSYSR

Table of contents

Constructors

• constructor

Methods

• Angle
• Axis
• Direction
• IsCoplanarWithAxis
• IsCoplanarWithCSYSR
• Location
• MirrorByAxis
• MirrorByCSYSR
• MirrorByPoint
• MirroredByAxis
• MirroredByCSYSR
• MirroredByPoint
• Rotate
• Rotated
• Scale
• Scaled
• SetDirection
• SetLocation
• SetXDirection
• SetYDirection
• Transform
• Transformed
• TranslateBy2Points
• TranslateByVec
• TranslatedBy2Points
• TranslatedByVec
• XDirection
• YDirection

Constructors

constructor

• new Mx3dGeCSYSR()

Create a default right-handed coordinate system object.

Overrides

Mx3dGeObject.constructor

• new Mx3dGeCSYSR(origin, z_axis, x_vec)

Create a right-handed coordinate system object using the origin, Z-axis direction, and X-axis vector.

Parameters

Name	Type	Description
Origin	[Mx3dGePoint] (Mx3dGePoint. md)	The origin of the coordinate system
The Z-axis direction of the coordinate system is Mx3dGeDir (Mx3dGeDir. md)
The X-axis vector of the coordinate system [Mx3dGeDir] (Mx3dGeDir. md)

Overrides

Mx3dGeObject.constructor

• new Mx3dGeCSYSR(origin, z_axis)

Create a right-handed coordinate system object using the origin and Z-axis direction, with the X and Y directions automatically determined.

Parameters

Name	Type	Description
Origin	[Mx3dGePoint] (Mx3dGePoint. md)	The origin of the coordinate system
The Z-axis direction of the coordinate system is Mx3dGeDir (Mx3dGeDir. md)

Overrides

Mx3dGeObject.constructor

Methods

Angle

▸ Angle(theOther): number

Calculate the angle with another right-handed coordinate system.

Parameters

Name	Type	Description
theOther	[Mx3dGeCSYSR] (Mx3dGeCSYSR. md)	Another right-handed coordinate system

Returns

number

The angle between two coordinate systems.

---

Axis

▸ Axis(): Mx3dGeAxis

Obtain the axis of the right-hand coordinate system.

Returns

Mx3dGeAxis

The axis of the right-hand coordinate system.

---

Direction

▸ Direction(): Mx3dGeDir

Obtain the Z-axis direction of the right-hand coordinate system.

Returns

Mx3dGeDir

Z-axis direction.

---

IsCoplanarWithAxis

▸ IsCoplanarWithAxis(A1, LinearTolerance, AngularTolerance): boolean

Determine whether the right-hand coordinate system is coplanar with an axis.

Parameters

Name	Type	Description
A1	[Mx3dGeAxis] (Mx3dGeAxis. md)	Axis object
LinearTolerance	number	Linear tolerance
AngularTolerance	number	Angle tolerance

Returns

boolean

Is it coplanar.

---

IsCoplanarWithCSYSR

▸ IsCoplanarWithCSYSR(Other, LinearTolerance, AngularTolerance): boolean

Determine whether the right-handed coordinate system is coplanar with another right-handed coordinate system.

Parameters

Name	Type	Description
Other	[Mx3dGeCSYSR] (Mx3dGeCSYSR. md)	Another right-handed coordinate system
LinearTolerance	number	Linear tolerance
AngularTolerance	number	Angle tolerance

Returns

boolean

Is it coplanar.

---

Location

▸ Location(): Mx3dGePoint

Obtain the origin position of the right-hand coordinate system.

Returns

Mx3dGePoint

Origin position.

---

MirrorByAxis

▸ MirrorByAxis(A1): void

Mirror the right-handed coordinate system through an axis.

Parameters

Name	Type	Description
A1	[Mx3dGeAxis] (Mx3dGeAxis. md)	Mirror axis

Returns

void

---

MirrorByCSYSR

▸ MirrorByCSYSR(A2): void

Mirror the current right-handed coordinate system using the right-handed coordinate system.

Parameters

Name	Type	Description
A2	[Mx3dGeCSYSR] (Mx3dGeCSYSR. md)	Right hand coordinate system object

Returns

void

---

MirrorByPoint

▸ MirrorByPoint(P): void

Mirror the right-hand coordinate system through a point.

Parameters

Name	Type	Description
P	[Mx3dGePoint] (Mx3dGePoint. md)	Mirror point

Returns

void

---

MirroredByAxis

▸ MirroredByAxis(A1): Mx3dGeCSYSR

Mirror the right-handed coordinate system through an axis and return the mirrored right-handed coordinate system object.

Parameters

Name	Type	Description
A1	[Mx3dGeAxis] (Mx3dGeAxis. md)	Mirror axis

Returns

Mx3dGeCSYSR

Mirror the right-handed coordinate system object.

---

MirroredByCSYSR

▸ MirroredByCSYSR(A2): Mx3dGeCSYSR

Mirror the current right-handed coordinate system using the right-handed coordinate system and return the mirrored right-handed coordinate system object.

Parameters

Name	Type	Description
A2	[Mx3dGeCSYSR] (Mx3dGeCSYSR. md)	Right hand coordinate system object

Returns

Mx3dGeCSYSR

Mirror the right-handed coordinate system object.

---

MirroredByPoint

▸ MirroredByPoint(P): Mx3dGeCSYSR

Mirror the right-handed coordinate system through a point and return the mirrored right-handed coordinate system object.

Parameters

Name	Type	Description
P	[Mx3dGePoint] (Mx3dGePoint. md)	Mirror point

Returns

Mx3dGeCSYSR

Mirror the right-handed coordinate system object.

---

Rotate

▸ Rotate(theA1, theAng): void

Rotate the right-hand coordinate system around the axis.

Parameters

Name	Type	Description
TheA1	[Mx3dGeAxis] (Mx3dGeAxis. md)	Rotation axis
TheAng	Number	Rotation angle

Returns

void

---

Rotated

▸ Rotated(theA1, theAng): Mx3dGeCSYSR

Rotate the right-handed coordinate system around the axis and return the rotated right-handed coordinate system object.

Parameters

Name	Type	Description
TheA1	[Mx3dGeAxis] (Mx3dGeAxis. md)	Rotation axis
TheAng	Number	Rotation angle

Returns

Mx3dGeCSYSR

Rotate the right-handed coordinate system object.

---

Scale

▸ Scale(theP, theS): void

Scale the right-hand coordinate system.

Parameters

Name	Type	Description
TheP	[Mx3dGePoint] (Mx3dGePoint. md)	Zoom center point
TheS	Number	Scale ratio

Returns

void

---

Scaled

▸ Scaled(theP, theS): Mx3dGeCSYSR

Scale the right-handed coordinate system and return the scaled right-handed coordinate system object.

Parameters

Name	Type	Description
TheP	[Mx3dGePoint] (Mx3dGePoint. md)	Zoom center point
TheS	Number	Scale ratio

Returns

Mx3dGeCSYSR

The scaled right-handed coordinate system object.

---

SetDirection

▸ SetDirection(z_dir): void

Set the Z-axis direction of the right-hand coordinate system.

Parameters

Name	Type	Description
Z-dir	[Mx3dGeDir] (Mx3dGeDir. md)	Z-axis direction

Returns

void

---

SetLocation

▸ SetLocation(origin): void

Set the origin position of the right-hand coordinate system.

Parameters

Name	Type	Description
Origin	[Mx3dGePoint] (Mx3dGePoint. md)	The origin of the coordinate system

Returns

void

▸ SetLocation(theX, theY, theZ): void

Set the origin position of the right-hand coordinate system.

Parameters

Name	Type	Description
The X coordinate of the origin
The Y coordinate of the origin
The Z coordinate of the origin

Returns

void

---

SetXDirection

▸ SetXDirection(x_dir): void

Set the X-axis direction of the right-hand coordinate system.

Parameters

Name	Type	Description
X_dir	[Mx3dGePoint] (Mx3dGePoint. md)	X-axis direction

Returns

void

---

SetYDirection

▸ SetYDirection(y_dir): void

Set the Y-axis direction of the right-hand coordinate system.

Parameters

Name	Type	Description
Y_dir	[Mx3dGeDir] (Mx3dGeDir. md)	Y-axis direction

Returns

void

---

Transform

▸ Transform(theT): void

Transform the right-handed coordinate system.

Parameters

Name	Type	Description
theT	[Mx3dGeTsf] (Mx3dGeTsf. md)	Transform matrix

Returns

void

---

Transformed

▸ Transformed(theT): Mx3dGeCSYSR

Transform the right-handed coordinate system and return the transformed right-handed coordinate system object.

Parameters

Name	Type	Description
theT	[Mx3dGeTsf] (Mx3dGeTsf. md)	Transform matrix

Returns

Mx3dGeCSYSR

The transformed right-handed coordinate system object.

---

TranslateBy2Points

▸ TranslateBy2Points(theP1, theP2): void

Translate the right-hand coordinate system through two points.

Parameters

Name	Type	Description
TheP1	[Mx3dGePoint] (Mx3dGePoint. md)	Starting point
TheP2	[Mx3dGePoint] (Mx3dGePoint. md)	Endpoint

Returns

void

---

TranslateByVec

▸ TranslateByVec(theV): void

Translate the right-hand coordinate system through vectors.

Parameters

Name	Type	Description
TheV	[Mx3dGeVec] (Mx3dGeVec. md)	Translation vector

Returns

void

---

TranslatedBy2Points

▸ TranslatedBy2Points(theP1, theP2): Mx3dGeCSYSR

Translate the right-handed coordinate system by two points and return the translated right-handed coordinate system object.

Parameters

Name	Type	Description
TheP1	[Mx3dGePoint] (Mx3dGePoint. md)	Starting point
TheP2	[Mx3dGePoint] (Mx3dGePoint. md)	Endpoint

Returns

Mx3dGeCSYSR

Translated right-handed coordinate system object.

---

TranslatedByVec

▸ TranslatedByVec(theV): Mx3dGeCSYSR

Translate the right-handed coordinate system through vectors and return the translated right-handed coordinate system object.

Parameters

Name	Type	Description
TheV	[Mx3dGeVec] (Mx3dGeVec. md)	Translation vector

Returns

Mx3dGeCSYSR

Translated right-handed coordinate system object.

---

XDirection

▸ XDirection(): Mx3dGeDir

Obtain the X-axis direction of the right-hand coordinate system.

Returns

Mx3dGeDir

X-axis direction.

---

YDirection

▸ YDirection(): Mx3dGeDir

Obtain the Y-axis direction of the right-handed coordinate system.

Returns

Mx3dGeDir

Y-axis direction.