/*
 * Header: VZNL_DetectRect.h
 * Description:当前文件为伟景智能(Vizum)所研发的EyeCB板提供检测形狀函数接口。
 *          
 * Sample:     
 *          VzNL_BeginDetectRect();
 *  
 *          VzNL_EndDetectRect();
 * Author: Mjw
 * Date:   2018/08/28
 */

#ifndef __VIZUM_DETECTED_RECT_HEADER__
#define __VIZUM_DETECTED_RECT_HEADER__

#include "VZNL_Export.h"
#include "VZNL_Types.h"

/// @brief
/// 开始矩形检测
/// <param name = "hDevice">[in]设备句柄</param>
/// @return 返回0为正确，失败返回错误码
VZNLAPI int VzNL_BeginDetectRect(VZNLHANDLE hDevice);

/// @brief
/// 设置检测距离
VZNLAPI int VzNL_ConfigDetectRectDistance(VZNLHANDLE hDevice, int nMin_mm, int nMax_mm);

/// @brief
/// 检测矩形
/// <param name = "hDevice">[in]设备句柄</param>
/// <param name = "pRectType">[in]要检测的矩形类型</param>
/// <param name = "nRectTypeCount">[in]要检测的矩形类型数量</param>
/// @return 返回0为正确，失败返回错误码
VZNLAPI int VzNL_DetectRect(VZNLHANDLE hDevice, const SVzNLSizeD* pRectType, int nRectTypeCount);

/// @brief
/// 获取矩形结果的个数
/// <param name = "hDevice">[in]设备句柄</param>
VZNLAPI int VzNL_GetRectResultCount(VZNLHANDLE hDevice);

/// @brief
/// 获取检测矩形的2D结果
/// <param name = "hDevice">[in]设备句柄</param>
/// <param name = "p2DRectResult">[out]2D矩形结果结构，内存空间由用户分配</param>
/// <param name = "pn3DRectCount">[in/out]传入:用户分配的SVzNL2DRectResult的结构个数;传出:用户需要分配多少个SVzNL2DRectResult</param>
/// @return 成功返回0，失败返回错误码。
VZNLAPI int VzNL_GetRect2DResult(VZNLHANDLE hDevice, SVzNL2DRectResult* p2DRectResult, int* pn2DRectCount);

/// @brief
/// 获取检测矩形的3D结果
/// <param name = "hDevice">[in]设备句柄</param>
/// <param name = "p3DRectResult">[out]3D矩形结果结构，内存空间由用户分配</param>
/// <param name = "pn3DRectCount">[in/out]传入:用户分配的SVzNL3DRectResult的结构个数;传出:用户需要分配多少个SVzNL3DRectResult</param>
/// @return 成功返回0，失败返回错误码。
VZNLAPI int	VzNL_GetRect3DResult(VZNLHANDLE hDevice, SVzNL3DRectResult* p3DRectResult, int* pn3DRectCount);

/// @brief
/// 结束矩形检测
/// <param name = "hDevice">[in]设备句柄</param>
VZNLAPI void VzNL_EndDetectRect(VZNLHANDLE hDevice);

#endif //__VIZUM_DETECTED_RECT_HEADER__