[mxcad_3d API Document](../README. md)/Mx3dGeLine
Class: Mx3dGeLine
A class that represents non parametric geometric lines.
Hierarchy
↳
Mx3dGeLine
Table of contents
Constructors
Methods
- Continuity
- D0
- D1
- D2
- D3
- DN
- Edge
- FirstParameter
- IsCN
- IsClosed
- IsPeriodic
- LastParameter
- ParametricTransformation
- Period
- Position
- Reverse
- Reversed
- ReversedParameter
- SetDirection
- SetLocation
- SetPosition
- Transform
- TransformedParameter
- Value
Constructors
constructor
• new Mx3dGeLine(A1
)
Create a straight line using an axis.
Parameters
Name | Type | Description |
---|---|---|
A1 | [Mx3dGeAxis] (Mx3dGeAxis. md) | Axis object |
Overrides
Mx3dGeCurve.constructor
• new Mx3dGeLine(P
, V
)
Create a straight line using points and directions.
Parameters
Name | Type | Description |
---|---|---|
P | [Mx3dGePoint] (Mx3dGePoint. md) | Starting point |
V | [Mx3dGeDir] (Mx3dGeDir. md) | Direction |
Overrides
Mx3dGeCurve.constructor
Methods
Continuity
▸ Continuity(): MxGAShapeEnum
Obtain the continuity of a straight line.
Returns
Continuity enumeration values.
D0
▸ D0(U
, P
): void
Get the point of the given parameter.
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 point and first derivative vector of the given parameters.
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 point, first derivative vector, and second derivative vector of the given parameters.
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 point, first derivative vector, second derivative vector, and third derivative vector of the given parameters.
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 vector of the given parameters.
Parameters
Name | Type | Description |
---|---|---|
The parameter value of 'U' | 'number' | |
N | number | derivative order |
Returns
N-order derivative vector.
Edge
▸ Edge(p1
, p2
): Mx3dShapeEdge
Retrieve the boundary within the specified parameter interval.
Parameters
Name | Type | Description |
---|---|---|
P1 | Number | Starting parameter |
P2 | number | Terminate parameter |
Returns
Boundary objects.
FirstParameter
▸ FirstParameter(): number
Get the starting parameters of the line.
Returns
number
Starting parameters.
IsCN
▸ IsCN(N
): boolean
Check the continuity level of the straight line.
Parameters
Name | Type | Description |
---|---|---|
N | number | Continuity level |
Returns
boolean
Has the specified continuity level been reached.
IsClosed
▸ IsClosed(): boolean
Check if the straight line is closed.
Returns
boolean
Is it closed.
IsPeriodic
▸ IsPeriodic(): boolean
Check if the straight line is periodic.
Returns
boolean
Is it periodic.
LastParameter
▸ LastParameter(): number
Get the termination parameter of the line.
Returns
number
Terminate parameter.
ParametricTransformation
▸ ParametricTransformation(T
): number
Obtain the result of parameter transformation.
Parameters
Name | Type | Description |
---|---|---|
T | [Mx3dGetStrf] (Mx3dGetStrf. md) | Transform the object |
Returns
number
Parameter transformation result.
Period
▸ Period(): number
Obtain the period of the straight line.
Returns
number
Cycle.
Position
▸ Position(): Mx3dGeAxis
Obtain the position of the straight line.
Returns
Axis object.
Reverse
▸ Reverse(): void
Reverse the direction of a straight line.
Returns
void
Reversed
▸ Reversed(): Mx3dGeLine
Obtain a new straight line with reversed direction.
Returns
The reversed new line object.
ReversedParameter
▸ ReversedParameter(U
): number
Get the inversion parameter.
Parameters
Name | Type | Description |
---|---|---|
U | number | Original parameter |
Returns
number
Inverted parameters.
SetDirection
▸ SetDirection(V
): void
Set the direction of the line.
Parameters
Name | Type | Description |
---|---|---|
V | [Mx3dGeDir] (Mx3dGeDir. md) | Directional object |
Returns
void
SetLocation
▸ SetLocation(P
): void
Set the starting point of the line.
Parameters
Name | Type | Description |
---|---|---|
P | [Mx3dGePoint] (Mx3dGePoint. md) | Point object |
Returns
void
SetPosition
▸ SetPosition(A1
): void
Set the position of the line.
Parameters
Name | Type | Description |
---|---|---|
A1 | [Mx3dGeAxis] (Mx3dGeAxis. md) | Axis object |
Returns
void
Transform
▸ Transform(T
): void
Apply transformations to straight lines.
Parameters
Name | Type | Description |
---|---|---|
T | [Mx3dGetStrf] (Mx3dGetStrf. md) | Transform the object |
Returns
void
TransformedParameter
▸ TransformedParameter(U
, T
): number
Obtain the transformed parameters.
Parameters
Name | Type | Description |
---|---|---|
U | number | Original parameter |
T | [Mx3dGetStrf] (Mx3dGetStrf. md) | Transform the object |
Returns
number
The transformed parameters.
Value
▸ Value(U
): Mx3dGePoint
Retrieve the point corresponding to the given parameter.
Parameters
Name | Type | Description |
---|---|---|
The parameter value of 'U' | 'number' |
Returns
Point object.