| MIL 10 Reference
| Customize Help
| Save Settings

MgraInquireList


See also
Availability
Available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
MgraInquire
MgraInteractive
Synopsis
Inquire information about a graphics list or a graphic contained within the 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 graphics list, or a graphic contained within the graphics list.

Unlike most other functions that modify a MIL object, you can call this function concurrently from multiple threads on the same MIL 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 if there is complementary information.
Parameters
This function is not supported on the selected boards.
Parameters
GraListId

Specifies the identifier of the graphics list about which to inquire information. The 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 graphics list itself. This parameter should be set to one of the following values:

function map For specifying the graphic or the graphics list
CollapseValue Description
Collapse

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.
Collapse

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.
Collapse M_LIST

Inquires information about the 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
CollapseValue Description
Collapse M_DEFAULT

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

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.

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

Parameter associations

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

To inquire about a setting of a 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.

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_INT.

function map For inquiring about a setting of a graphics list itself
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_INTERACTIVE_ANNOTATIONS_COLOR +

Inquires the color of the selection box and handles when in interactive mode. SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse M_COLOR_BLACK

Specifies the color black.
Collapse M_COLOR_BLUE

Specifies the color blue.
Collapse M_COLOR_BRIGHT_GRAY

Specifies the color bright gray.
Collapse M_COLOR_CYAN

Specifies the color cyan.
Collapse M_COLOR_DARK_BLUE

Specifies the color dark blue.
Collapse M_COLOR_DARK_CYAN

Specifies the color dark cyan.
Collapse M_COLOR_DARK_GREEN

Specifies the color dark green.
Collapse M_COLOR_DARK_MAGENTA

Specifies the color dark magenta.
Collapse M_COLOR_DARK_RED

Specifies the color dark red.
Collapse M_COLOR_DARK_YELLOW

Specifies the color dark yellow.
Collapse M_COLOR_GRAY

Specifies the color gray.
Collapse M_COLOR_GREEN

Specifies the color green.
Collapse M_COLOR_LIGHT_BLUE

Specifies the color light blue.
Collapse M_COLOR_LIGHT_GRAY

Specifies the color light gray.
Collapse M_COLOR_LIGHT_GREEN

Specifies the color light green.
Collapse M_COLOR_LIGHT_WHITE

Specifies the color light white.
Collapse M_COLOR_MAGENTA

Specifies the color magenta.
Collapse M_COLOR_RED

Specifies the color red.
Collapse M_COLOR_WHITE

Specifies the color white.
Collapse M_COLOR_YELLOW

Specifies the color yellow.
Collapse 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)
Collapse Value

Specifies a grayscale value. INFO
Collapse M_INTERACTIVE_GRAPHIC_STATE +

Inquires the current state of interactivity of the graphics list.

(summarize)
Collapse M_STATE_BEING_CREATED

Specifies that a new graphic is being created.
Collapse M_STATE_GRAPHIC_DRAGGED

Specifies that a graphic is being dragged using the mouse.
Collapse M_STATE_GRAPHIC_HOVERED

Specifies that the cursor is currently hovering over a graphic.
Collapse M_STATE_HANDLE_DRAGGED

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

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

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

Specifies that a graphic is queued for creation.
Collapse 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 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 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 22: Generating graphics for an example of how to inquire the label of a graphic added interactively.

(summarize)
Collapse M_NO_LABEL

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

Specifies the label of the last-added graphic in the list.
Collapse M_MULTIPLE_SELECTION +

Inquires whether interactive multiple selection is permitted. SET

(summarize)
Collapse M_DISABLE

Specifies that interactive multiple selection is not permitted.
Collapse M_ENABLE

Specifies that interactive multiple selection is permitted.
Collapse M_NUMBER_OF_GRAPHICS +

Inquires the number of graphics in the list.

(summarize)
Collapse Value >= 0

Specifies the number of graphics.
Collapse M_OWNER_SYSTEM +

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

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_ID

Collapse M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.
Collapse MIL system identifier

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

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

(summarize)
Collapse M_SYSTEM_1394_TYPE

Specifies a MIL IEEE 1394 IIDC system.
Collapse M_SYSTEM_CRONOSPLUS_TYPE

