| Customize Help
| Save Settings

M3dgraDots



Function Map
Synopsis
Add a dots graphic to a 3D graphics list.
Syntax
MIL_INT64 M3dgraDots(
MIL_ID List3dgraId, //in
MIL_INT64 ParentLabel, //in
MIL_INT NumPoints, //in
const MIL_DOUBLE *CoordXArrayPtr, //in
const MIL_DOUBLE *CoordYArrayPtr, //in
const MIL_DOUBLE *CoordZArrayPtr, //in
const MIL_UINT8 *PointsRArrayPtr, //in
const MIL_UINT8 *PointsGArrayPtr, //in
const MIL_UINT8 *PointsBArrayPtr, //in
MIL_INT64 ControlFlag //in
)
Description

This function adds a dots graphic to the specified 3D graphics list, allowing you to, for example, view the dots graphic on a 3D display.

You must specify the label of the 3D graphic, in the 3D graphics list, to use as the parent of the dots graphic. When the dots graphic is added to the 3D graphics list's tree structure, it is added as a child under the specified parent. If the 3D graphics list is empty, the dots graphic's parent must be the root node. All coordinates are expressed in the coordinate system of the dots graphic's parent.

The dots graphic has its own coordinate system that represents the position and orientation of the dots with respect to its parent's coordinate system. The coordinates of the dots, specified by CoordXArrayPtr, CoordYArrayPtr, and CoordZArrayPtr, are expressed in the dots graphic's coordinate system. Initially, the dots graphic's position and orientation is the identity matrix. This means that the dots graphic's position and orientation is the same as the position and orientation of its parent's coordinate system.

To modify or inquire 3D graphics list settings, use M3dgraControl() or M3dgraInquire(), respectively.

Unlike most other functions that modify a MIL object, you can call this function concurrently from multiple threads on the same MIL 3D graphics list (List3dgraId) without using an M_MUTEX object, as long as all the other parameters of the concurrent calls do not also share data.

Note that when using a C compiler (not a C++ or other compiler) in 64-bit mode, M3dgraDots() internally calls the MIL_DOUBLE version of this function (M3dgraDotsDouble()). If you need to pass type-specific values, call the MIL_FLOAT version of this function (M3dgraDotsFloat()).
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
List3dgraId

Specifies the identifier of the 3D graphics list in which to add the dots graphic.

ParentLabel

Specifies the label of the parent of the dots graphic in the 3D graphics list.

function map For specifying the parent label
Click to summarizeValue Description
Click to summarize M_DEFAULT

Same as M_ROOT_NODE.

Click to summarize M_ROOT_NODE

Specifies the top-most node of the 3D graphics list.

Click to summarize Value >= 0

Specifies the label of the parent of the dots graphic in the 3D graphics list. Label 0 is the 3D graphics list's root node.

(summarize)
NumPoints

Specifies the number of points in the dots graphic.

When using a standard vector (std::vector) overload function in C++, you can pass M_DEFAULT to this parameter and MIL will automatically determine the size based on the number of items in the vector passed to the CoordXArrayPtr, CoordYArrayPtr, CoordZArrayPtr, PointsRArrayPtr, PointsGArrayPtr, or PointsBArrayPtr parameter.

