diguyFormation.h

Go to the documentation of this file.

/*
 *  Copyright (C) 1992-2013 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 Software 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.
 */

/*********************************************************************
 **
 *t  diguyFormation
 **
 *b    Link against: libdiguy
 */

#ifndef __diguyFormation_H
#define __diguyFormation_H

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

#ifdef CPLUSPLUS_ONLY

class bdiScenarioFormation;
class diguyFormation;
class diguyCharacter;

#endif


#include <declspec_diguy.h>

/****************************************************************************/
class BDI_DECLSPEC_diguy diguyFormation
{

public:

        /*l
         *b  Description:
         **
         **    Returns the name of the object.  This pointer will never be NULL.
         **
         *b  Returns:
         **
         **    name of the object
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        const char* get_name();

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

        /*l
         *b  Returns:
         **
         **    type name of the object; this value will never be NULL
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        const char* get_type_name();


        /*l
         *b  Returns:
         **
         **    guide name used by this formation
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        const char* get_guide_name();

        /*l
         *b  Description:
         **
         **    Sets number of followers in the formation.
         **
         *b  Arguments:
         **
         *a    number - number of followers in this formation
         **
         *b  Returns:
         **
         **    0 if success
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_num_followers(int number);

        /*l
         *b  Returns:
         **
         **    number of members of formation (leader not included)
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int get_num_followers();

        /*l
         *b  Description:
         **
         **    Sets rz offset of member relative to leader.
         **
         *b  Arguments:
         **
         *a    follower_index - index of follower to modify
         *a    rz             - orientation of member relative to leader, in
         *a                     degrees
         **
         *b  Returns:
         **
         **    0 if success
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_follower_rz_offset(int follower_index, float rz);

        /*l
         *b  Description:
         **
         **    Creates a string describing the formation, with positions being
         **    relative to relative_x and relative_y.
         **
         *b  Arguments:
         **
         *a    relative_x, relative_y - relative positions in meters
         **
         *b  Returns:
         **
         **    string containing lua script
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        const char* to_lua_string(float relative_x = 0.0f,
                float relative_y = 0.0f);

        /*l
         *b  Description:
         **
         **    Gets x offset of formation member relative to leader.
         **
         *b  Arguments:
         **
         *a    follower_index - index of follower in formation (does not include
         *a                     leader)
         **
         *b  Returns:
         **
         **    x offset in meters
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        float get_follower_x_offset(int follower_index);

        /*l
         *b  Description:
         **
         **    Gets y offset of formation member relative to leader.
         **
         *b  Arguments:
         **
         *a    follower_index - index of follower in formation (does not include
         *a                     leader)
         **
         *b  Returns:
         **
         **    y offset in meters
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        float get_follower_y_offset(int follower_index);

        /*l
         *b  Description:
         **
         **    Gets rz (or yaw) of formation member relative to leader.
         **
         *b  Arguments:
         **
         *a    follower_index - index of follower in formation (does not include
         *a                     leader)
         **
         *b  Returns:
         **
         **    rz offset in degrees
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        float get_follower_rz_offset(int follower_index);

        /*l
         *b  Description:
         **
         **    Sets role name of member.
         **
         *b  Arguments:
         **
         *a    follower_index - index of follower to modify
         *a    role_name      - new role
         **
         *b  Returns:
         **
         **    0 if success
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_role_name(int follower_index, const char* role_name);

        /*l
         *b  Description:
         **
         **    Gets role.  Roles generally correlate with a character's carried
         **    object.
         **
         *    RYAN:  Give a little more information on what roles are, and at
         *    least one example.
         **
         *b  Arguments:
         **
         *a    follower_index - index of follower in formation (does not include
         *a                     leader)
         **
         *b  Returns:
         **
         **    string containing role, or "character" if specific role specified
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        const char* get_role_name(int follower_index);

        /*l
         *b  Arguments:
         **
         *a    follower_index - index of follower in formation (does not include
         *a                     leader)
         **
         *b  Returns:
         **
         **    string containing name of follower, if defined
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        const char* get_follower_instance(int follower_index);

        /*l
         *b  Description:
         **
         **    Sets subgroup size.  If > 0, this means that there are subgroups
         **    and that they will be applied.
         **
         *    RYAN:  What is a subgroup?  What is it used for?  Can there be
         *    only one?
         **
         *b  Arguments:
         **
         *a    size - size of subgroup
         **
         *b  Returns:
         **
         **    0 if success
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_subgroup_size(int size);

        /*l
         *b  Description:
         **
         **    Gets size of subgroup.  If > 0, this means that there are subgroups
         **    and that they will be applied.
         **
         *b  Returns:
         **
         **    number of followers in subgroup
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int get_subgroup_size();

        /*l
         *b  Description:
         **
         **    Get number of subgroups
         **
         *b  Returns:
         **
         **    number of subgroups
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int get_num_subgroups();

        /*l
         *b  Description:
         **
         **    Sets index of first subgroup.  Any members before this member are
         **    not in a subgroup.
         **
         *b  Arguments:
         **
         *a    index - index of first follower in subgroup
         **
         *b  Returns:
         **
         **    0 if success
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_first_subgroup_index(int index);

        /*l
         *b  Description:
         **
         **    Gets index of first formation member that's in a subgroup.
         **
         *b  Returns:
         **
         **    index of formation member
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int get_first_subgroup_index();

        /*l
         *b  Description:
         **
         **    Sets x, y offsets of member relative to leader.
         **
         *b  Arguments:
         **
         *a    follower_index - index of follower to modify
         *a    x, y           - offsets of member relative to leader, in meters
         **
         *    RYAN:  Does follower_index include leader?
         **
         *b  Returns:
         **
         **    0 if success
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_follower_offset(int follower_index, float x, float y);

        /*l
         *b  Returns:
         **
         **    radius of formation, in meters
         **
         *    RYAN:  Radius of what?  Relative to what?  The leader?
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        float get_radius();


#ifdef CPLUSPLUS_ONLY
        bdiScenarioFormation* get_scripted_object() {return m_scripted_object;}

private:

        /*l
         **    A private constructor.
         */
        diguyFormation(bdiScenarioFormation* formation);

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

        friend class bdiScenarioFormation;

#endif

};

#endif /* __diguyFormation_H */