M3ddispCopy

See also

User Guide:

Manipulating the view

Reference:

M3ddispAlloc M3ddispControl M3ddispInquire M3ddispSetView M3dgeoAlloc M3dgeoInquire MbufInquire

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Not supported on:

Not supported on Matrox Indio (Update 53 or Update 68) (w)

Not supported on Matrox Concord PoE with ToE (Update 82) (z)

Fully supported on:

Fully supported on Host system (a)

Fully supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Fully supported on Matrox Morphis (g)

Fully supported on Matrox Morphis QxT (h)

Fully supported on Matrox Orion HD (i)

Fully supported on Matrox Radient eCL (j)

Fully supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Fully supported on Matrox Solios eA/XA (l)

Fully supported on Matrox Solios ecl/xcl/ev-cl (m)

Fully supported on Matrox USB3 Vision driver (Update 19) (o)

Fully supported on Matrox RadientPro-CL (Update 7) (p)

Fully supported on Matrox Radient eV-CL (Update 27 or 74) (r)

Fully supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Fully supported on Matrox Clarity UHD (Update 36 or 76) (u)

Fully supported on Matrox GenTL driver (Update 34) (v)

Fully supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

Fully supported on Matrox Rapixo CL Pro (Update 96) (aa)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

m3ddisp.cpp
m3ddisp.cs
m3ddisp.vb
m3dreg.cpp
m3dreg.cs
m3dreg.vb

Function Map

Parameter Associations

Table:	For specifying the copy type
+ combination:	Specifies the starting position

Compilation information

Synopsis

Copy data to or from a 3D display.

Syntax

void M3ddispCopy(

MIL_ID SrcMilObjectId,	//in
MIL_ID DstMilObjectId,	//in
MIL_INT64 CopyType,	//in
MIL_INT64 ControlFlag	//in

)

Description

This function copies data (such as a transformation matrix or background image) to or from a 3D display.

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 which MIL system’s documentation you should use in its place and any possible differences.

Parameters

This function is not supported on the selected boards.

This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.

Parameters

SrcMilObjectId

Specifies the identifier of the source object. Note that if the source object is not a 3D display, the destination object must be.

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

DstMilObjectId

Specifies the identifier of the destination object. Note that if the destination object is not a 3D display, the source object must be.

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

CopyType

Specifies the type of copy operation to perform.

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 SrcMilObjectId, DstMilObjectId, and CopyType parameters.

For specifying the copy type

For specifying the copy type
CopyType			Description
	SrcMilObjectId
		DstMilObjectId
M_BACKGROUND_IMAGE			Specifies to set the background image of a 3D display, or to copy the background image of a 3D display to an image buffer. (summarize) Specifies to set the background image of a 3D display, or to copy the background image of a 3D display to an image buffer. (more details...)
	Image buffer identifier from which to copy		Specifies the identifier of the 8-bit unsigned image buffer to copy to the background of the 3D display. (summarize) Specifies the identifier of the 8-bit unsigned image buffer to copy to the background of the 3D display. (more details...)
		MIL 3D display identifier	Specifies the identifier of the 3D display to which the image buffer is copied. The 3D display must have been previously allocated using M3ddispAlloc(). (summarize) Specifies the identifier of the 3D display to which the image buffer is copied. (more details...)
	MIL 3D display identifier from which to copy		Specifies the identifier of the 3D display whose background to copy. The 3D display must have been previously allocated using M3ddispAlloc(). An error is generated if the 3D display does not have a background image. (summarize) Specifies the identifier of the 3D display whose background to copy. (more details...)
		Image buffer identifier	Specifies the identifier of the 8-bit unsigned image buffer in which to copy the background image. The image buffer must have the same width, height, and number of bands as the background image of the 3D display. You can determine the size and number of bands of the current background image buffer using M3ddispInquire() with M_BACKGROUND_IMAGE_SIZE_.... (summarize) Specifies the identifier of the 8-bit unsigned image buffer in which to copy the background image. (more details...)
