diguyCharacterGuide.h

Go to the documentation of this file.

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


/*********************************************************************
 **
 *t  diguyCharacterGuide
 **
 */

#ifndef __diguyCharacterGuide_H
#define __diguyCharacterGuide_H


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

#ifdef CPLUSPLUS_ONLY
class bdiScenarioCharacterGuide;
#endif


#include <declspec_diguy.h>

/*****************************************************************************/
class BDI_DECLSPEC_diguy diguyCharacterGuide
{

public:

/*****************************************************************************/
        /*l
         *b  Returns:
         **
         **    name of the guide
         */
        const char* get_name();

        /*l
         *b  Description:
         **
         **    This function sets the name of this object.
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int set_name(const char* name);

        /*l
         *b  Description:
         **
         **    This function enables or disables this guide.
         **
         *b  Arguments:
         **
         *a    enabled    - pass 1 to enable to guide, 0 to disable
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int set_enabled(int enabled);

        /*l
         *b  Returns:
         **
         **    whether this guide is enabled; see set_enabled()
         */
        int get_enabled();

        /*l
         *b  Description:
         **
         **    This function returns whether the character controlled
         **    by this guide has reached its desired position.
         **
         *b  Returns:
         **
         **    1 if position reached, 0 if not
         */
        int get_position_acquired();

        /*l
         *b  Description:
         **
         **    This function manually sets whether the character controlled
         **    by this guide has reached its desired position.  Normally
         **    this is determined automatically by the guide.
         **
         **    Note that calling this function may trigger a callback of
         **    diguyCharacter::CALLBACK_ID_GUIDE_POSITION_ACQUIRED or
         **    diguyCharacter::CALLBACK_ID_GUIDE_POSITION_UNACQUIRED.
         **
         *b  Arguments:
         **
         *a    acquired    - pass 1 to set the desired position as acquired,
         *a                  0 as unacquired
         */
        void set_position_acquired(int acquired);

        /*l
         *b  Description:
         **
         **    This function returns whether the character controlled
         **    by this guide has reached its desired orientation.
         **
         *b  Returns:
         **
         **    1 if orientation reached, 0 if not
         */
        int get_orientation_acquired();

        /*l
         *b  Description:
         **
         **    Similar to set_position_acquired(), but for orientation.
         **
         *b  Arguments:
         **
         *a    acquired    - pass 1 to set the desired orientation as acquired,
         *a                  0 as unacquired
         */
        void set_orientation_acquired(int acquired);

        /*l
         *b  Description:
         **
         **   Returns that name of the guide algorithm. 
         */
        const char *get_guide_algorithm();
        
        /*l
         *b  Description:
         **
         **    This function sets a float parameter for this guide's
         **    guide algorithm.
         **
         *b  Arguments:
         **
         *a    parameter       - name of the parameter to set
         *a    value           - new value of the parameter
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int set_guide_algorithm_float_parameter(const char* parameter, float value);

        /*l
         *b  Description:
         **
         **    This function gets the current setting for a float parameter of
         **    this guide's guide algorithm.
         **
         *b  Arguments:
         **
         *a    parameter       - name of the parameter to get
         **
         *b  Returns:
         **
         **    current value of parameter
         */
        float get_guide_algorithm_float_parameter(const char* parameter);

        /*l
         *b  Description:
         **
         **    This function sets a string parameter for this guide's
         **    guide algorithm.
         **
         *b  Arguments:
         **
         *a    parameter       - name of the parameter to set
         *a    value           - new value of the parameter
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int set_guide_algorithm_string_parameter(const char* parameter,
                const char * value);

        /*l
         *b  Description:
         **
         **    This function gets the current setting for a string parameter of
         **    this guide's guide algorithm.
         **
         *b  Arguments:
         **
         *a    parameter       - name of the parameter to get
         **
         *b  Returns:
         **
         **    current value of parameter
         */
        const char * get_guide_algorithm_string_parameter(const char* parameter);

        /*l
         *b  Description:
         **
         **    This function sets a vector parameter for this guide's
         **    guide algorithm.
         **
         *b  Arguments:
         **
         *a    parameter       - name of the parameter to set
         *a    x, y, z         - new value of the parameter
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int set_guide_algorithm_vector_parameter(const char* parameter,
                float x, float y, float z);

        /*l
         *b  Description:
         **
         **    This function gets the current setting for a vector parameter of
         **    this guide's guide algorithm.
         **
         *b  Arguments:
         **
         *a    parameter       - name of the parameter to get
         **
         *b  Returns:
         **
         **    x, y, z values of vector
         */
        void get_guide_algorithm_vector_parameter(const char* parameter, float *x, float *y, float *z);

        void get_current_desired_position(float *x, float *y, float *z);
        void get_current_desired_orientation(float *rz);
        void get_current_desired_position_double(double *x, double *y, double *z);

#ifdef CPLUSPLUS_ONLY

        bdiScenarioCharacterGuide* get_scripted_object() {return m_scripted_object;}

private:

        /*l
         **    A private constructor.
         */
        diguyCharacterGuide(bdiScenarioCharacterGuide* scripted_object);

        /*l
         **    A private destructor.
         */
        virtual ~diguyCharacterGuide();

        /*l
         **    A pointer to internal data.
         */
        bdiScenarioCharacterGuide* m_scripted_object;

        friend class bdiScenarioCharacterGuide;

#endif

};


#endif /* __diguyCharacterGuide_H */


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