diguyCharacterFaceExpression

Generated from diguyCharacterFaceExpression.h

DI-Guy API Version 12.5.1

This file was automatically generated from diguyCharacterFaceExpression.h. Do not edit this file directly; the changes will be lost.

Includes: declspec_diguy.h

Contents:

Alphabetical Index

Class acts as a wrapper around a individual face pose like mad or angry All functions in this class are callable from:

C++
Script

class diguyCharacterFaceExpression

class BDI_DECLSPEC_diguy diguyCharacterFaceExpression
{
public:
    const char* get_name();
    void clear();
    int get_register_count();
    const char* get_register_name_by_index(int register_index);
    float get_register_value(const char* name);
    int set_register_value(const char* name, float value);
    float get_register_value_by_index(int register_index);
    int set_register_value_by_index(int register_index, float value);
    int get_register_enabled(const char* name);
    int set_register_enabled(const char* name, int enabled);
    int set_all_registers_enabled(int enabled);
    int get_register_enabled_by_index(int register_index);
    int set_register_enabled_by_index(int register_index, int enabled);

function diguyCharacterFaceExpression::get_name

Prototype:
const char* get_name();
Description:

Returns the name of this face expression. This pointer will never be NULL.
Returns:

name of this face expression

function diguyCharacterFaceExpression::clear

Prototype:
void clear();
Description:

Sets all of this face expression's registers to zero.

function diguyCharacterFaceExpression::get_register_count

Prototype:
int get_register_count();
Returns:

number of registers in this face expression

function diguyCharacterFaceExpression::get_register_name_by_index

Prototype:
const char* get_register_name_by_index(int register_index);
Returns:

a register name, given the index of that register
Arguments:

register_index index of face_expression register

function diguyCharacterFaceExpression::get_register_value

Prototype:
float get_register_value(const char* name);
Description:

Gets the value of a face expression register, given the name of the register.
Arguments:

name name of register
Returns:

value of the specified register

function diguyCharacterFaceExpression::set_register_value

Prototype:
int set_register_value(const char* name, float value);
Description:

Sets the value of a face expression register.
Arguments:

name name of register to set
value new value for register
Returns:

0 on success, -1 on failure

function diguyCharacterFaceExpression::get_register_value_by_index

Prototype:
float get_register_value_by_index(int register_index);
Description:

Gets the value of a face expression register, given the index of the register.
Arguments:

register_index index of the register
Returns:

value of the specified register

function diguyCharacterFaceExpression::set_register_value_by_index

Prototype:
int set_register_value_by_index(int register_index, float value);
Description:

Sets the value of a face expression register.
Arguments:

register_index index of the register
value new value for register
Returns:

0 on success, -1 on failure

function diguyCharacterFaceExpression::get_register_enabled

Prototype:
int get_register_enabled(const char* name);
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.
Arguments:

name name of the register
Returns:

whether the register is enabled
See Also:

set_register_enabled()

function diguyCharacterFaceExpression::set_register_enabled

Prototype:
int set_register_enabled(const char* name, int enabled);
Description:

Sets whether a face expression register is enabled. See get_register_enabled().
Arguments:

name name of the register to check
enabled whether to enable the register
Returns:

0 on success, -1 on failure
See Also:

get_register_enabled(), set_all_registers_enabled()

function diguyCharacterFaceExpression::set_all_registers_enabled

Prototype:
int set_all_registers_enabled(int enabled);
Description:

Sets the enabled status of all face expression registers. This is used to turn all registers on, or all registers off.
Arguments:

enabled whether to enable or disable all registers
Returns:

0 on success, -1 on failure
C++ Example:
diguyCharacterFaceExpression* fx;

fx = scenario->create_face_expression("Smile_exp");
if (fx)
{
fx->set_register_value("Smile", 1);
fx->set_all_registers_enabled(1);
}

fx = scenario->create_face_expression("Smile_cl_exp");
if (fx)
{
fx->set_register_value("Smile_cl", 1);
fx->set_all_registers_enabled(1);
}

fx = scenario->create_face_expression("Mad_exp");
if (fx)
{
fx->set_register_value("Mad", 1);
fx->set_all_registers_enabled(1);
}

function diguyCharacterFaceExpression::get_register_enabled_by_index

Prototype:
int get_register_enabled_by_index(int register_index);
Description:

Gets whether a face expression register is enabled.
Arguments:

index index of the register to check
Returns:

whether the register is enabled

function diguyCharacterFaceExpression::set_register_enabled_by_index

Prototype:
int set_register_enabled_by_index(int register_index, int enabled);
Description:

Sets whether a face expression register is enabled.
Arguments:

index index of the register to modify
enabled whether to enable or disable the register
Returns:

0 on success, -1 on failure

Alphabetical Index

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.

`register_index`	index of the register
`value`	new value for register

`name`	name of the register to check
`enabled`	whether to enable the register

`index`	index of the register to modify
`enabled`	whether to enable or disable the register