diguyMotionPosture.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 1992-2015 VT MAK
 ** All rights reserved. 
 *********************************************************************/


/*********************************************************************
 **
 *t  diguyMotionPosture Type Declaration
 **
 */

#ifndef __diguyMotionPosture_H
#define __diguyMotionPosture_H

#ifdef SWIG
%module diguyMotionPosture
#else
#define CPLUSPLUS_ONLY
#endif

extern "C" {

#include <declspec_diguy.h>


/****************************************************************************/
typedef enum {
        DIGUY_MOTION_POSTURE_UPRIGHT = 0,
        DIGUY_MOTION_POSTURE_CROUCHED,
        DIGUY_MOTION_POSTURE_PRONE,
        DIGUY_MOTION_POSTURE_SITTING,

        DIGUY_MOTION_POSTURE_UNKNOWN,
        DIGUY_MOTION_POSTURE_ANY,
        DIGUY_MOTION_POSTURE_COUNT
} diguyMotionPosture;

/*l
 *b  Description:
 **
 **    This function converts the passed posture enumeration into
 **    a NULL-terminated C-style string.
 **
 *b  Returns:
 **
 **    C-style string identifying posture
 **
 *b  Callable From:
 **
 *-    - C++
 *-    - Script
 */
BDI_DECLSPEC_diguy
const char* diguy_motion_posture_to_string(diguyMotionPosture posture);

/*l
 *b  Description:
 **
 **    This function converts the passed C-style string into an
 **    enumerated value.
 **
 **    Postures are used in functions such as
 **    diguyCharacter::get_action_from_description().
 **
 *b  Returns:
 **
 **    enumeration value of posture
 **
 *b  Callable From:
 **
 *-    - C++
 *-    - Script
 */
BDI_DECLSPEC_diguy
diguyMotionPosture diguy_motion_posture_from_string(const char* string);


} /* end extern "C" */

#endif /* __diguyMotionPosture_H */


/*********************************************************************
 ** Copyright (c) 1992-2015 VT MAK
 ** All rights reserved. 
 *********************************************************************/