diguyCharacterPathActionBead

Generated from diguyCharacterPathActionBead.h

DI-Guy API Version 12.5.1

This file was automatically generated from diguyCharacterPathActionBead.h. Do not edit this file directly; the changes will be lost.
Includes: declspec_diguy.h

Contents:

Alphabetical Index

Link against: libdiguy

class diguyCharacterPathActionBead

class BDI_DECLSPEC_diguy diguyCharacterPathActionBead
{
public:
    const char* get_name();
    int set_name(const char* name);
    const char* get_action();
    int set_action(const char* action);
    float get_distance_into_path();
    int set_distance_into_path(float distance_into_path);
    float get_length();
    int set_length(float length);
    int get_derive_length_flag();
    int set_derive_length_flag(int derive_length_flag);
    float get_tin();
    int set_tin(float tin);
    float get_duration();
    int set_duration(float duration);
    int get_derive_duration_flag();
    int set_derive_duration_flag(int derive_duration_flag);
    float get_desired_duration();
    int set_desired_duration(float desired_duration);
    int get_derive_desired_duration_flag();
    int set_derive_desired_duration_flag(int derive_desired_duration_flag);
    int get_motion_reps();
    int set_motion_reps(int motion_reps);
    int get_derive_motion_reps_flag();
    int set_derive_motion_reps_flag(int derive_motion_reps);
    int get_transition_before_bead_flag();
    int set_transition_before_bead_flag(int transition_before_bead_flag);
    const char* get_companion_waypoint_name();
    int set_companion_waypoint_name(const char* companion_waypoint_name);
    int create_or_update_companion_waypoint();

function diguyCharacterPathActionBead::get_name

Prototype:

const char* get_name();
Description:

Returns the name of the object. This pointer will never be NULL.

Returns:

name of the object

Callable From:

function diguyCharacterPathActionBead::set_name

Prototype:

int set_name(const char* name);
Description:

This function sets the name of this object.

Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterPathActionBead::get_action

Prototype:

const char* get_action();
Description:

This function returns the action this bead specifies. This pointer will never be NULL.

Returns:

action of this bead

Callable From:

function diguyCharacterPathActionBead::set_action

Prototype:

int set_action(const char* action);
Description:

This function sets the action this bead specifies. When a character is traversing the path containing this bead, the specified action will be performed when this bead is reached.

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

Arguments:

actionthe action the character should perform when this bead is reached
Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterPathActionBead::get_distance_into_path

Prototype:

float get_distance_into_path();
Description:

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

Returns:

distance into path of this bead, in meters

Callable From:

function diguyCharacterPathActionBead::set_distance_into_path

Prototype:

int set_distance_into_path(float distance_into_path);
Description:

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.

Arguments:

distance_into_pathhow far into the path this bead is, in meters
Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterPathActionBead::get_length

Prototype:

float get_length();
Description:

This function returns where on the path this bead is.

Returns:

location of this bead, in meters

Callable From:

function diguyCharacterPathActionBead::set_length

Prototype:

int set_length(float length);
Description:

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.

Arguments:

durationduration of this bead, in seconds
Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterPathActionBead::get_derive_length_flag

Prototype:

int get_derive_length_flag();
Description:

This function returns whether the length of this bead is derived from other information in the bead. If so, calling set_length() will have no effect.

See set_derive_length_flag() for information on how length is derived.

Returns:

integer flag; 1 means length is derived, 0 means it is not

Callable From:

function diguyCharacterPathActionBead::set_derive_length_flag

Prototype:

int set_derive_length_flag(int derive_length_flag);
Description:

This function sets whether the length of this bead is derived from other information in the bead. If so, calling set_length() will have no effect.

(More documentation needed to explain how length is derived.)

Arguments:

derive_length_flagpass 1 for length to be derived, else 0
Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterPathActionBead::get_tin

Prototype:

float get_tin();
Description:

This function returns when on the path this bead is.

Returns:

time location of this bead, in seconds

Callable From:

function diguyCharacterPathActionBead::set_tin

Prototype:

int set_tin(float tin);
Description:

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.

Arguments:

tinwhen this bead begins to have an effect, in seconds
Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterPathActionBead::get_duration

Prototype:

float get_duration();
Description:

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

Returns:

duration of this bead, in seconds

Callable From:

function diguyCharacterPathActionBead::set_duration

Prototype:

int set_duration(float duration);
Description:

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.

Note that if duration is derived (as by a call to set_derive_duration_flag()), this function will have no 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'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.

Arguments:

durationduration of this bead, in seconds
Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterPathActionBead::get_derive_duration_flag

Prototype:

int get_derive_duration_flag();
Description:

This function returns whether the duration of this bead is derived from other information in the bead. If so, calling set_duration() will have no effect.

See set_derive_duration_flag() for information on how length is derived.

Returns:

integer flag; 1 means duration is derived, 0 means it is not

Callable From:

function diguyCharacterPathActionBead::set_derive_duration_flag

Prototype:

int set_derive_duration_flag(int derive_duration_flag);
Description:

This function sets whether the duration of this bead is derived from other information in the bead. If so, calling set_duration() will have no effect.

(More documentation needed to explain how duration is derived.)

Arguments:

derive_length_flagpass 1 for duration to be derived, else 0
Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterPathActionBead::get_desired_duration

Prototype:

float get_desired_duration();
Returns:

the desired duration of this bead

Callable From:

function diguyCharacterPathActionBead::set_desired_duration

Prototype:

int set_desired_duration(float desired_duration);
Description:

This function sets the desired duration of the action bead.

Arguments:

desired_durationdesired duration of action in seconds
Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterPathActionBead::get_derive_desired_duration_flag

Prototype:

int get_derive_desired_duration_flag();
Description:

This function returns whether the desired duration of this bead is derived from other information in the bead. If so, calling set_desired_duration() will have no effect.

Returns:

integer flag; 1 means duration is derived, 0 means it is not

Callable From:

function diguyCharacterPathActionBead::set_derive_desired_duration_flag

Prototype:

int set_derive_desired_duration_flag(int derive_desired_duration_flag);
Description:

This function sets whether the desired duration of this bead is derived from other information in the bead. If so, calling set_desired_duration() will have no effect.

Arguments:

derive_desired_duration_flagpass 1 for duration to be derived, else 0
Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterPathActionBead::get_motion_reps

Prototype:

int get_motion_reps();
Returns:

how many repetitions of the action's looping motion will be played

Callable From:

function diguyCharacterPathActionBead::set_motion_reps

Prototype:

int set_motion_reps(int motion_reps);
Description:

This function sets how many repetitions of the action's looping motion will be played.

Arguments:

motion_repshow many times to play the looping motion
Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterPathActionBead::get_derive_motion_reps_flag

Prototype:

int get_derive_motion_reps_flag();
Description:

This function returns whether the number of motion repetitions for this action is derived from other data in the bead. If so, calling set_motion_reps() will have no effect.

Returns:

integer flag; 1 means number of motion reps is derived, 0 means it is not

Callable From:

function diguyCharacterPathActionBead::set_derive_motion_reps_flag

Prototype:

int set_derive_motion_reps_flag(int derive_motion_reps);
Description:

This function sets whether the number of motion repetitions for this bead is derived from other information in the bead. If so, calling set_motion_reps() will have no effect.

Arguments:

derive_motion_repspass 1 for number of motion reps to be derived, else 0
Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterPathActionBead::get_transition_before_bead_flag

Prototype:

int get_transition_before_bead_flag();
Description:

This function returns whether the transition motion for this action bead from the previous action bead (if any) occurs before this action bead or after.

Returns:

integer flag; 1 means transition happens before, 0 means it happens after

Callable From:

function diguyCharacterPathActionBead::set_transition_before_bead_flag

Prototype:

int set_transition_before_bead_flag(int transition_before_bead_flag);
Description:

This function sets whether the transition motion for this action bead from the previous action bead (if any) occurs before this action bead or after.

Arguments:

transition_before_bead_flagpass 1 for transition to happen before, 0 for it to happen after
Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterPathActionBead::get_companion_waypoint_name

Prototype:

const char* get_companion_waypoint_name();
Description:

This function returns the name of this bead's companion waypoint.

Returns:

C string identifying name of companion waypoint; NULL if there is no companion waypoint

Callable From:

function diguyCharacterPathActionBead::set_companion_waypoint_name

Prototype:

int set_companion_waypoint_name(const char* companion_waypoint_name);
Description:

This function sets the name of this action bead's companion waypoint. The action bead will be constrained to stay at the companion waypoint as the waypoint is moved around.

Arguments:

companion_waypoint_namename of companion waypoint; pass NULL to un-set the companion waypoint
Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterPathActionBead::create_or_update_companion_waypoint

Prototype:

int create_or_update_companion_waypoint();
Description:

This function creates a companion waypoint for this action bead if it doesn't already have one. The created waypoint will be at the action bead's current position. If this action bead already has a companion waypoint, it may be modified to show facing direction changes if this action or the previous action have changed since the companion waypoint was assigned.

Returns:

0 on success, -1 on failure

Callable From:

Alphabetical Index



Copyright (C) 1992-2012 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/78 Fourth Avenue/Waltham MA 02451.