M_ROTATION_AXIS			Specifies to set the auto-rotation axis of a 3D display, or to copy the auto-rotation axis of a 3D display to a 3D line geometry object. This is the axis that the view of the 3D display rotates around when M_AUTO_ROTATE is set to M_ENABLE. (summarize) Specifies to set the auto-rotation axis of a 3D display, or to copy the auto-rotation axis of a 3D display to a 3D line geometry object. (more details...)
	MIL 3D display identifier from which to copy		Specifies the identifier of the 3D display whose auto-rotation axis to copy. The 3D display must have been previously allocated using M3ddispAlloc(). (summarize) Specifies the identifier of the 3D display whose auto-rotation axis to copy. (more details...)
		MIL 3D geometry object identifier	Specifies the identifier of the 3D geometry object to define. The 3D geometry object is defined as an infinite line. (summarize) Specifies the identifier of the 3D geometry object to define. (more details...)
	MIL 3D line geometry object identifier		Specifies the identifier of the 3D line geometry object used to set the 3D display's view. The 3D line geometry object must have been previously allocated using M3dgeoAlloc() with M_GEOMETRY, and defined as a line. (summarize) Specifies the identifier of the 3D line geometry object used to set the 3D display's view. (more details...)
		MIL 3D display identifier	Specifies the identifier of the 3D display whose view to set. The 3D display must have been previously allocated using M3ddispAlloc(). (summarize) Specifies the identifier of the 3D display whose view to set. (more details...)
M_VIEW_MATRIX +			Specifies to copy the view's transformation matrix. If copied before the view of the 3D display is moved, you can use this matrix with M3ddispCopy() or M3ddispSetView() to restore the current position and orientation of the view. The transformation matrix of a view is relative to a view with the viewpoint at (0,0,1), the interest point at (0,0,0), and an up vector of (0,1,0). This can also be thought of as a direct top-down view, with the up vector aligned with the Y-axis. (summarize) Specifies to copy the view's transformation matrix. (more details...)
	M_IDENTITY_MATRIX		Specifies to set the 3D display's view to the identity matrix. This can be used to reset the view's orientation. (summarize) Specifies to set the 3D display's view to the identity matrix. (more details...)
		MIL 3D display identifier	Specifies the identifier of the 3D display whose view to set. The 3D display must have been previously allocated using M3ddispAlloc(). (summarize) Specifies the identifier of the 3D display whose view to set. (more details...)
	MIL 3D display identifier from which to copy		Specifies the identifier of a 3D display from which to copy the view's orientation. The 3D display must have been previously allocated using M3ddispAlloc(). (summarize) Specifies the identifier of a 3D display from which to copy the view's orientation. (more details...)
		MIL transformation matrix object identifier	Specifies the identifier of the transformation matrix object in which to copy the view's orientation. The transformation matrix object must have been previously allocated using M3dgeoAlloc() with M_TRANSFORMATION_MATRIX. (summarize) Specifies the identifier of the transformation matrix object in which to copy the view's orientation. (more details...)
	MIL transformation matrix object identifier		Specifies the identifier of the transformation matrix object used to set the orientation of the 3D display's view. The transformation matrix object must have been previously allocated using M3dgeoAlloc() with M_TRANSFORMATION_MATRIX. (summarize) Specifies the identifier of the transformation matrix object used to set the orientation of the 3D display's view. (more details...)
		MIL 3D display identifier	Specifies the identifier of the 3D display of which to set the view's orientation. The 3D display must have been previously allocated using M3ddispAlloc(). (summarize) Specifies the identifier of the 3D display of which to set the view's orientation. (more details...)

Combination value for M_VIEW_MATRIX.

You can add one or more of the following value to the above-mentioned value to specify to use the current viewpoint as the starting point for the transformation..

Specifies the starting position
Combination value	Description
M_COMPOSE_WITH_CURRENT	Specifies to use the current viewpoint as the starting point for the transformation. This setting can only be used when copying a transformation matrix object to a 3D display. (summarize) Specifies to use the current viewpoint as the starting point for the transformation. (more details...)

Compilation information

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