C++ SDK Reference  12.5
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
diguyScenarioMergeSettings.h
Go to the documentation of this file.
1 
2 /*
3  * Copyright (C) 1992-2013 Boston Dynamics
4  * ALL RIGHTS RESERVED.
5  *
6  * These coded instructions, statements, and computer programs
7  * contain unpublished proprietary information of Boston Dynamics
8  * and are protected by Copyright Laws of the United States.
9  * They may not be used, duplicated, or disclosed in any form, in
10  * whole or in part, without the prior written consent from Boston
11  * Dynamics.
12  *
13  * RESTRICTED RIGHTS LEGEND
14  * Use, duplication, or disclosure by the government is subject
15  * to restrictions as set forth in FAR 52.227.19(c)(2) or
16  * subparagraph (c)(1)(ii) of the Rights in Technical Data and
17  * Computer Software clause at DFARS 252.227-7013 and/or in
18  * similar or successor clauses in the FAR, or the DOD or NASA
19  * FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the
20  * Commercial Computer Software--Restricted Rights at 48 CFR
21  * 52.227-19, as applicable. Unpublished-rights reserved under
22  * the Copyright Laws of the United States.
23  * Contractor/Manufacturer is:
24  * Boston Dynamics/78 Fourth Avenue/Waltham MA 02451.
25  */
26 
27 /*********************************************************************
28  **
29  *t diguyScenarioMergeSettings
30  **
31  *b Link against: libdiguy
32  */
33 
34 #ifndef __diguyScenarioMergeSettings_H
35 #define __diguyScenarioMergeSettings_H
36 
37 #ifdef SWIG
38 %module diguyScenarioMergeSettings
39 #else
40 #define CPLUSPLUS_ONLY
41 #endif
42 
43 #ifdef CPLUSPLUS_ONLY
44 #include <diguy_constants.h>
45 class bdiScenarioMergeSettings;
46 class diguyScenarioMergeSettings;
47 #endif /* CPLUSPLUS_ONLY */
48 
49 
50 #include <declspec_diguy.h>
51 
52 /****************************************************************************/
53 class BDI_DECLSPEC_diguy diguyScenarioMergeSettings
54 {
55 
56 public:
57 
58 /****************************************************************************/
66  /*l
67  *b Description:
68  **
69  ** This function sets the time offset, in seconds, of the
70  ** merged scenario from the existing scenario.
71  **
72  ** The default value is 0, or no time offset.
73  **
74  *b Arguments:
75  **
76  *a t - time offset in seconds; must be >= 0
77  **
78  *b Returns:
79  **
80  ** 0 on success, -1 on failure
81  **
82  *b Callable From:
83  **
84  *- - C++
85  *- - Script
86  */
87  int set_time_offset(float t);
88 
89  /*l
90  *b Returns:
91  **
92  ** time offset as set by set_time_offset()
93  **
94  *b Callable From:
95  **
96  *- - C++
97  *- - Script
98  */
99  float get_time_offset();
100 
101  /*l
102  *b Description:
103  **
104  ** This function sets the position offset, in meters, of the
105  ** merged scenario from its original position.
106  **
107  ** The default values are 0,0,0, or no position change.
108  **
109  *b Arguments:
110  **
111  *a tx, ty, tz - position offset in meters
112  **
113  *b Returns:
114  **
115  ** 0 on success, -1 on failure
116  **
117  *b Callable From:
118  **
119  *- - C++
120  *- - Script
121  */
122  int set_position_offset(float tx, float ty, float tz);
123 
124  /*l
125  *b Returns:
126  **
127  ** position offset as set by set_position_offset()
128  **
129  *b Arguments:
130  **
131  *a tx, ty, tz - position offset in meters
132  **
133  ** Pass NULL for any values that are not needed.
134  **
135  *b Callable From:
136  **
137  *- - C++
138  *- - Script
139  */
140  int get_position_offset(float* tx, float* ty, float* tz);
141 
142  /*l
143  *b Description:
144  **
145  ** This function sets the orientation offset, in degrees, of the
146  ** merged scenario from its original orientation. The rotation is
147  ** done about the point set by the function
148  ** set_transformation_reference_point() below.
149  **
150  ** The default values are 0,0,0, or no orientation change.
151  **
152  *b Arguments:
153  **
154  *a rz, rx, ry - orientation offset in degrees
155  **
156  *b Returns:
157  **
158  ** 0 on success, -1 on failure
159  **
160  *b Callable From:
161  **
162  *- - C++
163  *- - Script
164  */
165  int set_orientation_offset(float rz, float rx, float ry);
166 
167  /*l
168  *b Returns:
169  **
170  ** orientation offset as set by set_orientation_offset()
171  **
172  *b Arguments:
173  **
174  *a rz, rx, ry - orientations in degrees counter-clockwise from the
175  *a positive X axis
176  **
177  ** Pass NULL for any values that are not needed.
178  **
179  *b Callable From:
180  **
181  *- - C++
182  *- - Script
183  */
184  int get_orientation_offset(float* rz, float* rx, float* ry);
185 
186  /*l
187  *b Description:
188  **
189  ** This function sets the point about which the orientation offset
190  ** rotation will be done.
191  **
192  ** The default values are 0,0,0, or the origin.
193  **
194  *b Arguments:
195  **
196  *a tx, ty, tz - reference point location in meters from the origin
197  **
198  *b Returns:
199  **
200  ** 0 on success, -1 on failure
201  **
202  *b Callable From:
203  **
204  *- - C++
205  *- - Script
206  */
207  int set_transformation_reference_point(float tx, float ty, float tz);
208 
209  /*l
210  *b Returns:
211  **
212  ** reference point location as set by set_position_offset()
213  **
214  *b Arguments:
215  **
216  *a tx, ty, tz - reference point location in meters from the origin
217  **
218  ** Pass NULL for any values that are not needed.
219  **
220  *b Callable From:
221  **
222  *- - C++
223  *- - Script
224  */
225  int get_transformation_reference_point(float* tx, float* ty, float* tz);
226 
227  /*l
228  *b Description:
229  **
230  ** This function sets whether waypoints of any paths or path shapes
231  ** in the merged scenario are ground clamped after they have had
232  ** either a position or orientation offset applied.
233  **
234  ** The default value is 1, re-clamp waypoints.
235  **
236  *b Arguments:
237  **
238  *a reclamp_waypoints_flag - pass 1 to re-clamp waypoints; pass 0
239  *a to not do so
240  **
241  *b Returns:
242  **
243  ** 0 on success, -1 on failure
244  **
245  *b Callable From:
246  **
247  *- - C++
248  *- - Script
249  */
250  int set_reclamp_waypoints_flag(int reclamp_waypoints_flag);
251 
252  /*l
253  *b Returns:
254  **
255  ** whether to re-clamp waypoints, as set by
256  ** set_reclamp_waypoints_flag()
257  **
258  *b Callable From:
259  **
260  *- - C++
261  *- - Script
262  */
263  int get_reclamp_waypoints_flag();
264 
265 
266 /*****************************************************************************/
281  /*l
282  *b Description:
283  **
284  ** This function sets all merge flags to not merge. Individual flags
285  ** can the be modified to enable merges of specific types.
286  **
287  *b Callable From:
288  **
289  *- - C++
290  *- - Script
291  */
292  void set_all_merge_flags_to_dont_merge();
293 
294  /*l
295  *b Description:
296  **
297  ** This function sets how objects of the specified type should
298  ** be merged. Since there are a set number of camera settings
299  ** the options for the merge_flag argument are limited.
300  **
301  *b Arguments:
302  **
303  *a merge_flag - can be set only to DIGUY_MERGE_FLAG_DONT_MERGE
304  *a or DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
305  **
306  *b Returns:
307  **
308  ** 0 on success, -1 on failure
309  **
310  *b Callable From:
311  **
312  *- - C++
313  *- - Script
314  */
315  int set_camera_settings_merge_flag(diguyScenarioMergeFlag merge_flag);
316 
317  /*l
318  *b Returns:
319  **
320  ** most recent value set by set_camera_settings_merge_flag()
321  **
322  *b Callable From:
323  **
324  *- - C++
325  *- - Script
326  */
327  diguyScenarioMergeFlag get_camera_settings_merge_flag();
328 
329  /*l
330  *b Description:
331  **
332  ** This function sets how objects of the specified type should
333  ** be merged.
334  **
335  *b Arguments:
336  **
337  *a merge_flag - can be set to any merge flag value except
338  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
339  **
340  *b Returns:
341  **
342  ** 0 on success, -1 on failure
343  **
344  *b Callable From:
345  **
346  *- - C++
347  *- - Script
348  */
349  int set_chain_settings_merge_flag(diguyScenarioMergeFlag merge_flag);
350 
351  /*l
352  *b Returns:
353  **
354  ** most recent value set by set_chain_settings_merge_flag()
355  **
356  *b Callable From:
357  **
358  *- - C++
359  *- - Script
360  */
361  diguyScenarioMergeFlag get_chain_settings_merge_flag();
362 
363  /*l
364  *b Description:
365  **
366  ** This function sets how objects of the specified type should
367  ** be merged.
368  **
369  *b Arguments:
370  **
371  *a merge_flag - can be set to any merge flag value except
372  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
373  **
374  *b Returns:
375  **
376  ** 0 on success, -1 on failure
377  **
378  *b Callable From:
379  **
380  *- - C++
381  *- - Script
382  */
383  int set_character_merge_flag(diguyScenarioMergeFlag merge_flag);
384 
385  /*l
386  *b Returns:
387  **
388  ** most recent value set by set_character_merge_flag()
389  **
390  *b Callable From:
391  **
392  *- - C++
393  *- - Script
394  */
395  diguyScenarioMergeFlag get_character_merge_flag();
396 
397  /*l
398  *b Description:
399  **
400  ** This function sets how objects of the specified type should
401  ** be merged.
402  **
403  *b Arguments:
404  **
405  *a merge_flag - can be set to any merge flag value except
406  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
407  **
408  *b Returns:
409  **
410  ** 0 on success, -1 on failure
411  **
412  *b Callable From:
413  **
414  *- - C++
415  *- - Script
416  */
417  int set_crowd_merge_flag(diguyScenarioMergeFlag merge_flag);
418 
419  /*l
420  *b Returns:
421  **
422  ** most recent value set by set_crowd_merge_flag()
423  **
424  *b Callable From:
425  **
426  *- - C++
427  *- - Script
428  */
429  diguyScenarioMergeFlag get_crowd_merge_flag();
430 
431  /*l
432  *b Description:
433  **
434  ** This function sets how objects of the specified type should
435  ** be merged.
436  **
437  *b Arguments:
438  **
439  *a merge_flag - can be set to any merge flag value except
440  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
441  **
442  *b Returns:
443  **
444  ** 0 on success, -1 on failure
445  **
446  *b Callable From:
447  **
448  *- - C++
449  *- - Script
450  */
451  int set_crowd_profile_merge_flag(diguyScenarioMergeFlag merge_flag);
452 
453  /*l
454  *b Returns:
455  **
456  ** most recent value set by set_crowd_profile_merge_flag()
457  **
458  *b Callable From:
459  **
460  *- - C++
461  *- - Script
462  */
463  diguyScenarioMergeFlag get_crowd_profile_merge_flag();
464 
465  /*l
466  *b Description:
467  **
468  ** This function sets how objects of the specified type should
469  ** be merged.
470  **
471  *b Arguments:
472  **
473  *a merge_flag - can be set to any merge flag value except
474  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
475  **
476  *b Returns:
477  **
478  ** 0 on success, -1 on failure
479  **
480  *b Callable From:
481  **
482  *- - C++
483  *- - Script
484  */
485  int set_decision_merge_flag(diguyScenarioMergeFlag merge_flag);
486 
487  /*l
488  *b Returns:
489  **
490  ** most recent value set by set_decision_merge_flag()
491  **
492  *b Callable From:
493  **
494  *- - C++
495  *- - Script
496  */
497  diguyScenarioMergeFlag get_decision_merge_flag();
498 
499  /*l
500  *b Description:
501  **
502  ** This function sets how objects of the specified type should
503  ** be merged.
504  **
505  *b Arguments:
506  **
507  *a merge_flag - can be set to any merge flag value except
508  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
509  **
510  *b Returns:
511  **
512  ** 0 on success, -1 on failure
513  **
514  *b Callable From:
515  **
516  *- - C++
517  *- - Script
518  */
519  int set_face_exp_merge_flag(diguyScenarioMergeFlag merge_flag);
520 
521  /*l
522  *b Returns:
523  **
524  ** most recent value set by set_face_exp_merge_flag()
525  **
526  *b Callable From:
527  **
528  *- - C++
529  *- - Script
530  */
531  diguyScenarioMergeFlag get_face_exp_merge_flag();
532 
533  /*l
534  *b Description:
535  **
536  ** This function sets how objects of the specified type should
537  ** be merged. Since there are a set number of fog settings
538  ** the options for the merge_flag argument are limited.
539  **
540  *b Arguments:
541  **
542  *a merge_flag - can be set only to DIGUY_MERGE_FLAG_DONT_MERGE
543  *a or DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
544  **
545  *b Returns:
546  **
547  ** 0 on success, -1 on failure
548  **
549  *b Callable From:
550  **
551  *- - C++
552  *- - Script
553  */
554  int set_fog_settings_merge_flag(diguyScenarioMergeFlag merge_flag);
555 
556  /*l
557  *b Returns:
558  **
559  ** most recent value set by set_fog_settings_merge_flag()
560  **
561  *b Callable From:
562  **
563  *- - C++
564  *- - Script
565  */
566  diguyScenarioMergeFlag get_fog_settings_merge_flag();
567 
568  /*l
569  *b Description:
570  **
571  ** This function sets how objects of the specified type should
572  ** be merged.
573  **
574  *b Arguments:
575  **
576  *a merge_flag - can be set to any merge flag value except
577  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
578  **
579  *b Returns:
580  **
581  ** 0 on success, -1 on failure
582  **
583  *b Callable From:
584  **
585  *- - C++
586  *- - Script
587  */
588  int set_formation_merge_flag(diguyScenarioMergeFlag merge_flag);
589 
590  /*l
591  *b Returns:
592  **
593  ** most recent value set by set_formation_merge_flag()
594  **
595  *b Callable From:
596  **
597  *- - C++
598  *- - Script
599  */
600  diguyScenarioMergeFlag get_formation_merge_flag();
601 
602  /*l
603  *b Description:
604  **
605  ** This function sets how objects of the specified type should
606  ** be merged.
607  **
608  *b Arguments:
609  **
610  *a merge_flag - can be set to any merge flag value except
611  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
612  **
613  *b Returns:
614  **
615  ** 0 on success, -1 on failure
616  **
617  *b Callable From:
618  **
619  *- - C++
620  *- - Script
621  */
622  int set_group_merge_flag(diguyScenarioMergeFlag merge_flag);
623 
624  /*l
625  *b Returns:
626  **
627  ** most recent value set by set_group_merge_flag()
628  **
629  *b Callable From:
630  **
631  *- - C++
632  *- - Script
633  */
634  diguyScenarioMergeFlag get_group_merge_flag();
635 
636  /*l
637  *b Description:
638  **
639  ** This function sets how objects of the specified type should
640  ** be merged.
641  **
642  *b Arguments:
643  **
644  *a merge_flag - can be set to any merge flag value except
645  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
646  **
647  *b Returns:
648  **
649  ** 0 on success, -1 on failure
650  **
651  *b Callable From:
652  **
653  *- - C++
654  *- - Script
655  */
656  int set_guide_merge_flag(diguyScenarioMergeFlag merge_flag);
657 
658  /*l
659  *b Returns:
660  **
661  ** most recent value set by set_guide_merge_flag()
662  **
663  *b Callable From:
664  **
665  *- - C++
666  *- - Script
667  */
668  diguyScenarioMergeFlag get_guide_merge_flag();
669 
670  /*l
671  *b Description:
672  **
673  ** This function sets how objects of the specified type should
674  ** be merged.
675  **
676  *b Arguments:
677  **
678  *a merge_flag - can be set to any merge flag value except
679  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
680  **
681  *b Returns:
682  **
683  ** 0 on success, -1 on failure
684  **
685  *b Callable From:
686  **
687  *- - C++
688  *- - Script
689  */
690  int set_info_popup_merge_flag(diguyScenarioMergeFlag merge_flag);
691 
692  /*l
693  *b Returns:
694  **
695  ** most recent value set by set_info_popup_merge_flag()
696  **
697  *b Callable From:
698  **
699  *- - C++
700  *- - Script
701  */
702  diguyScenarioMergeFlag get_info_popup_merge_flag();
703 
704  /*l
705  *b Description:
706  **
707  ** This function sets how objects of the specified type should
708  ** be merged.
709  **
710  *b Arguments:
711  **
712  *a merge_flag - can be set to any merge flag value except
713  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
714  **
715  *b Returns:
716  **
717  ** 0 on success, -1 on failure
718  **
719  *b Callable From:
720  **
721  *- - C++
722  *- - Script
723  */
724  int set_library_function_merge_flag(diguyScenarioMergeFlag merge_flag);
725 
726  /*l
727  *b Returns:
728  **
729  ** most recent value set by set_library_function_merge_flag()
730  **
731  *b Callable From:
732  **
733  *- - C++
734  *- - Script
735  */
736  diguyScenarioMergeFlag get_library_function_merge_flag();
737 
738  /*l
739  *b Description:
740  **
741  ** This function sets how objects of the specified type should
742  ** be merged. Since there are a set number of light settings
743  ** the options for the merge_flag argument are limited.
744  **
745  *b Arguments:
746  **
747  *a merge_flag - can be set only to DIGUY_MERGE_FLAG_DONT_MERGE
748  *a or DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
749  **
750  *b Returns:
751  **
752  ** 0 on success, -1 on failure
753  **
754  *b Callable From:
755  **
756  *- - C++
757  *- - Script
758  */
759  int set_light_settings_merge_flag(diguyScenarioMergeFlag merge_flag);
760 
761  /*l
762  *b Returns:
763  **
764  ** most recent value set by set_light_settings_merge_flag()
765  **
766  *b Callable From:
767  **
768  *- - C++
769  *- - Script
770  */
771  diguyScenarioMergeFlag get_light_settings_merge_flag();
772 
773  /*l
774  *b Description:
775  **
776  ** This function sets how objects of the specified type should
777  ** be merged.
778  **
779  *b Arguments:
780  **
781  *a merge_flag - can be set to any merge flag value except
782  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
783  **
784  *b Returns:
785  **
786  ** 0 on success, -1 on failure
787  **
788  *b Callable From:
789  **
790  *- - C++
791  *- - Script
792  */
793  int set_particle_system_merge_flag(diguyScenarioMergeFlag merge_flag);
794 
795  /*l
796  *b Returns:
797  **
798  ** most recent value set by set_particle_system_merge_flag()
799  **
800  *b Callable From:
801  **
802  *- - C++
803  *- - Script
804  */
805  diguyScenarioMergeFlag get_particle_system_merge_flag();
806 
807  /*l
808  *b Description:
809  **
810  ** This function sets how objects of the specified type should
811  ** be merged.
812  **
813  *b Arguments:
814  **
815  *a merge_flag - can be set to any merge flag value except
816  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
817  **
818  *b Returns:
819  **
820  ** 0 on success, -1 on failure
821  **
822  *b Callable From:
823  **
824  *- - C++
825  *- - Script
826  */
827  int set_path_shape_merge_flag(diguyScenarioMergeFlag merge_flag);
828 
829  /*l
830  *b Returns:
831  **
832  ** most recent value set by set_path_shape_merge_flag()
833  **
834  *b Callable From:
835  **
836  *- - C++
837  *- - Script
838  */
839  diguyScenarioMergeFlag get_path_shape_merge_flag();
840 
841  /*l
842  *b Description:
843  **
844  ** This function sets how objects of the specified type should
845  ** be merged.
846  **
847  *b Arguments:
848  **
849  *a merge_flag - can be set to any merge flag value except
850  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
851  **
852  *b Returns:
853  **
854  ** 0 on success, -1 on failure
855  **
856  *b Callable From:
857  **
858  *- - C++
859  *- - Script
860  */
861  int set_region_merge_flag(diguyScenarioMergeFlag merge_flag);
862 
863  /*l
864  *b Returns:
865  **
866  ** most recent value set by set_region_merge_flag()
867  **
868  *b Callable From:
869  **
870  *- - C++
871  *- - Script
872  */
873  diguyScenarioMergeFlag get_region_merge_flag();
874 
875  /*l
876  *b Description:
877  **
878  ** This function sets how scenario settings should be merged.
879  ** Since there is only one set of scenario settings per scenario,
880  ** the options for the merge_flag argument are limited.
881  **
882  *b Arguments:
883  **
884  *a merge_flag - can be set only to DIGUY_MERGE_FLAG_DONT_MERGE
885  *a or DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
886  **
887  *b Returns:
888  **
889  ** 0 on success, -1 on failure
890  **
891  *b Callable From:
892  **
893  *- - C++
894  *- - Script
895  */
896  int set_scenario_settings_merge_flag(diguyScenarioMergeFlag merge_flag);
897 
898  /*l
899  *b Returns:
900  **
901  ** most recent value set by set_scenario_settings_merge_flag()
902  **
903  *b Callable From:
904  **
905  *- - C++
906  *- - Script
907  */
908  diguyScenarioMergeFlag get_scenario_settings_merge_flag();
909 
910  /*l
911  *b Description:
912  **
913  ** This function sets how objects of the specified type should
914  ** be merged.
915  **
916  *b Arguments:
917  **
918  *a merge_flag - can be set to any merge flag value except
919  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
920  **
921  *b Returns:
922  **
923  ** 0 on success, -1 on failure
924  **
925  *b Callable From:
926  **
927  *- - C++
928  *- - Script
929  */
930  int set_scene_object_merge_flag(diguyScenarioMergeFlag merge_flag);
931 
932  /*l
933  *b Returns:
934  **
935  ** most recent value set by set_scene_object_merge_flag()
936  **
937  *b Callable From:
938  **
939  *- - C++
940  *- - Script
941  */
942  diguyScenarioMergeFlag get_scene_object_merge_flag();
943 
944  /*l
945  *b Description:
946  **
947  ** This function sets how objects of the specified type should
948  ** be merged.
949  **
950  *b Arguments:
951  **
952  *a merge_flag - can be set to any merge flag value except
953  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
954  **
955  *b Returns:
956  **
957  ** 0 on success, -1 on failure
958  **
959  *b Callable From:
960  **
961  *- - C++
962  *- - Script
963  */
964  int set_scene_object_grid_merge_flag(diguyScenarioMergeFlag merge_flag);
965 
966  /*l
967  *b Returns:
968  **
969  ** most recent value set by set_scene_object_grid_merge_flag()
970  **
971  *b Callable From:
972  **
973  *- - C++
974  *- - Script
975  */
976  diguyScenarioMergeFlag get_scene_object_grid_merge_flag();
977 
978  /*l
979  *b Description:
980  **
981  ** This function sets how objects of the specified type should
982  ** be merged.
983  **
984  *b Arguments:
985  **
986  *a merge_flag - can be set to any merge flag value except
987  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
988  **
989  *b Returns:
990  **
991  ** 0 on success, -1 on failure
992  **
993  *b Callable From:
994  **
995  *- - C++
996  *- - Script
997  */
998  int set_script_merge_flag(diguyScenarioMergeFlag merge_flag);
999 
1000  /*l
1001  *b Returns:
1002  **
1003  ** most recent value set by set_script_merge_flag()
1004  **
1005  *b Callable From:
1006  **
1007  *- - C++
1008  *- - Script
1009  */
1010  diguyScenarioMergeFlag get_script_merge_flag();
1011 
1012  /*l
1013  *b Description:
1014  **
1015  ** This function sets how objects of the specified type should
1016  ** be merged.
1017  **
1018  *b Arguments:
1019  **
1020  *a merge_flag - can be set to any merge flag value except
1021  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
1022  **
1023  *b Returns:
1024  **
1025  ** 0 on success, -1 on failure
1026  **
1027  *b Callable From:
1028  **
1029  *- - C++
1030  *- - Script
1031  */
1032  int set_sensor_region_merge_flag(diguyScenarioMergeFlag merge_flag);
1033 
1034  /*l
1035  *b Returns:
1036  **
1037  ** most recent value set by set_sensor_region_merge_flag()
1038  **
1039  *b Callable From:
1040  **
1041  *- - C++
1042  *- - Script
1043  */
1044  diguyScenarioMergeFlag get_sensor_region_merge_flag();
1045 
1046  /*l
1047  *b Description:
1048  **
1049  ** This function sets how objects of the specified type should
1050  ** be merged.
1051  **
1052  *b Arguments:
1053  **
1054  *a merge_flag - can be set to any merge flag value except
1055  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
1056  **
1057  *b Returns:
1058  **
1059  ** 0 on success, -1 on failure
1060  **
1061  *b Callable From:
1062  **
1063  *- - C++
1064  *- - Script
1065  */
1066  int set_signal_merge_flag(diguyScenarioMergeFlag merge_flag);
1067 
1068  /*l
1069  *b Returns:
1070  **
1071  ** most recent value set by set_signal_merge_flag()
1072  **
1073  *b Callable From:
1074  **
1075  *- - C++
1076  *- - Script
1077  */
1078  diguyScenarioMergeFlag get_signal_merge_flag();
1079 
1080  /*l
1081  *b Description:
1082  **
1083  ** This function sets how objects of the specified type should
1084  ** be merged.
1085  **
1086  *b Arguments:
1087  **
1088  *a merge_flag - can be set to any merge flag value except
1089  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
1090  **
1091  *b Returns:
1092  **
1093  ** 0 on success, -1 on failure
1094  **
1095  *b Callable From:
1096  **
1097  *- - C++
1098  *- - Script
1099  */
1100  int set_sound_merge_flag(diguyScenarioMergeFlag merge_flag);
1101 
1102  /*l
1103  *b Returns:
1104  **
1105  ** most recent value set by set_sound_merge_flag()
1106  **
1107  *b Callable From:
1108  **
1109  *- - C++
1110  *- - Script
1111  */
1112  diguyScenarioMergeFlag get_sound_merge_flag();
1113 
1114  /*l
1115  *b Description:
1116  **
1117  ** This function sets how objects of the specified type should
1118  ** be merged.
1119  **
1120  *b Arguments:
1121  **
1122  *a merge_flag - can be set to any merge flag value except
1123  *a DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
1124  **
1125  *b Returns:
1126  **
1127  ** 0 on success, -1 on failure
1128  **
1129  *b Callable From:
1130  **
1131  *- - C++
1132  *- - Script
1133  */
1134  int set_variable_merge_flag(diguyScenarioMergeFlag merge_flag);
1135 
1136  /*l
1137  *b Returns:
1138  **
1139  ** most recent value set by set_variable_merge_flag()
1140  **
1141  *b Callable From:
1142  **
1143  *- - C++
1144  *- - Script
1145  */
1146  diguyScenarioMergeFlag get_variable_merge_flag();
1147 
1148 
1149 /*****************************************************************************/
1154  /*l
1155  *b Description:
1156  **
1157  ** This function sets what scenario elements will be reset after
1158  ** the merge is complete.
1159  **
1160  *b Arguments:
1161  **
1162  *a reset_flag - DIGUY_MERGE_RESET_NONE, (reset nothing) or
1163  *a DIGUY_MERGE_RESET_MERGED, (reset only merged
1164  *a elements) or DIGUY_MERGE_RESET_ALL (reset
1165  *a entire scenario); default is
1166  *a DIGUY_MERGE_RESET_ALL
1167  **
1168  *b Returns:
1169  **
1170  ** 0 on success, -1 on failure
1171  **
1172  *b Callable From:
1173  **
1174  *- - C++
1175  *- - Script
1176  */
1177  int set_reset_flag(diguyScenarioMergeResetFlag reset_flag);
1178 
1179  /*l
1180  *b Returns:
1181  **
1182  ** most recent value set by set_reset_flag()
1183  **
1184  *b Callable From:
1185  **
1186  *- - C++
1187  *- - Script
1188  */
1189  diguyScenarioMergeResetFlag get_reset_flag();
1190 
1191  /*l
1192  *b Description:
1193  **
1194  ** This function sets the prefix that will be added to merged
1195  ** object names if they are renamed.
1196  **
1197  ** The default value is the empty string, or no rename prefix.
1198  **
1199  ** If neither a prefix nor suffix are specified, a prefix will
1200  ** be derived and used to resolve name conflicts.
1201  **
1202  *b Arguments:
1203  **
1204  *a rename_prefix - string to be prepended to object names
1205  **
1206  *b Returns:
1207  **
1208  ** 0 on success, -1 on failure
1209  **
1210  *b Callable From:
1211  **
1212  *- - C++
1213  *- - Script
1214  */
1215  int set_rename_prefix(const char* rename_prefix);
1216 
1217  /*l
1218  *b Returns:
1219  **
1220  ** prefix to be prepended to object names as set by
1221  ** set_rename_prefix(); this pointer will never be NULL, but may
1222  ** be the empty string
1223  **
1224  *b Callable From:
1225  **
1226  *- - C++
1227  *- - Script
1228  */
1229  const char* get_rename_prefix();
1230 
1231  /*l
1232  *b Description:
1233  **
1234  ** This function sets the suffix that will be added to merged
1235  ** object names if they are renamed.
1236  **
1237  ** The default value is the empty string, or no rename suffix.
1238  **
1239  ** If neither a prefix nor suffix are specified, a prefix will
1240  ** be derived and used to resolve name conflicts.
1241  **
1242  *b Arguments:
1243  **
1244  *a rename_suffix - string to be appended to object names
1245  **
1246  *b Returns:
1247  **
1248  ** 0 on success, -1 on failure
1249  **
1250  *b Callable From:
1251  **
1252  *- - C++
1253  *- - Script
1254  */
1255  int set_rename_suffix(const char* rename_suffix);
1256 
1257  /*l
1258  *b Returns:
1259  **
1260  ** prefix to be appended to object names as set by
1261  ** set_rename_suffix(); this pointer will never be NULL, but may
1262  ** be the empty string
1263  **
1264  *b Callable From:
1265  **
1266  *- - C++
1267  *- - Script
1268  */
1269  const char* get_rename_suffix();
1270 
1271  /*l
1272  *b Description:
1273  **
1274  ** Sets the group characters in the merged scenario should
1275  ** be added to. This group will be created if it doesn't
1276  ** already exist.
1277  **
1278  ** By default merged characters will not be added to any
1279  ** group they are not already in the merged scenario.
1280  **
1281  *b Returns:
1282  **
1283  ** 0 on success, -1 on failure
1284  **
1285  *b Callable From:
1286  **
1287  *- - C++
1288  *- - Script
1289  */
1290  int set_character_group(const char* group_name);
1291 
1292  /*l
1293  *b Returns:
1294  **
1295  ** the most recent setting made by set_character_group()
1296  **
1297  *b Callable From:
1298  **
1299  *- - C++
1300  *- - Script
1301  */
1302  const char* get_character_group();
1303 
1304 
1309 #ifdef CPLUSPLUS_ONLY
1310 
1311 private:
1312 
1313  /*l
1314  ** A private constructor.
1315  */
1316  diguyScenarioMergeSettings(bdiScenarioMergeSettings* merge_settings);
1317 
1318  /*l
1319  ** A pointer to internal data.
1320  */
1321  bdiScenarioMergeSettings* m_scripted_object;
1322 
1323  friend class bdiScenarioMergeSettings;
1324  friend class diguyScenario;
1325 
1326 #endif /* CPLUSPLUS_ONLY */
1327 
1328 };
1329 
1330 #endif /* __diguyScenarioMergeSettings_H */
1331