M3dmodAllocResult

Board	Supported
Host System	Yes
V4L2	Yes
Clarity UHD	Yes
Concord PoE	No
GenTL	Yes
GevIQ	Yes
GigE Vision	Yes
Indio	No
Iris GTX	Yes
Radient eV-CL	Yes
Rapixo CL	Yes
Rapixo CoF	Yes
Rapixo CXP	Yes
USB3 Vision	Yes

Allocate a 3D model finder result buffer.

Syntax

AIL_ID M3dmodAllocResult(
    AIL_ID    SysId,            //in
    AIL_INT64 ResultType,       //in
    AIL_INT64 ControlFlag,      //in
    AIL_ID *  Result3dmodIdPtr  //out
)

Description

This function allocates a 3D model finder result buffer, on the specified system, to store results obtained from an M3dmodFind operation.

When the 3D model finder result buffer is no longer required, release it usingM3dmodFreeunless M_UNIQUE_ID was specified during allocation; if M_UNIQUE_ID was specified, the smart identifier manages the 3D model finder result buffer's lifetime and you must not manually free it.

Parameters

SysId (in, AIL_ID)

Specifies the system on which to allocate the result buffer. This parameter should be set to one of the following values:

For specifying the system

Value	Description
M_DEFAULT_HOST	Specifies the default Host system of the current Aurora Imaging Library application.
System identifier	Specifies a valid system identifier, previously allocated using MsysAlloc.

ResultType (in, AIL_INT64)

Specifies the type of result buffer to allocate.

For specifying the type of result buffer to allocate

Value	Description
M_FIND_BOX_RESULT	Specifies to allocate a box 3D model finder result buffer used to store M3dmodFind results.
M_FIND_CYLINDER_RESULT	Specifies to allocate a cylinder 3D model finder result buffer used to store M3dmodFind results.
M_FIND_PLANAR_SURFACE_RESULT	Specifies to allocate a planar surface 3D model finder result buffer used to store M3dmodFind results.
M_FIND_RECTANGULAR_PLANE_RESULT	Specifies to allocate a rectangular plane 3D model finder result buffer used to store M3dmodFind results.
M_FIND_SPHERE_RESULT	Specifies to allocate a sphere 3D model finder result buffer used to store M3dmodFind results.
M_FIND_SURFACE_RESULT	Specifies to allocate a surface 3D model finder result buffer used to store M3dmodFind results.

ControlFlag (in, AIL_INT64)

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

Result3dmodIdPtr *(out, AIL_ID)

Specifies the address of the variable in which to write the 3D model finder result buffer identifier or specifies the data type that the function should use to return the 3D model finder result buffer identifier.

For retrieving the identifier or specifying how to return it

Value	Description
M_NULL	Specifies that you will use this function's return value to obtain the identifier of the allocated 3D model finder result buffer; in this case, a standard Aurora Imaging Library identifier of type AIL_ID is returned.
M_UNIQUE_ID	Specifies that you will use this function's return value to obtain the identifier of the allocated 3D model finder result buffer; in this case, an Aurora Imaging Library smart identifier of type _AIL_UNIQUE_3DMOD_ID_is returned instead of a standard Aurora Imaging Library identifier.This setting is only available when using C++11 (or later).An Aurora Imaging Library smart identifier manages the lifespan of the Aurora Imaging Library object it owns (similar to a std::unique_ptr). Note, you can use an Aurora Imaging Library smart identifier as though it were a standard Aurora Imaging Library identifier, except that you cannot use it to manually free the 3D model finder result buffer (it is freed automatically). For more information, see Aurora Imaging Library smart identifiers.
Address in which to write the box 3D model finder result buffer identifier	Specifies the address of an AIL_ID in which to write the identifier of the allocated box 3D model finder result buffer.

If allocation fails, M_NULL is written as the identifier. | | Address in which to write the cylinder 3D model finder result buffer identifier | Specifies the address of an AIL_ID in which to write the identifier of the allocated cylinder 3D model finder result buffer.

If allocation fails, M_NULL is written as the identifier. | | Address in which to write the planar surface 3D model finder result buffer identifier | Specifies the address of an AIL_ID in which to write the identifier of the allocated planar surface 3D model finder result buffer.

If allocation fails, M_NULL is written as the identifier. | | Address in which to write the rectangular plane 3D model finder result buffer identifier | Specifies the address of an AIL_ID in which to write the identifier of the allocated rectangular plane 3D model finder result buffer.

If allocation fails, M_NULL is written as the identifier. | | Address in which to write the sphere 3D model finder result buffer identifier | Specifies the address of an AIL_ID in which to write the identifier of the allocated sphere 3D model finder result buffer.

If allocation fails, M_NULL is written as the identifier. | | Address in which to write the surface 3D model finder result buffer identifier | Specifies the address of an AIL_ID in which to write the identifier of the allocated surface 3D model finder result buffer.

If allocation fails, M_NULL is written as the identifier. |

Return Value

Type: AIL_ID

The returned value is the 3D model finder result buffer identifier either as a standard identifier (AIL_ID) or a smart identifier (AIL_UNIQUE_3DMOD_ID). If allocation fails, M_NULL is returned (or nullptr ifM_UNIQUE_ID was specified).