Loading Reference... User Guide... Hardware-specific Notes...

Customize Help

MIL systems:
Show All

Installed MIL systems

Multiple

None

Host system

Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)*

Matrox Morphis

Matrox Morphis QxT

Matrox Orion HD

Matrox Radient eCL

Matrox Radient eV-CXP (MIL 10 or Update 29)*

Matrox Solios eA/XA

Matrox Solios ecl/xcl/ev-cl

Matrox USB3 Vision driver (Update 19)

Matrox RadientPro-CL (Update 7)

Matrox Radient eV-CL (Update 27 or 74)

Matrox Iris GTR (Update 28 or Update 68)

Matrox Clarity UHD (Update 36 or 76)

Matrox GenTL driver (Update 34)

Matrox Indio (Update 53 or Update 68)

Matrox Rapixo CXP (Update 75 or Update 84)

Matrox Concord PoE with ToE (Update 82)

Matrox Rapixo CL Pro (Update 96)

As Tooltip

Value descriptions: Detailed Summarized

Save Settings

| Customize Help

| Save Settings

M3dgraGrid

See also

User Guide:

Annotating the 3D display

Reference:

M3dgeoInquire M3dgraArc M3dgraControl M3dgraInquire MthrAlloc

Availability

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/GPm

Available on Matrox Supersight

function map

Function map

Examples

c3ddisplaymanager.cpp
cameraonrobotarmcalibration.cpp
m3ddisp.cpp
m3ddisp.cs
m3ddisp.vb
m3dgra.cpp
m3dgra.cs
m3dgra.vb
stereocalibration.cpp

Function Map

Table:

For specifying the parent label

- Matrix3dgeoId

Table:

For specifying the transformation matrix object identifier

Parameter Associations

Table:

For specifying the grid graphic

Compilation information

Synopsis

Add a grid graphic to a 3D graphics list.

Syntax

MIL_INT64 M3dgraGrid(

MIL_ID List3dgraId,	//in
MIL_INT64 ParentLabel,	//in
MIL_INT64 CreationMode,	//in
MIL_ID Matrix3dgeoId,	//in
MIL_DOUBLE Param1,	//in
MIL_DOUBLE Param2,	//in
MIL_DOUBLE Param3,	//in
MIL_DOUBLE Param4,	//in
MIL_INT64 ControlFlag	//in

)

Description

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

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

The grid graphic has its own coordinate system that represents the grid's position and orientation with respect to its parent's coordinate system. The origin of the grid's coordinate system is the grid's center, and its orientation is the grid's orientation. The grid lies on its coordinate system's XY (Z=0) plane. You can set the grid's position and orientation using the Matrix3dgeoId parameter.

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

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

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see if there is complementary information.

Parameters

This function is not supported on the selected boards.

Parameters

List3dgraId

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

ParentLabel

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

For specifying the parent label
Value	Description
M_DEFAULT	Same as M_ROOT_NODE.
M_ROOT_NODE	Specifies the top-most node of the 3D graphics list.
Value >= 0	Specifies the label of the parent of the grid graphic in the 3D graphics list. Label 0 is the 3D graphics list's root node. (summarize) Specifies the label of the parent of the grid graphic in the 3D graphics list. (more details...)

CreationMode

Specifies how the grid graphic is defined.

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

Matrix3dgeoId

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

For specifying the transformation matrix object identifier
Value	Description
M_DEFAULT	Same as M_IDENTITY_MATRIX.
M_IDENTITY_MATRIX	Specifies the identity matrix. This means that the grid graphic's position and orientation is the same as the position and orientation of its parent's coordinate system. The resulting grid is on its parent's coordinate system's XY (Z=0) plane, and is centered on its parent's coordinate system's origin. (summarize) Specifies the identity matrix. (more details...)
MIL transformation matrix object identifier	Specifies the identifier of the transformation matrix that defines the grid graphic's position and orientation with respect to its parent's coordinate system. The transformation matrix must be of type M_RIGID. (summarize) Specifies the identifier of the transformation matrix that defines the grid graphic's position and orientation with respect to its parent's coordinate system. (more details...)

Param1

Specifies the first parameter used to define the grid.

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

Param2

Specifies the second parameter used to define the grid.

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

Param3

Specifies the third parameter used to define the grid.

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

Param4

Specifies the fourth parameter used to define the grid.

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

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Parameter associations

The table below lists possible values for the CreationMode, Param1, Param2, Param3, and Param4 parameters.

For specifying the grid graphic

For specifying the grid graphic
CreationMode			Description
	Param1
	Param2
	Param3
	Param4
M_SIZE_AND_SPACING			Defines the grid graphic using its size and line spacing. If the specified size is not a multiple of the specified line spacing, the size is rounded down to the nearest multiple of the line spacing. The grid always has at least one cell. If the specified size is smaller than the specified line spacing, there will be a single cell with the dimensions of the line spacing. (summarize) Defines the grid graphic using its size and line spacing. (more details...)
	Param1		Specifies the grid's size along its coordinate system's X-axis. (summarize) Specifies the grid's size along its coordinate system's X-axis. (more details...)
		Value > 0.0	Specifies the grid's size along its coordinate system's X-axis, in world units.
	Param2		Specifies the grid's size along its coordinate system's Y-axis. (summarize) Specifies the grid's size along its coordinate system's Y-axis. (more details...)
		Value > 0.0	Specifies the grid's size along its coordinate system's Y-axis, in world units.
	Param3		Specifies the grid's line spacing along its coordinate system's X-axis. (summarize) Specifies the grid's line spacing along its coordinate system's X-axis. (more details...)
		Value > 0.0	Specifies the grid's line spacing along its coordinate system's X-axis, in world units.
	Param4		Specifies the grid's line spacing along its coordinate system's Y-axis. (summarize) Specifies the grid's line spacing along its coordinate system's Y-axis. (more details...)
		Value > 0.0	Specifies the grid's line spacing along its coordinate system's Y-axis, in world units.
M_TILES_AND_SPACING			Defines the grid graphic using its number of cells and line spacing. The grid's size along its coordinate system's X- or Y-axis is equal to the number of cells along the given axis multiplied by the line spacing along the same axis. (summarize) Defines the grid graphic using its number of cells and line spacing. (more details...)
	Param1		Specifies the grid's number of cells along its coordinate system's X-axis. (summarize) Specifies the grid's number of cells along its coordinate system's X-axis. (more details...)
		Value >= 1	Specifies the grid's number of cells along its coordinate system's X-axis.
	Param2		Specifies the grid's number of cells along its coordinate system's Y-axis. (summarize) Specifies the grid's number of cells along its coordinate system's Y-axis. (more details...)
		Value >= 1	Specifies the grid's number of cells along its coordinate system's Y-axis.
	Param3		Specifies the grid's line spacing along its coordinate system's X-axis. (summarize) Specifies the grid's line spacing along its coordinate system's X-axis. (more details...)
		Value > 0.0	Specifies the grid's line spacing along its coordinate system's X-axis, in world units.
	Param4		Specifies the grid's line spacing along its coordinate system's Y-axis. (summarize) Specifies the grid's line spacing along its coordinate system's Y-axis. (more details...)
		Value > 0.0	Specifies the grid's line spacing along its coordinate system's Y-axis, in world units.

Return value

Returns the label of the grid graphic added to the 3D graphics list.

Compilation information

Header	Include mil.h.
Library	Use mil.lib; mil3d.lib.
DLL	Requires mil.dll; mil3d.dll.

DEFAULT ROOT NODE DEFAULT IDENTITY MATRIX TRUE SIZE AND SPACING TILES AND SPACING