Specifies a MIL CronosPlus system.
Collapse M_SYSTEM_GIGE_VISION_TYPE

Specifies a MIL GigE Vision system.
Collapse M_SYSTEM_GPU_TYPE

Specifies a MIL GPU system.
Collapse M_SYSTEM_HOST_TYPE

Specifies the Host.
Collapse M_SYSTEM_IRIS_GT_TYPE

Specifies a MIL Iris GT system.
Collapse M_SYSTEM_MORPHIS_TYPE

Specifies a MIL Morphis system.
Collapse M_SYSTEM_MORPHISQXT_TYPE

Specifies a MIL Morphis QxT system.
Collapse M_SYSTEM_ORION_HD_TYPE

Specifies a MIL Orion HD system.
Collapse M_SYSTEM_RADIENT_TYPE

Specifies a MIL Radient system.
Collapse M_SYSTEM_RADIENTCLHS_TYPE

Specifies a MIL Radient eV-CLHS system.
Collapse M_SYSTEM_RADIENTCXP_TYPE

Specifies a MIL Radient eV-CXP system.
Collapse M_SYSTEM_RADIENTEVCL_TYPE

Specifies a MIL Radient eV-CL system.
Collapse M_SYSTEM_RADIENTPRO_TYPE

Specifies a MIL Radient Pro system.
Collapse M_SYSTEM_SOLIOS_TYPE

Specifies a MIL Solios system.
Collapse M_SYSTEM_USB3_VISION_TYPE

Specifies a MIL USB3 Vision system.
Collapse M_SYSTEM_VIO_TYPE

Specifies a MIL Vio system.
Collapse M_SELECTED_COLOR +

Inquires the color of the selected graphics in interactive mode. SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse M_COLOR_BLACK

Specifies the color black.
Collapse M_COLOR_BLUE

Specifies the color blue.
Collapse M_COLOR_BRIGHT_GRAY

Specifies the color bright gray.
Collapse M_COLOR_CYAN

Specifies the color cyan.
Collapse M_COLOR_DARK_BLUE

Specifies the color dark blue.
Collapse M_COLOR_DARK_CYAN

Specifies the color dark cyan.
Collapse M_COLOR_DARK_GREEN

Specifies the color dark green.
Collapse M_COLOR_DARK_MAGENTA

Specifies the color dark magenta.
Collapse M_COLOR_DARK_RED

Specifies the color dark red.
Collapse M_COLOR_DARK_YELLOW

Specifies the color dark yellow.
Collapse M_COLOR_GRAY

Specifies the color gray.
Collapse M_COLOR_GREEN

Specifies the color green.
Collapse M_COLOR_LIGHT_BLUE

Specifies the color light blue.
Collapse M_COLOR_LIGHT_GRAY

Specifies the color light gray.
Collapse M_COLOR_LIGHT_GREEN

Specifies the color light green.
Collapse M_COLOR_LIGHT_WHITE

Specifies the color light white.
Collapse M_COLOR_MAGENTA

Specifies the color magenta.
Collapse M_COLOR_RED

Specifies the color red.
Collapse M_COLOR_WHITE

Specifies the color white.
Collapse M_COLOR_YELLOW

Specifies the color yellow.
Collapse 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)
Collapse Value

Specifies a grayscale value. INFO
Collapse M_SELECTION_RADIUS +

Inquires the size of the selection-radius when in interactive mode. SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value >= 1.0

Specifies the size of the selection-radius, in display units.

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

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_INT.

function map For inquiring about a setting applicable to all graphics types
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_COLOR +

Inquires the foreground color of the graphic. SET SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse M_COLOR_BLACK

Specifies the color black.
Collapse M_COLOR_BLUE

Specifies the color blue.
Collapse M_COLOR_BRIGHT_GRAY

Specifies the color bright gray.
Collapse M_COLOR_CYAN

Specifies the color cyan.
Collapse M_COLOR_DARK_BLUE

Specifies the color dark blue.
Collapse M_COLOR_DARK_CYAN

Specifies the color dark cyan.
Collapse M_COLOR_DARK_GREEN

Specifies the color dark green.
Collapse M_COLOR_DARK_MAGENTA

