Filters
Filter values by
  • Transformation matrix object
  • 3D geometry object
    • Box geometry
    • Cylinder geometry
    • Plane geometry
    • Sphere geometry
| Customize Help
| Save Settings

M3dgeoInquire


Function Map
Syntax
Description
Parameters
- GeometryOrMatrix3dgeoId
- InquireType
- UserVarPtr
Parameter Associations
Table: For inquiring about any 3D geometry object
Table: For inquiring about a specific type of 3D geometry object
Table: For inquiring about any transformation matrix object
+ combination: For inquiring whether an inquire type is supported
+ combination: For specifying the data type
Return value
Compilation information
Synopsis
Inquire about a 3D geometry object setting or transformation matrix object setting.
Syntax
MIL_DOUBLE M3dgeoInquire(
MIL_ID GeometryOrMatrix3dgeoId, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires about a specified setting of a 3D geometry object or transformation matrix object.

Note that if the specified 3D geometry object was transformed (for example, using the 3D image processing module), this function returns the modified coordinates and dimensions. In this case, the coordinates and dimensions returned by M3dgeoInquire() might not be the same initial coordinates and dimensions used to define the 3D geometry object.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see if there is complementary information.
Parameters
This function is not supported on the selected boards.
Parameters
GeometryOrMatrix3dgeoId

Specifies the identifier of the 3D geometry object or transformation matrix object about which to inquire information. The object must have been previously allocated using M3dgeoAlloc() with M_GEOMETRY or M_TRANSFORMATION_MATRIX.

See the Parameter associations section for possible values that can be specified.

InquireType

Specifies the setting to inquire.

See the Parameter associations section for possible values that can be specified.

UserVarPtr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ]
  • array of type MIL_FLOAT [optionally, in C++: a reference to a std::vector<MIL_FLOAT> ]
  • array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ]
  • array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ]
  • array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ]
  • MIL_DOUBLE
  • MIL_FLOAT
  • MIL_INT
  • MIL_INT32
  • MIL_INT64

Specifies the address in which to write the requested information. Since the M3dgeoInquire() function also returns the requested information, you can set this parameter to M_NULL.

See the Parameter associations section for possible values that can be returned.

Parameter associations

The tables below list possible values for the GeometryOrMatrix3dgeoId and InquireType parameters and possible values returned to the UserVarPtr parameter.

For any 3D geometry object, the GeometryOrMatrix3dgeoId and InquireType parameters can be set to one of the following:

function map For inquiring about any 3D geometry object
Click to summarizeGeometryOrMatrix3dgeoId Description
InquireType
UserVarPtr
- Possible values returned
Click to summarize 3D geometry object ID +

Specifies a 3D geometry object, allocated using M3dgeoAlloc() with M_GEOMETRY.

(summarize)
Click to summarize M_GEOMETRY_TYPE +

Inquires the 3D geometry type.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_BOX

Specifies a box.
Click to summarize M_CYLINDER

Specifies a cylinder.
Click to summarize M_LINE

Specifies a line.
Click to summarize M_NOT_INITIALIZED

Specifies that a geometry has not been defined for the 3D geometry object.
Click to summarize M_PLANE

Specifies a plane.
Click to summarize M_SPHERE

Specifies a sphere.

For a 3D geometry object of a specific type, the GeometryOrMatrix3dgeoId and InquireType parameters can be set to one of the following.

Note that for any 3D geometry object, you can use any inquire type available for its respective geometry type, regardless of the creation mode used to define the geometry.

function map For inquiring about a specific type of 3D geometry object
Click to summarize
GeometryOrMatrix3dgeoId		 Description
InquireType
UserVarPtr
- Possible values returned
Click to summarize 3D box geometry object ID +

Specifies a 3D box geometry object, allocated using M3dgeoAlloc() with M_GEOMETRY and successfully defined as a box.

Note that a box's corners are assigned the following indices upon initially defining the box, based on the corner's position with respect to the axes of the working coordinate system. The index of a box corner does not change based on the orientation of the box.

(summarize)
Click to summarize

Inquires the X-coordinate of the specified box corner.

(summarize)
Parameters

