GdkDef.h

Go to the documentation of this file.

/** 
 * @file    GdkDef.h
 * @brief   Essential Gdk declarations. 
 *
 * @internal
 * Copyright (C) 2013 by LMI Technologies Inc.  All rights reserved.
 */
#ifndef GDK_DEF_H
#define GDK_DEF_H

#include <kApi/kApiDef.h>

kBeginHeader()

#if defined(GDK_EMIT)
#   define GdkFx(TYPE)       kExportFx(TYPE)
#   define GdkDx(TYPE)       kExportDx(TYPE)
#else
#   define GdkFx(TYPE)       kImportFx(TYPE)
#   define GdkDx(TYPE)       kImportDx(TYPE)
#endif

typedef struct GdkRegion2d64f
{
    k64f x;
    k64f y;
    k64f width;
    k64f length;
} GdkRegion2d64f;

typedef struct GdkRegion3d64f
{
    k64f x;
    k64f y;
    k64f z;
    k64f width;
    k64f length;
    k64f height;
} GdkRegion3d64f;

typedef struct GdkRegionXZ64f
{
    k64f x;
    k64f z;
    k64f width;
    k64f height;
} GdkRegionXZ64f;

typedef struct GdkPointXZ16s
{
    k16s x;
    k16s z;
} GdkPointXZ16s;

GdkFx(kStatus) GdkRegion3d64f_FromRect(GdkRegion3d64f* region, const kRect3d64f* rect);
GdkFx(kStatus) GdkRegion3d64f_ToRect(const GdkRegion3d64f* region, kRect3d64f* rect);

/**
* @struct  GdkOrientation
* @extends kValue
* @ingroup Gdk
* @brief   Represents the sensor system orientation.
*/
typedef k32s GdkOrientation;

/** @relates GdkOrientation @{ */
#define GDK_ORIENTATION_WIDE         (0)             ///< Wide layout.
#define GDK_ORIENTATION_OPPOSITE     (1)             ///< Opposite layout.
#define GDK_ORIENTATION_REVERSE      (2)             ///< Reverse layout.
/** @} */

/**
* @struct  GdkDataSource
* @extends kValue
* @ingroup Gdk
* @brief   Represents a data source selections.
*/
typedef k32s GdkDataSource;

/** @relates GdkDataSource @{ */
#define GDK_DATA_SOURCE_NONE         (-1)            ///< None or invalid.
#define GDK_DATA_SOURCE_TOP          (0)             ///< Top.
#define GDK_DATA_SOURCE_BOTTOM       (1)             ///< Bottom.
#define GDK_DATA_SOURCE_TOP_LEFT     (2)             ///< Top left.
#define GDK_DATA_SOURCE_TOP_RIGHT    (3)             ///< Top right.
#define GDK_DATA_SOURCE_TOP_BOTTOM   (4)             ///< Top and bottom (separate data streams).
#define GDK_DATA_SOURCE_LEFT_RIGHT   (5)             ///< Left and right (separate data streams).
#define GDK_DATA_SOURCE_COUNT        (6)             ///< Reserved for internal use.
/** @} */

/**
* @struct  GdkDataType
* @extends kValue
* @ingroup Gdk
* @brief   Represents data source selections. Used as a bitmask.
*/
typedef k32s GdkDataType;

/** @relates GdkDataType @{ */
#define GDK_DATA_TYPE_NONE                   (0x1)           ///< None.
#define GDK_DATA_TYPE_RANGE                  (0x2)           ///< Range data.
#define GDK_DATA_TYPE_UNIFORM_PROFILE        (0x4)           ///< Uniformly-spaced (resampled) profile data.
#define GDK_DATA_TYPE_RAW_PROFILE            (0x8)           ///< Unresampled profile data.
#define GDK_DATA_TYPE_UNIFORM_SURFACE        (0x10)          ///< Uniformly-spaced height map.
#define GDK_DATA_TYPE_RAW_SURFACE            (0x20)          ///< Unresampled point cloud.
#define GDK_DATA_TYPE_UNMERGED_RAW_PROFILE   (0x40)          ///< Unmerged raw profile data. Reserved for future use.
/** @} */

/**
* @struct  GdkAxis
* @extends kValue
* @ingroup Gdk
* @brief   Represents data source selections.
*/
typedef k32s GdkAxis;

/** @relates GdkAxis @{ */
#define GDK_AXIS_X                   (0)             ///< X Axis.
#define GDK_AXIS_Y                   (1)             ///< Y Axis.
#define GDK_AXIS_Z                   (2)             ///< Z Axis.
#define GDK_AXIS_COUNT               (3)             ///< Reserved for internal use.
#define GDK_AXIS_NONE                (3)             ///< Reserved for internal use.
/** @} */

GdkFx(const kChar*) GdkAxis_Format(GdkAxis axis);
GdkFx(GdkAxis) GdkAxis_Parse(const kChar* name);

/**
* @struct  GdkRefFrame
* @extends kValue
* @ingroup Gdk
* @brief   Represents data source selections.
*/
typedef k32s GdkRefFrame;

/** @relates GdkRefFrame @{ */
#define GDK_REF_FRAME_SENSOR         (0)             ///< Sensor frame of reference.
#define GDK_REF_FRAME_SCAN           (1)             ///< Scan frame of reference (X in sensor frame, Y in part frame).
#define GDK_REF_FRAME_PART           (2)             ///< Part frame of reference.
/** @} */

/**
* @struct  GdkMeasurementValueType
* @extends kValue
* @ingroup Gdk
* @brief   Represents data source selections.
*/
typedef k32s GdkMeasurementValueType;

/** @relates GdkMeasurementValueType @{ */
#define GDK_MEASUREMENT_VALUE_TYPE_VALUE     (0)         ///< Generic value.
#define GDK_MEASUREMENT_VALUE_TYPE_X         (1)         ///< X value (mm).
#define GDK_MEASUREMENT_VALUE_TYPE_Y         (2)         ///< Y value (mm).
#define GDK_MEASUREMENT_VALUE_TYPE_Z         (3)         ///< Z value (mm).
#define GDK_MEASUREMENT_VALUE_TYPE_X_ANGLE   (4)         ///< X angle (degrees).
#define GDK_MEASUREMENT_VALUE_TYPE_Y_ANGLE   (5)         ///< Y angle (degrees).
#define GDK_MEASUREMENT_VALUE_TYPE_Z_ANGLE   (6)         ///< Z angle (degrees).
/** @} */

/**
* @struct  GdkMeasurementDecision
* @extends kValue
* @ingroup Gdk
* @brief   Represents a measurement result decision.
*/
typedef k8u GdkMeasurementDecision;

/** @relates GdkMeasurementDecision @{ */
#define GDK_MEASUREMENT_OK               (0)         ///< No error.
#define GDK_MEASUREMENT_ERROR_VALUE      (0x2)       ///< Invalid measurement value.
#define GDK_MEASUREMENT_ERROR_ANCHOR     (0x4)       ///< Invalid anchor input.
#define GDK_MEASUREMENT_ERROR_PART_MATCH (0x8)       ///< Part matching failure.
/** @} */

GdkFx(kStatus) GdkLogf(const kChar* message, ...);

kEndHeader()

#endif