Specifies the color dark magenta.
Collapse M_COLOR_DARK_RED

Specifies the color dark red.
Collapse M_COLOR_DARK_YELLOW

Specifies the color dark yellow.
Collapse M_COLOR_GRAY

Specifies the color gray.
Collapse M_COLOR_GREEN

Specifies the color green.
Collapse M_COLOR_LIGHT_BLUE

Specifies the color light blue.
Collapse M_COLOR_LIGHT_GRAY

Specifies the color light gray.
Collapse M_COLOR_LIGHT_GREEN

Specifies the color light green.
Collapse M_COLOR_LIGHT_WHITE

Specifies the color light white.
Collapse M_COLOR_MAGENTA

Specifies the color magenta.
Collapse M_COLOR_RED

Specifies the color red.
Collapse M_COLOR_WHITE

Specifies the color white.
Collapse M_COLOR_YELLOW

Specifies the color yellow.
Collapse 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)
Collapse Value

Specifies a grayscale value. INFO
Collapse M_DRAW_OFFSET_X +

Inquires the offset subtracted from the source X-coordinates. SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value

Specifies the X-coordinate offset to subtract, in pixels.
Collapse M_DRAW_OFFSET_Y +

Inquires the offset subtracted from the source Y-coordinates. SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value

Specifies the Y-coordinate offset to subtract, in pixels.
Collapse M_DRAW_ZOOM_X +

Inquires the scale factor in the X-direction. SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value > 0

Specifies the scale factor in the X-direction.
Collapse M_DRAW_ZOOM_Y +

Inquires the scale factor in the Y-direction. SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value > 0

Specifies the scale factor in the Y-direction.
Collapse M_FIXTURE +

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

If with respect to that of the source 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 calibration information. SET SET

(summarize)
Collapse M_USE_DESTINATION_FIRST

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

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

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

(summarize)
Collapse M_PRESERVE_SHAPE_AVERAGE

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

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

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

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

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_ID

Collapse M_NULL

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

Specifies the identifier of the internal calibration context that will be used.
Collapse M_GRAPHIC_TYPE +

Inquires the type of the graphic.

(summarize)
Collapse M_GRAPHIC_TYPE_ARC

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

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

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

Specifies dots (created using MgraDots()).
Collapse M_GRAPHIC_TYPE_INFINITE_LINES

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

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

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

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

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

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

Specifies text (created using MgraText()).
Collapse 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)
Collapse M_INVALID

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

(summarize)
Collapse Value >= 0

Specifies the index value associated with the specified graphic.
Collapse M_INPUT_UNITS +

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

(summarize)
Collapse 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
Collapse M_PIXEL

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

Specifies to interpret the values in world units, with respect to the relative coordinate system. INFO
Collapse 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)
Collapse Value > 0

Specifies the label value that was automatically associated with the specified graphic.
Collapse 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)
Collapse 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 graphics context settings that affect the interactivity of a graphic, drawn in a 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.

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_INT.

function map For inquiring about a setting related to interactivity
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse 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)
Collapse M_DISABLE

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

Specifies that the graphic can be edited via user interaction.
Collapse M_GRAPHIC_SELECTED +

Inquires whether the graphic is selected. SET

(summarize)
Collapse M_FALSE

Specifies that the graphic is not selected.
Collapse M_TRUE

Specifies that the graphic is selected.
Collapse M_MOVABLE +

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

(summarize)
Collapse M_DISABLE

Specifies that the graphic cannot be moved via user interaction. INFO
Collapse M_ENABLE

Specifies that the graphic can be moved via user interaction by clicking and dragging the graphic, its selection box, or its center handle.
Collapse 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)
Collapse M_DISABLE

Specifies that the graphic cannot be resized via user interaction and the resize handles will not be displayed if a graphic is selected. INFO
Collapse M_ENABLE

Specifies that the graphic can be resized via user interaction by clicking and dragging one of the resize handle.
Collapse M_ROTATABLE +

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

(summarize)
Collapse M_DISABLE

Specifies that the graphic cannot be rotated via user interaction and the rotate handle will not be displayed if a graphic is selected. INFO
Collapse M_ENABLE

