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

M3dgeoPlane

See also

User Guide:

Defining 3D geometries Performing 3D fitting

Reference:

M3dgeoAlloc 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

bottlecapinspection.cpp
m3dmap.cpp
m3dmap.cs
m3dmap.vb

M3dgeoMatrixSetWithAxes

Function Map

- Geometry3dgeoId

- X1

- Y1

- Z1

- Y2

- Z2

- X3

- Y3

- Z3

Parameter Associations

Table:

For specifying the plane

Compilation information

Synopsis

Define a 3D plane geometry object.

Syntax

void M3dgeoPlane(

MIL_ID Geometry3dgeoId,	//in
MIL_INT64 CreationMode,	//in
MIL_DOUBLE X1,	//in
MIL_DOUBLE Y1,	//in
MIL_DOUBLE Z1,	//in
MIL_DOUBLE X2OrD,	//in
MIL_DOUBLE Y2,	//in
MIL_DOUBLE Z2,	//in
MIL_DOUBLE X3,	//in
MIL_DOUBLE Y3,	//in
MIL_DOUBLE Z3,	//in
MIL_INT64 ControlFlag	//in

)

Description

This function defines a 3D plane geometry object. You can translate, rotate, or transform the resulting plane, using the 3D image processing module.

You can use the resulting plane 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 plane 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 plane, and CreationMode is set to M_POINT_AND_NORMAL, you can leave the components of the plane's normal vector unchanged, even if the plane was modified using the 3D image processing module.

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 plane is defined.

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

X1

Specifies the first parameter used to define the plane.

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

Y1

Specifies the second parameter used to define the plane.

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

Z1

Specifies the third parameter used to define the plane.

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

X2OrD

Specifies the fourth parameter used to define the plane.

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

Y2

Specifies the fifth parameter used to define the plane.

Set this parameter to M_DEFAULT if not used.

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

Z2

Specifies the sixth parameter used to define the plane.

Set this parameter to M_DEFAULT if not used.

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

X3

Specifies the seventh parameter used to define the plane.

Set this parameter to M_DEFAULT if not used.

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

Y3

Specifies the eighth parameter used to define the plane.

Set this parameter to M_DEFAULT if not used.

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

Z3

Specifies the ninth parameter used to define the plane.

Set this parameter to M_DEFAULT if not used.

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

ControlFlag

Reserved for future expansion. This parameter must be set to M_DEFAULT.

Parameter associations

The table below lists possible values for the CreationMode, X1, Y1, Z1, X2OrD, Y2, Z2, X3, Y3, and Z3 parameters.

For specifying the plane

Set unused parameters to M_DEFAULT.

For specifying the plane INQ
CreationMode			Description
	X1
	Y1
	Z1
	X2OrD
	Y2
	Z2
	X3
	Y3
	Z3
M_COEFFICIENTS			Specifies to define the plane using coefficients from the plane equation (Ax + By + Cz + D = 0). Coefficients A, B, and C cannot all be zero. Note that the coefficients will be internally normalized such that A^2 + B^2 + C^2 = 1. (summarize) Specifies to define the plane using coefficients from the plane equation (Ax + By + Cz + D = 0). (more details...)
	X1		Specifies coefficient A of the plane equation.
	Y1		Specifies coefficient B of the plane equation.
	Z1		Specifies coefficient C of the plane equation.
	X2OrD		Specifies coefficient D of the plane equation.
M_POINT_AND_NORMAL			Specifies to define the plane using a point on the plane and the plane's normal. The plane's normal must have a non-zero magnitude. Note that the plane's normal will be internally converted to a unit vector. Note that if Geometry3dgeoId specifies a previously-defined plane, you can leave the components of its normal vector 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) Specifies to define the plane using a point on the plane and the plane's normal. (more details...)
	X1		Specifies the X-coordinate of the point on the plane.
	Y1		Specifies the Y-coordinate of the point on the plane.
	Z1		Specifies the Z-coordinate of the point on the plane.
	X2OrD		Specifies the X-component of the normal. (summarize) Specifies the X-component of the normal. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the X-component of the normal.
	Y2		Specifies the Y-component of the normal. (summarize) Specifies the Y-component of the normal. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the Y-component of the normal.
	Z2		Specifies the Z-component of the normal. (summarize) Specifies the Z-component of the normal. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the Z-component of the normal.
M_POINT_AND_TWO_VECTORS			Specifies to define the plane using a point on the plane and two vectors parallel to the plane. The two vectors must have non-zero magnitudes and cannot be co-linear. (summarize) Specifies to define the plane using a point on the plane and two vectors parallel to the plane. (more details...)
	X1		Specifies the X-coordinate of the point on the plane.
	Y1		Specifies the Y-coordinate of the point on the plane.
	Z1		Specifies the Z-coordinate of the point on the plane.
	X2OrD		Specifies the X-component of the first vector.
	Y2		Specifies the Y-component of the first vector.
	Z2		Specifies the Z-component of the first vector.
	X3		Specifies the X-component of the second vector.
	Y3		Specifies the Y-component of the second vector.
	Z3		Specifies the Z-component of the second vector.
M_THREE_POINTS			Specifies to define the plane using three points on the plane. (summarize) Specifies to define the plane using three points on the plane. (more details...)
	X1		Specifies the X-coordinate of the first point on the plane.
	Y1		Specifies the Y-coordinate of the first point on the plane.
	Z1		Specifies the Z-coordinate of the first point on the plane.
	X2OrD		Specifies the X-coordinate of the second point on the plane.
	Y2		Specifies the Y-coordinate of the second point on the plane.
	Z2		Specifies the Z-coordinate of the second point on the plane.
	X3		Specifies the X-coordinate of the third point on the plane.
	Y3		Specifies the Y-coordinate of the third point on the plane.
	Z3		Specifies the Z-coordinate of the third point on the plane.

Compilation information

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

COEFFICIENTS POINT AND NORMAL UNCHANGED UNCHANGED UNCHANGED POINT AND TWO VECTORS THREE POINTS PLANE