Specifies the index of the box corner.
0 <= Value <= 7

Specifies the box corner.
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the X-coordinate of the specified box corner, expressed in the working coordinate system.
Click to summarize

Inquires the Y-coordinate of the specified box corner.

(summarize)
Parameters

Specifies the index of the box corner.
0 <= Value <= 7

Specifies the box corner.
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Y-coordinate of the specified box corner, expressed in the working coordinate system.
Click to summarize

Inquires the Z-coordinate of the specified box corner.

(summarize)
Parameters

Specifies the index of the box corner.
0 <= Value <= 7

Specifies the box corner.
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Z-coordinate of the specified box corner, expressed in the working coordinate system.
Click to summarize M_AXIS_ALIGNED +

Inquires whether the box is axis-aligned with the working coordinate system.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_FALSE

Specifies that the box is not axis-aligned; a rotation has been applied.
Click to summarize M_TRUE

Specifies that the box is axis-aligned; no rotation has been applied.
Click to summarize M_CENTER_X +

Inquires the X-coordinate of the box's center point. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the X-coordinate of the box's center point, expressed in the working coordinate system.
Click to summarize M_CENTER_Y +

Inquires the Y-coordinate of the box's center point. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Y-coordinate of the box's center point, expressed in the working coordinate system.
Click to summarize M_CENTER_Z +

Inquires the Z-coordinate of the box's center point. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Z-coordinate of the box's center point, expressed in the working coordinate system.
Click to summarize M_CORNER_X_ALL +

Inquires the X-coordinate of each of the box's 8 corners, in their index order.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize Value

Specifies the X-component the box's corner, expressed in the working coordinate system.
Click to summarize M_CORNER_Y_ALL +

Inquires the Y-coordinate of each of the box's 8 corners, in their index order.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize Value

Specifies the Y-component the box's corner, expressed in the working coordinate system.
Click to summarize M_CORNER_Z_ALL +

Inquires the Z-coordinate of each of the box's 8 corners, in their index order.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize Value

Specifies the Z-component the box's corner, expressed in the working coordinate system.
Click to summarize M_SIZE_X +

Inquires the box's length along the X-axis, ignoring the box's rotation. The length is returned as if the box is axis-aligned. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value >= 0.0

Specifies the length of the unrotated box, in world units, along the X-axis of the working coordinate system.
Click to summarize M_SIZE_Y +

Inquires the box's length along the Y-axis, ignoring the box's rotation. The length is returned as if the box is axis-aligned. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value >= 0.0

Specifies the length of the unrotated box, in world units, along the Y-axis of the working coordinate system.
Click to summarize M_SIZE_Z +

Inquires the box's length along the Z-axis, ignoring the box's rotation. The length is returned as if the box is axis-aligned. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value >= 0.0

Specifies the length of the unrotated box, in world units, along the Z-axis of the working coordinate system.
Click to summarize M_UNROTATED_MAX_X +

Inquires the box's maximum X-coordinate, ignoring the box's rotation. The coordinate is returned as if the box is axis-aligned.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the box's maximum X-coordinate, ignoring the box's rotation, expressed in the working coordinate system.
Click to summarize M_UNROTATED_MAX_Y +

Inquires the box's maximum Y-coordinate, ignoring the box's rotation. The coordinate is returned as if the box is axis-aligned.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the box's maximum Y-coordinate, ignoring the box's rotation, expressed in the working coordinate system.
Click to summarize M_UNROTATED_MAX_Z +

Inquires the box's maximum Z-coordinate, ignoring the box's rotation. The coordinate is returned as if the box is axis-aligned.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the box's maximum Z-coordinate, ignoring the box's rotation, expressed in the working coordinate system.
Click to summarize M_UNROTATED_MIN_X +

Inquires the box's minimum X-coordinate, ignoring the box's rotation. The coordinate is returned as if the box is axis-aligned.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the box's minimum X-coordinate, ignoring the box's rotation, expressed in the working coordinate system.
Click to summarize M_UNROTATED_MIN_Y +

