diguyCharacterFaceExpression.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.
 */

#ifndef __diguyCharacterFaceExpression_H
#define __diguyCharacterFaceExpression_H

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

#ifdef CPLUSPLUS_ONLY

class bdiFaceExpression;
class diguyCharacterFaceExpression;

#endif /* CPLUSPLUS_ONLY */


#include <declspec_diguy.h>


/*********************************************************************/
class BDI_DECLSPEC_diguy diguyCharacterFaceExpression
{

public:

        /*l
         *b  Description:
         **
         **    Returns the name of this face expression.  This pointer will
         **    never be NULL.
         **
         *b  Returns:
         **
         **    name of this face expression
         */
        const char* get_name();

        /*l
         *b  Description:
         **
         **    Sets all of this face expression's registers to zero.
         */
        void clear();

        /*l
         *b  Returns:
         **
         **    number of registers in this face expression
         */
        int get_register_count();

        /*l
         *b  Returns:
         **
         **    a register name, given the index of that
         **    register
         **
         *b  Arguments:
         **
         *a    register_index - index of face_expression register
         */
        const char* get_register_name_by_index(int register_index);

        /*l
         *b  Description:
         **
         **    Gets the value of a face expression register, given the name of the
         **    register.
         **
         *b  Arguments:
         **
         *a    name - name of register
         **
         *b  Returns:
         **
         **    value of the specified register
         */
        float get_register_value(const char* name);

        /*l
         *b  Description:
         **
         **    Sets the value of a face expression register.
         **
         *b  Arguments:
         **
         *a    name  - name of register to set
         *a    value - new value for register
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int set_register_value(const char* name, float value);

        /*l
         *b  Description:
         **
         **    Gets the value of a face expression register, given the index of
         **    the register.
         **
         *b  Arguments:
         **
         *a    register_index - index of the register
         **
         *b  Returns:
         **
         **    value of the specified register
         */
        float get_register_value_by_index(int register_index);

        /*l
         *b  Description:
         **
         **    Sets the value of a face expression register.
         **
         *b  Arguments:
         **
         *a    register_index - index of the register
         *a    value          - new value for register
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int set_register_value_by_index(int register_index, float value);

        /*l
         *b  Description:
         **
         **    Gets whether a face expression register is enabled.
         **
         **    A nonzero value means that the register's value will be assigned to
         **    the character's face's corresponding attribute when the character
         **    applies the face expression using
         **    diguyCharacter::set_face_expression().
         **
         **    A zero value means that the register will have no effect on the
         **    character's face when the character applies the face expression
         **    using diguyCharacter::set_face_expression().
         **
         **    So, each face expression can affect some, all, or no attributes of
         **    the character's face.
         **
         *b  Arguments:
         **
         *a    name - name of the register
         **
         *b  Returns:
         **
         **    whether the register is enabled
         **
         *b  See Also:
         **
         **    set_register_enabled()
         */
        int get_register_enabled(const char* name);

        /*l
         *b  Description:
         **
         **    Sets whether a face expression register is enabled. See
         **    get_register_enabled().
         **
         *b  Arguments:
         **
         *a    name    - name of the register to check
         *a    enabled - whether to enable the register
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  See Also:
         **
         **    get_register_enabled(), set_all_registers_enabled()
         **/
        int set_register_enabled(const char* name, int enabled);

        /*l
         *b  Description:
         **
         **    Sets the enabled status of all face expression registers.
         **    This is used to turn all registers on, or all registers off.
         **
         *b  Arguments:
         **
         *a    enabled - whether to enable or disable all registers
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  C++ Example:
         **
         *e   diguyCharacterFaceExpression* fx;
         *e
         *e   fx = scenario->create_face_expression("Smile_exp");
         *e   if (fx)
         *e   {
         *e      fx->set_register_value("Smile", 1);
         *e      fx->set_all_registers_enabled(1);
         *e   }
         *e
         *e   fx = scenario->create_face_expression("Smile_cl_exp");
         *e   if (fx)
         *e   {
         *e      fx->set_register_value("Smile_cl", 1);
         *e      fx->set_all_registers_enabled(1);
         *e   }
         *e
         *e   fx = scenario->create_face_expression("Mad_exp");
         *e   if (fx)
         *e   {
         *e      fx->set_register_value("Mad", 1);
         *e      fx->set_all_registers_enabled(1);
         *e   }
         */
        int set_all_registers_enabled(int enabled);

        /*l
         *b  Description:
         **
         **    Gets whether a face expression register is enabled.
         **
         *b  Arguments:
         **
         *a    index - index of the register to check
         **
         *b  Returns:
         **
         **    whether the register is enabled
         **
         */
        int get_register_enabled_by_index(int register_index);

        /*l
         *b  Description:
         **
         **    Sets whether a face expression register is enabled.
         **
         *b  Arguments:
         **
         *a    index   - index of the register to modify
         *a    enabled - whether to enable or disable the register
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         */
        int set_register_enabled_by_index(int register_index, int enabled);

#ifdef CPLUSPLUS_ONLY

        bdiFaceExpression* get_scripted_object() {return m_scripted_object;}

private:

        /*l
         **    A private constructor.
         */
        diguyCharacterFaceExpression(bdiFaceExpression* face_expression);

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

        friend class bdiFaceExpression;

#endif /* CPLUSPLUS_ONLY */

};

#endif /* __diguyCharacterFaceExpression_H */