[mxcad_3d API documentation](../README. md)/Mx3dGeomHyperbola

Class: Mx3dGeomHyperbola

The class representing parameter geometric hyperbolas inherits from Mx3dGeomConic.

Hierarchy

• Mx3dGeomConic

  ↳ Mx3dGeomHyperbola

Table of contents

Constructors

• constructor

Methods

• Asymptote1
• Asymptote2
• Axis
• ConjugateBranch1
• ConjugateBranch2
• Continuity
• Copy
• D0
• D1
• D2
• D3
• DN
• Directrix1
• Directrix2
• DynamicType
• Eccentricity
• Edge
• FirstParameter
• Focal
• Focus1
• Focus2
• IsCN
• IsClosed
• IsPeriodic
• LastParameter
• Location
• MajorRadius
• MinorRadius
• MirrorByAxis
• MirrorByCSYSR
• MirrorByPoint
• MirroredByAxis
• MirroredByCSYSR
• MirroredByPoint
• OffsetCurve
• OtherBranch
• Parameter
• Period
• Position
• Reverse
• Reversed
• ReversedParameter
• Rotate
• Rotated
• Scale
• Scaled
• SetAxis
• SetLocation
• SetMajorRadius
• SetMinorRadius
• SetPosition
• Transform
• Transformed
• TranslateBy2Points
• TranslateByVec
• TranslatedBy2Points
• TranslatedByVec
• Value
• XAxis
• YAxis
• DownCast

Constructors

constructor

• new Mx3dGeomHyperbola(A2, MajorRadius, MinorRadius)

Constructor that accepts a coordinate system, major axis radius, and minor axis radius as parameters.

Parameters

Name	Type	Description
A2	[Mx3dGeCSYSR] (Mx3dGeCSYSR. md)	Coordinate system object
MajorRadius	number	major axis radius
MinorRadius	number	short axis radius

Overrides

Mx3dGeomConic.constructor

Methods

Asymptote1

▸ Asymptote1(): Mx3dGeAxis

Get the first asymptote.

Returns

Mx3dGeAxis

The asymptote object.

---

Asymptote2

▸ Asymptote2(): Mx3dGeAxis

Obtain the second asymptote.

Returns

Mx3dGeAxis

The asymptote object.

---

Axis

▸ Axis(): Mx3dGeAxis

Obtain the axis of the quadratic curve.

Returns

Mx3dGeAxis

Axis object.

Inherited from

Mx3dGeomConic.Axis

---

ConjugateBranch1

▸ ConjugateBranch1(): Mx3dGeomHyperbola

Obtain the first conjugate branch.

Returns

Mx3dGeomHyperbola

The first conjugate branch object.

---

ConjugateBranch2

▸ ConjugateBranch2(): Mx3dGeomHyperbola

Obtain the second conjugate branch.

Returns

Mx3dGeomHyperbola

The second conjugate branch object.

---

Continuity

▸ Continuity(): MxGAShapeEnum

Obtain the continuity of the quadratic curve.

Returns

MxGAShapeEnum

Continuity enumeration values.

Inherited from

Mx3dGeomConic.Continuity

---

Copy

▸ Copy(): Mx3dGeomObject

Copy hyperbolic objects.

Returns

Mx3dGeomObject

Copy the hyperbolic object.

---

D0

▸ D0(U, P): void

Obtain the point coordinates at parameter U.

Parameters

Name	Type	Description
The parameter value of 'U'	'number'
P	[Mx3dGePoint] (Mx3dGePoint. md)	Point object

Returns

void

---

D1

▸ D1(U, P, V1): void

Obtain the first derivative at parameter U.

Parameters

Name	Type	Description
The parameter value of 'U'	'number'
P	[Mx3dGePoint] (Mx3dGePoint. md)	Point object
V1	[Mx3dGeVec] (Mx3dGeVec. md)	First derivative vector

Returns

void

---

D2

▸ D2(U, P, V1, V2): void

Obtain the second derivative at parameter U.

Parameters

Name	Type	Description
The parameter value of 'U'	'number'
P	[Mx3dGePoint] (Mx3dGePoint. md)	Point object
V1	[Mx3dGeVec] (Mx3dGeVec. md)	First derivative vector
V2	[Mx3dGeVec] (Mx3dGeVec. md)	Second derivative vector