Inquires the box's minimum Y-coordinate, ignoring the box's rotation. The coordinate is returned as if the box is axis-aligned.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the box's minimum Y-coordinate, ignoring the box's rotation, expressed in the working coordinate system.
Click to summarize M_UNROTATED_MIN_Z +

Inquires the box's minimum Z-coordinate, ignoring the box's rotation. The coordinate is returned as if the box is axis-aligned.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the box's minimum Z-coordinate, ignoring the box's rotation, expressed in the working coordinate system.
Click to summarize 3D cylinder geometry object ID +

Specifies a 3D cylinder geometry object, allocated using M3dgeoAlloc() with M_GEOMETRY and successfully defined as a cylinder.

(summarize)
Click to summarize M_AXIS_X +

Inquires the X-component of the cylinder's central axis unit vector. This vector does not reflect the cylinder's length, regardless of whether a vector was used to define the cylinder's length.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize -1.0 >= Value >= 1.0

Specifies the X-component of the cylinder's central axis unit vector, expressed in the working coordinate system.
Click to summarize M_AXIS_Y +

Inquires the Y-component of the cylinder's central axis unit vector. This vector does not reflect the cylinder's length, regardless of whether a vector was used to define the cylinder's length.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize -1.0 >= Value >= 1.0

Specifies the Y-component of the cylinder's central axis unit vector, expressed in the working coordinate system.
Click to summarize M_AXIS_Z +

Inquires the Z-component of the cylinder's central axis unit vector. This vector does not reflect the cylinder's length, regardless of whether a vector was used to define the cylinder's length.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize -1.0 >= Value >= 1.0

Specifies the Z-component of the cylinder's central axis unit vector, expressed in the working coordinate system.
Click to summarize M_CENTER_X +

Inquires the X-coordinate of the center point on the cylinder's central axis. This inquire type is only available if the cylinder's length is not M_INFINITE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the X-coordinate of the center point on the cylinder's central axis, expressed in the working coordinate system.
Click to summarize M_CENTER_Y +

Inquires the Y-coordinate of the center point on the cylinder's central axis. This inquire type is only available if the cylinder's length is not M_INFINITE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Y-coordinate of the center point on the cylinder's central axis, expressed in the working coordinate system.
Click to summarize M_CENTER_Z +

Inquires the Z-coordinate of the center point on the cylinder's central axis. This inquire type is only available if the cylinder's length is not M_INFINITE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Z-coordinate of the center point on the cylinder's central axis, expressed in the working coordinate system.
Click to summarize M_END_POINT_X +

Inquires the X-coordinate of the cylinder's end point, positioned at the center of the cylinder's second circular base. This inquire type is only available if the cylinder's length is not M_INFINITE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the X-coordinate of the cylinder's end point, expressed in the working coordinate system.
Click to summarize M_END_POINT_Y +

Inquires the Y-coordinate of the cylinder's end point, positioned at the center of the cylinder's second circular base. This inquire type is only available if the cylinder's length is not M_INFINITE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Y-coordinate of the cylinder's end point, expressed in the working coordinate system.
Click to summarize M_END_POINT_Z +

Inquires the Z-coordinate of the cylinder's end point, positioned at the center of the cylinder's second circular base. This inquire type is only available if the cylinder's length is not M_INFINITE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Z-coordinate of the cylinder's end point, expressed in the working coordinate system.
Click to summarize M_LENGTH +

Inquires the cylinder's length.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_INFINITE

Specifies that the cylinder is infinite.
Click to summarize Value >= 0.0

Specifies the cylinder's length in world units.
Click to summarize M_RADIUS +

Inquires the cylinder's radius. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value >= 0.0

Specifies the cylinder's radius in world units.
Click to summarize M_START_POINT_X +

Inquires the X-coordinate of the cylinder's start point on the cylinder's central axis.

When the cylinder's length is infinite, this returns the X-coordinate of the first point used to define the cylinder. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the X-coordinate of the first point on the central axis used to define the cylinder, expressed in the working coordinate system.
Click to summarize M_START_POINT_Y +

Inquires the Y-coordinate of the cylinder's start point on the cylinder's central axis.

