DI-Guy SDK Documentation  13.5
List of all members
diguyScenarioMergeSettings Class Reference
DI-Guy

#include <diguyScenarioMergeSettings.h>

Public Member Functions

Offset Functions

The following functions allow characters and other objects in the merged scenario to be offset in time and/or space.

int set_time_offset (float t)
 This function sets the time offset, in seconds, of the merged scenario from the existing scenario. More...
 
float get_time_offset ()
 Returns: time offset as set by set_time_offset() More...
 
int set_position_offset (float tx, float ty, float tz)
 This function sets the position offset, in meters, of the merged scenario from its original position. More...
 
int get_position_offset (float *tx, float *ty, float *tz)
 Returns: position offset as set by set_position_offset() More...
 
int set_orientation_offset (float rz, float rx, float ry)
 This function sets the orientation offset, in degrees, of the merged scenario from its original orientation. More...
 
int get_orientation_offset (float *rz, float *rx, float *ry)
 Returns: orientation offset as set by set_orientation_offset() More...
 
int set_transformation_reference_point (float tx, float ty, float tz)
 This function sets the point about which the orientation offset rotation will be done. More...
 
int get_transformation_reference_point (float *tx, float *ty, float *tz)
 Returns: reference point location as set by set_position_offset() More...
 
int set_reclamp_waypoints_flag (int reclamp_waypoints_flag)
 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. More...
 
int get_reclamp_waypoints_flag ()
 Returns: whether to re-clamp waypoints, as set by set_reclamp_waypoints_flag() More...
 
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.

void set_all_merge_flags_to_dont_merge ()
 This function sets all merge flags to not merge. More...
 
int set_camera_settings_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_camera_settings_merge_flag ()
 Returns: most recent value set by set_camera_settings_merge_flag() More...
 
int set_chain_settings_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_chain_settings_merge_flag ()
 Returns: most recent value set by set_chain_settings_merge_flag() More...
 
int set_character_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_character_merge_flag ()
 Returns: most recent value set by set_character_merge_flag() More...
 
int set_crowd_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_crowd_merge_flag ()
 Returns: most recent value set by set_crowd_merge_flag() More...
 
int set_crowd_profile_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_crowd_profile_merge_flag ()
 Returns: most recent value set by set_crowd_profile_merge_flag() More...
 
int set_decision_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_decision_merge_flag ()
 Returns: most recent value set by set_decision_merge_flag() More...
 
int set_face_exp_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_face_exp_merge_flag ()
 Returns: most recent value set by set_face_exp_merge_flag() More...
 
int set_fog_settings_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_fog_settings_merge_flag ()
 Returns: most recent value set by set_fog_settings_merge_flag() More...
 
int set_formation_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_formation_merge_flag ()
 Returns: most recent value set by set_formation_merge_flag() More...
 
int set_group_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_group_merge_flag ()
 Returns: most recent value set by set_group_merge_flag() More...
 
int set_guide_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_guide_merge_flag ()
 Returns: most recent value set by set_guide_merge_flag() More...
 
int set_info_popup_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_info_popup_merge_flag ()
 Returns: most recent value set by set_info_popup_merge_flag() More...
 
int set_library_function_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_library_function_merge_flag ()
 Returns: most recent value set by set_library_function_merge_flag() More...
 
int set_light_settings_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_light_settings_merge_flag ()
 Returns: most recent value set by set_light_settings_merge_flag() More...
 
int set_particle_system_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_particle_system_merge_flag ()
 Returns: most recent value set by set_particle_system_merge_flag() More...
 
int set_path_shape_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_path_shape_merge_flag ()
 Returns: most recent value set by set_path_shape_merge_flag() More...
 
int set_region_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_region_merge_flag ()
 Returns: most recent value set by set_region_merge_flag() More...
 
int set_scenario_settings_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how scenario settings should be merged. More...
 
diguyScenarioMergeFlag get_scenario_settings_merge_flag ()
 Returns: most recent value set by set_scenario_settings_merge_flag() More...
 
int set_scene_object_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_scene_object_merge_flag ()
 Returns: most recent value set by set_scene_object_merge_flag() More...
 
