diguyCharacterPathDecisionBead

Generated from diguyCharacterPathDecisionBead.h

DI-Guy API Version 12.5.1

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

Includes: declspec_diguy.h

Contents:

Experimental Functions

Alphabetical Index

Link against: libdiguy

class diguyCharacterPathDecisionBead

class BDI_DECLSPEC_diguy diguyCharacterPathDecisionBead
{
public:
    const char* get_name();
    int set_name(const char* name);
    float get_distance_into_path();
    int set_distance_into_path(float distance_into_path);
    float get_length();
    int set_length(float length);
    float get_tin();
    int set_tin(float tin);
    float get_duration();
    int set_duration(float duration);
    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);

function diguyCharacterPathDecisionBead::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:

C++
Script

function diguyCharacterPathDecisionBead::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:

C++
Script

function diguyCharacterPathDecisionBead::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:

C++
Script

function diguyCharacterPathDecisionBead::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_path how far into the path this bead is, in meters
Returns:

0 on success, -1 on failure
Callable From:

C++
Script

function diguyCharacterPathDecisionBead::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:

C++
Script

function diguyCharacterPathDecisionBead::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:

duration duration of this bead, in seconds
Returns:

0 on success, -1 on failure
Callable From:

C++
Script

function diguyCharacterPathDecisionBead::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:

C++
Script

function diguyCharacterPathDecisionBead::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:

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

0 on success, -1 on failure
Callable From:

C++
Script

function diguyCharacterPathDecisionBead::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:

C++
Script

function diguyCharacterPathDecisionBead::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.

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:

duration duration of this bead, in seconds
Returns:

0 on success, -1 on failure
Callable From:

C++
Script

Experimental Functions

The following functions are experimental and may change or disappear with no warning.

function diguyCharacterPathDecisionBead::get_begin_at_object_name

Prototype:

const char* get_begin_at_object_name();

function diguyCharacterPathDecisionBead::set_begin_at_object_name

Prototype:

int set_begin_at_object_name(const char* begin_at_object_name);

function diguyCharacterPathDecisionBead::get_begin_at_object_offset

Prototype:

float get_begin_at_object_offset();

function diguyCharacterPathDecisionBead::set_begin_at_object_offset

Prototype:

int set_begin_at_object_offset(float begin_at_object_offset);

function diguyCharacterPathDecisionBead::get_end_at_object_name

Prototype:

const char* get_end_at_object_name();

function diguyCharacterPathDecisionBead::set_end_at_object_name

Prototype:

int set_end_at_object_name(const char* end_at_object_name);

function diguyCharacterPathDecisionBead::get_end_at_object_offset

Prototype:

float get_end_at_object_offset();

function diguyCharacterPathDecisionBead::set_end_at_object_offset

Prototype:

int set_end_at_object_offset(float end_at_object_offset);

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.