When the cylinder's length is infinite, this returns the Y-coordinate of the first point used to define the cylinder. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Y-coordinate of the first point on the central axis used to define the cylinder, expressed in the working coordinate system.
Click to summarize M_START_POINT_Z +

Inquires the Z-coordinate of the cylinder's start point on the cylinder's central axis.

When the cylinder's length is infinite, this returns the Z-coordinate of the first point used to define the cylinder. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Z-coordinate of the first point on the central axis used to define the cylinder, expressed in the working coordinate system.
Click to summarize 3D line geometry object ID +

Specifies a 3D line geometry object, allocated using M3dgeoAlloc() with M_GEOMETRY and successfully defined as a line.

(summarize)
Click to summarize M_AXIS_X +

Inquires the X-component of the line's direction unit vector. This vector does not reflect the line's length, regardless of whether a vector was used to define the line's length.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize -1.0 >= Value >= 1.0

Specifies the X-component of the line's direction unit vector, expressed in the working coordinate system.
Click to summarize M_AXIS_Y +

Inquires the Y-component of the line's direction unit vector. This vector does not reflect the line's length, regardless of whether a vector was used to define the line's length.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize -1.0 >= Value >= 1.0

Specifies the Y-component of the line's direction unit vector, expressed in the working coordinate system.
Click to summarize M_AXIS_Z +

Inquires the Z-component of the line's direction unit vector. This vector does not reflect the line's length, regardless of whether a vector was used to define the line's length.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize -1.0 >= Value >= 1.0

Specifies the Z-component of the line's direction unit vector, expressed in the working coordinate system.
Click to summarize M_CENTER_X +

Inquires the X-coordinate of the line's center point. This inquire type is only available if the line's length is not M_INFINITE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the X-coordinate of the center point on the line, expressed in the working coordinate system.
Click to summarize M_CENTER_Y +

Inquires the Y-coordinate of the line's center point. This inquire type is only available if the line's length is not M_INFINITE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Y-coordinate of the center point on the line, expressed in the working coordinate system.
Click to summarize M_CENTER_Z +

Inquires the Z-coordinate of the line's center point. This inquire type is only available if the line's length is not M_INFINITE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Z-coordinate of the center point on the line, expressed in the working coordinate system.
Click to summarize M_END_POINT_X +

Inquires the X-coordinate of the line's end point. This inquire type is only available if the line's length is not M_INFINITE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the X-coordinate of the line's end point, expressed in the working coordinate system.
Click to summarize M_END_POINT_Y +

Inquires the Y-coordinate of the line's end point. This inquire type is only available if the line's length is not M_INFINITE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Y-coordinate of the line's end point, expressed in the working coordinate system.
Click to summarize M_END_POINT_Z +

Inquires the Z-coordinate of the line's end point. This inquire type is only available if the line's length is not M_INFINITE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Z-coordinate of the line's end point, expressed in the working coordinate system.
Click to summarize M_LENGTH +

Inquires the line's length.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_INFINITE

Specifies that the line is infinite.
Click to summarize Value >= 0.0

Specifies the line's length in world units.
Click to summarize M_START_POINT_X +

Inquires the X-coordinate of the line's start point.

When the line's length is infinite, this returns the X-coordinate of the first point used to define the line. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the X-coordinate of the first point used to define the line, expressed in the working coordinate system.
Click to summarize M_START_POINT_Y +

Inquires the Y-coordinate of the line's start point.

When the line's length is infinite, this returns the Y-coordinate of the first point used to define the line. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Y-coordinate of the first point used to define the line, expressed in the working coordinate system.
Click to summarize M_START_POINT_Z +

Inquires the Z-coordinate of the line's start point.

When the line's length is infinite, this returns the Z-coordinate of the first point used to define the line. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Z-coordinate of the first point used to define the line, expressed in the working coordinate system.
Click to summarize 3D plane geometry object ID +

Specifies a 3D plane geometry object, allocated using M3dgeoAlloc() with M_GEOMETRY and successfully defined as a plane.

(summarize)
Click to summarize M_CLOSEST_TO_ORIGIN_X +

Inquires the X-coordinate of the point on the plane closest to the origin of the working coordinate system.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the X-coordinate of the point on the plane closest to the origin of the working coordinate system.
Click to summarize M_CLOSEST_TO_ORIGIN_Y +

