diguyCharacterGroup Class Declaration

diguyCharacterGroup.h

DI-Guy API Version 5.1.26

This file was automatically generated from comments in the C/C++ header file diguyCharacterGroup.h. Do not edit this file directly; the changes will be lost. Please mail suggestions or corrections to diguy@bdi.com

Alphabetical Index

Includes: declspec_diguy.h

class diguyCharacterGroup

class BDI_DECLSPEC_diguy diguyCharacterGroup
{
public:
    const char* get_name();
    int add_member(diguyCharacter* character);
    int add_all_characters_as_members();
    int remove_member(diguyCharacter* character);
    int remove_all_members();
    int is_member(diguyCharacter* character);
    int set_all_members_enabled(int enabled);
    int set_all_members_t(float t);
#ifdef CPLUSPLUS_ONLY
    int draw_all_members();
    int draw_pass1_all_members();
    int draw_pass2_all_members();
#endif
    int set_all_members_current_tin(float tin);
    int set_all_members_current_tout(float tout);
#ifdef CPLUSPLUS_ONLY
    bdiScenarioCharacterGroup* get_scripted_object() {return m_scripted_object;}
};

function diguyCharacterGroup::get_name

Prototype:

const char* get_name();
Returns:

name of the group

Callable From:

function diguyCharacterGroup::add_member

Prototype:

int add_member(diguyCharacter* character);
Description:

Adds the passed character to the group if not already in it.

Returns:

0 if the character is now a part of the group; -1 if not

Callable From:

function diguyCharacterGroup::add_all_characters_as_members

Prototype:

int add_all_characters_as_members();
Description:

Adds all characters of the scenario as members of the group.

Returns:

Always return 0.

Callable From:

function diguyCharacterGroup::remove_member

Prototype:

int remove_member(diguyCharacter* character);
Description:

Removes the passed character from the group if it is a member.

Returns:

0 if the character was part of the group and removed; -1 if not

Callable From:

function diguyCharacterGroup::remove_all_members

Prototype:

int remove_all_members();
Description:

Removes all members of the group.

Returns:

Always return 0.

Callable From:

function diguyCharacterGroup::is_member

Prototype:

int is_member(diguyCharacter* character);
Returns:

1 if the passed character is a member of the group; 0 if not

Callable From:

function diguyCharacterGroup::set_all_members_enabled

Prototype:

int set_all_members_enabled(int enabled);
Description:

Set whether all characters in group are enabled. See diguyCharacter::set_enabled().

Returns:

Always return 0.

Callable From:

function diguyCharacterGroup::set_all_members_t

Prototype:

int set_all_members_t(float t);
Description:

This function sets the current t of all characters in the group. See diguyCharacter::set_t().

Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterGroup::draw_all_members

Prototype:

int draw_all_members();
Description:

This function draws all members of the group. See diguyCharacter::draw().

Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterGroup::draw_pass1_all_members

Prototype:

int draw_pass1_all_members();
Description:

This function draws pass 1 of all members of the group. See diguyCharacter::draw_pass1().

Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterGroup::draw_pass2_all_members

Prototype:

int draw_pass2_all_members();
Description:

This function draws pass 2 all members of the group. See diguyCharacter::draw_pass2().

Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterGroup::set_all_members_current_tin

Prototype:

int set_all_members_current_tin(float tin);
Description:

This function sets the current tin time of all characters in the group. See diguyCharacter::set_current_tin().

Arguments:

tinnew value of current tin in seconds
Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterGroup::set_all_members_current_tout

Prototype:

int set_all_members_current_tout(float tout);
Description:

This function sets the current tout time of all characters in the group. See diguyCharacter::set_current_tout().

Arguments:

toutnew value of current tout in seconds
Returns:

0 on success, -1 on failure

Callable From:

function diguyCharacterGroup::get_scripted_object

Prototype:

bdiScenarioCharacterGroup* get_scripted_object();

Alphabetical Index


Copyright (C) 1992-2003

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/515 Massachusetts Avenue/Cambridge MA 02139.