Returns

void

---

D3

▸ D3(U, P, V1, V2, V3): void

Obtain the third derivative at parameter U.

Parameters

Name	Type	Description
The parameter value of 'U'	'number'
P	[Mx3dGePoint] (Mx3dGePoint. md)	Point object
V1	[Mx3dGeVec] (Mx3dGeVec. md)	First derivative vector
V2	[Mx3dGeVec] (Mx3dGeVec. md)	Second derivative vector
V3	[Mx3dGeVec] (Mx3dGeVec. md)	Third derivative vector

Returns

void

---

DN

▸ DN(U, N): Mx3dGeVec

Obtain the Nth derivative at parameter U.

Parameters

Name	Type	Description
The parameter value of 'U'	'number'
N	number	order

Returns

Mx3dGeVec

N-order derivative vector.

---

Directrix1

▸ Directrix1(): Mx3dGeAxis

Obtain the first guide line.

Returns

Mx3dGeAxis

Alignment object.

---

Directrix2

▸ Directrix2(): Mx3dGeAxis

Obtain the second guideline.

Returns

Mx3dGeAxis

Alignment object.

---

DynamicType

▸ DynamicType(): string

Return the dynamic type of the object.

Returns

string

A dynamically typed string.

Overrides

Mx3dGeomConic.DynamicType

---

Eccentricity

▸ Eccentricity(): number

Obtain eccentricity.

Returns

number

Centrifuge rate value.

---

Edge

▸ Edge(p1, p2): Mx3dShapeEdge

Obtain the edges of the hyperbola.

Parameters

Name	Type	Description
P1	Number	The first parameter
P2	number	Second parameter

Returns

Mx3dShapeEdge

The edge object of a hyperbola.

---

FirstParameter

▸ FirstParameter(): number

Get the first parameter of the hyperbola.

Returns

number

The first parameter.

---

Focal

▸ Focal(): number

Obtain the focal length.

Returns

number

Focal length value.

---

Focus1

▸ Focus1(): Mx3dGePoint

Get the first focus.

Returns

Mx3dGePoint

The first focal object.

---

Focus2

▸ Focus2(): Mx3dGePoint

Get the second focus.

Returns

Mx3dGePoint

The second focal object.

---

IsCN

▸ IsCN(N): boolean

Check if the quadratic curve has continuity of the specified order.

Parameters

Name	Type	Description
N	number	order

Returns

boolean

If there is continuity of the specified order, return true; otherwise, return false.

Inherited from

Mx3dGeomConic.IsCN

---

IsClosed

▸ IsClosed(): boolean

Check if the hyperbola is closed.

Returns

boolean

If the hyperbola is closed, return true; Otherwise, return false.

---

IsPeriodic

▸ IsPeriodic(): boolean

Check if the hyperbola is periodic.

Returns

boolean

If the hyperbola is periodic, return true; Otherwise, return false.

---

LastParameter

▸ LastParameter(): number

Get the last parameter of the hyperbola.

Returns

number

The last parameter.

---

Location

▸ Location(): Mx3dGePoint

Obtain the position of the quadratic curve.

Returns

Mx3dGePoint

Point object.

Inherited from

Mx3dGeomConic.Location

---

MajorRadius

▸ MajorRadius(): number

Obtain the long axis radius.

Returns

number

Long axis radius value.

---

MinorRadius

▸ MinorRadius(): number

Obtain the short axis radius.

Returns

number

Short axis radius value.

---

MirrorByAxis

▸ MirrorByAxis(A1): void

Mirror transform geometric objects through axes.

Parameters

Name	Type	Description
A1	[Mx3dGeAxis] (Mx3dGeAxis. md)	Axis object

Returns

void

Inherited from

Mx3dGeomConic.MirrorByAxis

---

MirrorByCSYSR

▸ MirrorByCSYSR(A2): void

Mirror transform geometric objects using a right-handed coordinate system.

Parameters

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

Returns

void

Inherited from

Mx3dGeomConic.MirrorByCSYSR

---

MirrorByPoint

▸ MirrorByPoint(P): void

Mirror transform geometric objects through points.

Parameters

Name	Type	Description
P	[Mx3dGePoint] (Mx3dGePoint. md)	Point object

Returns

void

Inherited from

Mx3dGeomConic.MirrorByPoint