Inquires the Y-coordinate of the point on the plane closest to the origin of the working coordinate system.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Y-coordinate of the point on the plane closest to the origin of the working coordinate system.
Click to summarize M_CLOSEST_TO_ORIGIN_Z +

Inquires the Z-coordinate of the point on the plane closest to the origin of the working coordinate system.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Z-coordinate of the point on the plane closest to the origin of the working coordinate system.
Click to summarize M_COEFFICIENT_A +

Inquires the coefficient A of the plane equation, Ax + By + Cz + D = 0. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize -1.0 >= Value >= 1.0

Specifies the coefficient A of the plane equation.
Click to summarize M_COEFFICIENT_B +

Inquires the coefficient B of the plane equation, Ax + By + Cz + D = 0. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize -1.0 >= Value >= 1.0

Specifies the coefficient B of the plane equation.
Click to summarize M_COEFFICIENT_C +

Inquires the coefficient C of the plane equation, Ax + By + Cz + D = 0. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize -1.0 >= Value >= 1.0

Specifies the coefficient C of the plane equation.
Click to summarize M_COEFFICIENT_D +

Inquires the coefficient D of the plane equation, Ax + By + Cz + D = 0. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the coefficient D of the plane equation.
Click to summarize M_NORMAL_X +

Inquires the X-component of the plane's normal unit vector. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize -1.0 >= Value >= 1.0

Specifies the X-component of the plane's normal unit vector, expressed in the working coordinate system.
Click to summarize M_NORMAL_Y +

Inquires the Y-component of the plane's normal unit vector. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize -1.0 >= Value >= 1.0

Specifies the Y-component of the plane's normal unit vector, expressed in the working coordinate system.
Click to summarize M_NORMAL_Z +

Inquires the Z-component of the plane's normal unit vector. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize -1.0 >= Value >= 1.0

Specifies the Z-component of the plane's normal unit vector, expressed in the working coordinate system.
Click to summarize 3D sphere geometry object ID +

Specifies a 3D sphere geometry object, allocated using M3dgeoAlloc() with M_GEOMETRY and successfully defined as a sphere.

(summarize)
Click to summarize M_CENTER_X +

Inquires the X-coordinate of the sphere's center point. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the X-coordinate of the sphere's center point, expressed in the working coordinate system.
Click to summarize M_CENTER_Y +

Inquires the Y-coordinate of the sphere's center point. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Y-coordinate of the sphere's center point, expressed in the working coordinate system.
Click to summarize M_CENTER_Z +

Inquires the Z-coordinate of the sphere's center point. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the Z-coordinate of the sphere's center point, expressed in the working coordinate system.
Click to summarize M_RADIUS +

Inquires the sphere's radius. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value >= 0.0

Specifies the sphere's radius in world units.

For any transformation matrix object, the GeometryOrMatrix3dgeoId and InquireType parameters can be set to one of the following:

function map For inquiring about any transformation matrix object
Click to summarize
GeometryOrMatrix3dgeoId		 Description
InquireType
UserVarPtr
- Possible values returned
Click to summarize Transformation matrix object ID +

Specifies a transformation matrix object, allocated using M3dgeoAlloc() with M_TRANSFORMATION_MATRIX.

(summarize)
Click to summarize M_AFFINE +

Inquires whether the transformation matrix object is an affine transformation matrix.

An affine transformation matrix has translation and/or rotation and/or scale transformations. The scale can be uniform or non-uniform.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_FALSE

Specifies that the transformation matrix object is not an affine transformation matrix.
Click to summarize M_TRUE

Specifies that the transformation matrix object is an affine transformation matrix.
Click to summarize M_AXIS_ALIGNED +

Inquires whether the transformation matrix object is an axis-aligned transformation matrix.

An axis-aligned transformation matrix has translation and/or scale transformations.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_FALSE

Specifies that the transformation matrix object is not an axis-aligned transformation matrix.
Click to summarize M_TRUE

Specifies that the transformation matrix object is an axis-aligned transformation matrix.
Click to summarize M_IDENTITY +

