| Customize Help
| Save Settings

MgraInquireList



Function Map
Synopsis
Inquire information about a 2D graphics list or a graphic contained within the 2D graphics list.
Syntax
MIL_INT MgraInquireList(
MIL_ID GraListId, //in
MIL_INT LabelOrIndex, //in
MIL_INT SubIndex, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires information about a specified 2D graphics list, or a graphic contained within the 2D graphics list.

Unlike most other functions that modify a MIL object, you can call this function concurrently from multiple threads on the same MIL 2D graphics list (GraListId) 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 which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
Parameters
GraListId

Specifies the identifier of the 2D graphics list about which to inquire information. The 2D graphics list must have been previously allocated on the required system using MgraAllocList().

LabelOrIndex

Specifies the graphic about which to inquire, or specifies to inquire about the 2D graphics list itself. This parameter should be set to one of the following values:

function map For specifying the graphic or the 2D graphics list
Click to summarizeValue Description
Click to summarize

Specifies the index of an existing graphic about which to inquire.

(summarize)
Parameters

Specifies the index. The index is from 0 (inclusive) to the total number of graphics in the list minus 1. You can get the number graphics in the list with M_NUMBER_OF_GRAPHICS.

If the inquired value is not supported on the graphic specified, an error is generated.

Click to summarize

Specifies the label of an existing graphic about which to inquire.

(summarize)
Parameters

Specifies the label. The label must be greater than 0. You can get the label of the last graphic added to the list with M_LAST_LABEL.

If the inquired value is not supported on the graphic specified, an error is generated.

Click to summarize M_LIST

Inquires information about the 2D graphics list itself.

SubIndex

Specifies the index of the sub-element of the graphic about which to inquire. If this information is not required or supported, set this parameter to M_DEFAULT.

function map For specifying the index of a graphic's sub-element
Click to summarizeValue Description
Click to summarize M_DEFAULT

Specifies to inquire about the graphic itself (instead of just a sub-element).

Click to summarize 0 <= Value <= M_NUMBER_OF_SUB_ELEMENTS

Specifies the index of the sub-element of the graphic about which to inquire. The following table lists all the graphics for which you can inquire information about their individual sub-elements and outlines how sub-indices are assigned for each of these.

Graphics types

Index of sub-element values

Dots (created using MgraDots()).

The indices, starting from 0, are assigned to each dot in order of creation.

A single line (created using MgraLine() or user-defined using MgraInteractive() set to M_GRAPHIC_TYPE_LINE).

0 is assigned to the specified start point, and 1 is assigned to the specified end point of the line.

Sets of finite length lines (created using MgraLines() with M_LINE_LIST).

The indices, starting from 0, are assigned to the specified start point and end point of each line, in order of creation. For example, the start point of the first line has an index of 0 and the end point has an index of 1, and the start point of the second line has an index of 2 and the end point has an index of 3.

Sets of infinite lines (created using MgraLines() with M_INFINITE_LINES).

The indices, starting from 0, are assigned to the first and second specified point of each line, in order of creation. For example, the first specified point of the first line has an index of 0 and its second specified point has an index of 1, and the first specified point of the second line has an index of 2 and its second specified point has an index of 3.

A polygon (created using MgraLines() with M_POLYGON or user-defined using MgraInteractive() set to M_GRAPHIC_TYPE_POLYGON).

The indices, starting from 0, are assigned to each polygon vertex in order of creation.

A polyline (created using MgraLines() with M_POLYLINE or user-defined using MgraInteractive() set to M_GRAPHIC_TYPE_POLYLINE).

The indices, starting from 0, are assigned to each polyline point in order of creation.

(summarize)
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):
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT
  • MIL_INT32
  • MIL_INT64

Specifies the address in which to write the requested information. Since the MgraInquireList() 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.

To inquire about a setting of a 2D graphics list, the InquireType parameter should be set to one of the following values. In this case, you must set the LabelOrIndex parameter to M_LIST and the SubIndex parameter to M_DEFAULT.

function map For inquiring about a setting of a 2D graphics list itself
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_ANGLE_SNAPPING_VALUE +

Inquires the value to use as a multiple when rotating the graphic. This value only applies when using M_MODE_ROTATE with M_ANGLE_SNAPPING. 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 <= 180.0

Specifies the value to use as a multiple, in degrees. INFO

Click to summarize M_EASY_SELECTION +

Inquires whether MIL allows for the easy selection of graphics on the display. SET

