Filters
Filter values by
Graphic type
  • Arc graphic
  • Axis graphic
  • Box graphic
  • Cylinder graphic
  • Dots graphic
  • Grid graphic
  • Line graphic
  • Node graphic
  • Node graphic
  • Pointc cloud or depth map graphic
  • Polygon graphic
  • Sphere graphic
  • Text graphic
| Customize Help
| Save Settings

M3dgraInquire



Function Map
Synopsis
Inquire information about a 3D graphic in a 3D graphics list.
Syntax
MIL_INT64 M3dgraInquire(
MIL_ID List3dgraId, //in
MIL_INT64 Label, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires information about a setting of the specified 3D graphic in a 3D graphics list.

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 containing the 3D graphic about which to inquire information. You can inquire the settings of a 3D graphic in the 3D graphics list, as well as the default settings of the 3D graphics list itself.

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

Label

Specifies the label of the 3D graphic to inquire. You can also inquire the default settings of the 3D graphics list itself.

function map For specifying the 3D graphic label
Click to summarizeValue Description
Click to summarize M_DEFAULT_SETTINGS

Specifies to inquire the default settings of the 3D graphics that are added to the 3D graphics list.

Click to summarize M_LIST

Specifies to inquire about the 3D graphics list itself.

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

(summarize)
InquireType

Specifies the type of setting to inquire.

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

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

Specifies the address in which to write the requested information.

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

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

The following inquire type allows you to inquire about the 3D graphics list when Label is M_LIST.

function map For inquiring about the 3D graphics list
Click to summarize
List3dgraId
Description
InquireType
UserVarPtr
- Possible values returned
Click to summarize Graphics list identifier with Label set to
M_LIST

Specifies a 3D graphics list, allocated using M3dgraAlloc().

(summarize)
Click to summarize M_EMPTY +

Inquires whether the 3D graphics list contains no displayable 3D graphics. Invisible 3D graphics include nodes, 3D graphics with M_VISIBLE set to M_FALSE, and containers with no valid points.

(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 3D graphics list contains displayable 3D graphics.

Click to summarize M_TRUE

Specifies that the 3D graphics list does not contain any displayable 3D graphics.

The following inquire types allow you to inquire about the default settings of a 3D graphics list when Label is M_DEFAULT_SETTINGS.

function map For inquiring about the default settings of a 3D graphics list
Click to summarize
List3dgraId
Description
InquireType
UserVarPtr
- Possible values returned
Click to summarize Graphics list identifier with Labelset to
M_DEFAULT_SETTINGS

Specifies a 3D graphics list, allocated using M3dgraAlloc(), and M_DEFAULT_SETTINGS specified by the Label parameter.

(summarize)
Click to summarize M_APPEARANCE +

Inquires whether the 3D graphics added to the 3D graphics list are displayed, by default, as a solid surface, wireframe, or points. 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_POINTS

Specifies a points appearance. INFO

Click to summarize M_SOLID

Specifies a solid appearance.

Click to summarize M_SOLID_WITH_WIREFRAME

Specifies a solid appearance with a wireframe.

Click to summarize M_WIREFRAME

Specifies a wireframe appearance. INFO

Click to summarize M_BACKGROUND_COLOR +

Inquires the default background color for text graphics added to the 3D graphics list. SET

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

Specifies the color black.

Click to summarize M_COLOR_BLUE

Specifies the color blue. INFO

Click to summarize M_COLOR_BRIGHT_GRAY

Specifies the color bright gray. INFO

Click to summarize M_COLOR_CYAN

Specifies the color cyan. INFO

Click to summarize M_COLOR_DARK_BLUE

Specifies the color dark blue. INFO

Click to summarize M_COLOR_DARK_CYAN

Specifies the color dark cyan. INFO

Click to summarize M_COLOR_DARK_GREEN

Specifies the color dark green. INFO

Click to summarize M_COLOR_DARK_MAGENTA

Specifies the color dark magenta. INFO

Click to summarize M_COLOR_DARK_RED

Specifies the color dark red. INFO

Click to summarize M_COLOR_DARK_YELLOW

Specifies the color dark yellow. INFO

Click to summarize M_COLOR_GRAY

Specifies the color gray. INFO

Click to summarize M_COLOR_GREEN

Specifies the color green. INFO

Click to summarize M_COLOR_LIGHT_BLUE

Specifies the color light blue. INFO

Click to summarize M_COLOR_LIGHT_GRAY

Specifies the color light gray. INFO

Click to summarize M_COLOR_LIGHT_GREEN

Specifies the color light green. INFO

Click to summarize M_COLOR_LIGHT_WHITE

Specifies the color light white. INFO

Click to summarize M_COLOR_MAGENTA

Specifies the color magenta. INFO

Click to summarize M_COLOR_RED

Specifies the color red. INFO

Click to summarize M_COLOR_WHITE

Specifies the color white. INFO

Click to summarize M_COLOR_YELLOW

Specifies the color yellow. INFO

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 M_BACKGROUND_MODE +

Inquires the default background mode for text graphics added to the 3D graphics list. 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_OPAQUE

Specifies that the background of the text graphic is filled with the current background color.

Click to summarize M_TRANSPARENT

Specifies that the text graphic does not have a background.

Click to summarize M_COLOR +

Inquires the default color of the points and lines of the 3D graphics added to the 3D graphics list. SET

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

Specifies the color black. INFO

Click to summarize M_COLOR_BLUE

Specifies the color blue. INFO

Click to summarize M_COLOR_BRIGHT_GRAY

Specifies the color bright gray. INFO

Click to summarize M_COLOR_CYAN

Specifies the color cyan. INFO

Click to summarize M_COLOR_DARK_BLUE

Specifies the color dark blue. INFO

Click to summarize M_COLOR_DARK_CYAN

Specifies the color dark cyan. INFO

Click to summarize M_COLOR_DARK_GREEN

Specifies the color dark green. INFO

Click to summarize M_COLOR_DARK_MAGENTA

Specifies the color dark magenta. INFO

Click to summarize M_COLOR_DARK_RED

Specifies the color dark red. INFO

Click to summarize M_COLOR_DARK_YELLOW

Specifies the color dark yellow. INFO

Click to summarize M_COLOR_GRAY

Specifies the color gray. INFO

Click to summarize M_COLOR_GREEN

Specifies the color green. INFO

Click to summarize M_COLOR_LIGHT_BLUE

Specifies the color light blue. INFO

Click to summarize M_COLOR_LIGHT_GRAY

Specifies the color light gray. INFO

Click to summarize M_COLOR_LIGHT_GREEN

Specifies the color light green. INFO

Click to summarize M_COLOR_LIGHT_WHITE

Specifies the color light white. INFO

Click to summarize M_COLOR_MAGENTA

Specifies the color magenta. INFO

Click to summarize M_COLOR_RED

Specifies the color red. INFO

Click to summarize M_COLOR_WHITE

Specifies the color white.

Click to summarize M_COLOR_YELLOW

Specifies the color yellow. INFO

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 M_COLOR_AXIS_X +

Inquires the default color of the X-axis of axis graphics added to the 3D graphics list. SET

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

Specifies the color black. INFO

Click to summarize M_COLOR_BLUE

Specifies the color blue. INFO

Click to summarize M_COLOR_BRIGHT_GRAY

Specifies the color bright gray. INFO

Click to summarize M_COLOR_CYAN

Specifies the color cyan. INFO

Click to summarize M_COLOR_DARK_BLUE

Specifies the color dark blue. INFO