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

Class: Mx3dGeHyperbola

Represents a hyperbolic object in three-dimensional space. This class is used to create, manipulate, and query various properties of hyperbolas, including their axis, position, radius, and various transformation states.

Hierarchy

• Mx3dGeObject

  ↳ Mx3dGeHyperbola

Table of contents

Constructors

• constructor

Methods

• Asymptote1
• Asymptote2
• Axis
• ConjugateBranch1
• ConjugateBranch2
• Directrix1
• Directrix2
• Eccentricity
• Focal
• Focus1
• Focus2
• Location
• MajorRadius
• MinorRadius
• MirrorByAxis
• MirrorByCSYSR
• MirrorByPoint
• MirroredByAxis
• MirroredByCSYSR
• MirroredByPoint
• OtherBranch
• Parameter
• Position
• Rotate
• Rotated
• Scale
• Scaled
• SetAxis
• SetLocation
• SetMajorRadius
• SetMinorRadius
• SetPosition
• Transform
• Transformed
• TranslateBy2Points
• TranslateByVec
• TranslatedBy2Points
• TranslatedByVec
• XAxis
• YAxis

Constructors

constructor

• new Mx3dGeHyperbola()

The default constructor is used to create an undefined hyperbola.

Overrides

Mx3dGeObject.constructor

• new Mx3dGeHyperbola(theA2, theMajorRadius, theMinorRadius)

Construct a hyperbola based on the given primary and secondary radii and a coordinate system (Mx3dGeCSYSR). The coordinate system defines the position of hyperbolas, where: -The origin is the center of the hyperbola, -The 'X direction' defines the principal axis of the hyperbola, -The 'Y direction' defines the secondary axis of a hyperbola.

Parameters

Name	Type	Description
TheA2	[Mx3dGeCSYSR] (Mx3dGeCSYSR. md)	Define the coordinate system for hyperbolic positions
The MajorRadius	number	The principal radius of a hyperbola
The MinorRadius	Number	The sub radius of a hyperbola

Overrides

Mx3dGeObject.constructor

Methods

Asymptote1

▸ Asymptote1(): Mx3dGeAxis

Obtain the symmetry axis of the hyperbola.

Returns

Mx3dGeAxis

Return the axis of symmetry of the hyperbola.

---

Asymptote2

▸ Asymptote2(): Mx3dGeAxis

Obtain another axis of symmetry.

Returns

Mx3dGeAxis

Return the other axis of symmetry of the hyperbola.

---

Axis

▸ Axis(): Mx3dGeAxis

Obtain the axis of the hyperbola.

Returns

Mx3dGeAxis

The axis of a hyperbola.

---

ConjugateBranch1

▸ ConjugateBranch1(): Mx3dGeHyperbola

Obtain conjugate branch 1.

Returns

Mx3dGeHyperbola

Conjugate branch 1 of hyperbola.

---

ConjugateBranch2

▸ ConjugateBranch2(): Mx3dGeHyperbola

Obtain conjugate branch 2.

Returns

Mx3dGeHyperbola

Conjugate branch 2 of hyperbola.

---

Directrix1

▸ Directrix1(): Mx3dGeAxis

Obtain direct line 1.

Returns

Mx3dGeAxis

The direct line 1 of the hyperbola.

---

Directrix2

▸ Directrix2(): Mx3dGeAxis

Obtain direct line 2.

Returns

Mx3dGeAxis

The direct line 2 of the hyperbola.

---

Eccentricity

▸ Eccentricity(): number

Obtain eccentricity.

Returns

number

The eccentricity of hyperbolas.

---

Focal

▸ Focal(): number

Obtain the focal length.

Returns

number

The focal length of a hyperbola.

---

Focus1

▸ Focus1(): Mx3dGePoint

Get Focus 1.

Returns

Mx3dGePoint

The first focal point of a hyperbola.

---

Focus2

▸ Focus2(): Mx3dGePoint

Get Focus 2.

Returns

Mx3dGePoint

The second focal point of the hyperbola.

---

Location

▸ Location(): Mx3dGePoint

Obtain the current position point of the hyperbola, which is the center point.

Returns

Mx3dGePoint

Location point.

---

MajorRadius

▸ MajorRadius(): number

Obtain the major axis radius of the hyperbola.

Returns

number

A number representing the major axis radius of a hyperbola.

---

MinorRadius

▸ MinorRadius(): number

Obtain the short axis radius of the hyperbola.

Returns

number

A number representing the short axis radius of a hyperbola.

---

MirrorByAxis

▸ MirrorByAxis(theA1): void

Mirror hyperbolic curves along the axis.

Parameters

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

Returns

void

---

MirrorByCSYSR

▸ MirrorByCSYSR(theA2): void

Mirror hyperbolic curves according to the coordinate system.

Parameters

Name	Type	Description
TheA2	[Mx3dGeCSYSR] (Mx3dGeCSYSR. md)	Mirror coordinate system (Mx3dGeCSYSR)

Returns

void

---

MirrorByPoint

▸ MirrorByPoint(theP): void

Transform hyperbolas through point mirroring.

Parameters

Name	Type	Description
TheP	[Mx3dGePoint] (Mx3dGePoint. md)	An Mx3dGePoint object representing the center point of a mirror image

Returns

void

---

MirroredByAxis