---

MirroredByAxis

▸ MirroredByAxis(A1): Mx3dGeomHyperbola

Return the new geometric object transformed through axis mirroring.

Parameters

Name	Type	Description
A1	[Mx3dGeAxis] (Mx3dGeAxis. md)	Axis object

Returns

Mx3dGeomHyperbola

New geometric objects.

Inherited from

Mx3dGeomConic.MirroredByAxis

---

MirroredByCSYSR

▸ MirroredByCSYSR(A2): Mx3dGeomHyperbola

Return the new geometric object after mirror transformation through the right-handed coordinate system.

Parameters

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

Returns

Mx3dGeomHyperbola

New geometric objects.

Inherited from

Mx3dGeomConic.MirroredByCSYSR

---

MirroredByPoint

▸ MirroredByPoint(P): Mx3dGeomHyperbola

Return the new geometric object after point mirror transformation.

Parameters

Name	Type	Description
P	[Mx3dGePoint] (Mx3dGePoint. md)	Point object

Returns

Mx3dGeomHyperbola

New geometric objects.

Inherited from

Mx3dGeomConic.MirroredByPoint

---

OffsetCurve

▸ OffsetCurve(Offset, V, isNotCheckC0): Mx3dShapeEdge

Obtain the offset curve of the hyperbola.

Parameters

Name	Type	Description
Offset	Number	Offset
V	[Mx3dGeDir] (Mx3dGeDir. md)	Direction vector, perpendicular to the offset direction
IsNotCheckC0	boolean	Check for C0 continuity

Returns

Mx3dShapeEdge

Offset the edge object of the curve.

---

OtherBranch

▸ OtherBranch(): Mx3dGeomHyperbola

Obtain another hyperbola.

Returns

Mx3dGeomHyperbola

Another hyperbolic object.

---

Parameter

▸ Parameter(): number

Get parameters.

Returns

number

Parameter values.

---

Period

▸ Period(): number

Return the period of the curve.

Returns

number

The period of the curve.

Inherited from

Mx3dGeomConic.Period

---

Position

▸ Position(): Mx3dGeCSYSR

Obtain the right-hand coordinate system of the quadratic curve.

Returns

Mx3dGeCSYSR

Right hand coordinate system object.

Inherited from

Mx3dGeomConic.Position

---

Reverse

▸ Reverse(): void

Reverse the direction of the quadratic curve.

Returns

void

Inherited from

Mx3dGeomConic.Reverse

---

Reversed

▸ Reversed(): Mx3dGeomHyperbola

Return the new geometric curve object in reverse.

Returns

Mx3dGeomHyperbola

New geometric curve object.

Inherited from

Mx3dGeomConic.Reversed

---

ReversedParameter

▸ ReversedParameter(U): number

Get reverse parameters.

Parameters

Name	Type	Description
The parameter value of 'U'	'number'

Returns

number

Reverse parameter value.

---

Rotate

▸ Rotate(A1, Ang): void

Rotate geometric objects.

Parameters

Name	Type	Description
A1	[Mx3dGeAxis] (Mx3dGeAxis. md)	Axis object
Ang	number	Rotation angle

Returns

void

Inherited from

Mx3dGeomConic.Rotate

---

Rotated

▸ Rotated(A1, Ang): Mx3dGeomHyperbola

Return the rotated new geometric object.

Parameters

Name	Type	Description
A1	[Mx3dGeAxis] (Mx3dGeAxis. md)	Axis object
Ang	number	Rotation angle

Returns

Mx3dGeomHyperbola

New geometric objects.

Inherited from

Mx3dGeomConic.Rotated

---

Scale

▸ Scale(P, S): void

Scale geometric objects.

Parameters

Name	Type	Description
P	[Mx3dGePoint] (Mx3dGePoint. md)	Point object
S	number	scaling ratio

Returns

void

Inherited from

Mx3dGeomConic.Scale

---

Scaled

▸ Scaled(P, S): Mx3dGeomHyperbola

Return the scaled new geometric object.

Parameters

Name	Type	Description
P	[Mx3dGePoint] (Mx3dGePoint. md)	Point object
S	number	scaling ratio

Returns

Mx3dGeomHyperbola

New geometric objects.

Inherited from

Mx3dGeomConic.Scaled

---

SetAxis