Inquires whether the transformation matrix object is an identity transformation matrix.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_FALSE

Specifies that the transformation matrix object is not an identity matrix.
Click to summarize M_TRUE

Specifies that the transformation matrix object is an identity matrix.
Click to summarize M_MIRROR +

Inquires whether the transformation matrix object preserves the handedness of the coordinate system. If true, applying the matrix will flip the handedness of the coordinate system.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_FALSE

Specifies that applying the transformation matrix object will flip the handedness of the coordinate system.
Click to summarize M_TRUE

Specifies that applying the transformation matrix object preserves the handedness of the coordinate system.
Click to summarize M_RIGID +

Inquires whether the transformation matrix object is a rigid transformation matrix.

A rigid transformation matrix has translation and/or rotation transformations.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_FALSE

Specifies that the transformation matrix object is not a rigid transformation matrix.
Click to summarize M_TRUE

Specifies that the transformation matrix object is a rigid transformation matrix.
Click to summarize M_ROTATION +

Inquires whether the transformation matrix object is a rotation transformation matrix.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_FALSE

Specifies that the transformation matrix object is not a rotation transformation matrix.
Click to summarize M_TRUE

Specifies that the transformation matrix object is a rotation transformation matrix.
Click to summarize M_SCALE +

Inquires whether the transformation matrix object is a scale transformation matrix. The scale can be uniform or non-uniform.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_FALSE

Specifies that the transformation matrix object is not a scale transformation matrix.
Click to summarize M_TRUE

Specifies that the transformation matrix object is a scale transformation matrix.
Click to summarize M_SCALE_UNIFORM +

Inquires whether the transformation matrix object is a uniform scale transformation matrix.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_FALSE

Specifies that the transformation matrix object is not a uniform scale transformation matrix.
Click to summarize M_TRUE

Specifies that the transformation matrix object is a uniform scale transformation matrix.
Click to summarize M_SIMILARITY +

Inquires whether the transformation matrix object is a similarity transformation matrix.

A similarity transformation matrix has translation and/or rotation and/or uniform scale transformations.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_FALSE

Specifies that the transformation matrix object is not a similarity transformation matrix.
Click to summarize M_TRUE

Specifies that the transformation matrix object is a similarity transformation matrix.
Click to summarize M_TRANSFORMATION_TYPE +

Inquires the transformation matrix object's transformation type.

Note that this inquire type will return the strictest type that matches the transformation matrix object. For example, if the transformation matrix object is a rotation transformation matrix, it will return true for M_ROTATION, M_RIGID, M_SIMILARITY, and M_AFFINE, but M_TRANSFORMATION_TYPE will return M_ROTATION.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_AFFINE

Specifies an affine transformation matrix. This is returned if the transformation matrix object has a non-uniform scale transformation, and at least one other type of transformation, including translation or rotation.

(summarize)
Click to summarize M_AXIS_ALIGNED

Specifies an axis-aligned transformation matrix. This is returned if the transformation matrix object has translation and scale transformations.

(summarize)
Click to summarize M_IDENTITY

Specifies an identity transformation matrix.
Click to summarize M_PROJECTION

Specifies a projection transformation matrix.
Click to summarize M_RIGID

Specifies a rigid transformation matrix. This is returned if the transformation matrix object has rotation and translation transformations.

(summarize)
Click to summarize M_ROTATION

Specifies a rotation transformation matrix.
Click to summarize M_SCALE

Specifies a scale transformation matrix. This is returned if the transformation matrix object has a non-uniform transformation.

(summarize)
Click to summarize M_SCALE_UNIFORM

Specifies a uniform scale transformation matrix.
Click to summarize M_SIMILARITY

Specifies a similarity transformation matrix. This is returned if the transformation matrix object has a uniform scale transformation, and at least one other type of transformation, including translation or rotation.

(summarize)
Click to summarize M_TRANSLATION

Specifies a translation transformation matrix.
Click to summarize M_TRANSLATION +

Inquires whether the transformation matrix object is a translation transformation matrix.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_FALSE

Specifies that the transformation matrix object is not a translation transformation matrix.
Click to summarize M_TRUE