Specifies that the graphic can be rotated via user interaction by clicking and dragging the rotation handle.
Collapse M_SELECTABLE +

Inquires whether a graphic in a graphics list can be selected via user interaction in an interactive display. If a graphic is not visible, it is not selectable and this setting is ignored. SET SET

(summarize)
Collapse M_DISABLE

Specifies that the graphic cannot be selected via user interaction. INFO
Collapse M_ENABLE

Specifies that the graphic can be selected by clicking on it.
Collapse M_SPECIFIC_FEATURES_EDITABLE +

Inquires whether a graphic can be modified via user interaction in an interactive display using handles that are specific to its graphic type. If a graphic is not visible, not selectable, or not editable, it cannot be modified using its type-specific handles and this setting is ignored. SET SET

(summarize)
Collapse M_DISABLE

Specifies that the graphic cannot be modified via user interaction and its specific feature handles will not be displayed if a graphic is selected. INFO
Collapse M_ENABLE

Specifies that the graphic can be modified via user interaction by clicking and dragging one of the type-specific handles.
Collapse M_VISIBLE +

Inquires whether a graphic is rendered on the display. SET SET

(summarize)
Collapse M_FALSE

Specifies that the graphic is not rendered.
Collapse M_TRUE

Specifies that the graphic is rendered.

To inquire about a setting specific to text in the graphics list, the InquireType parameter should be set to one of the following values. You must set the LabelOrIndex parameter to the label or index of text, and the SubIndex parameter to M_DEFAULT. Inquiring one of the following settings for graphics that are not text will generate an error.

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_INT.

function map For inquiring about a setting specific to text
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_BACKCOLOR +

Inquires the background color of the text. SET SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse M_COLOR_BLACK

Specifies the color black.
Collapse M_COLOR_BLUE

Specifies the color blue.
Collapse M_COLOR_BRIGHT_GRAY

Specifies the color bright gray.
Collapse M_COLOR_CYAN

Specifies the color cyan.
Collapse M_COLOR_DARK_BLUE

Specifies the color dark blue.
Collapse M_COLOR_DARK_CYAN

Specifies the color dark cyan.
Collapse M_COLOR_DARK_GREEN

Specifies the color dark green.
Collapse M_COLOR_DARK_MAGENTA

Specifies the color dark magenta.
Collapse M_COLOR_DARK_RED

Specifies the color dark red.
Collapse M_COLOR_DARK_YELLOW

Specifies the color dark yellow.
Collapse M_COLOR_GRAY

Specifies the color gray.
Collapse M_COLOR_GREEN

Specifies the color green.
Collapse M_COLOR_LIGHT_BLUE

Specifies the color light blue.
Collapse M_COLOR_LIGHT_GRAY

Specifies the color light gray.
Collapse M_COLOR_LIGHT_GREEN

Specifies the color light green.
Collapse M_COLOR_LIGHT_WHITE

Specifies the color light white.
Collapse M_COLOR_MAGENTA

Specifies the color magenta.
Collapse M_COLOR_RED

Specifies the color red.
Collapse M_COLOR_WHITE

Specifies the color white.
Collapse M_COLOR_YELLOW

Specifies the color yellow.
Collapse 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)
Collapse Value

Specifies a grayscale value. INFO
Collapse M_BACKGROUND_MODE +

Inquires whether the text's background is filled. SET SET

(summarize)
Collapse M_OPAQUE

Specifies that the background will be filled with the current background color before drawing text.
Collapse M_TRANSPARENT

Specifies not to change the background before drawing text. INFO
Collapse M_FONT +

Inquires the font of the characters in the text. SET SET

(summarize)
Collapse M_FONT_DEFAULT_LARGE

Specifies a large bitmap font, where each character is drawn in a 16x32 pixel area.
Collapse M_FONT_DEFAULT_MEDIUM

Specifies a medium bitmap font, where each character is drawn in a 12x24 pixel area.
Collapse M_FONT_DEFAULT_SMALL

Specifies a small bitmap font, where each character is drawn in a 8x16 pixel area.
Collapse M_FONT_TTF

Specifies a TrueType font. This value is returned when using MgraControlList() with MIL_FONT_NAME().

(summarize)
Collapse M_FONT_AUTO_SELECT +

