[mxcad_3d API documentation](../README. md)/Mx3dGeLocation
Class: Mx3dGeLocation
Representing the position in a 3D geometric system. Provides various methods for manipulating 3D positions and transformations.
Hierarchy
↳
Mx3dGeLocation
Table of contents
Constructors
Methods
- Clear
- Divided
- FirstPower
- Identity
- Inverted
- IsDifferent
- IsEqual
- IsIdentity
- Multiplied
- NextLocation
- Powered
- Predivided
- ScalePrec
Constructors
constructor
• new Mx3dGeLocation()
The default constructor creates a unit position.
Overrides
Mx3dGeObject.constructor
• new Mx3dGeLocation(theTrsf
)
Constructor, initialize the position using the specified transformation.
Parameters
Name | Type | Description |
---|---|---|
theTrsf | [Mx3dGeTrsf ] (Mx3dGeTrsf. md) | Used to initialize the position transformation object |
Overrides
Mx3dGeObject.constructor
Methods
Clear
▸ Clear(): void
Clear the transformation of the current position.
Returns
void
Divided
▸ Divided(Other
): Mx3dGeLocation
Calculate the division between the current position and another position.
Parameters
Name | Type | Description |
---|---|---|
Other | [Mx3dGeLocation. md] | Another location object |
Returns
The position object after division.
FirstPower
▸ FirstPower(): number
Obtain the first power of the location.
Returns
number
The first power value of the position.
Identity
▸ Identity(): void
Set the current position as a unit transformation.
Returns
void
Inverted
▸ Inverted(): Mx3dGeLocation
Calculate the inverse transformation of the current position.
Returns
The position object after inverse transformation.
IsDifferent
▸ IsDifferent(Other
): boolean
Check if the current location is different from another location.
Parameters
Name | Type | Description |
---|---|---|
Other | [Mx3dGeLocation. md] | Another location object |
Returns
boolean
If the current location is different from another location, return true; Otherwise, return false.
IsEqual
▸ IsEqual(Other
): boolean
Check if the current position is equal to another position.
Parameters
Name | Type | Description |
---|---|---|
Other | [Mx3dGeLocation. md] | Another location object |
Returns
boolean
If the current position is equal to another position, return true; Otherwise, return false.
IsIdentity
▸ IsIdentity(): boolean
Check if the current position is a unit transformation.
Returns
boolean
If the current position is a unit transformation, return true; Otherwise, return false.
Multiplied
▸ Multiplied(theLocation
): Mx3dGeLocation
Calculate the product of the current location and another location.
Parameters
Name | Type | Description |
---|---|---|
TheLocation | [Mx3dGeLocation. md] | Another location object |
Returns
The position object after multiplication.
NextLocation
▸ NextLocation(): Mx3dGeLocation
Get the next location object.
Returns
Next location object.
Powered
▸ Powered(pwr
): Mx3dGeLocation
Calculate the power operation of the current position.
Parameters
Name | Type | Description |
---|---|---|
The value of the power of 'pwr' | 'number' |
Returns
The position object after power operation.
Predivided
▸ Predivided(Other
): Mx3dGeLocation
Calculate the left division (front division) between the current position and another position.
Parameters
Name | Type | Description |
---|---|---|
Other | [Mx3dGeLocation. md] | Another location object |
Returns
The position object after left division.
ScalePrec
▸ ScalePrec(): number
Obtain the scaling accuracy of the position.
Returns
number
The scaling accuracy value of the position.