A bead that sits on a character's spline path and triggers a new gaze. More...

#include <diguyCharacterPathGazeBead.h>

Public Member Functions
General Functions
Unless otherwise specified, all functions callable from: C++ Script
const char *	get_name ()
	Returns the name of the object. More...

int	set_name (const char *name)
	This function sets the name of this object. More...

float	get_distance_into_path ()
	This function returns how far into the path this bead is. More...

int	set_distance_into_path (float distance_into_path)
	This function sets how far into the path this bead is. More...

float	get_length ()
	This function returns where on the path this bead is. More...

int	set_length (float length)
	This function sets how long this bead will have an effect. More...

float	get_tin ()
	This function returns when on the path this bead is. More...

int	set_tin (float tin)
	This function sets when this bead will begin to have an effect. More...

float	get_duration ()
	This function returns how long this bead will have an effect. More...

int	set_duration (float duration)
	This function sets how long this bead will have an effect. More...

const char *	get_begin_at_object_name ()

int	set_begin_at_object_name (const char *begin_at_object_name)

float	get_begin_at_object_offset ()

int	set_begin_at_object_offset (float begin_at_object_offset)

const char *	get_end_at_object_name ()

int	set_end_at_object_name (const char *end_at_object_name)

float	get_end_at_object_offset ()

int	set_end_at_object_offset (float end_at_object_offset)

Private Functions
The functions and variables past this point are for internal use only. No external access to them is expected or necessary.
class	bdiBeadGaze

bdiBeadGaze *	m_scripted_object
	A pointer to internal data. More...

bdiBeadGaze *	get_scripted_object ()

	diguyCharacterPathGazeBead (bdiBeadGaze *scripted_object)
	A private constructor. More...

	~diguyCharacterPathGazeBead ()
	A private destructor. More...

Detailed Description

A bead that sits on a character's spline path and triggers a new gaze.

Constructor & Destructor Documentation

diguyCharacterPathGazeBead::diguyCharacterPathGazeBead ( bdiBeadGaze * scripted_object )

private

A private constructor.

diguyCharacterPathGazeBead::~diguyCharacterPathGazeBead ( )

private

A private destructor.

Member Function Documentation

const char* diguyCharacterPathGazeBead::get_name ( )

Returns the name of the object.

This pointer will never be NULL.

Returns:

name of the object

int diguyCharacterPathGazeBead::set_name ( const char * name )

This function sets the name of this object.

Returns:

0 on success, -1 on failure

float diguyCharacterPathGazeBead::get_distance_into_path ( )

This function returns how far into the path this bead is.

Returns:

distance into path of this bead, in meters

int diguyCharacterPathGazeBead::set_distance_into_path ( float distance_into_path )

This function sets how far into the path this bead is.

Since distances and times on paths are interrelated, calling this function will have the side-effect of setting when on the path the bead is located, as if to a call to set_tin().

If this script bead is part of a diguyCharacterPath, the diguyCharacterPath::update() function must be called for changes to take effect.

Parameters

distance_into_path how far into the path this bead is, in meters

Returns:

0 on success, -1 on failure

float diguyCharacterPathGazeBead::get_length ( )

This function returns where on the path this bead is.

Returns:

location of this bead, in meters

int diguyCharacterPathGazeBead::set_length ( float length )

This function sets how long this bead will have an effect.

The bead will have an effect from its initial distance into the path (as set by set_distance_into_path()) to (distance + length) seconds.

Since distances and times on paths are interrelated, calling this function will have the side-effect of setting when on the path the bead's effect ends, as if to a call to set_duration().

If this script bead is part of a diguyCharacterPath, the diguyCharacterPath::update() function must be called for changes to take effect.

Parameters

duration duration of this bead, in seconds

Returns:

0 on success, -1 on failure

float diguyCharacterPathGazeBead::get_tin ( )

This function returns when on the path this bead is.

Returns:

time location of this bead, in seconds

int diguyCharacterPathGazeBead::set_tin ( float tin )

This function sets when this bead will begin to have an effect.

Since distances and times on paths are interrelated, calling this function will have the side-effect of setting where on the path the bead is located, as if to a call to set_distance_into_path().

If this script bead is part of a diguyCharacterPath, the diguyCharacterPath::update() function must be called for changes to take effect.

Parameters

tin	when this bead begins to have an effect, in seconds

Returns:

0 on success, -1 on failure

float diguyCharacterPathGazeBead::get_duration ( )

This function returns how long this bead will have an effect.

Returns:

duration of this bead, in seconds

int diguyCharacterPathGazeBead::set_duration ( float duration )

This function sets how long this bead will have an effect.

The bead will have an effect from tin seconds (as set by set_tin()) to (tin + duration) seconds.

Since distances and times on paths are interrelated, calling this function will have the side-effect of setting where on the path the bead's effect ends, as if to a call to set_length().

If this script bead is part of a diguyCharacterPath, the diguyCharacterPath::update() function must be called for changes to take effect.

Parameters

duration duration of this bead, in seconds

Returns:

0 on success, -1 on failure

const char* diguyCharacterPathGazeBead::get_begin_at_object_name ( )

int diguyCharacterPathGazeBead::set_begin_at_object_name ( const char * begin_at_object_name )

float diguyCharacterPathGazeBead::get_begin_at_object_offset ( )

int diguyCharacterPathGazeBead::set_begin_at_object_offset ( float begin_at_object_offset )

const char* diguyCharacterPathGazeBead::get_end_at_object_name ( )

int diguyCharacterPathGazeBead::set_end_at_object_name ( const char * end_at_object_name )

float diguyCharacterPathGazeBead::get_end_at_object_offset ( )

int diguyCharacterPathGazeBead::set_end_at_object_offset ( float end_at_object_offset )

bdiBeadGaze* diguyCharacterPathGazeBead::get_scripted_object ( )

inline

Friends And Related Function Documentation

friend class bdiBeadGaze

friend

Member Data Documentation

bdiBeadGaze* diguyCharacterPathGazeBead::m_scripted_object

private

A pointer to internal data.

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

diguyCharacterPathGazeBead.h

Public Member Functions

Private Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation