diguyFormation

Generated from diguyFormation.h

DI-Guy API Version 12.5.1

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

Contents:

Alphabetical Index

Link against: libdiguy

class diguyFormation

class BDI_DECLSPEC_diguy diguyFormation
{
public:
    const char* get_name();
    int set_name(const char* name);
    const char* get_type_name();
    const char* get_guide_name();
    int set_num_followers(int number);
    int get_num_followers();
    int set_follower_rz_offset(int follower_index, float rz);
    const char* to_lua_string(float relative_x = 0.0f,
        float relative_y = 0.0f);
    float get_follower_x_offset(int follower_index);
    float get_follower_y_offset(int follower_index);
    float get_follower_rz_offset(int follower_index);
    int set_role_name(int follower_index, const char* role_name);
    const char* get_role_name(int follower_index);
    const char* get_follower_instance(int follower_index);
    int set_subgroup_size(int size);
    int get_subgroup_size();
    int get_num_subgroups();
    int set_first_subgroup_index(int index);
    int get_first_subgroup_index();
    int set_follower_offset(int follower_index, float x, float y);
    float get_radius();

function diguyFormation::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 diguyFormation::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 diguyFormation::get_type_name

Prototype:

const char* get_type_name();
Returns:

type name of the object; this value will never be NULL

Callable From:

function diguyFormation::get_guide_name

Prototype:

const char* get_guide_name();
Returns:

guide name used by this formation

Callable From:

function diguyFormation::set_num_followers

Prototype:

int set_num_followers(int number);
Description:

Sets number of followers in the formation.

Arguments:

numbernumber of followers in this formation
Returns:

0 if success

Callable From:

function diguyFormation::get_num_followers

Prototype:

int get_num_followers();
Returns:

number of members of formation (leader not included)

Callable From:

function diguyFormation::set_follower_rz_offset

Prototype:

int set_follower_rz_offset(int follower_index, float rz);
Description:

Sets rz offset of member relative to leader.

Arguments:

follower_indexindex of follower to modify
rz orientation of member relative to leader, in degrees
Returns:

0 if success

Callable From:

function diguyFormation::to_lua_string

Prototype:

const char* to_lua_string(float relative_x = 0.0f,
    float relative_y = 0.0f);
Description:

Creates a string describing the formation, with positions being relative to relative_x and relative_y.

Arguments:

relative_x, relative_yrelative positions in meters
Returns:

string containing lua script

Callable From:

function diguyFormation::get_follower_x_offset

Prototype:

float get_follower_x_offset(int follower_index);
Description:

Gets x offset of formation member relative to leader.

Arguments:

follower_indexindex of follower in formation (does not include leader)
Returns:

x offset in meters

Callable From:

function diguyFormation::get_follower_y_offset

Prototype:

float get_follower_y_offset(int follower_index);
Description:

Gets y offset of formation member relative to leader.

Arguments:

follower_indexindex of follower in formation (does not include leader)
Returns:

y offset in meters

Callable From:

function diguyFormation::get_follower_rz_offset

Prototype:

float get_follower_rz_offset(int follower_index);
Description:

Gets rz (or yaw) of formation member relative to leader.

Arguments:

follower_indexindex of follower in formation (does not include leader)
Returns:

rz offset in degrees

Callable From:

function diguyFormation::set_role_name

Prototype:

int set_role_name(int follower_index, const char* role_name);
Description:

Sets role name of member.

Arguments:

follower_indexindex of follower to modify
role_name new role
Returns:

0 if success

Callable From:

function diguyFormation::get_role_name

Prototype:

const char* get_role_name(int follower_index);
Description:

Gets role. Roles generally correlate with a character's carried object.

Arguments:

follower_indexindex of follower in formation (does not include leader)
Returns:

string containing role, or "character" if specific role specified

Callable From:

function diguyFormation::get_follower_instance

Prototype:

const char* get_follower_instance(int follower_index);
Arguments:

follower_indexindex of follower in formation (does not include leader)
Returns:

string containing name of follower, if defined

Callable From:

function diguyFormation::set_subgroup_size

Prototype:

int set_subgroup_size(int size);
Description:

Sets subgroup size. If > 0, this means that there are subgroups and that they will be applied.

Arguments:

sizesize of subgroup
Returns:

0 if success

Callable From:

function diguyFormation::get_subgroup_size

Prototype:

int get_subgroup_size();
Description:

Gets size of subgroup. If > 0, this means that there are subgroups and that they will be applied.

Returns:

number of followers in subgroup

Callable From:

function diguyFormation::get_num_subgroups

Prototype:

int get_num_subgroups();
Description:

Get number of subgroups

Returns:

number of subgroups

Callable From:

function diguyFormation::set_first_subgroup_index

Prototype:

int set_first_subgroup_index(int index);
Description:

Sets index of first subgroup. Any members before this member are not in a subgroup.

Arguments:

indexindex of first follower in subgroup
Returns:

0 if success

Callable From:

function diguyFormation::get_first_subgroup_index

Prototype:

int get_first_subgroup_index();
Description:

Gets index of first formation member that's in a subgroup.

Returns:

index of formation member

Callable From:

function diguyFormation::set_follower_offset

Prototype:

int set_follower_offset(int follower_index, float x, float y);
Description:

Sets x, y offsets of member relative to leader.

Arguments:

follower_indexindex of follower to modify
x, y offsets of member relative to leader, in meters
Returns:

0 if success

Callable From:

function diguyFormation::get_radius

Prototype:

float get_radius();
Returns:

radius of formation, in meters

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.