[mxcad_3d API documentation](../README. md)/Mx3dGePoint
Class: Mx3dGePoint
Represents a point in three-dimensional space.
Provide constructors and methods for obtaining and setting the coordinates of points.
Hierarchy
↳
Mx3dGePoint
Table of contents
Constructors
Methods
Constructors
constructor
• new Mx3dGePoint()
By default, construct a point located at the origin (0,0,0).
Overrides
Mx3dGeObject.constructor
• new Mx3dGePoint(theXYZ
)
Construct a point using the given coordinate array.
Parameters
Name | Type | Description |
---|---|---|
TheXYZ | Vector | contains X, Y. An array of Z-coordinate values |
Overrides
Mx3dGeObject.constructor
• new Mx3dGePoint(theX
, theY
, theZ
)
Using the given X, Y. Construct a point based on the Z-coordinate value.
Parameters
Name | Type | Description |
---|---|---|
TheX | Number | X coordinate value |
TheY | Number | Y coordinate value |
TheZ | Number | Z coordinate value |
Overrides
Mx3dGeObject.constructor
Methods
Vertex
▸ Vertex(): Mx3dShapeVertex
Obtain the topological point shape of the current point
Returns
Topological point shape
X
▸ X(): number
Obtain the X coordinate value of a point in the world coordinate system
Returns
number
X-coordinate value
Y
▸ Y(): number
Obtain the Y-coordinate value of a point in the world coordinate system
Returns
number
Y coordinate value
Z
▸ Z(): number
Obtain the Z-coordinate value of a point in the world coordinate system
Returns
number
Z-coordinate value
setX
▸ setX(theX
): void
Set the X coordinate value of the point in the world coordinate system
Parameters
Name | Type | Description |
---|---|---|
TheX | number | X coordinate value |
Returns
void
setXYZ
▸ setXYZ(theX
, theY
, theZ
): void
Set the X, Y, Z coordinate values of the point in the world coordinate system
Parameters
Name | Type | Description |
---|---|---|
TheX | number | X coordinate value |
TheY | number | Y coordinate value |
TheZ | number | Z coordinate value |
Returns
void
setY
▸ setY(theY
): void
Set the Y coordinate value of the point in the world coordinate system
Parameters
Name | Type | Description |
---|---|---|
TheY | number | Y coordinate value |
Returns
void
setZ
▸ setZ(theZ
): void
Set the Z-coordinate value of the point in the world coordinate system
Parameters
Name | Type | Description |
---|---|---|
TheZ | number | Z coordinate value |
Returns
void