DI-Guy API, Constants and Enumerations

diguy_constants.h

DI-Guy API Version 5.1.26

This file was automatically generated from comments in the C/C++ header file diguy_constants.h. Do not edit this file directly; the changes will be lost. Please mail suggestions or corrections to diguy@bdi.com

Alphabetical Index

The API is subject to change in future releases.

Version Constants

constants

#define DIGUY_VERSION_STRING "5.1.26"
#define DIGUY_VERSION_MAJOR 5
#define DIGUY_VERSION_MINOR 1
#define DIGUY_VERSION_POINT 26

constant DIGUY_DEFAULT_FLOAT

#define DIGUY_DEFAULT_FLOAT (-16384.0f)
Description:

This value is a magic number that, when passed to certain functions, means that the function should use or compute an appropriate default value for the argument.

constant DIGUY_DEFAULT_INT

#define DIGUY_DEFAULT_INT   (-16384)
Description:

This value is a magic number that, when passed to certain functions, means that the function should use or compute an appropriate default value for the argument.

enumeration diguyCallbackReturn

typedef enum
{
	DIGUY_CALLBACK_STOP = 0,
	DIGUY_CALLBACK_CONTINUE
} diguyCallbackReturn;
Description:

DI-Guy callbacks return a value of type diguyCallbackReturn, which will be DIGUY_CALLBACK_STOP or DIGUY_CALLBACK_CONTINUE. If the callback returns DIGUY_CALLBACK_STOP, the default handler of the function will not be called; the callback is asserting that it has done everything necessary for the function call. If the callback returns DIGUY_CALLBACK_CONTINUE, the default handler for the function will be called after the callback.

enumeration diguySensorType

typedef enum
{
	DIGUY_SENSOR_TYPE_UNKNOWN = -1,
	DIGUY_SENSOR_TYPE_DISTANCE_XY_ZONES,
	DIGUY_SENSOR_TYPE_DISTANCE_XYZ_ZONES,
	DIGUY_SENSOR_TYPE_DISTANCE_X_ZONES,
	DIGUY_SENSOR_TYPE_DISTANCE_Y_ZONES,
	DIGUY_SENSOR_TYPE_DISTANCE_Z_ZONES,
	DIGUY_SENSOR_TYPE_AZIMUTH_ZONES,
	DIGUY_SENSOR_TYPE_ELEVATION_ZONES,
	DIGUY_SENSOR_TYPE_COUNT
} diguySensorType;
Description:

DI-Guy sensor set types.

enumeration diguyCharacterMode

typedef enum
{
	DIGUY_CHARACTER_MODE_PATH = 0,
	DIGUY_CHARACTER_MODE_FREE,
	DIGUY_CHARACTER_MODE_COUNT
} diguyCharacterMode;
Description:

This is an enumeration of the different modes a DI-Guy character can be in. See diguyCharacter::get_action_mode(), diguyCharacter::get_position_mode().

enumeration diguyMuzzle

typedef enum
{
	DIGUY_MUZZLE_DEFAULT = 0,
	DIGUY_MUZZLE_RIFLE,
	DIGUY_MUZZLE_GRENADE_LAUNCHER,
	DIGUY_MUZZLE_ACCESSORY1,
	DIGUY_MUZZLE_COUNT
} diguyMuzzle;
Description:

This is an enumeration of the different muzzles that can be specified to various DI-Guy function calls, such as diguyCharacter::set_default_weapon_muzzle() and diguyCharacter::fire_weapon().

enumeration diguyViewCameraMoveMode

typedef enum
{
	DIGUY_CAMERA_MOVE_FORWARD = 0,
	DIGUY_CAMERA_MOVE_SIDEWAYS,
	DIGUY_CAMERA_MOVE_VERTICAL
} diguyViewCameraMoveMode;
Description:

DI-Guy camera move modes.

enumeration diguyViewCameraProjectionMode

typedef enum
{
	DIGUY_CAMERA_PROJECTION_PERSPECTIVE = 0,
	DIGUY_CAMERA_PROJECTION_PLANVIEW_XY,
	DIGUY_CAMERA_PROJECTION_PLANVIEW_XZ,
	DIGUY_CAMERA_PROJECTION_PLANVIEW_YZ
} diguyViewCameraProjectionMode;
Description:

DI-Guy camera projection modes.

enumeration diguyViewFogMode

typedef enum
{
	DIGUY_FOG_MODE_DISABLED = 0,
	DIGUY_FOG_MODE_EXP,
	DIGUY_FOG_MODE_EXP2,
	DIGUY_FOG_MODE_LINEAR,
	DIGUY_FOG_MODE_PIX_EXP,
	DIGUY_FOG_MODE_PIX_EXP2,
	DIGUY_FOG_MODE_PIX_LINEAR
} diguyViewFogMode;
Description:

DI-Guy fog modes.

enumeration diguyHistoryType

typedef enum
{
	DIGUY_HISTORY_TYPE_NONE = 0,
	DIGUY_HISTORY_TYPE_FIRST,
	DIGUY_HISTORY_TYPE_COMPLETE,
	DIGUY_HISTORY_TYPE_LAST
} diguyHistoryType;
Description:

DI-Guy character history types.

enumeration

enum
{
	DIGUY_CLASSID_START = 0x400,

	DIGUY_CLASSID_CREATURE,
	DIGUY_CLASSID_LINK,
	DIGUY_CLASSID_SHAPE,

	DIGUY_CLASSID_CHARACTER,
	DIGUY_CLASSID_SCENE_OBJECT,
	DIGUY_CLASSID_PATH,
	DIGUY_CLASSID_PATH_SHAPE,
	DIGUY_CLASSID_SENSOR_REGION
};
Description:

DI-Guy renderer class ids.

enumeration

enum
{
	DIGUY_ERROR                                       = -1,  

	DIGUY_ERROR_LICENSE_FAILURE                       = -100,
	DIGUY_ERROR_LICENSE_SOFTWARE_INITIALIZATION_ERROR = -101,
	DIGUY_ERROR_LICENSE_NOT_FOUND                     = -102,
	DIGUY_ERROR_LICENSE_EXPIRED                       = -103,
	DIGUY_ERROR_LICENSE_VERSION_MISMATCH              = -104,
	DIGUY_ERROR_LICENSE_COUNT_TOO_LOW                 = -105,
	DIGUY_ERROR_LICENSE_FILE_NOT_FOUND                = -106,
	DIGUY_ERROR_LICENSE_SERVER_ERROR                  = -107,

	DIGUY_ERROR_GRAPHICS_SUBSYSTEM_INIT_FAILED        = -200,
	DIGUY_ERROR_SIMULATION_SUBSYSTEM_INIT_FAILED      = -201 

};
Description:

DI-Guy error codes.


Alphabetical Index


Copyright (C) 1992-2003

Boston Dynamics

ALL RIGHTS RESERVED.

These coded instructions, statements, and computer programs contain unpublished proprietary information of Boston Dynamics and are protected by Copyright Laws of the United States. They may not be used, duplicated, or disclosed in any form, in whole or in part, without the prior written consent from Boston Dynamics.

RESTRICTED RIGHTS LEGEND

Use, duplication, or disclosure by the government is subject to restrictions as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Sofware clause at DFARS 252.227-7013 and/or in similar or successor clauses in the FAR, or the DOD or NASA FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the Commercial Computer Software--Restricted Rights at 48 CFR 52.227-19, as applicable. Unpublished-rights reserved under the Copyright Laws of the United States.

Contractor/Manufacturer is:

Boston Dynamics/515 Massachusetts Avenue/Cambridge MA 02139.