diguyMotionDirection Type Declaration

Generated from diguyMotionDirection.h

DI-Guy API Version 12.5.1

This file was automatically generated from diguyMotionDirection.h. Do not edit this file directly; the changes will be lost.
Includes: declspec_diguy.h

Contents:

Alphabetical Index

enumeration diguyMotionDirection

typedef enum {
	DIGUY_MOTION_DIRECTION_NONE = 0,
	DIGUY_MOTION_DIRECTION_FORWARD,
	DIGUY_MOTION_DIRECTION_BACKWARD,
	DIGUY_MOTION_DIRECTION_LEFT,
	DIGUY_MOTION_DIRECTION_RIGHT,

	DIGUY_MOTION_DIRECTION_UP,
	DIGUY_MOTION_DIRECTION_DOWN,
	DIGUY_MOTION_DIRECTION_TURN_LEFT,
	DIGUY_MOTION_DIRECTION_TURN_RIGHT,
	DIGUY_MOTION_DIRECTION_NONLINEAR,
	DIGUY_MOTION_DIRECTION_LINEAR_OFFAXIS,
	DIGUY_MOTION_DIRECTION_INHERIT,
	DIGUY_MOTION_DIRECTION_UNKNOWN,
	DIGUY_MOTION_DIRECTION_COUNT
} diguyMotionDirection;

function diguy_motion_direction_to_string

Prototype:

const char* diguy_motion_direction_to_string(diguyMotionDirection direction);
Description:

This function converts the passed direction enumeration into a NULL-terminated C-style string.

Returns:

C-style string identifying direction

Callable From:

function diguy_motion_direction_from_string

Prototype:

diguyMotionDirection diguy_motion_direction_from_string(const char* string);
Description:

This function converts the passed C-style string into an enumerated value.

Directions are used in functions such as diguyCharacter::get_action_from_description().

Returns:

enumeration value of direction

Callable From:

function diguy_motion_direction_to_angle

Prototype:

float diguy_motion_direction_to_angle(diguyMotionDirection direction);
Description:

This function converts the passed direction enumeration into a floating point angle. The returned angle is in degrees.

Currently only the following directions return useful angles:

All other directions return an angle of 0.

Returns:

yaw angle of direction in degrees

Callable From:

function diguy_motion_direction_from_angle

Prototype:

diguyMotionDirection diguy_motion_direction_from_angle(float angle,
    float allowed_error = 1.0f);
Description:

This function converts the passed angle into a direction enumeration.

Currently only the following directions will be returned:

If the passed angle isn't within the specified error amount of any direction's "exact" angle, the value DIGUY_MOTION_DIRECTION_UNKNOWN will be returned.

Arguments:

angle angle for which to retrieve direction, in degrees
allowed_errorhow much error there can be from the direction's "exact" angle
Returns:

enumeration value of direction

Callable From:

Alphabetical Index



Copyright (C) 1992-2012 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/78 Fourth Avenue/Waltham MA 02451.