(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_DISABLE

Specifies that MIL does not allow for the easy selection of graphics on the display.

Click to summarize M_ENABLE

Specifies that MIL allows for the easy selection of graphics on the display.

Click to summarize M_INTERACTIVE_ANNOTATIONS_COLOR +

Inquires the color of the selection box and handles when in interactive mode. 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 M_COLOR_BLACK

Specifies the color black.

Click to summarize M_COLOR_BLUE

Specifies the color blue.

Click to summarize M_COLOR_BRIGHT_GRAY

Specifies the color bright gray.

Click to summarize M_COLOR_CYAN

Specifies the color cyan.

Click to summarize M_COLOR_DARK_BLUE

Specifies the color dark blue.

Click to summarize M_COLOR_DARK_CYAN

Specifies the color dark cyan.

Click to summarize M_COLOR_DARK_GREEN

Specifies the color dark green.

Click to summarize M_COLOR_DARK_MAGENTA

Specifies the color dark magenta.

Click to summarize M_COLOR_DARK_RED

Specifies the color dark red.

Click to summarize M_COLOR_DARK_YELLOW

Specifies the color dark yellow.

Click to summarize M_COLOR_GRAY

Specifies the color gray.

Click to summarize M_COLOR_GREEN

Specifies the color green.

Click to summarize M_COLOR_LIGHT_BLUE

Specifies the color light blue.

Click to summarize M_COLOR_LIGHT_GRAY

Specifies the color light gray.

Click to summarize M_COLOR_LIGHT_GREEN

Specifies the color light green.

Click to summarize M_COLOR_LIGHT_WHITE

Specifies the color light white.

Click to summarize M_COLOR_MAGENTA

Specifies the color magenta.

Click to summarize M_COLOR_RED

Specifies the color red.

Click to summarize M_COLOR_WHITE

Specifies the color white.

Click to summarize M_COLOR_YELLOW

Specifies the color yellow.

Click to summarize Byte-encoded RGB value

Specifies an encoded RGB value. To verify if the value is a byte-encoded RGB value, use the M_IS_RGB888 macro. To retrieve the R, G, and B components, use the M_RGB888_R, M_RGB888_G, and M_RGB888_B macros.

(summarize)
Click to summarize Value

Specifies a grayscale value. INFO

Click to summarize M_INTERACTIVE_GRAPHIC_STATE +

Inquires the current state of interactivity of the 2D graphics list.

(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_STATE_BEING_CREATED

Specifies that a new graphic is being created.

Click to summarize M_STATE_GRAPHIC_DRAGGED

Specifies that a graphic is being dragged using the mouse.

Click to summarize M_STATE_GRAPHIC_HOVERED

Specifies that the cursor is currently hovering over a graphic.

Click to summarize M_STATE_HANDLE_DRAGGED

Specifies that a graphic's handle is being dragged using the mouse.

Click to summarize M_STATE_HANDLE_HOVERED

Specifies that the cursor is currently hovering over a graphic's handle.

Click to summarize M_STATE_IDLE

Specifies that the cursor is not hovering over anything and that no graphic is queued for creation.

Click to summarize M_STATE_WAITING_FOR_CREATION

Specifies that a graphic is queued for creation.

Click to summarize M_LAST_LABEL +

Inquires the label that was automatically assigned to the last graphic added to the list in the current thread. This label value will never change, even if the order of the graphics in the list changes.

After adding a graphic to the 2D graphics list, you should use this inquire type to establish the label assigned to it. This label can be used as a means of identifying the graphic independently from its index, which might change if a graphic is deleted from the list.

You cannot retrieve the label value of the last added graphic if it has been deleted or moved to another 2D graphics list. If a graphic was added to the list from a different thread, the value returned will be that of the last graphic added to the list from the current thread; it will not return the label value of graphics added from a separate thread. This can be problematic when using MgraInteractive() to add graphics to the list interactively, since the graphics might be added from a separate thread. In this case, use MgraGetHookInfo() with M_GRAPHIC_LABEL_VALUE. See the Creating and modifying graphics interactively section of Chapter 24: Generating graphics for an example of how to inquire the label of a graphic added interactively.

(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_NO_LABEL

Specifies the last-added graphic is no longer in the list or no graphics have been added to the list.

Click to summarize Value

Specifies the label of the last-added graphic in the list.

Click to summarize M_MODE_RESIZE +

Inquires the interactive behavior when resizing the graphic using its selection box. SET

(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_FIXED_CENTER +

Specifies that all sides of the selection box move symmetrically, and the center does not move, when resizing the graphic.

Click to summarize M_FIXED_CORNER +

Specifies that the center moves, and the opposite corner does not move, when resizing the graphic. INFO

Click to summarize M_MODE_RESIZE_ALT +

Inquires the interactive behavior when resizing the graphic using its selection box and pressing the Alt key. SET

(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_DISABLE

Specifies that pressing the Alt key does not affect how to resize the graphic. INFO

Click to summarize M_FIXED_ASPECT_RATIO

Specifies that the aspect ratio of the graphic remains constant, when resizing the graphic while pressing the Alt key. INFO

Click to summarize M_FIXED_CENTER

Specifies that all sides of the selection box move symmetrically, and the center does not move, when resizing the graphic while pressing the Alt key. INFO

Click to summarize M_FIXED_CORNER

Specifies that the center moves, and the opposite corner does not move, when resizing the graphic while pressing the Alt key. INFO

Click to summarize M_NO_CONSTRAINT

Specifies that the aspect ratio of the graphic can change, when resizing it while pressing the Alt key. INFO

Click to summarize M_SQUARE_ASPECT_RATIO

Specifies that the aspect ratio of the graphic will be 1:1 (square), when resizing it while pressing the Alt key. INFO

Click to summarize M_MODE_RESIZE_CTRL +

Inquires the interactive behavior when resizing the graphic using its selection box and pressing the Ctrl key. SET

(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_DISABLE

Specifies that pressing the Ctrl key does not affect how to resize the graphic. INFO

Click to summarize M_FIXED_ASPECT_RATIO

Specifies that the aspect ratio of the graphic remains constant, when resizing the graphic while pressing the Ctrl key. INFO

Click to summarize M_FIXED_CENTER

Specifies that all sides of the selection box move symmetrically, and the center does not move, when resizing the graphic while pressing the Ctrl key. INFO

Click to summarize M_FIXED_CORNER

Specifies that the center moves, and the opposite corner does not move, when resizing the graphic while pressing the Ctrl key. INFO

Click to summarize M_NO_CONSTRAINT

Specifies that the aspect ratio of the graphic can change, when resizing it while pressing the Ctrl key. INFO

Click to summarize M_SQUARE_ASPECT_RATIO

Specifies that the aspect ratio of the graphic will be 1:1 (square), when resizing it while pressing the Ctrl key. INFO

Click to summarize M_MODE_RESIZE_SECONDARY_DIMENSION +

Inquires the interactive behavior when changing the graphic's secondary dimension during its creation. SET

(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_ONE_SIDED

Specifies to establish the graphic's secondary dimension on one side of a previously established part. INFO

Click to summarize M_SYMMETRIC

Specifies to establish the graphic's secondary dimension symmetrically on both sides of a previously established part. INFO

Click to summarize M_MODE_RESIZE_SECONDARY_DIMENSION_ALT +

Inquires the interactive behavior when changing the graphic's secondary dimension during its creation, and pressing the Alt key. SET

(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_DISABLE

Specifies that pressing the Alt key does not affect how to establish the graphic's secondary dimension when defining it interactively on the display. INFO

Click to summarize M_ONE_SIDED

Specifies to establish the graphic's secondary dimension on one side of a previously established part, while pressing the Alt key. INFO

Click to summarize M_SYMMETRIC

Specifies to establish the graphic's secondary dimension symmetrically on both sides of a previously established part, while pressing the Alt key. INFO

Click to summarize M_MODE_RESIZE_SECONDARY_DIMENSION_CTRL +

Inquires the interactive behavior when changing the graphic's secondary dimension during its creation, and pressing the Ctrl key. SET

(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_DISABLE

Specifies that pressing the Ctrl key does not affect how to establish the graphic's secondary dimension when defining it interactively on the display. INFO

Click to summarize M_ONE_SIDED

Specifies to establish the graphic's secondary dimension on one side of a previously established part, while pressing the Ctrl key. INFO

Click to summarize M_SYMMETRIC

Specifies to establish the graphic's secondary dimension symmetrically on both sides of a previously established part, while pressing the Ctrl key. INFO

Click to summarize M_MODE_RESIZE_SECONDARY_DIMENSION_SHIFT +

Inquires the interactive behavior when changing the graphic's secondary dimension during its creation, and pressing the Shift key. SET

(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_DISABLE

Specifies that pressing the Shift key does not affect how to establish the graphic's secondary dimension when defining it interactively on the display. INFO

Click to summarize M_ONE_SIDED

Specifies to establish the graphic's secondary dimension on one side of a previously established part, while pressing the Shift key. INFO

Click to summarize M_SYMMETRIC

Specifies to establish the graphic's secondary dimension symmetrically on both sides of a previously established part, while pressing the Shift key. INFO

Click to summarize M_MODE_RESIZE_SHIFT +

Inquires the interactive behavior when resizing the graphic using its selection box and pressing the Shift key. SET

(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_DISABLE

Specifies that pressing the Shift key does not affect how to resize the graphic. INFO

Click to summarize M_FIXED_ASPECT_RATIO

Specifies that the aspect ratio of the graphic remains constant, when resizing the graphic while pressing the Shift key. INFO

Click to summarize M_FIXED_CENTER

Specifies that all sides of the selection box move symmetrically, and the center does not move, when resizing the graphic while pressing the Shift key. INFO

Click to summarize M_FIXED_CORNER

Specifies that the center moves, and the opposite corner does not move, when resizing the graphic while pressing the Shift key. INFO

Click to summarize M_NO_CONSTRAINT

Specifies that the aspect ratio of the graphic can change, when resizing it while pressing the Shift key. INFO

Click to summarize M_SQUARE_ASPECT_RATIO

Specifies that the aspect ratio of the graphic will be 1:1 (square), when resizing it while pressing the Shift key. INFO

Click to summarize M_MODE_ROTATE +

Inquires the interactive behavior when rotating the graphic using its selection box. SET

(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_ANGLE_SNAPPING

Specifies to rotate the graphic by snapping it to an angle that is a multiple of the value set by M_ANGLE_SNAPPING_VALUE.

Click to summarize M_NO_CONSTRAINT

Specifies to rotate the graphic freely.

Click to summarize M_MODE_ROTATE_ALT +

Inquires the interactive behavior when rotating the graphic using its selection box and pressing the Alt key. SET

(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_ANGLE_SNAPPING

Specifies to rotate the graphic by snapping it to an angle that is a multiple of the value set by M_ANGLE_SNAPPING_VALUE, when rotating it while pressing the Alt key. INFO

Click to summarize M_DISABLE

Specifies that pressing the Alt key does not affect how to rotate the graphic. INFO

Click to summarize M_NO_CONSTRAINT

Specifies to rotate the graphic freely, when rotating it while pressing the Alt key. INFO

Click to summarize M_MODE_ROTATE_CTRL +

Inquires the interactive behavior when rotating the graphic using its selection box and pressing the Ctrl key. SET

(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_ANGLE_SNAPPING

Specifies to rotate the graphic by snapping it to an angle that is a multiple of the value set by M_ANGLE_SNAPPING_VALUE, when rotating it while pressing the Ctrl key. INFO

Click to summarize M_DISABLE

Specifies that pressing the Ctrl key does not affect how to rotate the graphic. INFO

Click to summarize M_NO_CONSTRAINT

Specifies to rotate the graphic freely, when rotating it while pressing the Ctrl key. INFO

Click to summarize M_MODE_ROTATE_SHIFT +

Inquires the interactive behavior when rotating the graphic using its selection box and pressing the Shift key. SET

(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_ANGLE_SNAPPING

Specifies to rotate the graphic by snapping it to an angle that is a multiple of the value set by M_ANGLE_SNAPPING_VALUE, when rotating it while pressing the Shift key. INFO

Click to summarize M_DISABLE

Specifies that pressing the Shift key does not affect how to rotate the graphic. INFO

Click to summarize M_NO_CONSTRAINT

Specifies to rotate the graphic freely, when rotating it while pressing the Shift key. INFO

Click to summarize M_MODE_TRANSLATE +

Inquires the interactive behavior when moving (translating) the graphic. SET

(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_AXIS_ALIGNED

Specifies to move the graphic along the X- and Y-axes.

Click to summarize M_NO_CONSTRAINT

Specifies to move the graphic freely.

Click to summarize M_MODE_TRANSLATE_ALT +

Inquires the interactive behavior when moving (translating) the graphic and pressing the Alt key. SET

(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_AXIS_ALIGNED

Specifies to move the graphic along the X- and Y-axes, when moving it while pressing the Alt key. INFO

Click to summarize M_DISABLE

Specifies that pressing the Alt key does not affect how to move the graphic. INFO

Click to summarize M_NO_CONSTRAINT

Specifies to move the graphic freely, when moving it while pressing the Alt key. INFO

Click to summarize M_MODE_TRANSLATE_CTRL +

Inquires the interactive behavior when moving (translating) the graphic and pressing the Ctrl key. SET

(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_AXIS_ALIGNED

Specifies to move the graphic along the X- and Y-axes, when moving it while pressing the Ctrl key. INFO

Click to summarize M_DISABLE

Specifies that pressing the Ctrl key does not affect how to move the graphic. INFO

Click to summarize M_NO_CONSTRAINT

Specifies to move the graphic freely, when moving it while pressing the Ctrl key. INFO

Click to summarize M_MODE_TRANSLATE_SHIFT +

Inquires the interactive behavior when moving (translating) the graphic and pressing the Shift key. SET

(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_AXIS_ALIGNED

Specifies to move the graphic along the X- and Y-axes, when moving it while pressing the Shift key. INFO

Click to summarize M_DISABLE

Specifies that pressing the Shift key does not affect how to move the graphic. INFO

Click to summarize M_NO_CONSTRAINT

Specifies to move the graphic freely, when moving it while pressing the Shift key. INFO

Click to summarize M_MULTIPLE_SELECTION +

Inquires whether interactive multiple selection is permitted. SET

(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_DISABLE

Specifies that interactive multiple selection is not permitted.

Click to summarize M_ENABLE

Specifies that interactive multiple selection is permitted.

Click to summarize M_MULTIPLE_SELECTION_KEY +

Inquires the keyboard key that you can press to select multiple graphics with your mouse on the display. SET

(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_KEY_ALT

Specifies that you can press the Alt key to select (or deselect) multiple graphics.

Click to summarize M_KEY_CTRL

Specifies that you can press the Ctrl key to select (or deselect) multiple graphics.

Click to summarize M_KEY_SHIFT

Specifies that you can press the Shift key to select (or deselect) multiple graphics.

Click to summarize M_NUMBER_OF_GRAPHICS +

Inquires the number of graphics in the list.

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

Specifies the number of graphics.

Click to summarize M_OWNER_SYSTEM +

Inquires the identifier of the system on which the 2D graphics list was allocated. SET

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

Specifies the default Host system of the current MIL application.

Click to summarize MIL system identifier

Specifies a valid system identifier, previously allocated using MsysAlloc().

Click to summarize M_OWNER_SYSTEM_TYPE +

Inquires the type of system on which the 2D graphics list was allocated. SET

(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_SYSTEM_CLARITY_UHD_TYPE

Specifies a MIL Clarity UHD system.

Click to summarize M_SYSTEM_GENTL_TYPE

Specifies a MIL GenTL system.

Click to summarize M_SYSTEM_GIGE_VISION_TYPE

Specifies a MIL GigE Vision system.

Click to summarize M_SYSTEM_HOST_TYPE

Specifies the Host.

Click to summarize M_SYSTEM_IRIS_GTR_TYPE

Specifies a MIL Iris GTR system.

Click to summarize M_SYSTEM_MORPHIS_TYPE

Specifies a MIL Morphis system.

Click to summarize M_SYSTEM_MORPHISQXT_TYPE

Specifies a MIL Morphis QxT system.

Click to summarize M_SYSTEM_ORION_HD_TYPE

Specifies a MIL Orion HD system.

Click to summarize M_SYSTEM_RADIENT_TYPE

Specifies a MIL Radient system.

Click to summarize M_SYSTEM_RADIENTCXP_TYPE

Specifies a MIL Radient eV-CXP system.

Click to summarize M_SYSTEM_RADIENTEVCL_TYPE

Specifies a MIL Radient eV-CL system.

Click to summarize M_SYSTEM_RADIENTPRO_TYPE

Specifies a MIL Radient Pro system.

Click to summarize M_SYSTEM_RAPIXOCL_TYPE

Specifies a MIL Rapixo Pro CL system.

Click to summarize M_SYSTEM_RAPIXOCXP_TYPE

Specifies a MIL Rapixo CXP system.

Click to summarize M_SYSTEM_SOLIOS_TYPE

Specifies a MIL Solios system.

Click to summarize M_SYSTEM_USB3_VISION_TYPE

Specifies a MIL USB3 Vision system.

Click to summarize M_SELECTED_COLOR +

Inquires the color of the selected graphics in interactive mode. 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 M_COLOR_BLACK

Specifies the color black.

Click to summarize M_COLOR_BLUE

Specifies the color blue.

Click to summarize M_COLOR_BRIGHT_GRAY

Specifies the color bright gray.

Click to summarize M_COLOR_CYAN

Specifies the color cyan.

Click to summarize M_COLOR_DARK_BLUE

Specifies the color dark blue.

Click to summarize M_COLOR_DARK_CYAN

Specifies the color dark cyan.

Click to summarize M_COLOR_DARK_GREEN

Specifies the color dark green.

Click to summarize M_COLOR_DARK_MAGENTA

Specifies the color dark magenta.

Click to summarize M_COLOR_DARK_RED

Specifies the color dark red.

Click to summarize M_COLOR_DARK_YELLOW

Specifies the color dark yellow.

Click to summarize M_COLOR_GRAY

Specifies the color gray.

Click to summarize M_COLOR_GREEN

Specifies the color green.

Click to summarize M_COLOR_LIGHT_BLUE

Specifies the color light blue.

Click to summarize M_COLOR_LIGHT_GRAY

Specifies the color light gray.

Click to summarize M_COLOR_LIGHT_GREEN

Specifies the color light green.

Click to summarize M_COLOR_LIGHT_WHITE

Specifies the color light white.

Click to summarize M_COLOR_MAGENTA

Specifies the color magenta.

Click to summarize M_COLOR_RED

Specifies the color red.

Click to summarize M_COLOR_WHITE

Specifies the color white.

Click to summarize M_COLOR_YELLOW

Specifies the color yellow.

Click to summarize Byte-encoded RGB value

Specifies an encoded RGB value. To verify if the value is a byte-encoded RGB value, use the M_IS_RGB888 macro. To retrieve the R, G, and B components, use the M_RGB888_R, M_RGB888_G, and M_RGB888_B macros.

(summarize)
Click to summarize Value

Specifies a grayscale value. INFO

Click to summarize M_SELECTION_RADIUS +

Inquires the size of the selection-radius when in interactive mode. 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 >= 1.0

Specifies the size of the selection-radius, in display units (these are pixel units that remain unaltered when you pan or zoom the display).

Combination values for M_FIXED_CENTER (when InquireType=M_MODE_RESIZE and UserVarPtr=M_FIXED_CENTER); M_FIXED_CORNER (when InquireType=M_MODE_RESIZE and UserVarPtr=M_FIXED_CORNER).

One of the following values might be combined with the above-mentioned values to get the aspect ratio used when resizing the graphic.

The following values will not modify the graphic's aspect ratio if it is set to 1 using MgraControlList() with M_CONSTRAIN_ASPECT_RATIO.

function map For inquiring the aspect ratio when resizing the graphic
Click to summarize
Combination value
Description
Click to summarize M_FIXED_ASPECT_RATIO

Specifies that the aspect ratio of the graphic remains constant when resizing it.

Click to summarize M_NO_CONSTRAINT

Specifies that the aspect ratio of the graphic can change when resizing it.

Click to summarize M_SQUARE_ASPECT_RATIO

Specifies that the aspect ratio of the graphic will be 1:1 (square) when resizing it.

To inquire about a general graphic setting, the InquireType parameter should be set to one of the following values. You can set the LabelOrIndex parameter to the label or index of a graphic in the list, and the SubIndex parameter to M_DEFAULT. Unless otherwise specified, these affect all types of graphics.

function map For inquiring about a general graphic setting
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_COLOR +

Inquires the foreground color of the graphic. SET SET 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 M_COLOR_BLACK

Specifies the color black.

Click to summarize M_COLOR_BLUE

Specifies the color blue.

Click to summarize M_COLOR_BRIGHT_GRAY

Specifies the color bright gray.

Click to summarize M_COLOR_CYAN

Specifies the color cyan.

Click to summarize M_COLOR_DARK_BLUE

Specifies the color dark blue.

Click to summarize M_COLOR_DARK_CYAN

Specifies the color dark cyan.

Click to summarize M_COLOR_DARK_GREEN

Specifies the color dark green.

Click to summarize M_COLOR_DARK_MAGENTA

Specifies the color dark magenta.

Click to summarize M_COLOR_DARK_RED

Specifies the color dark red.

Click to summarize M_COLOR_DARK_YELLOW

Specifies the color dark yellow.

Click to summarize M_COLOR_GRAY

Specifies the color gray.

Click to summarize M_COLOR_GREEN

Specifies the color green.

Click to summarize M_COLOR_LIGHT_BLUE

Specifies the color light blue.

Click to summarize M_COLOR_LIGHT_GRAY

Specifies the color light gray.

Click to summarize M_COLOR_LIGHT_GREEN

Specifies the color light green.

Click to summarize M_COLOR_LIGHT_WHITE

Specifies the color light white.

Click to summarize M_COLOR_MAGENTA

Specifies the color magenta.

Click to summarize M_COLOR_RED

Specifies the color red.

Click to summarize M_COLOR_WHITE

Specifies the color white.

Click to summarize M_COLOR_YELLOW

Specifies the color yellow.

Click to summarize Byte-encoded RGB value

Specifies an encoded RGB value. To verify if the value is a byte-encoded RGB value, use the M_IS_RGB888 macro. To retrieve the R, G, and B components, use the M_RGB888_R, M_RGB888_G, and M_RGB888_B macros.

(summarize)
Click to summarize Value

Specifies a grayscale value. INFO

Click to summarize M_DRAW_DIRECTION +

Inquires how to draw (render) an arrow pointing in the direction with which a graphic was defined. SET

(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_NONE

Specifies that no direction is drawn. INFO

Click to summarize M_PRIMARY_DIRECTION

Specifies to draw an arrow showing the primary direction of the graphic. INFO

Click to summarize M_PRIMARY_DIRECTION + M_SECONDARY_DIRECTION

Specifies to draw an arrow showing both the primary and secondary direction of the graphic. INFO

Click to summarize M_SECONDARY_DIRECTION

Specifies to draw an arrow showing the secondary direction of the graphic. INFO

Click to summarize M_DRAW_OFFSET_X +

Inquires the offset subtracted from the source X-coordinates. SET 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 offset to subtract, in pixels.

Click to summarize M_DRAW_OFFSET_Y +

Inquires the offset subtracted from the source Y-coordinates. SET 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 offset to subtract, in pixels.

Click to summarize M_DRAW_ZOOM_X +

Inquires the scale factor in the X-direction. SET 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

Specifies the scaling factor in the X-direction.

Click to summarize M_DRAW_ZOOM_Y +

Inquires the scale factor in the Y-direction. SET 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

Specifies the scaling factor in the Y-direction.

Click to summarize M_FIXTURE +

Inquires the camera calibration information used when rendering (drawing or displaying) a graphic defined in world units, when both source camera calibration information and destination camera calibration information are available to interpret positioning and dimensioning information.

If with respect to that of the source camera calibration information (M_USE_SOURCE_FIRST), positions and dimensions are transformed from this relative coordinate system to the absolute coordinate system; then, since it is assumed that there is only one absolute coordinate system, these positions and dimensions are transformed from the absolute coordinate system to the pixel coordinate system, using the destination camera calibration information. SET SET

(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_USE_DESTINATION_FIRST

Specifies that the camera calibration information of the destination is used when rendering the graphic. INFO

Click to summarize M_USE_SOURCE_FIRST

Specifies that the camera calibration information of the graphic, set with M_GRAPHIC_SOURCE_CALIBRATION, is used when rendering the graphic. INFO

Click to summarize M_GRAPHIC_CONVERSION_MODE +

Inquires how the shape of a graphic, defined in world units, is converted to pixels (rendered). SET SET

(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_PRESERVE_SHAPE_AVERAGE

Specifies to render the graphic so that its shape is preserved even if it means not respecting the camera calibration information exactly. INFO

Click to summarize M_RESHAPE_FOLLOWING_DISTORTION

Specifies that all points along the contour of the graphic will be converted using the camera calibration information, following any non-linear distortion. INFO

Click to summarize M_RESHAPE_FROM_POINTS

Specifies that only a few key points or features will be converted using the camera calibration information; from these points, the rest of the graphic will be rendered respecting the shape of the graphic. INFO

Click to summarize M_GRAPHIC_SOURCE_CALIBRATION +

Inquires the identifier of the camera calibration information used to interpret positioning and dimensioning information of a graphic defined in world units. SET SET

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

Specifies that no source camera calibration information is available to interpret positioning and dimensioning information of a graphic defined in world units.

Click to summarize MIL Identifier

Specifies the identifier of the internal camera calibration context that will be used.

Click to summarize M_GRAPHIC_TYPE +

Inquires the type of the graphic.

(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_GRAPHIC_TYPE_ARC

Specifies an arc (created using MgraArc(), MgraArcFill(), MgraArcAngle(), or user-defined using MgraInteractive() set to M_GRAPHIC_TYPE_ARC).

Click to summarize M_GRAPHIC_TYPE_COLLECTION

Specifies a drawing created using the M...Draw() function of a processing or analysis module, like MmodDraw() or MmeasDraw().

Click to summarize M_GRAPHIC_TYPE_DOT

Specifies a dot (created using MgraDot() or user-defined using MgraInteractive() set to M_GRAPHIC_TYPE_DOT).

Click to summarize M_GRAPHIC_TYPE_DOTS

Specifies dots (created using MgraDots()).

Click to summarize M_GRAPHIC_TYPE_INFINITE_LINES

Specifies infinite lines (created using MgraLines() with M_INFINITE_LINES).

Click to summarize M_GRAPHIC_TYPE_LINE

Specifies a line (created using MgraLine() or user-defined using MgraInteractive() set to M_GRAPHIC_TYPE_LINE).

Click to summarize M_GRAPHIC_TYPE_LINES

Specifies lines (created using MgraLines() with M_LINE_LIST).

Click to summarize M_GRAPHIC_TYPE_POLYGON

Specifies a polygon (created using MgraLines() with M_POLYGON or user-defined using MgraInteractive() set to M_GRAPHIC_TYPE_POLYGON).

Click to summarize M_GRAPHIC_TYPE_POLYLINE

Specifies a polyline (created using MgraLines() with M_POLYLINE or user-defined using MgraInteractive() set to M_GRAPHIC_TYPE_POLYLINE).

Click to summarize M_GRAPHIC_TYPE_RECT

Specifies a rectangle (created using MgraRect(), MgraRectFill(), MgraRectAngle(), or user-defined using MgraInteractive() set to M_GRAPHIC_TYPE_RECT).

Click to summarize M_GRAPHIC_TYPE_TEXT

Specifies text (created using MgraText()).

Click to summarize M_INDEX_VALUE +

Inquires the index associated with the graphic. In this case, the LabelOrIndex parameter must be set to the label of the required graphic.

(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_INVALID

Specifies that the graphic label is invalid. This is returned if the specified label is not associated with a graphic.

(summarize)
Click to summarize Value >= 0

Specifies the index value associated with the specified graphic.

Click to summarize M_INPUT_UNITS +

Inquires the units with which to interpret the graphic's position and dimensional information, for graphics already added to the 2D graphics list. SET SET

(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_DISPLAY

Specifies to interpret the values in pixel units that, unlike M_PIXEL, are not altered when the display is panned or zoomed. INFO

Click to summarize M_PIXEL

Specifies to interpret the values in pixel units, with respect to the pixel coordinate system. INFO

Click to summarize M_WORLD

Specifies to interpret the values in world units, with respect to the relative coordinate system. INFO

Click to summarize M_LABEL_VALUE +

Inquires the label that was automatically associated with the graphic when it was added to the list. This label value will never change, even if the order of the graphics in the list changes.

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

Specifies the label value that was automatically associated with the specified graphic.

Click to summarize M_NUMBER_OF_SUB_ELEMENTS +

Inquires the number of sub-elements (position-points) within the specified graphic. Note that in this case the SubIndex parameter must be set to M_DEFAULT.

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

Specifies the number of sub-elements. This value can only be greater than zero for the following graphics: dots, line, lines, polylines, infinite lines, and polygons. For example, a line contains two sub-elements (position points).

(summarize)

To inquire 2D graphics context settings that affect the interactivity of a graphic, drawn in a 2D graphics list associated with a display when interactive mode is enabled (MdispControl() with M_GRAPHIC_LIST_INTERACTIVE set to M_ENABLE), the InquireType parameter should be set to one of the following values. You can set the LabelOrIndex parameter to the label or index of a specific graphic, and the SubIndex parameter must be set to M_DEFAULT.

function map For inquiring about a setting related to interactivity
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_EDITABLE +

Inquires whether a graphic can be edited via user interaction in an interactive display. If a graphic is not visible or if it is not selectable, it is not editable and this setting is ignored. SET SET

(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_DISABLE

Specifies that the graphic cannot be edited via user interaction. INFO

Click to summarize M_ENABLE

Specifies that the graphic can be edited via user interaction.

Click to summarize M_GRAPHIC_SELECTED +

Inquires whether the graphic is selected. SET

(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 graphic is not selected.

Click to summarize M_TRUE

Specifies that the graphic is selected.

Click to summarize M_RESIZABLE +

Inquires whether a graphic can be resized via user interaction in an interactive display. If a graphic is not visible, not selectable, or not editable, it is not resizeable and this setting is ignored. SET SET

(summarize)