Inquires whether MIL will search for a suitable font to draw text if the currently selected font is a TrueType font that does not support the character code. SET SET

(summarize)
Collapse M_DISABLE

Specifies that MIL will not search for a suitable font. INFO
Collapse M_ENABLE

Specifies that MIL will search for a suitable font.
Collapse M_FONT_SIZE +

Inquires the size in which text is drawn for a TrueType font. SET SET

(summarize)
Collapse Value >= 1

Specifies the text's font size, in points.
Collapse M_FONT_X_SCALE +

Inquires the bitmap font's horizontal scaling factor. SET SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value > 0

Specifies the factor by which to multiply the width of the font characters. INFO
Collapse M_FONT_Y_SCALE +

Inquires the bitmap font's vertical scaling factor. SET SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value > 0

Specifies the factor by which to multiply the height of the font characters. INFO
Collapse M_TEXT_ALIGN_HORIZONTAL +

Inquires the horizontal alignment of the text. SET SET

(summarize)
Collapse M_CENTER

Specifies that text is horizontally centered.
Collapse M_LEFT

Specifies that text is left-aligned.
Collapse M_RIGHT

Specifies that text is right-aligned.
Collapse M_TEXT_ALIGN_VERTICAL +

Inquires the vertical alignment of the text. SET SET

(summarize)
Collapse M_BOTTOM

Specifies that text is bottom-aligned.
Collapse M_CENTER

Specifies that text is vertically centered.
Collapse M_TOP

Specifies that text is top-aligned.
Collapse M_TEXT_BORDER +

Inquires how borders are drawn around the text.

Note that a combination of the values below can be returned. Bitwise operators must be used to verify the presence of a specific border. SET SET

(summarize)
Collapse M_BOTTOM

Specifies that a line is drawn underneath the text.
Collapse M_LEFT

Specifies that a line is drawn to the left of the text.
Collapse M_NONE

Specifies that no border is drawn around the text. INFO
Collapse M_RIGHT

Specifies that a line is drawn to the right of the text.
Collapse M_TOP

Specifies that a line is drawn above the text.
Collapse M_TEXT_DIRECTION +

Inquires the direction text is drawn when using a TrueType font. SET SET

(summarize)
Collapse M_LEFT_TO_RIGHT

Specifies that text will be drawn from left to right.
Collapse M_RIGHT_TO_LEFT

Specifies that text will be drawn from right to left.

You can add one of the following values to the above-mentioned values to get the color used for a 16-bit or 32-bit multi-band buffer.

You must inquire each color component (R,G, and B) separately.

function map For inquiring the color value used (for 16- or 32-bit multi-band buffers)
CollapseCombination value Description
Collapse M_BLUE

Inquires the blue color component.
Collapse M_GREEN

Inquires the green color component.
Collapse M_RED

Inquires the red color component.

To inquire about the position and dimensional information settings of a graphic (typically set when the graphic is added to the list), the InquireType parameter should be set to one of the following values. You must set the LabelOrIndex parameter to the label or index of a graphic that supports that setting. Unless otherwise specified, the SubIndex parameter should be set to M_DEFAULT.

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_INT.

function map For inquiring about a setting regarding the position and dimensional information of a graphic
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_ANGLE +

Inquires the angle of the graphic.

An angle interpreted with respect to the pixel coordinate system is always measured counter-clockwise. For information on the angle's direction of rotation when interpreting the angle with respect to the relative coordinate system, see the Angle convention in MIL subsection of the Working with real-world units section of Chapter 25: Calibrating your camera setup.

This setting can be inquired for all graphics except a single dot (MgraDot()), multiple dots (MgraDots()), text (MgraText()), and drawings created using a processing or analysis module draw function (M...Draw()). Inquiring this value for any of the unsupported types of graphics will generate an error. SET SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse -360.0 <= Value <= 360.0

Specifies the angle, in degrees, relative to the input coordinate system specified using M_INPUT_UNITS. INFO
Collapse M_ANGLE_END +

Inquires the angle at which to stop drawing the arc.

This setting can only be inquired for arcs (MgraArc(), MgraArcFill(), and MgraArcAngle()). Inquiring this value for any other type of graphic will generate an error. SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value

