| Customize Help
| Save Settings

M3dgraAxis


Function Map
Syntax
Description
Parameters
- List3dgraId
- ParentLabel
Table: For specifying the parent label
- Matrix3dgeoId
Table: For specifying the transformation matrix object identifier
- AxisLength
Table: For specifying the length of the axes
- Name
Table: For specifying the string
- Options
Table: For specifying extra options
- ControlFlag
Return value
Compilation information
Synopsis
Add an axis graphic to a 3D graphics list.
Syntax
MIL_INT64 M3dgraAxis(
MIL_ID List3dgraId, //in
MIL_INT64 ParentLabel, //in
MIL_ID Matrix3dgeoId, //in
MIL_DOUBLE AxisLength, //in
MIL_CONST_TEXT_PTR Name, //in
MIL_INT64 Options, //in
MIL_INT64 ControlFlag //in
)
Description

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

Axis graphics consist of three orthogonal right-handed axes (X, Y, and Z) that intersect at a single point. This 3D graphic can be used to represent a coordinate system.

You must specify the label of the 3D graphic, in the 3D graphics list, to use as the parent of the axis graphic. When the axis 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 axis graphic's parent must be the root node.

The axis graphic has its own coordinate system that represents the position and orientation of the axis graphic's axes with respect to its parent's coordinate system. The origin of the axis graphic's coordinate system is the origin of the axes, and its orientation is the orientation of the axes. Therefore, the axis graphic's coordinate system is the axis graphic itself. You can set the axis graphic's position and orientation using the Matrix3dgeoId parameter.

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 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 axis graphic.

ParentLabel

Specifies the label of the parent of the axis 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 axis graphic in the 3D graphics list. Label 0 is the 3D graphics list's root node.

(summarize)
Matrix3dgeoId

Specifies the identifier of the transformation matrix that defines the axis graphic's position and orientation with respect to its parent's coordinate system.

function map For specifying the transformation matrix object identifier
Click to summarizeValue Description
Click to summarize M_DEFAULT

Same as M_IDENTITY_MATRIX.
Click to summarize M_IDENTITY_MATRIX

Specifies the identity matrix. This means that the axis graphic's position and orientation is the same as the position and orientation of its parent's coordinate system.

(summarize)
Click to summarize MIL transformation matrix object identifier

Specifies the identifier of the transformation matrix that defines the axis graphic's position and orientation with respect to its parent's coordinate system. The transformation matrix must be of type M_RIGID.

(summarize)
AxisLength

Specifies the length of the axes.

function map For specifying the length of the axes
Click to summarizeValue Description
Click to summarize Value > 0.0

Specifies the length of the axes, in world units.
Name

Specifies an optional name for the axis graphic (for example, "Working coordinate system"). If this parameter is not empty, this creates a text graphic with the axis graphic as its parent, and the axis name as its text.

function map For specifying the string
Click to summarizeValue Description
Click to summarize M_NULL

Specifies not to give the axis graphic a name.
Click to summarize MIL_TEXT("String") 1

Specifies the address of the null-terminated (\0) ASCII string that must be shown in the text graphic. There is no restriction on the length of the string.

(summarize)

1 If you are passing the value in a variable, don't enclose it in MIL_TEXT().

Options

Specifies extra options for the appearance of the Name text graphic. If Name is set to an empty string, or to M_NULL, this parameter is ignored.

function map For specifying extra options
Click to summarizeValue Description
Click to summarize M_DEFAULT

Specifies that the text is written in the direction of the text graphic's coordinate system's X-axis, and that the text faces the direction of the Z-axis of the text graphic's coordinate system. INFO
Click to summarize M_FLIP

Specifies that the text is mirrored across the X-axis. INFO
ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Return value
Returns the label of the axis graphic added to the 3D graphics list.
Compilation information
Header Include mil.h.
Library Use mil.lib; mil3d.lib.
DLL Requires mil.dll; mil3d.dll.
DEFAULT ROOT NODE DEFAULT IDENTITY MATRIX TRUE NULL DEFAULT FLIP