A class representing a facial pose. More...

#include <diguyCharacterFaceExpression.h>

Public Member Functions
const char *	get_name ()
	Returns the name of this face expression. More...

void	clear ()
	Sets all of this face expression's registers to zero. More...

int	get_register_count ()
	Returns: number of registers in this face expression. More...

const char *	get_register_name_by_index (int register_index)
	Returns: a register name, given the index of that register. More...

float	get_register_value (const char *name)
	Gets the value of a face expression register, given the name of the register. More...

int	set_register_value (const char *name, float value)
	Sets the value of a face expression register. More...

float	get_register_value_by_index (int register_index)
	Gets the value of a face expression register, given the index of the register. More...

int	set_register_value_by_index (int register_index, float value)
	Sets the value of a face expression register. More...

int	get_register_enabled (const char *name)
	Gets whether a face expression register is enabled. More...

int	set_register_enabled (const char *name, int enabled)
	Sets whether a face expression register is enabled. More...

int	set_all_registers_enabled (int enabled)
	Sets the enabled status of all face expression registers. More...

int	get_register_enabled_by_index (int register_index)
	Gets whether a face expression register is enabled. More...

int	set_register_enabled_by_index (int register_index, int enabled)
	Sets whether a face expression register is enabled. More...

Private Functions
The functions and variables past this point are for internal use only. No external access to them is expected or necessary.
bdiFaceExpression *	m_scripted_object
	A pointer to internal data. More...

class	bdiFaceExpression

bdiFaceExpression *	get_scripted_object ()

	diguyCharacterFaceExpression (bdiFaceExpression *face_expression)
	A private constructor. More...

Detailed Description

A class representing a facial pose.

Class acts as a wrapper around an individual face pose, such as "mad" or "angry"

Constructor & Destructor Documentation

diguyCharacterFaceExpression::diguyCharacterFaceExpression ( bdiFaceExpression * face_expression )

private

A private constructor.

Member Function Documentation

const char* diguyCharacterFaceExpression::get_name ( )

Returns the name of this face expression.

This pointer will never be NULL.

Returns:

name of this face expression

void diguyCharacterFaceExpression::clear ( )

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

int diguyCharacterFaceExpression::get_register_count ( )

Returns: number of registers in this face expression.

const char* diguyCharacterFaceExpression::get_register_name_by_index ( int register_index )

Returns: a register name, given the index of that register.

Parameters

register_index index of face_expression register

float diguyCharacterFaceExpression::get_register_value ( const char * name )

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

Parameters

name	name of register

Returns:

value of the specified register

int diguyCharacterFaceExpression::set_register_value	(	const char *	name,
		float	value
	)

Sets the value of a face expression register.

Parameters

name	name of register to set
value	new value for register

Returns:

0 on success, -1 on failure

float diguyCharacterFaceExpression::get_register_value_by_index ( int register_index )

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

Parameters

register_index index of the register

Returns:

value of the specified register

int diguyCharacterFaceExpression::set_register_value_by_index	(	int	register_index,
		float	value
	)

Sets the value of a face expression register.

Parameters

register_index	index of the register
value	new value for register

Returns:

0 on success, -1 on failure

int diguyCharacterFaceExpression::get_register_enabled ( const char * name )

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.

Parameters

name	name of the register

Returns:

whether the register is enabled

See Also:

set_register_enabled()

int diguyCharacterFaceExpression::set_register_enabled	(	const char *	name,
		int	enabled
	)

Sets whether a face expression register is enabled.

See get_register_enabled().

Parameters

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

Returns:

0 on success, -1 on failure

int diguyCharacterFaceExpression::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.

Parameters

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);
}

int diguyCharacterFaceExpression::get_register_enabled_by_index ( int register_index )

Gets whether a face expression register is enabled.

Parameters

index index of the register to check

Returns:

whether the register is enabled

int diguyCharacterFaceExpression::set_register_enabled_by_index	(	int	register_index,
		int	enabled
	)

Sets whether a face expression register is enabled.

Parameters

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

Returns:

0 on success, -1 on failure

bdiFaceExpression* diguyCharacterFaceExpression::get_scripted_object ( )

inline

Friends And Related Function Documentation

friend class bdiFaceExpression

friend

Member Data Documentation

bdiFaceExpression* diguyCharacterFaceExpression::m_scripted_object

private

A pointer to internal data.

The documentation for this class was generated from the following file:

E:/nightly/2751/include/diguyCharacterFaceExpression.h

Public Member Functions

Private Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation