
This file was automatically generated from comments in the C/C++ header file diguyCharacterFaceExpression.h. Do not edit this file directly; the changes will be lost. Please mail suggestions or corrections to diguy@bdi.com
Includes: declspec_diguy.h
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); #ifdef CPLUSPLUS_ONLY bdiFaceExpression* get_scripted_object() {return m_scripted_object;} };
function diguyCharacterFaceExpression::get_name |
Prototype:
Description:const char* get_name();
Returns the name of this face expression. This pointer will never be NULL.
Returns:
none
name of this face expressionCallable From:
- C++
- Script
function diguyCharacterFaceExpression::clear |
Prototype:
Description:void clear();
Sets all of this face expression's registers to zero.
Callable From:
none
- C++
- Script
function diguyCharacterFaceExpression::get_register_count |
Prototype:
Returns:int get_register_count();
number of registers in this face expressionCallable From:
- C++
- Script
function diguyCharacterFaceExpression::get_register_name_by_index |
Prototype:
Returns:const char* get_register_name_by_index(int register_index);
a register name, given the index of that registerArguments:
Callable From:
register_index index of face_expression register
- C++
- Script
function diguyCharacterFaceExpression::get_register_value |
Prototype:
Description:float get_register_value(const char* name);
Gets the value of a face expression register, given the name of the register.Arguments:
Returns:
name name of register
value of the specified registerCallable From:
- C++
- Script
function diguyCharacterFaceExpression::set_register_value |
Prototype:
Description:int set_register_value(const char* name, float value);
Sets the value of a face expression register.Arguments:
Returns:
name name of register to set value new value for register
0 on success, -1 on failureCallable From:
- C++
- Script
function diguyCharacterFaceExpression::get_register_value_by_index |
Prototype:
Description:float get_register_value_by_index(int register_index);
Gets the value of a face expression register, given the index of the register.Arguments:
Returns:
register_index index of the register
value of the specified registerCallable From:
- C++
- Script
function diguyCharacterFaceExpression::set_register_value_by_index |
Prototype:
Description:int set_register_value_by_index(int register_index, float value);
Sets the value of a face expression register.Arguments:
Returns:
register_index index of the register value new value for register
0 on success, -1 on failureCallable From:
- C++
- Script
function diguyCharacterFaceExpression::get_register_enabled |
Prototype:
Description:int get_register_enabled(const char *name);
Gets whether a face expression register is enabled.
A nonzero 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:
Returns:
name name of the register
whether the register is enabledSee Also:
set_register_enabled()Callable From:
- C++
- Script
function diguyCharacterFaceExpression::set_register_enabled |
Prototype:
Description:int set_register_enabled(const char* name, int enabled);
Sets whether a face expression register is enabled. See get_register_enabled().Arguments:
Returns:
name name of the register to check enabled whether to enable the register
0 on success, -1 on failure
See Also:
get_register_enabled(), set_all_registers_enabled()Callable From:
- C++
- Script
function diguyCharacterFaceExpression::set_all_registers_enabled |
Prototype:
Description:int set_all_registers_enabled(int enabled);
Sets the enabled status of all face expression registers. This is used to turn all registers on, or all registers off.Arguments:
Returns:
enabled whether to enable or disable all registers
0 on success, -1 on failureC++ Example:
Callable From:
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); }
- C++
- Script
function diguyCharacterFaceExpression::get_register_enabled_by_index |
Prototype:
Description:int get_register_enabled_by_index(int register_index);
Gets whether a face expression register is enabled.Arguments:
Returns:
index index of the register to check
whether the register is enabledCallable From:
- C++
- Script
function diguyCharacterFaceExpression::set_register_enabled_by_index |
Prototype:
Description:int set_register_enabled_by_index(int register_index, int enabled);
Sets whether a face expression register is enabled.Arguments:
Returns:
index index of the register to modify enabled whether to enable or disable the register.
0 on success, -1 on failureCallable From:
- C++
- Script
function diguyCharacterFaceExpression::get_scripted_object |
Prototype:
bdiFaceExpression* get_scripted_object();
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 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/515 Massachusetts Avenue/Cambridge MA 02139.