Specifies the end angle, in degrees, relative to the input coordinate system specified using M_INPUT_UNITS. INFO
Collapse M_ANGLE_START +

Inquires the angle at which to start drawing the arc.

This setting can only be inquired for arcs (MgraArc(), MgraArcFill(), and MgraArcAngle()). Inquiring this value for any other type of graphic will generate an error. SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value

Specifies the start angle, in degrees, relative to the input coordinate system specified using M_INPUT_UNITS. INFO
Collapse M_ARC_STYLE +

Inquires whether to draw an arc or a sector.

This setting can only be inquired for arcs (MgraArc(), MgraArcFill(), and MgraArcAngle()). Inquiring this value for any other type of graphic will generate an error. SET SET SET

(summarize)
Collapse M_CONTOUR

Specifies that the arc (the curve between the specified start and end angles) is drawn without lines extending from the center of the ellipse to the start and end points of the arc.
Collapse M_SECTOR

Specifies that a sector is drawn with lines extending from the center of the ellipse to the start and end points of the arc, unless the specified start and end angles form a closed curve.
Collapse M_CONSTRAIN_ASPECT_RATIO +

Inquires whether the width and height are forced to be equal.

This setting can only be inquired for arcs (MgraArc(), MgraArcFill(), and MgraArcAngle()) and rectangles (MgraRect(), MgraRectFill(), and MgraRectAngle()). Inquiring this value for any other type of graphic will generate a MIL error. SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse M_DISABLE

Specifies that the width and height of a graphic are not forced to be equal.
Collapse 1.0

Specifies that the width and height of a graphic are forced to be equal. INFO
Collapse M_FILLED +

Inquires whether the graphic is filled.

This setting can only be inquired for arcs (MgraArc(), MgraArcFill(), and MgraArcAngle()), polygons (MgraLines() with M_POLYGON), and rectangles (MgraRect(), MgraRectFill(), and MgraRectAngle()). Inquiring this value for any other type of graphic will generate an error. SET SET SET SET

(summarize)
Collapse M_FALSE

Specifies that the graphic is not filled.
Collapse M_TRUE

Specifies that the graphic is filled.
Collapse M_POSITION_TYPE +

Inquires how to interpret M_POSITION_X and M_POSITION_Y.

This setting can only be inquired for rectangles (MgraRect(), MgraRectFill(), and MgraRectAngle()). Inquiring this value for any other type of graphic will generate an error. SET SET

(summarize)
Collapse M_CENTER_AND_DIMENSION

Specifies to interpret M_POSITION_X and M_POSITION_Y as the rectangle's center.
Collapse M_CORNER_AND_DIMENSION

Specifies to interpret M_POSITION_X and M_POSITION_Y as the rectangle's top-left corner.
Collapse M_POSITION_X +

Inquires the specified X-position of a graphic or of one of its sub-elements.

This value is set whenever a graphic is defined, either programatically or interactively. The point returned for the position of a graphic is its center for arcs, sets of dots, a single line, sets of finite-length lines, sets of infinite lines, polygons, and polylines. The point returned for the position of text is dependent upon M_TEXT_ALIGN_HORIZONTAL and M_TEXT_ALIGN_VERTICAL. The point returned for the position of a rectangle is its center or its top left corner, dependent upon the setting of M_POSITION_TYPE.

If SubIndex is set to M_DEFAULT, this setting is inquired for the entire graphic. If a sub-element is specified, this setting is inquired for a single point within the graphic.

This setting applies to all graphics except for drawings created using a processing or analysis module draw function (M...Draw()). Inquiring this value on an unsupported graphic will generate an error. SET SET SET SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value

Specifies the X-position. INFO
Collapse M_POSITION_Y +

Inquires the specified Y-position of a graphic or of one of its sub-elements.

This value is set whenever a graphic is defined, either programatically or interactively. The point returned for the position of a graphic is its center for arcs, sets of dots, a single line, sets of finite-length lines, sets of infinite lines, polygons, and polylines. The point returned for the position of text is dependent upon M_TEXT_ALIGN_HORIZONTAL and M_TEXT_ALIGN_VERTICAL. The point returned for the position of a rectangle is its center or its top left corner, dependent upon the setting of M_POSITION_TYPE.

