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

M3dgeoBox

See also

User Guide:

Annotating the 3D display Defining 3D geometries Manipulating the view Working with 3D

Reference:

M3dgeoAlloc M3dgeoCopy M3dgeoInquire

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

3dcadregistration.cpp
3dmodelheightdefect.cpp
3dprofilemetrology.cpp
examplemanagerfor3d.cpp
m3dgra.cpp
m3dgra.cs
m3dgra.vb
simple3dbinpicking.cpp
simple3dstitching.cpp
sphereinspection.cpp

Function Map

- Geometry3dgeoId

- XPos2OrLength

- YPos2OrLength

- ZPos2OrLength

Parameter Associations

Table:	For specifying the box
+ combination:	For specifying to leave the orientation unchanged

Compilation information

Synopsis

Define a 3D box geometry object.

Syntax

void M3dgeoBox(

MIL_ID Geometry3dgeoId,	//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_INT64 ControlFlag	//in

)

Description

This function defines an axis-aligned, 3D box geometry object. You can get or set the 3D box orientation using M3dgeoCopy(). You can translate, rotate, scale, or transform the resulting box, using the 3D image processing module.

You can use the resulting box to, for example, crop a point cloud or perform an arithmetic operation on a depth map using the 3D image processing module, or calculate its distance from each point in a point cloud using the 3D metrology module.

If you want to define a box geometry object from results obtained in a different module, you can use the copy function of that module.

All coordinates are expressed in world units in the working coordinate system.

Note that if Geometry3dgeoId specifies a previously-defined box, and CreationMode is set to M_CENTER_AND_DIMENSION, you can leave some of the box's attributes unchanged, even if that attribute was set using a different creation mode or was modified using the 3D image processing module. Unless you specify M_ORIENTATION_UNCHANGED, its orientation will be reset to the identity matrix.

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

Geometry3dgeoId

Specifies the identifier of the 3D geometry object, previously allocated on the required system using M3dgeoAlloc() with M_GEOMETRY.

CreationMode

Specifies how the box 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.

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.

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.

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, or the length of the box along the X-axis.

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, or the length of the box along the Y-axis.

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, or the length of the box along the Z-axis.

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, XPos1, YPos1, ZPos1, XPos2OrLength, YPos2OrLength, and ZPos2OrLength parameters.

For specifying the box

For specifying the box INQ
CreationMode			Description
	XPos1
	YPos1
	ZPos1
	XPos2OrLength
	YPos2OrLength
	ZPos2OrLength
M_BOTH_CORNERS			Defines the box using any two opposite corners. (summarize) Defines the box using any two opposite corners. (more details...)
	XPos1		Specifies the X-coordinate of the first corner of the box.
	YPos1		Specifies the Y-coordinate of the first corner of the box.
	ZPos1		Specifies the Z-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.
	YPos2OrLength		Specifies the Y-coordinate of the second corner of the box, opposite to the first corner.
	ZPos2OrLength		Specifies the Z-coordinate of the second corner of the box, opposite to the first corner.
M_CENTER_AND_DIMENSION +			Defines the box by its center point and its length along each axis. You can determine the coordinates of the corners of the box by taking a coordinate from the center point and adding or subtracting half the box's length, along the coordinate's axis. For example, the Y-coordinates of the corners of the box are YPos1 ± (YPos2OrLength /2). You can also use M3dgeoInquire() with M_CORNER_.... Note that the box's size along each axis, M_SIZE_X, M_SIZE_Y, and M_SIZE_Z, will be the absolute values of the corresponding lengths specified by XPos2OrLength, YPos2OrLength, and ZPos2OrLength. Note that if Geometry3dgeoId specifies a previously-defined box, you can leave some of its attributes unchanged, even if that attribute was set using a different creation mode or was modified using the 3D image processing module. To do so, set the corresponding parameter to M_UNCHANGED. (summarize) Defines the box by its center point and its length along each axis. (more details...)
	XPos1		Specifies the X-coordinate of the center of the box. (summarize) Specifies the X-coordinate of the center of the box. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the box center's X-coordinate.
	YPos1		Specifies the Y-coordinate of the center of the box. (summarize) Specifies the Y-coordinate of the center of the box. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the box center's Y-coordinate.
	ZPos1		Specifies the Z-coordinate of the center of the box. (summarize) Specifies the Z-coordinate of the center of the box. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the box center's Z-coordinate.
	XPos2OrLength		Specifies the length of the box along the X-axis. (summarize) Specifies the length of the box along the X-axis. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the box's length along the X-axis.
	YPos2OrLength		Specifies the length of the box along the Y-axis. (summarize) Specifies the length of the box along the Y-axis. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the box's length along the Y-axis.
	ZPos2OrLength		Specifies the length of the box along the Z-axis. (summarize) Specifies the length of the box along the Z-axis. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the box's length along the Z-axis.
M_CORNER_AND_DIMENSION			Defines the box by one of its corners and its length (or negative length) along each axis. A positive value for length extends the box in the direction of the positive axis, starting from the specified corner point. A negative value extends the box in the direction of the negative axis, starting at the specified corner point. For example, if the specified corner is (1, 1, 1) and the value of the X, Y, and Z lengths are all positive 3 (a cube), the coordinates of the corner opposite the specified corner would be (4, 4, 4). If the X length was -3, while the other two lengths remained positive 3 (still a cube), the coordinates of the corner opposite the specified corner would be (-2, 4, 4). Note that the box's size along each axis, M_SIZE_X, M_SIZE_Y, and M_SIZE_Z, will be the absolute values of the corresponding lengths specified by XPos2OrLength, YPos2OrLength, and ZPos2OrLength. (summarize) Defines the box by one of its corners and its length (or negative length) along each axis. (more details...)
	XPos1		Specifies the X-coordinate of one corner of the box.
	YPos1		Specifies the Y-coordinate of one corner of the box.
	ZPos1		Specifies the Z-coordinate of one corner of the box.
	XPos2OrLength		Specifies the length of the box along the X-axis.
	YPos2OrLength		Specifies the length of the box along the Y-axis.
	ZPos2OrLength		Specifies the length of the box along the Z-axis.

Combination value for M_CENTER_AND_DIMENSION.

You can add the following value to the above-mentioned value to specify to leave the orientation of the previously-defined box unchanged.

For specifying to leave the orientation unchanged
Combination value	Description
M_ORIENTATION_UNCHANGED	Specifies to leave the orientation of the previously-defined box unchanged.

Compilation information

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

BOTH CORNERS CENTER AND DIMENSION UNCHANGED UNCHANGED UNCHANGED UNCHANGED UNCHANGED UNCHANGED CORNER AND DIMENSION ORIENTATION UNCHANGED BOX