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

M3dgeoCylinder

See also

User Guide:

Defining 3D geometries

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

3dplanarity.cpp
3dplanefit.cpp
studinspection.cpp

Function Map

- Geometry3dgeoId

- XPos2OrVector

- YPos2OrVector

- ZPos2OrVector

Table:

For specifying the cylinder's radius

Table:

For specifying to override the default cylinder length

Parameter Associations

Table:

For specifying the cylinder

Compilation information

Synopsis

Define a 3D cylinder geometry object.

Syntax

void M3dgeoCylinder(

MIL_ID Geometry3dgeoId,	//in
MIL_INT64 CreationMode,	//in
MIL_DOUBLE XPos1,	//in
MIL_DOUBLE YPos1,	//in
MIL_DOUBLE ZPos1,	//in
MIL_DOUBLE XPos2OrVector,	//in
MIL_DOUBLE YPos2OrVector,	//in
MIL_DOUBLE ZPos2OrVector,	//in
MIL_DOUBLE Radius,	//in
MIL_DOUBLE Length,	//in
MIL_INT64 ControlFlag	//in

)

Description

This function defines an arbitrary right circular 3D cylinder geometry object. You can translate, rotate, scale, or transform the resulting cylinder, using the 3D image processing module.

You can use the resulting cylinder 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 cylinder 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 cylinder, 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.

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

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

XPos1

Specifies the X-coordinate of a point on the cylinder's central axis.

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

YPos1

Specifies the Y-coordinate of a point on the cylinder's central axis.

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

ZPos1

Specifies the Z-coordinate of a point on the cylinder's central axis.

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

XPos2OrVector

Specifies the X-coordinate of the cylinder's second defining point, or the X-component of the cylinder's central axis vector.

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

YPos2OrVector

Specifies the Y-coordinate of the cylinder's second defining point, or the Y-component of the cylinder's central axis vector.

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

ZPos2OrVector

Specifies the Z-coordinate of the cylinder's second defining point, or the Z-component of the cylinder's central axis vector.

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

Radius INQ

Specifies the cylinder's radius.

For specifying the cylinder's radius
Value	Description
M_UNCHANGED	Specifies to use the previously-defined value.
Value > 0.0	Specifies the cylinder's radius.

Length

Specifies to override the default cylinder length.

For specifying to override the default cylinder length
Value	Description
M_DEFAULT	Specifies the default length defined by the creation mode.
M_INFINITE	Specifies an infinite cylinder.
M_UNCHANGED	Specifies to use the previously-defined value.
Value >= 0.0	Specifies to override the cylinder'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, XPos1, YPos1, ZPos1, XPos2OrVector, YPos2OrVector, and ZPos2OrVector parameters.

For specifying the cylinder

For specifying the cylinder INQ
CreationMode			Description
	XPos1
	YPos1
	ZPos1
	XPos2OrVector
	YPos2OrVector
	ZPos2OrVector
M_POINT_AND_VECTOR			Defines the cylinder using a point on the cylinder's central axis and a nonzero vector defining the central axis direction. By default, the length of the cylinder is finite and is set to the vector's magnitude. The point is at the center of the cylinder's first circular base. Note that if you set one of the vector's components to M_UNCHANGED, you must also set the other two components to M_UNCHANGED. (summarize) Defines the cylinder using a point on the cylinder's central axis and a nonzero vector defining the central axis direction. (more details...)
	XPos1		Specifies the X-coordinate of the point on the cylinder's central axis. (summarize) Specifies the X-coordinate of the point on the cylinder's central axis. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the X-coordinate of the first point on the cylinder's central axis.
	YPos1		Specifies the Y-coordinate of the point on the cylinder's central axis. (summarize) Specifies the Y-coordinate of the point on the cylinder's central axis. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the Y-coordinate of the first point on the cylinder's central axis.
	ZPos1		Specifies the Z-coordinate of the point on the cylinder's central axis. (summarize) Specifies the Z-coordinate of the point on the cylinder's central axis. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the Z-coordinate of the first point on the cylinder's central axis.
	XPos2OrVector		Specifies the X-component of the vector defining the central axis direction. (summarize) Specifies the X-component of the vector defining the central axis direction. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the X-component of the vector defining the central axis direction.
	YPos2OrVector		Specifies the Y-component of the vector defining the central axis direction. (summarize) Specifies the Y-component of the vector defining the central axis direction. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the Y-component of the vector defining the central axis direction.
	ZPos2OrVector		Specifies the Z-component of the vector defining the central axis direction. (summarize) Specifies the Z-component of the vector defining the central axis direction. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the Z-component of the vector defining the central axis direction.
M_TWO_POINTS			Defines the cylinder using any two non-identical points on the cylinder's central axis. By default, the length of the cylinder is finite and is set to the distance between the two specified points. The first specified point is at the center of the cylinder's first circular base and the second specified point is at the center of the cylinder's second circular base. (summarize) Defines the cylinder using any two non-identical points on the cylinder's central axis. (more details...)
	XPos1		Specifies the X-coordinate of the first point on the cylinder's central axis. (summarize) Specifies the X-coordinate of the first point on the cylinder's central axis. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the X-coordinate of the first point on the cylinder's central axis.
	YPos1		Specifies the Y-coordinate of the first point on the cylinder's central axis. (summarize) Specifies the Y-coordinate of the first point on the cylinder's central axis. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the Y-coordinate of the first point on the cylinder's central axis.
	ZPos1		Specifies the Z-coordinate of the first point on the cylinder's central axis. (summarize) Specifies the Z-coordinate of the first point on the cylinder's central axis. (more details...)
		M_UNCHANGED	Specifies to use the previously-defined value.
		Value	Specifies the Z-coordinate of the first point on the cylinder's central axis.
	XPos2OrVector		Specifies the X-coordinate of the second point on the cylinder's central axis.
	YPos2OrVector		Specifies the Y-coordinate of the second point on the cylinder's central axis.
	ZPos2OrVector		Specifies the Z-coordinate of the second point on the cylinder's central axis.

Compilation information

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

UNCHANGED DEFAULT INFINITE UNCHANGED POINT AND VECTOR UNCHANGED UNCHANGED UNCHANGED UNCHANGED UNCHANGED UNCHANGED TWO POINTS UNCHANGED UNCHANGED UNCHANGED CYLINDER