If SubIndex is set to M_DEFAULT, this setting is inquired for the entire graphic. If a sub-element is specified, this setting is inquired for a single point within the graphic.

This setting applies to all graphics except for drawings created using a processing or analysis module draw function (M...Draw()). Inquiring this value on an unsupported graphic will generate an error. SET SET SET SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value

Specifies the Y-position. INFO
Collapse M_RADIUS_X +

Inquires the radius of the arc, in the X-direction.

This setting can only be inquired for arcs (MgraArc(), MgraArcFill(), and MgraArcAngle()). Inquiring this value for any other type of graphic will generate an error. SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value >= 0

Specifies the radius.
Collapse M_RADIUS_Y +

Inquires the radius of the arc, in the Y-direction.

This setting can only be inquired for arcs (MgraArc(), MgraArcFill(), and MgraArcAngle()). Inquiring this value for any other type of graphic will generate an error. SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value >= 0

Specifies the radius.
Collapse M_RECTANGLE_HEIGHT +

Inquires the height of the rectangle.

This setting can only be inquired for rectangles (MgraRect(), MgraRectFill(), and MgraRectAngle()). Inquiring this value for any other type of graphic will generate an error. SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value

Specifies the height.
Collapse M_RECTANGLE_WIDTH +

Inquires the width of a rectangle.

This setting can only be inquired for rectangles (MgraRect(), MgraRectFill(), and MgraRectAngle()). Inquiring this value for any other type of graphic will generate an error. SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value

Specifies the width.

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

function map For specifying the data type
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_TYPE_MIL_DOUBLE

Casts the requested information to a MIL_DOUBLE.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse M_TYPE_MIL_ID

Casts the requested information to a MIL_ID. Note that M_TYPE_MIL_ID should only be used with M_OWNER_SYSTEM and M_GRAPHIC_SOURCE_CALIBRATION.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_ID

Collapse M_TYPE_MIL_INT

Casts the requested information to a MIL_INT.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_INT

Collapse M_TYPE_MIL_INT32

Casts the requested information to a MIL_INT32.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_INT32

Collapse M_TYPE_MIL_INT64

Casts the requested information to a MIL_INT64.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_INT64