▸ SetAxis(theA1): void

Set the axis of the quadratic curve.

Parameters

Name	Type	Description
TheA1	[Mx3dGeAxis] (Mx3dGeAxis. md)	Axis object

Returns

void

Inherited from

Mx3dGeomConic.SetAxis

---

SetLocation

▸ SetLocation(theP): void

Set the position of the quadratic curve.

Parameters

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

Returns

void

Inherited from

Mx3dGeomConic.SetLocation

---

SetMajorRadius

▸ SetMajorRadius(MajorRadius): void

Set the long axis radius.

Parameters

Name	Type	Description
MajorRadius	number	major axis radius

Returns

void

---

SetMinorRadius

▸ SetMinorRadius(MinorRadius): void

Set the short axis radius.

Parameters

Name	Type	Description
MinorRadius	number	short axis radius

Returns

void

---

SetPosition

▸ SetPosition(theA2): void

Set the right-hand coordinate system for the quadratic curve.

Parameters

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

Returns

void

Inherited from

Mx3dGeomConic.SetPosition

---

Transform

▸ Transform(T): void

Transform the hyperbola.

Parameters

Name	Type	Description
T	[Mx3dGetStrf] (Mx3dGetStrf. md)	Transform the object

Returns

void

---

Transformed

▸ Transformed(T): Mx3dGeomHyperbola

Return the transformed new geometric object.

Parameters

Name	Type	Description
T	[Mx3dGetStrf] (Mx3dGetStrf. md)	Transform the object

Returns

Mx3dGeomHyperbola

New geometric objects.

Inherited from

Mx3dGeomConic.Transformed

---

TranslateBy2Points

▸ TranslateBy2Points(P1, P2): void

Translate geometric objects through two points.

Parameters

Name	Type	Description
P1	[Mx3dGePoint] (Mx3dGePoint. md)	Starting point object
P2	[Mx3dGePoint] (Mx3dGePoint. md)	End point object

Returns

void

Inherited from

Mx3dGeomConic.TranslateBy2Points

---

TranslateByVec

▸ TranslateByVec(V): void

Translate geometric objects through vectors.

Parameters

Name	Type	Description
V	[Mx3dGeVec] (Mx3dGeVec. md)	Vector object

Returns

void

Inherited from

Mx3dGeomConic.TranslateByVec

---

TranslatedBy2Points

▸ TranslatedBy2Points(P1, P2): Mx3dGeomHyperbola

Return the new geometric object after translating through two points.

Parameters

Name	Type	Description
P1	[Mx3dGePoint] (Mx3dGePoint. md)	Starting point object
P2	[Mx3dGePoint] (Mx3dGePoint. md)	End point object

Returns

Mx3dGeomHyperbola

New geometric objects.

Inherited from

Mx3dGeomConic.TranslatedBy2Points

---

TranslatedByVec

▸ TranslatedByVec(V): Mx3dGeomHyperbola

Return the new geometric object after vector translation.

Parameters

Name	Type	Description
V	[Mx3dGeVec] (Mx3dGeVec. md)	Vector object

Returns

Mx3dGeomHyperbola

New geometric objects.

Inherited from

Mx3dGeomConic.TranslatedByVec

---

Value

▸ Value(U): Mx3dGePoint

Return the point at the given parameter U.

Parameters

Name	Type	Description
The parameter value of 'U'	'number'

Returns

Mx3dGePoint

The point object at the given parameter.

Inherited from

Mx3dGeomConic.Value

---

XAxis

▸ XAxis(): Mx3dGeAxis

Obtain the X-axis of the quadratic curve.

Returns

Mx3dGeAxis

X-axis object.

Inherited from

Mx3dGeomConic.XAxis

---

YAxis

▸ YAxis(): Mx3dGeAxis

Obtain the Y-axis of the quadratic curve.

Returns

Mx3dGeAxis

Y-axis object.

Inherited from

Mx3dGeomConic.YAxis

---

DownCast

▸ Static DownCast(theObject): Mx3dGeomHyperbola

Convert parent class object to Mx3dGeomHyperbola class object

Parameters

Name	Type	Description
TheObject	[Mx3dGeomObject] (Mx3dGeomObject. md)	Parent class object

Returns

Mx3dGeomHyperbola

Mx3dGeomHyperbola class object