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

M3dgraBox

See also

User Guide:

3D display and graphics overview 3D graphics lists Annotating the 3D display Steps to display 3D data Working with 3D

Reference:

M3dgeoBox 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

m3dgra.cpp
m3dgra.cs
m3dgra.vb
simple3dstitching.cpp

Function Map

Table:

For specifying the parent label

- XPos2OrLength

- YPos2OrLength

- ZPos2OrLength

- Matrix3dgeoId

Table:

For specifying the transformation matrix object identifier

Parameter Associations

Table:

For specifying the box graphic

Compilation information

Synopsis

Add a box graphic to a 3D graphics list.

Syntax

MIL_INT64 M3dgraBox(

MIL_ID List3dgraId,	//in
MIL_INT64 ParentLabel,	//in
MIL_INT64 CreationMode,	//in
MIL_DOUBLE XPos1,	//in
MIL_DOUBLE YPos1,	//in
MIL_DOUBLE ZPos1,	//in
MIL_DOUBLE XPos2OrLength,	//in
MIL_DOUBLE YPos2OrLength,	//in
MIL_DOUBLE ZPos2OrLength,	//in
MIL_ID Matrix3dgeoId,	//in
MIL_INT64 ControlFlag	//in

)

Description

This function adds a box graphic to the specified 3D graphics list, allowing you to, for example, view the box 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 box graphic. When the box 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 box graphic's parent must be the root node. All coordinates are expressed in the coordinate system of the box graphic's parent.

The box graphic has its own coordinate system that represents the box graphic's position and orientation with respect to its parent's coordinate system. The center of the box graphic's coordinate system is the box graphic's center, and its coordinate system's orientation is the box graphic's orientation. You can set the box graphic's 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 box graphic.

ParentLabel

Specifies the label of the parent of the box 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 box 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 box graphic in the 3D graphics list. (more details...)

CreationMode

Specifies how the box graphic is defined.

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

XPos1

Specifies the X-coordinate of the first point used to define the box graphic.

Set this parameter to M_DEFAULT if not used.

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

YPos1

Specifies the Y-coordinate of the first point used to define the box graphic.

Set this parameter to M_DEFAULT if not used.

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

ZPos1

Specifies the Z-coordinate of the first point used to define the box graphic.

Set this parameter to M_DEFAULT if not used.

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

XPos2OrLength

Specifies the X-coordinate of the second point used to define the box graphic, or the length of the box graphic along its coordinate system's X-axis.

Set this parameter to M_DEFAULT if not used.

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

YPos2OrLength

Specifies the Y-coordinate of the second point used to define the box graphic, or the length of the box graphic along its coordinate system's Y-axis.

Set this parameter to M_DEFAULT if not used.

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

ZPos2OrLength

Specifies the Z-coordinate of the second point used to define the box graphic, or the length of the box graphic along its coordinate system's Z-axis.

Set this parameter to M_DEFAULT if not used.

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

Matrix3dgeoId

Specifies the identifier of the transformation matrix that defines the box graphic's 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 box graphic's position and orientation is the same as the position and orientation of its parent's coordinate system. The resulting box graphic is axis-aligned with respect to its parent's coordinate system. (summarize) Specifies the identity matrix. (more details...)
MIL transformation matrix object identifier	Specifies the identifier of the transformation matrix that defines the box graphic's orientation with respect to its parent's coordinate system. The transformation matrix must be of type M_ROTATION. (summarize) Specifies the identifier of the transformation matrix that defines the box graphic's orientation with respect to its parent's coordinate system. (more details...)

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Parameter associations

The table below lists possible values for the CreationMode, XPos1, YPos1, ZPos1, XPos2OrLength, YPos2OrLength, and ZPos2OrLength parameters.

For specifying the box graphic

Set unused parameters to M_DEFAULT.

For specifying the box graphic
CreationMode			Description
	XPos1
	YPos1
	ZPos1
	XPos2OrLength
	YPos2OrLength
	ZPos2OrLength
M_BOTH_CORNERS			Defines the box graphic using any two opposite corners. (summarize) Defines the box graphic using any two opposite corners. (more details...)
	XPos1		Specifies the X-coordinate of the first corner of the box.
	XPos2OrLength		Specifies the X-coordinate of the second corner of the box, opposite to the first corner.
	YPos1		Specifies the Y-coordinate of the first corner of the box.
	YPos2OrLength		Specifies the Y-coordinate of the second corner of the box, opposite to the first corner.
	ZPos1		Specifies the Z-coordinate of the first corner of the box.
	ZPos2OrLength		Specifies the Z-coordinate of the second corner of the box, opposite to the first corner.
M_CENTER_AND_DIMENSION			Defines the box graphic by its center point and its length along each of its coordinate system's axes. (summarize) Defines the box graphic by its center point and its length along each of its coordinate system's axes. (more details...)
	XPos1		Specifies the X-coordinate of the center of the box graphic.
	YPos1		Specifies the Y-coordinate of the center of the box graphic.
	ZPos1		Specifies the Z-coordinate of the center of the box graphic.
	XPos2OrLength		Specifies the length of the box graphic along its coordinate system's X-axis. (summarize) Specifies the length of the box graphic along its coordinate system's X-axis. (more details...)
		Value > 0.0	Specifies the length of the box graphic along its coordinate system's X-axis, in world units.
	YPos2OrLength		Specifies the length of the box graphic along its coordinate system's Y-axis. (summarize) Specifies the length of the box graphic along its coordinate system's Y-axis. (more details...)
		Value > 0.0	Specifies the length of the box graphic along its coordinate system's Y-axis, in world units.
	ZPos2OrLength		Specifies the length of the box graphic along its coordinate system's Z-axis. (summarize) Specifies the length of the box graphic along its coordinate system's Z-axis. (more details...)
		Value > 0.0	Specifies the length of the box graphic along its coordinate system's Z-axis, in world units.
M_CORNER_AND_DIMENSION			Defines the box graphic by one of its corners and its length along each of its coordinate system's axes. (summarize) Defines the box graphic by one of its corners and its length along each of its coordinate system's axes. (more details...)
	XPos1		Specifies the X-coordinate of one corner of the box graphic.
	YPos1		Specifies the Y-coordinate of one corner of the box graphic.
	ZPos1		Specifies the Z-coordinate of one corner of the box graphic.
	XPos2OrLength		Specifies the length of the box graphic along its coordinate system's X-axis. (summarize) Specifies the length of the box graphic along its coordinate system's X-axis. (more details...)
		Value > 0.0	Specifies the length of the box graphic along its coordinate system's X-axis, in world units.
	YPos2OrLength		Specifies the length of the box graphic along its coordinate system's Y-axis. (summarize) Specifies the length of the box graphic along its coordinate system's Y-axis. (more details...)
		Value > 0.0	Specifies the length of the box graphic along its coordinate system's Y-axis, in world units.
	ZPos2OrLength		Specifies the length of the box graphic along its coordinate system's Z-axis. (summarize) Specifies the length of the box graphic along its coordinate system's Z-axis. (more details...)
		Value > 0.0	Specifies the length of the box graphic along its coordinate system's Z-axis, in world units.

Return value

Returns the label of the box 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 BOTH CORNERS CENTER AND DIMENSION CORNER AND DIMENSION