diguyScenarioMergeSettings

Generated from diguyScenarioMergeSettings.h

DI-Guy API Version 12.5.1

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

Contents:

Alphabetical Index

Link against: libdiguy

class diguyScenarioMergeSettings

class BDI_DECLSPEC_diguy diguyScenarioMergeSettings
{
public:
    int set_time_offset(float t);
    float get_time_offset();
    int set_position_offset(float tx, float ty, float tz);
    int get_position_offset(float* tx, float* ty, float* tz);
    int set_orientation_offset(float rz, float rx, float ry);
    int get_orientation_offset(float* rz, float* rx, float* ry);
    int set_transformation_reference_point(float tx, float ty, float tz);
    int get_transformation_reference_point(float* tx, float* ty, float* tz);
    int set_reclamp_waypoints_flag(int reclamp_waypoints_flag);
    int get_reclamp_waypoints_flag();
    void set_all_merge_flags_to_dont_merge();
    int set_camera_settings_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_camera_settings_merge_flag();
    int set_chain_settings_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_chain_settings_merge_flag();
    int set_character_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_character_merge_flag();
    int set_crowd_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_crowd_merge_flag();
    int set_crowd_profile_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_crowd_profile_merge_flag();
    int set_decision_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_decision_merge_flag();
    int set_face_exp_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_face_exp_merge_flag();
    int set_fog_settings_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_fog_settings_merge_flag();
    int set_formation_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_formation_merge_flag();
    int set_group_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_group_merge_flag();
    int set_guide_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_guide_merge_flag();
    int set_info_popup_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_info_popup_merge_flag();
    int set_library_function_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_library_function_merge_flag();
    int set_light_settings_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_light_settings_merge_flag();
    int set_particle_system_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_particle_system_merge_flag();
    int set_path_shape_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_path_shape_merge_flag();
    int set_region_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_region_merge_flag();
    int set_scenario_settings_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_scenario_settings_merge_flag();
    int set_scene_object_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_scene_object_merge_flag();
    int set_scene_object_grid_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_scene_object_grid_merge_flag();
    int set_script_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_script_merge_flag();
    int set_sensor_region_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_sensor_region_merge_flag();
    int set_signal_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_signal_merge_flag();
    int set_sound_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_sound_merge_flag();
    int set_variable_merge_flag(diguyScenarioMergeFlag merge_flag);
    diguyScenarioMergeFlag get_variable_merge_flag();
    int set_reset_flag(diguyScenarioMergeResetFlag reset_flag);
    diguyScenarioMergeResetFlag get_reset_flag();
    int set_rename_prefix(const char* rename_prefix);
    const char* get_rename_prefix();
    int set_rename_suffix(const char* rename_suffix);
    const char* get_rename_suffix();
    int set_character_group(const char* group_name);
    const char* get_character_group();
Offset Functions
The following functions allow characters and other objects in the merged scenario to be offset in time and/or space.

function diguyScenarioMergeSettings::set_time_offset

Prototype:

int set_time_offset(float t);
Description:

This function sets the time offset, in seconds, of the merged scenario from the existing scenario.

The default value is 0, or no time offset.

Arguments:

ttime offset in seconds; must be >= 0
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_time_offset

Prototype:

float get_time_offset();
Returns:

time offset as set by set_time_offset()

Callable From:

function diguyScenarioMergeSettings::set_position_offset

Prototype:

int set_position_offset(float tx, float ty, float tz);
Description:

This function sets the position offset, in meters, of the merged scenario from its original position.

The default values are 0,0,0, or no position change.

Arguments:

tx, ty, tzposition offset in meters
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_position_offset

Prototype:

int get_position_offset(float* tx, float* ty, float* tz);
Returns:

position offset as set by set_position_offset()

Arguments:

tx, ty, tzposition offset in meters
Pass NULL for any values that are not needed.

Callable From:

function diguyScenarioMergeSettings::set_orientation_offset

Prototype:

int set_orientation_offset(float rz, float rx, float ry);
Description:

This function sets the orientation offset, in degrees, of the merged scenario from its original orientation. The rotation is done about the point set by the function set_transformation_reference_point() below.

The default values are 0,0,0, or no orientation change.

Arguments:

rz, rx, ryorientation offset in degrees
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_orientation_offset

Prototype:

int get_orientation_offset(float* rz, float* rx, float* ry);
Returns:

orientation offset as set by set_orientation_offset()

Arguments:

rz, rx, ryorientations in degrees counter-clockwise from the positive X axis
Pass NULL for any values that are not needed.

Callable From:

function diguyScenarioMergeSettings::set_transformation_reference_point

Prototype:

int set_transformation_reference_point(float tx, float ty, float tz);
Description:

This function sets the point about which the orientation offset rotation will be done.

The default values are 0,0,0, or the origin.

Arguments:

tx, ty, tzreference point location in meters from the origin
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_transformation_reference_point

Prototype:

int get_transformation_reference_point(float* tx, float* ty, float* tz);
Returns:

reference point location as set by set_position_offset()

Arguments:

tx, ty, tzreference point location in meters from the origin
Pass NULL for any values that are not needed.

Callable From:

function diguyScenarioMergeSettings::set_reclamp_waypoints_flag

Prototype:

int set_reclamp_waypoints_flag(int reclamp_waypoints_flag);
Description:

This function sets whether waypoints of any paths or path shapes in the merged scenario are ground clamped after they have had either a position or orientation offset applied.

The default value is 1, re-clamp waypoints.

Arguments:

reclamp_waypoints_flagpass 1 to re-clamp waypoints; pass 0 to not do so
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_reclamp_waypoints_flag

Prototype:

int get_reclamp_waypoints_flag();
Returns:

whether to re-clamp waypoints, as set by set_reclamp_waypoints_flag()

Callable From:

Merge Flags
The following functions specify whether objects of specific types are merged at all, and if so, what to do if there is a conflict with an existing object.

The default values for these flags are determined by the initial_settings argument passed to the diguyScenario::create_merge_settings() function. See the documentation for this function for what the default values are.

function diguyScenarioMergeSettings::set_all_merge_flags_to_dont_merge

Prototype:

void set_all_merge_flags_to_dont_merge();
Description:

This function sets all merge flags to not merge. Individual flags can the be modified to enable merges of specific types.

Callable From:

function diguyScenarioMergeSettings::set_camera_settings_merge_flag

Prototype:

int set_camera_settings_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged. Since there are a set number of camera settings the options for the merge_flag argument are limited.

Arguments:

merge_flagcan be set only to DIGUY_MERGE_FLAG_DONT_MERGE or DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_camera_settings_merge_flag

Prototype:

diguyScenarioMergeFlag get_camera_settings_merge_flag();
Returns:

most recent value set by set_camera_settings_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_chain_settings_merge_flag

Prototype:

int set_chain_settings_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_chain_settings_merge_flag

Prototype:

diguyScenarioMergeFlag get_chain_settings_merge_flag();
Returns:

most recent value set by set_chain_settings_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_character_merge_flag

Prototype:

int set_character_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_character_merge_flag

Prototype:

diguyScenarioMergeFlag get_character_merge_flag();
Returns:

most recent value set by set_character_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_crowd_merge_flag

Prototype:

int set_crowd_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_crowd_merge_flag

Prototype:

diguyScenarioMergeFlag get_crowd_merge_flag();
Returns:

most recent value set by set_crowd_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_crowd_profile_merge_flag

Prototype:

int set_crowd_profile_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_crowd_profile_merge_flag

Prototype:

diguyScenarioMergeFlag get_crowd_profile_merge_flag();
Returns:

most recent value set by set_crowd_profile_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_decision_merge_flag

Prototype:

int set_decision_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_decision_merge_flag

Prototype:

diguyScenarioMergeFlag get_decision_merge_flag();
Returns:

most recent value set by set_decision_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_face_exp_merge_flag

Prototype:

int set_face_exp_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_face_exp_merge_flag

Prototype:

diguyScenarioMergeFlag get_face_exp_merge_flag();
Returns:

most recent value set by set_face_exp_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_fog_settings_merge_flag

Prototype:

int set_fog_settings_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged. Since there are a set number of fog settings the options for the merge_flag argument are limited.

Arguments:

merge_flagcan be set only to DIGUY_MERGE_FLAG_DONT_MERGE or DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_fog_settings_merge_flag

Prototype:

diguyScenarioMergeFlag get_fog_settings_merge_flag();
Returns:

most recent value set by set_fog_settings_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_formation_merge_flag

Prototype:

int set_formation_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_formation_merge_flag

Prototype:

diguyScenarioMergeFlag get_formation_merge_flag();
Returns:

most recent value set by set_formation_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_group_merge_flag

Prototype:

int set_group_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_group_merge_flag

Prototype:

diguyScenarioMergeFlag get_group_merge_flag();
Returns:

most recent value set by set_group_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_guide_merge_flag

Prototype:

int set_guide_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_guide_merge_flag

Prototype:

diguyScenarioMergeFlag get_guide_merge_flag();
Returns:

most recent value set by set_guide_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_info_popup_merge_flag

Prototype:

int set_info_popup_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_info_popup_merge_flag

Prototype:

diguyScenarioMergeFlag get_info_popup_merge_flag();
Returns:

most recent value set by set_info_popup_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_library_function_merge_flag

Prototype:

int set_library_function_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_library_function_merge_flag

Prototype:

diguyScenarioMergeFlag get_library_function_merge_flag();
Returns:

most recent value set by set_library_function_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_light_settings_merge_flag

Prototype:

int set_light_settings_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged. Since there are a set number of light settings the options for the merge_flag argument are limited.

Arguments:

merge_flagcan be set only to DIGUY_MERGE_FLAG_DONT_MERGE or DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_light_settings_merge_flag

Prototype:

diguyScenarioMergeFlag get_light_settings_merge_flag();
Returns:

most recent value set by set_light_settings_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_particle_system_merge_flag

Prototype:

int set_particle_system_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_particle_system_merge_flag

Prototype:

diguyScenarioMergeFlag get_particle_system_merge_flag();
Returns:

most recent value set by set_particle_system_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_path_shape_merge_flag

Prototype:

int set_path_shape_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_path_shape_merge_flag

Prototype:

diguyScenarioMergeFlag get_path_shape_merge_flag();
Returns:

most recent value set by set_path_shape_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_region_merge_flag

Prototype:

int set_region_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_region_merge_flag

Prototype:

diguyScenarioMergeFlag get_region_merge_flag();
Returns:

most recent value set by set_region_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_scenario_settings_merge_flag

Prototype:

int set_scenario_settings_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how scenario settings should be merged. Since there is only one set of scenario settings per scenario, the options for the merge_flag argument are limited.

Arguments:

merge_flagcan be set only to DIGUY_MERGE_FLAG_DONT_MERGE or DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_scenario_settings_merge_flag

Prototype:

diguyScenarioMergeFlag get_scenario_settings_merge_flag();
Returns:

most recent value set by set_scenario_settings_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_scene_object_merge_flag

Prototype:

int set_scene_object_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_scene_object_merge_flag

Prototype:

diguyScenarioMergeFlag get_scene_object_merge_flag();
Returns:

most recent value set by set_scene_object_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_scene_object_grid_merge_flag

Prototype:

int set_scene_object_grid_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_scene_object_grid_merge_flag

Prototype:

diguyScenarioMergeFlag get_scene_object_grid_merge_flag();
Returns:

most recent value set by set_scene_object_grid_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_script_merge_flag

Prototype:

int set_script_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_script_merge_flag

Prototype:

diguyScenarioMergeFlag get_script_merge_flag();
Returns:

most recent value set by set_script_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_sensor_region_merge_flag

Prototype:

int set_sensor_region_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_sensor_region_merge_flag

Prototype:

diguyScenarioMergeFlag get_sensor_region_merge_flag();
Returns:

most recent value set by set_sensor_region_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_signal_merge_flag

Prototype:

int set_signal_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_signal_merge_flag

Prototype:

diguyScenarioMergeFlag get_signal_merge_flag();
Returns:

most recent value set by set_signal_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_sound_merge_flag

Prototype:

int set_sound_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_sound_merge_flag

Prototype:

diguyScenarioMergeFlag get_sound_merge_flag();
Returns:

most recent value set by set_sound_merge_flag()

Callable From:

function diguyScenarioMergeSettings::set_variable_merge_flag

Prototype:

int set_variable_merge_flag(diguyScenarioMergeFlag merge_flag);
Description:

This function sets how objects of the specified type should be merged.

Arguments:

merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_variable_merge_flag

Prototype:

diguyScenarioMergeFlag get_variable_merge_flag();
Returns:

most recent value set by set_variable_merge_flag()

Callable From:

Misc Settings

function diguyScenarioMergeSettings::set_reset_flag

Prototype:

int set_reset_flag(diguyScenarioMergeResetFlag reset_flag);
Description:

This function sets what scenario elements will be reset after the merge is complete.

Arguments:

reset_flagDIGUY_MERGE_RESET_NONE, (reset nothing) or DIGUY_MERGE_RESET_MERGED, (reset only merged elements) or DIGUY_MERGE_RESET_ALL (reset entire scenario); default is DIGUY_MERGE_RESET_ALL
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_reset_flag

Prototype:

diguyScenarioMergeResetFlag get_reset_flag();
Returns:

most recent value set by set_reset_flag()

Callable From:

function diguyScenarioMergeSettings::set_rename_prefix

Prototype:

int set_rename_prefix(const char* rename_prefix);
Description:

This function sets the prefix that will be added to merged object names if they are renamed.

The default value is the empty string, or no rename prefix.

If neither a prefix nor suffix are specified, a prefix will be derived and used to resolve name conflicts.

Arguments:

rename_prefixstring to be prepended to object names
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_rename_prefix

Prototype:

const char* get_rename_prefix();
Returns:

prefix to be prepended to object names as set by set_rename_prefix(); this pointer will never be NULL, but may be the empty string

Callable From:

function diguyScenarioMergeSettings::set_rename_suffix

Prototype:

int set_rename_suffix(const char* rename_suffix);
Description:

This function sets the suffix that will be added to merged object names if they are renamed.

The default value is the empty string, or no rename suffix.

If neither a prefix nor suffix are specified, a prefix will be derived and used to resolve name conflicts.

Arguments:

rename_suffixstring to be appended to object names
Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_rename_suffix

Prototype:

const char* get_rename_suffix();
Returns:

prefix to be appended to object names as set by set_rename_suffix(); this pointer will never be NULL, but may be the empty string

Callable From:

function diguyScenarioMergeSettings::set_character_group

Prototype:

int set_character_group(const char* group_name);
Description:

Sets the group characters in the merged scenario should be added to. This group will be created if it doesn't already exist.

By default merged characters will not be added to any group they are not already in the merged scenario.

Returns:

0 on success, -1 on failure

Callable From:

function diguyScenarioMergeSettings::get_character_group

Prototype:

const char* get_character_group();
Returns:

the most recent setting made by set_character_group()

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.