CoordXArrayPtr
Accepts the address of one of the following:
  • array of type MIL_DOUBLE [optionally, in C++: a reference to a constant std::vector<MIL_DOUBLE> ] (and a maximum array rank for C# of 1)
    Required array size:(NumPoints)
  • array of type MIL_FLOAT [optionally, in C++: a reference to a constant std::vector<MIL_FLOAT> ] (and a maximum array rank for C# of 1)
    Required array size:(NumPoints)

Specifies the list of X-coordinates of the points in the dots graphic.

CoordYArrayPtr
Accepts the address of one of the following:
  • array of type MIL_DOUBLE [optionally, in C++: a reference to a constant std::vector<MIL_DOUBLE> ] (and a maximum array rank for C# of 1)
    Required array size:(NumPoints)
  • array of type MIL_FLOAT [optionally, in C++: a reference to a constant std::vector<MIL_FLOAT> ] (and a maximum array rank for C# of 1)
    Required array size:(NumPoints)

Specifies the list of Y-coordinates of the points in the dots graphic.

CoordZArrayPtr
Accepts the address of one of the following:
  • array of type MIL_DOUBLE [optionally, in C++: a reference to a constant std::vector<MIL_DOUBLE> ] (and a maximum array rank for C# of 1)
    Required array size:(NumPoints)
  • array of type MIL_FLOAT [optionally, in C++: a reference to a constant std::vector<MIL_FLOAT> ] (and a maximum array rank for C# of 1)
    Required array size:(NumPoints)

Specifies the list of Z-coordinates of the points in the dots graphic.

PointsRArrayPtr
Accepts the address of one of the following:
  • array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ] (and a maximum array rank for C# of 1)
    Required array size:(NumPoints)

Specifies the list of red values of the color of the points in the dots graphic.

You can set this parameter to M_NULL, in which case PointsGArrayPtr and PointsBArrayPtr must also be set to M_NULL. All points will be colored using M_COLOR_WHITE.

PointsGArrayPtr
Accepts the address of one of the following:
  • array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ] (and a maximum array rank for C# of 1)
    Required array size:(NumPoints)

Specifies the list of green values of the color of the points in the dots graphic.

PointsBArrayPtr
Accepts the address of one of the following:
  • array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ] (and a maximum array rank for C# of 1)
    Required array size:(NumPoints)

Specifies the list of blue values of the color of the points in the dots graphic.

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Return value
Returns the label of the dots graphic added to the 3D graphics list.
Type-specific versions of the function when using a C compiler under 64-bit
MIL_INT64 M3dgraDotsDouble (MIL_ID List3dgraId, MIL_INT64 ParentLabel, MIL_INT NumPoints, const MIL_DOUBLE *CoordXArrayPtr, const MIL_DOUBLE *CoordYArrayPtr, const MIL_DOUBLE *CoordZArrayPtr, const MIL_UINT8 *PointsRArrayPtr, const MIL_UINT8 *PointsGArrayPtr, const MIL_UINT8 *PointsBArrayPtr, MIL_INT64 ControlFlag)
Parameters

List3dgraId

See List3dgraId of the main function for a description.

ParentLabel

See ParentLabel of the main function for a description.

NumPoints

See NumPoints of the main function for a description.

CoordXArrayPtr

See CoordXArrayPtr of the main function for a description.

CoordYArrayPtr

See CoordYArrayPtr of the main function for a description.

CoordZArrayPtr

See CoordZArrayPtr of the main function for a description.

PointsRArrayPtr

See PointsRArrayPtr of the main function for a description.

PointsGArrayPtr

See PointsGArrayPtr of the main function for a description.

PointsBArrayPtr

See PointsBArrayPtr of the main function for a description.

ControlFlag

See ControlFlag of the main function for a description.

MIL_INT64 M3dgraDotsFloat (MIL_ID List3dgraId, MIL_INT64 ParentLabel, MIL_INT NumPoints, const MIL_FLOAT *CoordXArrayPtr, const MIL_FLOAT *CoordYArrayPtr, const MIL_FLOAT *CoordZArrayPtr, const MIL_UINT8 *PointsRArrayPtr, const MIL_UINT8 *PointsGArrayPtr, const MIL_UINT8 *PointsBArrayPtr, MIL_INT64 ControlFlag)
Parameters

List3dgraId

See List3dgraId of the main function for a description.

ParentLabel

See ParentLabel of the main function for a description.

NumPoints

See NumPoints of the main function for a description.

CoordXArrayPtr

See CoordXArrayPtr of the main function for a description.

CoordYArrayPtr

See CoordYArrayPtr of the main function for a description.

CoordZArrayPtr

See CoordZArrayPtr of the main function for a description.

PointsRArrayPtr

See PointsRArrayPtr of the main function for a description.

PointsGArrayPtr

See PointsGArrayPtr of the main function for a description.

PointsBArrayPtr

See PointsBArrayPtr of the main function for a description.

ControlFlag

See ControlFlag of the main function for a description.

Compilation information
Header Include mil.h.
Library Use mil.lib; mil3d.lib.
DLL Requires mil.dll; mil3d.dll.
DEFAULT ROOT NODE