int set_scene_object_grid_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_scene_object_grid_merge_flag ()
 Returns: most recent value set by set_scene_object_grid_merge_flag() More...
 
int set_script_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_script_merge_flag ()
 Returns: most recent value set by set_script_merge_flag() More...
 
int set_sensor_region_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_sensor_region_merge_flag ()
 Returns: most recent value set by set_sensor_region_merge_flag() More...
 
int set_signal_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_signal_merge_flag ()
 Returns: most recent value set by set_signal_merge_flag() More...
 
int set_sound_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_sound_merge_flag ()
 Returns: most recent value set by set_sound_merge_flag() More...
 
int set_variable_merge_flag (diguyScenarioMergeFlag merge_flag)
 This function sets how objects of the specified type should be merged. More...
 
diguyScenarioMergeFlag get_variable_merge_flag ()
 Returns: most recent value set by set_variable_merge_flag() More...
 
Misc Settings
int set_reset_flag (diguyScenarioMergeResetFlag reset_flag)
 This function sets what scenario elements will be reset after the merge is complete. More...
 
diguyScenarioMergeResetFlag get_reset_flag ()
 Returns: most recent value set by set_reset_flag() More...
 
int set_rename_prefix (const char *rename_prefix)
 This function sets the prefix that will be added to merged object names if they are renamed. More...
 
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. More...
 
int set_rename_suffix (const char *rename_suffix)
 This function sets the suffix that will be added to merged object names if they are renamed. More...
 
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. More...
 
int set_character_group (const char *group_name)
 Sets the group characters in the merged scenario should be added to. More...
 
const char * get_character_group ()
 Returns: the most recent setting made by set_character_group() More...
 

Private Functions

The functions and variables past this point are for internal use only.

No external access to them is expected or necessary.

bdiScenarioMergeSettings * m_scripted_object
 A pointer to internal data. More...
 
class bdiScenarioMergeSettings
 
class diguyScenario
 
 diguyScenarioMergeSettings (bdiScenarioMergeSettings *merge_settings)
 A private constructor. More...
 

Constructor & Destructor Documentation

diguyScenarioMergeSettings::diguyScenarioMergeSettings ( bdiScenarioMergeSettings *  merge_settings)
private

A private constructor.

Member Function Documentation

int diguyScenarioMergeSettings::set_time_offset ( float  t)

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.

Parameters
ttime offset in seconds; must be >= 0

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
float diguyScenarioMergeSettings::get_time_offset ( )

Returns: time offset as set by set_time_offset()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_position_offset ( float  tx,
float  ty,
float  tz 
)

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.

Parameters
tx,ty,tzposition offset in meters

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::get_position_offset ( float *  tx,
float *  ty,
float *  tz 
)

Returns: position offset as set by set_position_offset()

Parameters
tx,ty,tzposition offset in meters

Pass NULL for any values that are not needed.

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_orientation_offset ( float  rz,
float  rx,
float  ry 
)

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.

Parameters
rz,rx,ryorientation offset in degrees

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::get_orientation_offset ( float *  rz,
float *  rx,
float *  ry 
)

Returns: orientation offset as set by set_orientation_offset()

Parameters
rz,rx,ryorientations in degrees counter-clockwise from the positive X axis

Pass NULL for any values that are not needed.

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_transformation_reference_point ( float  tx,
float  ty,
float  tz 
)

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

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

Parameters
tx,ty,tzreference point location in meters from the origin

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::get_transformation_reference_point ( float *  tx,
float *  ty,
float *  tz 
)

Returns: reference point location as set by set_position_offset()

Parameters
tx,ty,tzreference point location in meters from the origin

Pass NULL for any values that are not needed.

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_reclamp_waypoints_flag ( int  reclamp_waypoints_flag)

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.

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

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::get_reclamp_waypoints_flag ( )

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

Callable From:

  • C++
  • Script
void diguyScenarioMergeSettings::set_all_merge_flags_to_dont_merge ( )

This function sets all merge flags to not merge.

Individual flags can the be modified to enable merges of specific types.

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_camera_settings_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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.

Parameters
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:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_camera_settings_merge_flag ( )

