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

M3dgraLine

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

3dplanefit.cpp
m3dgra.cpp
m3dgra.cs
m3dgra.vb
stereocalibration.cpp

Function Map

Table:

For specifying the parent label

- PointOrVectorX

- PointOrVectorY

- PointOrVectorZ

Table:

For specifying to override the default line graphic's length

Parameter Associations

Table:

For specifying the line graphic

Compilation information

Synopsis

Add a line graphic to a 3D graphics list.

Syntax

MIL_INT64 M3dgraLine(

MIL_ID List3dgraId,	//in
MIL_INT64 ParentLabel,	//in
MIL_INT64 CreationMode,	//in
MIL_INT64 Symbol,	//in
MIL_DOUBLE PointX,	//in
MIL_DOUBLE PointY,	//in
MIL_DOUBLE PointZ,	//in
MIL_DOUBLE PointOrVectorX,	//in
MIL_DOUBLE PointOrVectorY,	//in
MIL_DOUBLE PointOrVectorZ,	//in
MIL_DOUBLE Length,	//in
MIL_INT64 ControlFlag	//in

)

Description

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

The line graphic has its own coordinate system that represents the line graphic's position and orientation with respect to its parent's coordinate system. The origin of the line graphic's coordinate system is the line graphic's start point, and its Z-axis shares the same direction as the line graphic's direction. You can inquire the line graphic's start point using M3dgraInquire() with M_START_POINT_....

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

ParentLabel

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

CreationMode

Specifies how the line graphic is defined.

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

Symbol

Reserved for future expansion and must be set to M_DEFAULT.

PointX

Specifies the first parameter used to define the line graphic.

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

PointY

Specifies the second parameter used to define the line graphic.

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

PointZ

Specifies the third parameter used to define the line graphic.

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

PointOrVectorX

Specifies the fourth parameter used to define the line graphic.

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

PointOrVectorY

Specifies the fifth parameter used to define the line graphic.

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

PointOrVectorZ

Specifies the sixth parameter used to define the line graphic.

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

Length

Specifies to override the default line graphic's length.

For specifying to override the default line graphic's length
Value	Description
M_DEFAULT	Specifies the default length defined by the creation mode.
M_INFINITE	Specifies an infinite line graphic. The line graphic's size is determined upon creation, using its 3D graphics list's clipping box. (summarize) Specifies an infinite line graphic. (more details...)
Value > 0.0	Specifies to override the line graphic's length with a specific value.

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Parameter associations

The table below lists possible values for the CreationMode, PointX, PointY, PointZ, PointOrVectorX, PointOrVectorY, and PointOrVectorZ parameters.

For specifying the line graphic

For specifying the line graphic
CreationMode		Description
	PointX
	PointY
	PointZ
	PointOrVectorX
	PointOrVectorY
	PointOrVectorZ
M_POINT_AND_VECTOR		Defines the line graphic using a point on the line and a nonzero vector defining the line's direction. By default, the length of the line graphic is finite and is set to the vector's magnitude. The point is at the start of the line graphic. (summarize) Defines the line graphic using a point on the line and a nonzero vector defining the line's direction. (more details...)
	PointX	Specifies the X-coordinate of the point on the line graphic.
	PointY	Specifies the Y-coordinate of the point on the line graphic.
	PointZ	Specifies the Z-coordinate of the point on the line graphic.
	PointOrVectorX	Specifies the X-component of the vector defining the line graphic's direction.
	PointOrVectorY	Specifies the Y-component of the vector defining the line graphic's direction.
	PointOrVectorZ	Specifies the Z-component of the vector defining the line graphic's direction.
M_TWO_POINTS		Defines the line graphic using any two non-identical points. By default, the length of the line graphic is finite and is set to the distance between the two specified points. The line graphic starts at the first point, and ends at the second point. (summarize) Defines the line graphic using any two non-identical points. (more details...)
	PointX	Specifies the X-coordinate of the first point on the line graphic.
	PointY	Specifies the Y-coordinate of the first point on the line graphic.
	PointZ	Specifies the Z-coordinate of the first point on the line graphic.
	PointOrVectorX	Specifies the X-coordinate of the second point on the line graphic.
	PointOrVectorY	Specifies the Y-coordinate of the second point on the line graphic.
	PointOrVectorZ	Specifies the Z-coordinate of the second point on the line graphic.

Return value

Returns the label of the line 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 INFINITE POINT AND VECTOR TWO POINTS