diguyCrowdProfile

Generated from diguyCrowdProfile.h

DI-Guy API Version 12.5.1

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

Contents:

Alphabetical Index

class diguyCrowdProfile

class BDI_DECLSPEC_diguy diguyCrowdProfile
{
public:
    const char* get_name();
    int set_name(const char* name);
    const char* get_type_name();
    int create_entry(const char* character_type = NULL,
        const char* appearance = NULL,
        float proportion = 1.0f);
    void destroy_entry(int entry_index);
    int get_num_entries();
    int get_random_entry_index();
    int set_character_type(int entry_index, const char* character_type);
    const char* get_character_type(int entry_index);
    int set_appearance(int entry_index, const char* appearance);
    const char* get_appearance(int entry_index);
    int set_mind_base_class(int entry_index, const char* mind);
    const char* get_mind_base_class(int entry_index);
    int set_proportion(int entry_index, float proportion);
    float get_proportion(int entry_index);
    int set_default_crowd_size(int default_crowd_size);
    int get_default_crowd_size();
    diguyAgentParams* get_default_agent_params();
    diguyCharacter * create_character(diguyCrowd * crowd, int is_temporary = 0);
    const char* get_mind_init_argument(int entry_index, int arg);
    int set_character_type_and_appearance(int entry_index,
        const char* character_type,
        const char* appearance);
    int add_entry(const char* character_type, const char* appearance);

function diguyCrowdProfile::get_name

Prototype:

const char* get_name();
Returns:

name of this object; this value will never be NULL

Callable From:

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

Prototype:

const char* get_type_name();
Returns:

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

Callable From:

function diguyCrowdProfile::create_entry

Prototype:

int create_entry(const char* character_type = NULL,
    const char* appearance = NULL,
    float proportion = 1.0f);
Description:

This function creates a new crowd profile entry. The entry is initialized with the passed parameters.

Returns:

the index of the created entry; -1 if no entry created

Arguments:

character_typesee set_character_type()
appearance see set_appearance()
proportion see set_proportion()
If NULL is passed for character_type, the set_character_type() function must be called with a valid character type before this new entry is valid.

Callable From:

function diguyCrowdProfile::destroy_entry

Prototype:

void destroy_entry(int entry_index);
Description:

This function destroys the crowd profile entry at the specified index.

Callable From:

function diguyCrowdProfile::get_num_entries

Prototype:

int get_num_entries();
Returns:

number of entries in this crowd profile

Callable From:

function diguyCrowdProfile::get_random_entry_index

Prototype:

int get_random_entry_index();
Returns:

a random entry index from all entries in this profile; entries with higher proportions are more likely to be returned

Callable From:

function diguyCrowdProfile::set_character_type

Prototype:

int set_character_type(int entry_index, const char* character_type);
Description:

This function sets the character type of the given entry. This character type will be used for some characters in crowds created using this crowd profile.

On creation, the character type is set to "(none)".

Returns:

0 on success, -1 on failure

Arguments:

entry_index index of entry to be modified as returned by create_entry()
character_typestring identifying character type to be associated with this entry; valid values are the same as those that can be passed to diguyScenario::create_character()
Callable From:

function diguyCrowdProfile::get_character_type

Prototype:

const char* get_character_type(int entry_index);
Returns:

the character type of the specified entry; "(none)" if there is no such entry, or if the specified entry has not yet had its character type set

Arguments:

entry_index index of entry to be queried as returned by create_entry()
Callable From:

function diguyCrowdProfile::set_appearance

Prototype:

int set_appearance(int entry_index, const char* appearance);
Description:

This function sets the appearance of the given entry. This appearance will be used for some characters in crowds created using this crowd profile.

On creation, the appearance is set to "default".

Returns:

0 on success, -1 on failure

Arguments:

entry_index index of entry to be modified as returned by create_entry()
appearance appearance to be associated with the new entry; passing NULL sets appearance to "default"
Callable From:

function diguyCrowdProfile::get_appearance

Prototype:

const char* get_appearance(int entry_index);
Returns:

the appearance of the specified entry; NULL will be returned if there is no such entry

Arguments:

entry_index index of entry to be queried as returned by create_entry()
Callable From:

function diguyCrowdProfile::set_mind_base_class

Prototype:

int set_mind_base_class(int entry_index, const char* mind);
Description:

This function sets the mind of the given entry. This mind will be used for some characters in crowds created using this crowd profile.

On creation, the mind is set to "none".

Returns:

0 on success, -1 on failure

Arguments:

entry_index index of entry to be modified as returned by create_entry()
mind mind to be associated with the new entry; passing NULL sets the mind to none
Callable From:

function diguyCrowdProfile::get_mind_base_class

Prototype:

const char* get_mind_base_class(int entry_index);
Returns:

the mind of the specified entry; NULL will be returned if there is no such entry

Arguments:

entry_index index of entry to be queried as returned by create_entry()
Callable From:

function diguyCrowdProfile::set_proportion

Prototype:

int set_proportion(int entry_index, float proportion);
Description:

This function sets the proportion of the given entry. The proportion affects show often the specified entry will be chosen for get_random_entry_index() calls. Entries with higher proportions will be chosen more often than those with lower proportions.

The default proportion for a new entry is 1.0.

Returns:

0 on success, -1 on failure

Arguments:

entry_index index of entry to be modified as returned by create_entry()
proportion how often the new entry should be chosen relative to other entries
Callable From:

function diguyCrowdProfile::get_proportion

Prototype:

float get_proportion(int entry_index);
Returns:

the proportion of the specified entry; 0.0 will be returned if there is no such entry

Arguments:

entry_index index of entry to be queried as returned by create_entry()
Callable From:

function diguyCrowdProfile::set_default_crowd_size

Prototype:

int set_default_crowd_size(int default_crowd_size);
Description:

This function sets the default crowd size (i.e., number of characters) of a crowd that is created using this profile. The default crowd size of a crowd profile is 20.

Returns:

0 on success, -1 on failure

Arguments:

default_crowd_sizerecommended number of characters that should be in a crowd based on this profile
Callable From:

function diguyCrowdProfile::get_default_crowd_size

Prototype:

int get_default_crowd_size();
Returns:

the default crowd size of a crowd based on this profile

Callable From:

function diguyCrowdProfile::get_default_agent_params

Prototype:

diguyAgentParams* get_default_agent_params();
Returns:

the default agent parameters that will be used for crowd members of crowds created using this profile; the parameters can be modified using function calls of the diguyAgentParams class

Callable From:

function diguyCrowdProfile::create_character

Prototype:

diguyCharacter * create_character(diguyCrowd * crowd, int is_temporary = 0);
Returns:

a character that's been created from this profiles template and added to the crowd specified.

Callable From:

function diguyCrowdProfile::get_mind_init_argument

Prototype:

const char* get_mind_init_argument(int entry_index, int arg);
Deprecated Functions
The following functions are deprecated.

As these functions may disappear in a future version of DI-Guy, it is recommended that you remove calls to these functions from your application.

function diguyCrowdProfile::set_character_type_and_appearance

Prototype:

int set_character_type_and_appearance(int entry_index,
    const char* character_type,
    const char* appearance);
Deprecated as of 8.6.3; pass desired character_type and appearance to create_entry() function instead, or call set_character_type() and set_appearance() separately.

function diguyCrowdProfile::add_entry

Prototype:

int add_entry(const char* character_type, const char* appearance);
Deprecated as of 8.6.3; call create_entry() instead.

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.