▸ MirroredByAxis(theA1): Mx3dGeHyperbola

Obtain the hyperbolic curve mirrored by axis.

Parameters

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

Returns

Mx3dGeHyperbola

The hyperbolic curve (Mx3dGeHyperbola) mirrored along the axis.

---

MirroredByCSYSR

▸ MirroredByCSYSR(theA2): Mx3dGeHyperbola

Obtain the hyperbolic curve mirrored in the coordinate system.

Parameters

Name	Type	Description
TheA2	[Mx3dGeCSYSR] (Mx3dGeCSYSR. md)	Mirror coordinate system (Mx3dGeCSYSR)

Returns

Mx3dGeHyperbola

The hyperbolic curve (Mx3dGeHyperbola) mirrored in the coordinate system.

---

MirroredByPoint

▸ MirroredByPoint(theP): Mx3dGeHyperbola

Obtain the hyperbolic curve after point mirroring.

Parameters

Name	Type	Description
TheP	[Mx3dGePoint] (Mx3dGePoint. md)	Mirror Point (Mx3dGePoint)

Returns

Mx3dGeHyperbola

The hyperbolic curve (Mx3dGeHyperbola) after point mirroring.

---

OtherBranch

▸ OtherBranch(): Mx3dGeHyperbola

Obtain another branch of the hyperbola that is symmetric about the main axis with the current branch.

Returns

Mx3dGeHyperbola

Another branch.

---

Parameter

▸ Parameter(): number

Get the parameters of the hyperbola.

Returns

number

A number representing the parameters of a hyperbola.

---

Position

▸ Position(): Mx3dGeCSYSR

Obtain the coordinate system of the hyperbola and define its position and direction.

Returns

Mx3dGeCSYSR

Coordinate system.

---

Rotate

▸ Rotate(theA1, theAng): void

Rotating hyperbola.

Parameters

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

Returns

void

---

Rotated

▸ Rotated(theA1, theAng): Mx3dGeHyperbola

Obtain the rotated hyperbola.

Parameters

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

Returns

Mx3dGeHyperbola

The rotated hyperbola (Mx3dGeHyperbola).

---

Scale

▸ Scale(theP, theS): void

Scale the hyperbola.

Parameters

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

Returns

void

---

Scaled

▸ Scaled(theP, theS): Mx3dGeHyperbola

Obtain the scaled hyperbolic curve.

Parameters

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

Returns

Mx3dGeHyperbola

The scaled hyperbola (Mx3dGeHyperbola).

---

SetAxis

▸ SetAxis(theA1): void

Set the axis of the hyperbola.

Parameters

Name	Type	Description
TheA1	[Mx3dGeAxis] (Mx3dGeAxis. md)	The new axis to be set

Returns

void

---

SetLocation

▸ SetLocation(theP): void

Set the position of the hyperbola.

Parameters

Name	Type	Description
TheP	[Mx3dGePoint] (Mx3dGePoint. md)	New location point

Returns

void

---

SetMajorRadius

▸ SetMajorRadius(theMajorRadius): void

Set the main radius of the hyperbola.

Parameters

Name	Type	Description
theMajorRadius	number	New main radius value

Returns

void

---

SetMinorRadius

▸ SetMinorRadius(theMinorRadius): void

Set the secondary radius of the hyperbola.

Parameters

Name	Type	Description
The MinorRadius	number	new sub radius value

Returns

void

---

SetPosition

▸ SetPosition(theA2): void

Set up a coordinate system for hyperbolas to redefine their position and direction.

Parameters

Name	Type	Description
TheA2	[Mx3dGeCSYSR] (Mx3dGeCSYSR. md)	New coordinate system

Returns

void

---

Transform

▸ Transform(theT): void

Transform the hyperbola.

Parameters

Name	Type
theT	Mx3dGeTrsf

Returns

void

---

Transformed

▸ Transformed(theT): Mx3dGeHyperbola

Obtain the transformed hyperbola.

Parameters

Name	Type
theT	Mx3dGeTrsf

Returns

Mx3dGeHyperbola

The transformed hyperbola (Mx3dGeHyperbola).

---

TranslateBy2Points

▸ TranslateBy2Points(theP1, theP2): void

Translate the hyperbola by point.

Parameters

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

Returns

void

---

TranslateByVec

▸ TranslateByVec(theV): void

Translate the hyperbola by vector.

Parameters

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

Returns

void

---

TranslatedBy2Points

▸ TranslatedBy2Points(theP1, theP2): Mx3dGeHyperbola

Obtain the hyperbolic curve after point translation.

Parameters

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

Returns

Mx3dGeHyperbola

The hyperbolic curve (Mx3dGeHyperbola) after point translation.

---

TranslatedByVec

▸ TranslatedByVec(theV): Mx3dGeHyperbola

Obtain the hyperbolic curve translated by vector.

Parameters

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

Returns

Mx3dGeHyperbola

Translated hyperbola (Mx3dGeHyperbola).

---

XAxis

▸ XAxis(): Mx3dGeAxis

Obtain the X-axis and define the main direction of the hyperbola.

Returns

Mx3dGeAxis

X-axis.

---

YAxis

▸ YAxis(): Mx3dGeAxis

Obtain the Y-axis and define the secondary direction of the hyperbola.

Returns

Mx3dGeAxis

Y-axis.