Return value
The returned value is the required information, cast to a MIL_INT.
Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.
NUMBER OF GRAPHICS LIST DEFAULT INTERACTIVE ANNOTATIONS COLOR COLOR BLACK COLOR BLUE COLOR BRIGHT GRAY COLOR CYAN COLOR DARK BLUE COLOR DARK CYAN COLOR DARK GREEN COLOR DARK MAGENTA COLOR DARK RED COLOR DARK YELLOW COLOR GRAY COLOR GREEN COLOR LIGHT BLUE COLOR LIGHT GRAY COLOR LIGHT GREEN COLOR LIGHT WHITE COLOR MAGENTA COLOR RED COLOR WHITE COLOR YELLOW INTERACTIVE GRAPHIC STATE STATE BEING CREATED STATE GRAPHIC DRAGGED STATE GRAPHIC HOVERED STATE HANDLE DRAGGED STATE HANDLE HOVERED STATE IDLE STATE WAITING FOR CREATION LAST LABEL NO LABEL MULTIPLE SELECTION DISABLE ENABLE NUMBER OF GRAPHICS OWNER SYSTEM DEFAULT HOST OWNER SYSTEM TYPE SYSTEM 1394 TYPE SYSTEM CRONOSPLUS TYPE SYSTEM GIGE VISION TYPE SYSTEM GPU TYPE SYSTEM HOST TYPE SYSTEM IRIS GT TYPE SYSTEM MORPHIS TYPE SYSTEM MORPHISQXT TYPE SYSTEM ORION HD TYPE SYSTEM RADIENT TYPE SYSTEM RADIENTCLHS TYPE SYSTEM RADIENTCXP TYPE SYSTEM RADIENTEVCL TYPE SYSTEM RADIENTPRO TYPE SYSTEM SOLIOS TYPE SYSTEM USB3 VISION TYPE SYSTEM VIO TYPE SELECTED COLOR COLOR BLACK COLOR BLUE COLOR BRIGHT GRAY COLOR CYAN COLOR DARK BLUE COLOR DARK CYAN COLOR DARK GREEN COLOR DARK MAGENTA COLOR DARK RED COLOR DARK YELLOW COLOR GRAY COLOR GREEN COLOR LIGHT BLUE COLOR LIGHT GRAY COLOR LIGHT GREEN COLOR LIGHT WHITE COLOR MAGENTA COLOR RED COLOR WHITE COLOR YELLOW SELECTION RADIUS COLOR COLOR BLACK COLOR BLUE COLOR BRIGHT GRAY COLOR CYAN COLOR DARK BLUE COLOR DARK CYAN COLOR DARK GREEN COLOR DARK MAGENTA COLOR DARK RED COLOR DARK YELLOW COLOR GRAY COLOR GREEN COLOR LIGHT BLUE COLOR LIGHT GRAY COLOR LIGHT GREEN COLOR LIGHT WHITE COLOR MAGENTA COLOR RED COLOR WHITE COLOR YELLOW DRAW OFFSET X DRAW OFFSET Y DRAW ZOOM X DRAW ZOOM Y FIXTURE USE DESTINATION FIRST USE SOURCE FIRST GRAPHIC CONVERSION MODE PRESERVE SHAPE AVERAGE RESHAPE FOLLOWING DISTORTION RESHAPE FROM POINTS GRAPHIC SOURCE CALIBRATION NULL GRAPHIC TYPE GRAPHIC TYPE ARC GRAPHIC TYPE COLLECTION GRAPHIC TYPE DOT GRAPHIC TYPE DOTS GRAPHIC TYPE INFINITE LINES GRAPHIC TYPE LINE GRAPHIC TYPE LINES GRAPHIC TYPE POLYGON GRAPHIC TYPE POLYLINE GRAPHIC TYPE RECT GRAPHIC TYPE TEXT INDEX VALUE INVALID INPUT UNITS DISPLAY PIXEL WORLD LABEL VALUE NUMBER OF SUB ELEMENTS EDITABLE DISABLE ENABLE GRAPHIC SELECTED FALSE TRUE MOVABLE DISABLE ENABLE RESIZABLE DISABLE ENABLE ROTATABLE DISABLE ENABLE SELECTABLE DISABLE ENABLE SPECIFIC FEATURES EDITABLE DISABLE ENABLE VISIBLE FALSE TRUE BACKCOLOR COLOR BLACK COLOR BLUE COLOR BRIGHT GRAY COLOR CYAN COLOR DARK BLUE COLOR DARK CYAN COLOR DARK GREEN COLOR DARK MAGENTA COLOR DARK RED COLOR DARK YELLOW COLOR GRAY COLOR GREEN COLOR LIGHT BLUE COLOR LIGHT GRAY COLOR LIGHT GREEN COLOR LIGHT WHITE COLOR MAGENTA COLOR RED COLOR WHITE COLOR YELLOW BACKGROUND MODE OPAQUE TRANSPARENT FONT FONT DEFAULT LARGE FONT DEFAULT MEDIUM FONT DEFAULT SMALL FONT TTF FONT AUTO SELECT DISABLE ENABLE FONT SIZE FONT X SCALE FONT Y SCALE TEXT ALIGN HORIZONTAL CENTER LEFT RIGHT TEXT ALIGN VERTICAL BOTTOM CENTER TOP TEXT BORDER BOTTOM LEFT NONE RIGHT TOP TEXT DIRECTION LEFT TO RIGHT RIGHT TO LEFT BLUE GREEN RED ANGLE ANGLE END ANGLE START ARC STYLE CONTOUR SECTOR CONSTRAIN ASPECT RATIO DISABLE FILLED FALSE TRUE POSITION TYPE CENTER AND DIMENSION CORNER AND DIMENSION POSITION X POSITION Y RADIUS X RADIUS Y RECTANGLE HEIGHT RECTANGLE WIDTH TYPE MIL DOUBLE TYPE MIL ID TYPE MIL INT TYPE MIL INT32 TYPE MIL INT64 LIST DEFAULT LIST DEFAULT GRAPHIC TYPE TEXT LIST ALL ALL SELECTED DEFAULT