Specifies that the transformation matrix object is a translation transformation matrix.
Combination value for the values listed in all the parameter association tables.

You can add the following value to the above-mentioned values to determine whether an inquire type is supported.

function map For inquiring whether an inquire type is supported
Click to summarizeGeometryOrMatrix3dgeoId Description
InquireType
UserVarPtr
- Possible values returned
Click to summarize M_SUPPORTED

Inquires whether the specified inquire type is supported.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_FALSE

Specifies that the inquire type is not supported.
Click to summarize M_TRUE

Specifies that the inquire type is supported.
Combination values for the values listed in all the parameter association tables.

You can add one of the following values to the above-mentioned values to cast the requested information to the required data type.

Note: In C++, when using a standard vector (std::vector) instead of an array, the values listed in this combination table must not be used. If you need to use a specific data type, instantiate the vector with the necessary data type.

function map For specifying the data type
Click to summarizeGeometryOrMatrix3dgeoId Description
InquireType
UserVarPtr
- Possible values returned
Click to summarize M_TYPE_MIL_DOUBLE

Casts the requested information to a MIL_DOUBLE.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_TYPE_MIL_FLOAT

Casts the requested information to a MIL_FLOAT.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_FLOAT  |  array of type MIL_FLOAT [optionally, in C++: a reference to a std::vector<MIL_FLOAT> ] MORE
Click to summarize M_TYPE_MIL_INT

Casts the requested information to a MIL_INT.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT  |  array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE
Click to summarize M_TYPE_MIL_INT32

Casts the requested information to a MIL_INT32.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT32  |  array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ] MORE
Click to summarize M_TYPE_MIL_INT64

Casts the requested information to a MIL_INT64.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64  |  array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] MORE
Return value
The returned value is the requested information, cast to a MIL_DOUBLE. If the requested information does not fit into a MIL_DOUBLE, this function will return M_NULL or truncate the information.
Compilation information
Header Include mil.h.
Library Use mil.lib; mil3d.lib.
DLL Requires mil.dll; mil3d.dll.
GEOMETRY TYPE BOX CYLINDER LINE NOT INITIALIZED PLANE SPHERE BOX AXIS ALIGNED FALSE TRUE CENTER X CENTER Y CENTER Z CORNER X ALL CORNER Y ALL CORNER Z ALL SIZE X SIZE Y SIZE Z UNROTATED MAX X UNROTATED MAX Y UNROTATED MAX Z UNROTATED MIN X UNROTATED MIN Y UNROTATED MIN Z CYLINDER AXIS X AXIS Y AXIS Z CENTER X CENTER Y CENTER Z END POINT X END POINT Y END POINT Z LENGTH INFINITE RADIUS START POINT X START POINT Y START POINT Z LINE AXIS X AXIS Y AXIS Z CENTER X CENTER Y CENTER Z END POINT X END POINT Y END POINT Z LENGTH INFINITE START POINT X START POINT Y START POINT Z PLANE CLOSEST TO ORIGIN X CLOSEST TO ORIGIN Y CLOSEST TO ORIGIN Z COEFFICIENT A COEFFICIENT B COEFFICIENT C COEFFICIENT D NORMAL X NORMAL Y NORMAL Z SPHERE CENTER X CENTER Y CENTER Z RADIUS AFFINE FALSE TRUE AXIS ALIGNED FALSE TRUE IDENTITY FALSE TRUE MIRROR FALSE TRUE RIGID FALSE TRUE ROTATION FALSE TRUE SCALE FALSE TRUE SCALE UNIFORM FALSE TRUE SIMILARITY FALSE TRUE TRANSFORMATION TYPE AFFINE AXIS ALIGNED IDENTITY PROJECTION RIGID ROTATION SCALE SCALE UNIFORM SIMILARITY TRANSLATION TRANSLATION FALSE TRUE SUPPORTED FALSE TRUE TYPE MIL DOUBLE TYPE MIL FLOAT TYPE MIL INT TYPE MIL INT32 TYPE MIL INT64 BOX CYLINDER LINE PLANE SPHERE INFINITE INFINITE