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

M3dgraPlane

See also

User Guide:

Annotating the 3D display

Reference:

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

3dplanarity.cpp
3dplanefit.cpp
3dprofilemetrology.cpp
m3dgra.cpp
m3dgra.cs
m3dgra.vb

Function Map

Table:

For specifying the parent label

- X1

- Y1

- Z1

- Y2

- Z2

- X3

- Y3

- Z3

Parameter Associations

Table:

For specifying the plane graphic

Compilation information

Synopsis

Add a plane graphic to a 3D graphics list.

Syntax

MIL_INT64 M3dgraPlane(

MIL_ID List3dgraId,	//in
MIL_INT64 ParentLabel,	//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_DOUBLE Size,	//in
MIL_INT64 ControlFlag	//in

)

Description

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

The plane graphic has its own coordinate system that represents the plane graphic's position and orientation with respect to its parent's coordinate system. The plane graphic's coordinate system's origin is the point on the plane graphic closest to the origin of its parent's coordinate system, and its Z-axis is the plane graphic's normal vector. The plane graphic's coordinate system's XY (Z=0) plane lies on the plane graphic.

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 plane graphic.

ParentLabel

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

CreationMode

Specifies how the plane graphic is defined.

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

X1

Specifies the first parameter used to define the plane graphic.

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

Y1

Specifies the second parameter used to define the plane graphic.

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

Z1

Specifies the third parameter used to define the plane graphic.

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

X2OrD

Specifies the fourth parameter used to define the plane graphic.

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

Y2

Specifies the fifth parameter used to define the plane graphic.

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 graphic.

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 graphic.

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 graphic.

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 graphic.

Set this parameter to M_DEFAULT if not used.

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

Size

Specifies the size of the plane graphic. Finite plane graphics are square-shaped. If the plane graphic is infinite, it is clipped using the 3D graphics list's clipping box, which results in a polygon with 3 to 6 edges.

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, Z3, and Size parameters.

For specifying the plane graphic

Set unused parameters to M_DEFAULT.

For specifying the plane graphic
CreationMode			Description
	X1
	Y1
	Z1
	X2OrD
	Y2
	Z2
	X3
	Y3
	Z3
	Size
M_COEFFICIENTS			Defines the plane graphic using coefficients from the plane equation (Ax + By + Cz + D = 0). Coefficients A, B, and C cannot all be zero. (summarize) Defines the plane graphic 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.
	Size		Specifies the size of the plane graphic. (summarize) Specifies the size of the plane graphic. (more details...)
		M_DEFAULT	Same as M_INFINITE.
		M_INFINITE	Specifies an infinite plane graphic. The plane graphic's size is determined upon creation, using its 3D graphics list's clipping box. (summarize) Specifies an infinite plane graphic. (more details...)
M_POINT_AND_NORMAL			Defines the plane graphic using a point on the plane graphic and the plane graphic's normal. The plane graphic's normal must have a non-zero magnitude. (summarize) Defines the plane graphic using a point on the plane graphic and the plane graphic's normal. (more details...)
	X1		Specifies the X-coordinate of the point on the plane graphic.
	Y1		Specifies the Y-coordinate of the point on the plane graphic.
	Z1		Specifies the Z-coordinate of the point on the plane graphic.
	X2OrD		Specifies the X-component of the normal.
	Y2		Specifies the Y-component of the normal.
	Z2		Specifies the Z-component of the normal.
	Size		Specifies the size of the plane graphic. (summarize) Specifies the size of the plane graphic. (more details...)
		M_DEFAULT	Same as M_INFINITE.
		M_INFINITE	Specifies an infinite plane graphic. The plane graphic's size is determined upon creation, using its 3D graphics list's clipping box. (summarize) Specifies an infinite plane graphic. (more details...)
		Value > 0.0	Specifies the length of the plane graphic's sides. The plane graphic is a square centered on (X1, Y1, Z1). (summarize) Specifies the length of the plane graphic's sides. (more details...)
M_POINT_AND_TWO_VECTORS			Defines the plane graphic using a point on the plane graphic and two vectors parallel to the plane graphic. The two vectors must have non-zero magnitudes and cannot be co-linear. (summarize) Defines the plane graphic using a point on the plane graphic and two vectors parallel to the plane graphic. (more details...)
	X1		Specifies the X-coordinate of the point on the plane graphic.
	Y1		Specifies the Y-coordinate of the point on the plane graphic.
	Z1		Specifies the Z-coordinate of the point on the plane graphic.
	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.
	Size		Specifies the size of the plane graphic. (summarize) Specifies the size of the plane graphic. (more details...)
		M_DEFAULT	Same as M_INFINITE.
		M_INFINITE	Specifies an infinite plane graphic. The plane graphic's size is determined upon creation, using its 3D graphics list's clipping box. (summarize) Specifies an infinite plane graphic. (more details...)
		Value > 0.0	Specifies the length of the plane graphic's sides. The plane graphic is a square centered on (X1, Y1, Z1). (summarize) Specifies the length of the plane graphic's sides. (more details...)
M_THREE_POINTS			Defines the plane graphic using three points on the plane graphic. (summarize) Defines the plane graphic using three points on the plane graphic. (more details...)
	X1		Specifies the X-coordinate of the first point on the plane graphic.
	Y1		Specifies the Y-coordinate of the first point on the plane graphic.
	Z1		Specifies the Z-coordinate of the first point on the plane graphic.
	X2OrD		Specifies the X-coordinate of the second point on the plane graphic.
	Y2		Specifies the Y-coordinate of the second point on the plane graphic.
	Z2		Specifies the Z-coordinate of the second point on the plane graphic.
	X3		Specifies the X-coordinate of the third point on the plane graphic.
	Y3		Specifies the Y-coordinate of the third point on the plane graphic.
	Z3		Specifies the Z-coordinate of the third point on the plane graphic.
	Size		Specifies the size of the plane graphic. (summarize) Specifies the size of the plane graphic. (more details...)
		M_DEFAULT	Same as M_INFINITE.
		M_INFINITE	Specifies an infinite plane graphic. The plane graphic's size is determined upon creation, using its 3D graphics list's clipping box. (summarize) Specifies an infinite plane graphic. (more details...)
		Value > 0.0	Specifies the length of the plane graphic's sides. The plane graphic is a square centered on (X1, Y1, Z1). (summarize) Specifies the length of the plane graphic's sides. (more details...)

Return value

Returns the label of the plane 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 COEFFICIENTS DEFAULT INFINITE POINT AND NORMAL DEFAULT INFINITE POINT AND TWO VECTORS DEFAULT INFINITE THREE POINTS DEFAULT INFINITE