Returns: most recent value set by set_camera_settings_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_chain_settings_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_chain_settings_merge_flag ( )

Returns: most recent value set by set_chain_settings_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_character_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_character_merge_flag ( )

Returns: most recent value set by set_character_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_crowd_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_crowd_merge_flag ( )

Returns: most recent value set by set_crowd_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_crowd_profile_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_crowd_profile_merge_flag ( )

Returns: most recent value set by set_crowd_profile_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_decision_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_decision_merge_flag ( )

Returns: most recent value set by set_decision_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_face_exp_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_face_exp_merge_flag ( )

Returns: most recent value set by set_face_exp_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_fog_settings_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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.

Parameters
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:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_fog_settings_merge_flag ( )

Returns: most recent value set by set_fog_settings_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_formation_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_formation_merge_flag ( )

Returns: most recent value set by set_formation_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_group_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_group_merge_flag ( )

Returns: most recent value set by set_group_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_guide_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_guide_merge_flag ( )

Returns: most recent value set by set_guide_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_info_popup_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_info_popup_merge_flag ( )

Returns: most recent value set by set_info_popup_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_library_function_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_library_function_merge_flag ( )

Returns: most recent value set by set_library_function_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_light_settings_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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.

Parameters
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:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_light_settings_merge_flag ( )

Returns: most recent value set by set_light_settings_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_particle_system_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_particle_system_merge_flag ( )

Returns: most recent value set by set_particle_system_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_path_shape_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_path_shape_merge_flag ( )

Returns: most recent value set by set_path_shape_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_region_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_region_merge_flag ( )

Returns: most recent value set by set_region_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_scenario_settings_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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.

Parameters
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:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_scenario_settings_merge_flag ( )

Returns: most recent value set by set_scenario_settings_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_scene_object_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_scene_object_merge_flag ( )

Returns: most recent value set by set_scene_object_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_scene_object_grid_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_scene_object_grid_merge_flag ( )

Returns: most recent value set by set_scene_object_grid_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_script_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_script_merge_flag ( )

Returns: most recent value set by set_script_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_sensor_region_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_sensor_region_merge_flag ( )

Returns: most recent value set by set_sensor_region_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_signal_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_signal_merge_flag ( )

Returns: most recent value set by set_signal_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_sound_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_sound_merge_flag ( )

Returns: most recent value set by set_sound_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_variable_merge_flag ( diguyScenarioMergeFlag  merge_flag)

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

Parameters
merge_flagcan be set to any merge flag value except DIGUY_MERGE_FLAG_OVERWRITE_EXISTING

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
diguyScenarioMergeFlag diguyScenarioMergeSettings::get_variable_merge_flag ( )

Returns: most recent value set by set_variable_merge_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_reset_flag ( diguyScenarioMergeResetFlag  reset_flag)

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

Parameters
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:

  • C++
  • Script
diguyScenarioMergeResetFlag diguyScenarioMergeSettings::get_reset_flag ( )

Returns: most recent value set by set_reset_flag()

Callable From:

  • C++
  • Script
int diguyScenarioMergeSettings::set_rename_prefix ( const char *  rename_prefix)

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.

Parameters
rename_prefixstring to be prepended to object names

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
const char* diguyScenarioMergeSettings::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:

  • C++
  • Script
int diguyScenarioMergeSettings::set_rename_suffix ( const char *  rename_suffix)

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.

Parameters
rename_suffixstring to be appended to object names

Returns:

0 on success, -1 on failure

Callable From:

  • C++
  • Script
const char* diguyScenarioMergeSettings::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:

  • C++
  • Script
int diguyScenarioMergeSettings::set_character_group ( const char *  group_name)

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:

  • C++
  • Script
const char* diguyScenarioMergeSettings::get_character_group ( )

Returns: the most recent setting made by set_character_group()

Callable From:

  • C++
  • Script

Friends And Related Function Documentation

friend class bdiScenarioMergeSettings
friend
friend class diguyScenario
friend

Member Data Documentation

bdiScenarioMergeSettings* diguyScenarioMergeSettings::m_scripted_object
private

A pointer to internal data.

The documentation for this class was generated from the following file: