From 5b9d9f92ea76320e405a1ffef8f1ed295cbd9999 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Tue, 5 Jun 2012 18:53:11 +0000 Subject: Documentation update --- Doc/doxygen/html/_cmpn_screen_8cpp_source.html | 551 ++++++++++++------------- 1 file changed, 271 insertions(+), 280 deletions(-) (limited to 'Doc/doxygen/html/_cmpn_screen_8cpp_source.html') diff --git a/Doc/doxygen/html/_cmpn_screen_8cpp_source.html b/Doc/doxygen/html/_cmpn_screen_8cpp_source.html index c23b6cb..bc473d9 100644 --- a/Doc/doxygen/html/_cmpn_screen_8cpp_source.html +++ b/Doc/doxygen/html/_cmpn_screen_8cpp_source.html @@ -394,368 +394,359 @@ $(document).ready(function(){initNavTree('_cmpn_screen_8cpp.html','');});
290  }
291  }
292 
-
293 #ifdef STARSHATTER_DEMO_RELEASE
-
294  if (!campaign->IsTraining()) {
-
295  Mouse::Show(false);
-
296  MusicDirector::SetMode(MusicDirector::MENU);
-
297  stars->SetGameMode(Starshatter::MENU_MODE);
-
298  return;
-
299  }
-
300 #endif
-
301 
-
302  // continue on to the next available campaign:
-
303  if (campaign->GetCampaignId() < Campaign::GetLastCampaignId()) {
-
304  stars->StartOrResumeGame();
-
305  }
-
306 
-
307  // if this was the last campaign, just go back to the menu:
-
308  else {
-
309  Mouse::Show(false);
-
310  MusicDirector::SetMode(MusicDirector::MENU);
-
311  stars->SetGameMode(Starshatter::MENU_MODE);
-
312  return;
-
313  }
-
314  }
-
315  }
-
316 
-
317  if (completion_stage < 1) {
-
318  MusicDirector::SetMode(MusicDirector::MENU);
-
319  Mouse::Show(!IsCmpSceneShown());
-
320  }
-
321 }
-
322 
-
323 // +--------------------------------------------------------------------+
-
324 
-
325 bool
-
326 CmpnScreen::CloseTopmost()
-
327 {
-
328  bool processed = false;
-
329 
-
330  if (IsCmdMsgShown()) {
-
331  HideCmdMsgDlg();
-
332  processed = true;
-
333  }
-
334 
-
335  else if (IsCmpFileShown()) {
-
336  HideCmpFileDlg();
-
337  processed = true;
-
338  }
+
293  // continue on to the next available campaign:
+
294  if (campaign->GetCampaignId() < Campaign::GetLastCampaignId()) {
+
295  stars->StartOrResumeGame();
+
296  }
+
297 
+
298  // if this was the last campaign, just go back to the menu:
+
299  else {
+
300  Mouse::Show(false);
+
301  MusicDirector::SetMode(MusicDirector::MENU);
+
302  stars->SetGameMode(Starshatter::MENU_MODE);
+
303  return;
+
304  }
+
305  }
+
306  }
+
307 
+
308  if (completion_stage < 1) {
+
309  MusicDirector::SetMode(MusicDirector::MENU);
+
310  Mouse::Show(!IsCmpSceneShown());
+
311  }
+
312 }
+
313 
+
314 // +--------------------------------------------------------------------+
+
315 
+
316 bool
+
317 CmpnScreen::CloseTopmost()
+
318 {
+
319  bool processed = false;
+
320 
+
321  if (IsCmdMsgShown()) {
+
322  HideCmdMsgDlg();
+
323  processed = true;
+
324  }
+
325 
+
326  else if (IsCmpFileShown()) {
+
327  HideCmpFileDlg();
+
328  processed = true;
+
329  }
+
330 
+
331  return processed;
+
332 }
+
333 
+
334 void
+
335 CmpnScreen::Show()
+
336 {
+
337  if (!isShown) {
+
338  isShown = true;
339 
-
340  return processed;
-
341 }
+
340  campaign = Campaign::GetCampaign();
+
341  completion_stage = 0;
342 
-
343 void
-
344 CmpnScreen::Show()
-
345 {
-
346  if (!isShown) {
-
347  isShown = true;
-
348 
-
349  campaign = Campaign::GetCampaign();
-
350  completion_stage = 0;
-
351 
-
352  bool cutscene = false;
-
353  CombatEvent* event = 0;
-
354 
-
355  if (campaign->IsActive() && !campaign->GetEvents().isEmpty()) {
-
356  ListIter<CombatEvent> iter = campaign->GetEvents();
-
357  while (++iter) {
-
358  event = iter.value();
-
359 
-
360  if (event && !event->Visited() && event->SceneFile() && *event->SceneFile()) {
-
361  stars->ExecCutscene(event->SceneFile(), campaign->Path());
-
362 
-
363  if (stars->InCutscene()) {
-
364  cutscene = true;
-
365  ShowCmpSceneDlg();
-
366  }
-
367 
-
368  event->SetVisited(true);
-
369  break;
-
370  }
-
371  }
-
372  }
-
373 
-
374  if (!cutscene)
-
375  ShowCmdDlg();
+
343  bool cutscene = false;
+
344  CombatEvent* event = 0;
+
345 
+
346  if (campaign->IsActive() && !campaign->GetEvents().isEmpty()) {
+
347  ListIter<CombatEvent> iter = campaign->GetEvents();
+
348  while (++iter) {
+
349  event = iter.value();
+
350 
+
351  if (event && !event->Visited() && event->SceneFile() && *event->SceneFile()) {
+
352  stars->ExecCutscene(event->SceneFile(), campaign->Path());
+
353 
+
354  if (stars->InCutscene()) {
+
355  cutscene = true;
+
356  ShowCmpSceneDlg();
+
357  }
+
358 
+
359  event->SetVisited(true);
+
360  break;
+
361  }
+
362  }
+
363  }
+
364 
+
365  if (!cutscene)
+
366  ShowCmdDlg();
+
367  }
+
368 }
+
369 
+
370 void
+
371 CmpnScreen::Hide()
+
372 {
+
373  if (isShown) {
+
374  HideAll();
+
375  isShown = false;
376  }
377 }
378 
379 void
-
380 CmpnScreen::Hide()
+
380 CmpnScreen::HideAll()
381 {
-
382  if (isShown) {
-
383  HideAll();
-
384  isShown = false;
-
385  }
-
386 }
-
387 
-
388 void
-
389 CmpnScreen::HideAll()
-
390 {
-
391  if (cmd_force_dlg) cmd_force_dlg->Hide();
-
392  if (cmd_missions_dlg) cmd_missions_dlg->Hide();
-
393  if (cmd_orders_dlg) cmd_orders_dlg->Hide();
-
394  if (cmd_intel_dlg) cmd_intel_dlg->Hide();
-
395  if (cmd_theater_dlg) cmd_theater_dlg->Hide();
-
396  if (cmd_msg_dlg) cmd_msg_dlg->Hide();
-
397  if (cmp_file_dlg) cmp_file_dlg->Hide();
-
398  if (cmp_end_dlg) cmp_end_dlg->Hide();
-
399  if (cmp_scene_dlg) cmp_scene_dlg->Hide();
-
400 }
-
401 
-
402 // +--------------------------------------------------------------------+
-
403 
-
404 void
-
405 CmpnScreen::ShowCmdDlg()
-
406 {
-
407  ShowCmdOrdersDlg();
-
408 }
-
409 
-
410 // +--------------------------------------------------------------------+
-
411 
-
412 void
-
413 CmpnScreen::ShowCmdForceDlg()
-
414 {
-
415  HideAll();
-
416  cmd_force_dlg->Show();
-
417  Mouse::Show(true);
+
382  if (cmd_force_dlg) cmd_force_dlg->Hide();
+
383  if (cmd_missions_dlg) cmd_missions_dlg->Hide();
+
384  if (cmd_orders_dlg) cmd_orders_dlg->Hide();
+
385  if (cmd_intel_dlg) cmd_intel_dlg->Hide();
+
386  if (cmd_theater_dlg) cmd_theater_dlg->Hide();
+
387  if (cmd_msg_dlg) cmd_msg_dlg->Hide();
+
388  if (cmp_file_dlg) cmp_file_dlg->Hide();
+
389  if (cmp_end_dlg) cmp_end_dlg->Hide();
+
390  if (cmp_scene_dlg) cmp_scene_dlg->Hide();
+
391 }
+
392 
+
393 // +--------------------------------------------------------------------+
+
394 
+
395 void
+
396 CmpnScreen::ShowCmdDlg()
+
397 {
+
398  ShowCmdOrdersDlg();
+
399 }
+
400 
+
401 // +--------------------------------------------------------------------+
+
402 
+
403 void
+
404 CmpnScreen::ShowCmdForceDlg()
+
405 {
+
406  HideAll();
+
407  cmd_force_dlg->Show();
+
408  Mouse::Show(true);
+
409 }
+
410 
+
411 // +--------------------------------------------------------------------+
+
412 
+
413 void
+
414 CmpnScreen::HideCmdForceDlg()
+
415 {
+
416  if (IsCmdForceShown())
+
417  cmd_force_dlg->Hide();
418 }
419 
420 // +--------------------------------------------------------------------+
421 
-
422 void
-
423 CmpnScreen::HideCmdForceDlg()
+
422 bool
+
423 CmpnScreen::IsCmdForceShown()
424 {
-
425  if (IsCmdForceShown())
-
426  cmd_force_dlg->Hide();
-
427 }
-
428 
-
429 // +--------------------------------------------------------------------+
-
430 
-
431 bool
-
432 CmpnScreen::IsCmdForceShown()
-
433 {
-
434  return cmd_force_dlg && cmd_force_dlg->IsShown();
-
435 }
-
436 
-
437 // +--------------------------------------------------------------------+
-
438 
-
439 void
-
440 CmpnScreen::ShowCmdOrdersDlg()
-
441 {
-
442  HideAll();
-
443  cmd_orders_dlg->Show();
-
444  Mouse::Show(true);
+
425  return cmd_force_dlg && cmd_force_dlg->IsShown();
+
426 }
+
427 
+
428 // +--------------------------------------------------------------------+
+
429 
+
430 void
+
431 CmpnScreen::ShowCmdOrdersDlg()
+
432 {
+
433  HideAll();
+
434  cmd_orders_dlg->Show();
+
435  Mouse::Show(true);
+
436 }
+
437 
+
438 // +--------------------------------------------------------------------+
+
439 
+
440 void
+
441 CmpnScreen::HideCmdOrdersDlg()
+
442 {
+
443  if (IsCmdOrdersShown())
+
444  cmd_orders_dlg->Hide();
445 }
446 
447 // +--------------------------------------------------------------------+
448 
-
449 void
-
450 CmpnScreen::HideCmdOrdersDlg()
+
449 bool
+
450 CmpnScreen::IsCmdOrdersShown()
451 {
-
452  if (IsCmdOrdersShown())
-
453  cmd_orders_dlg->Hide();
-
454 }
-
455 
-
456 // +--------------------------------------------------------------------+
-
457 
-
458 bool
-
459 CmpnScreen::IsCmdOrdersShown()
-
460 {
-
461  return cmd_orders_dlg && cmd_orders_dlg->IsShown();
-
462 }
-
463 
-
464 // +--------------------------------------------------------------------+
-
465 
-
466 void
-
467 CmpnScreen::ShowCmdMissionsDlg()
-
468 {
-
469  HideAll();
-
470  cmd_missions_dlg->Show();
-
471  Mouse::Show(true);
+
452  return cmd_orders_dlg && cmd_orders_dlg->IsShown();
+
453 }
+
454 
+
455 // +--------------------------------------------------------------------+
+
456 
+
457 void
+
458 CmpnScreen::ShowCmdMissionsDlg()
+
459 {
+
460  HideAll();
+
461  cmd_missions_dlg->Show();
+
462  Mouse::Show(true);
+
463 }
+
464 
+
465 // +--------------------------------------------------------------------+
+
466 
+
467 void
+
468 CmpnScreen::HideCmdMissionsDlg()
+
469 {
+
470  if (IsCmdMissionsShown())
+
471  cmd_missions_dlg->Hide();
472 }
473 
474 // +--------------------------------------------------------------------+
475 
-
476 void
-
477 CmpnScreen::HideCmdMissionsDlg()
+
476 bool
+
477 CmpnScreen::IsCmdMissionsShown()
478 {
-
479  if (IsCmdMissionsShown())
-
480  cmd_missions_dlg->Hide();
-
481 }
-
482 
-
483 // +--------------------------------------------------------------------+
-
484 
-
485 bool
-
486 CmpnScreen::IsCmdMissionsShown()
-
487 {
-
488  return cmd_missions_dlg && cmd_missions_dlg->IsShown();
-
489 }
-
490 
-
491 // +--------------------------------------------------------------------+
-
492 
-
493 void
-
494 CmpnScreen::ShowCmdIntelDlg()
-
495 {
-
496  HideAll();
-
497  cmd_intel_dlg->Show();
-
498  Mouse::Show(true);
+
479  return cmd_missions_dlg && cmd_missions_dlg->IsShown();
+
480 }
+
481 
+
482 // +--------------------------------------------------------------------+
+
483 
+
484 void
+
485 CmpnScreen::ShowCmdIntelDlg()
+
486 {
+
487  HideAll();
+
488  cmd_intel_dlg->Show();
+
489  Mouse::Show(true);
+
490 }
+
491 
+
492 // +--------------------------------------------------------------------+
+
493 
+
494 void
+
495 CmpnScreen::HideCmdIntelDlg()
+
496 {
+
497  if (IsCmdIntelShown())
+
498  cmd_intel_dlg->Hide();
499 }
500 
501 // +--------------------------------------------------------------------+
502 
-
503 void
-
504 CmpnScreen::HideCmdIntelDlg()
+
503 bool
+
504 CmpnScreen::IsCmdIntelShown()
505 {
-
506  if (IsCmdIntelShown())
-
507  cmd_intel_dlg->Hide();
-
508 }
-
509 
-
510 // +--------------------------------------------------------------------+
-
511 
-
512 bool
-
513 CmpnScreen::IsCmdIntelShown()
-
514 {
-
515  return cmd_intel_dlg && cmd_intel_dlg->IsShown();
-
516 }
-
517 
-
518 // +--------------------------------------------------------------------+
-
519 
-
520 void
-
521 CmpnScreen::ShowCmdTheaterDlg()
-
522 {
-
523  HideAll();
-
524  cmd_theater_dlg->Show();
-
525  Mouse::Show(true);
+
506  return cmd_intel_dlg && cmd_intel_dlg->IsShown();
+
507 }
+
508 
+
509 // +--------------------------------------------------------------------+
+
510 
+
511 void
+
512 CmpnScreen::ShowCmdTheaterDlg()
+
513 {
+
514  HideAll();
+
515  cmd_theater_dlg->Show();
+
516  Mouse::Show(true);
+
517 }
+
518 
+
519 // +--------------------------------------------------------------------+
+
520 
+
521 void
+
522 CmpnScreen::HideCmdTheaterDlg()
+
523 {
+
524  if (IsCmdTheaterShown())
+
525  cmd_theater_dlg->Hide();
526 }
527 
528 // +--------------------------------------------------------------------+
529 
-
530 void
-
531 CmpnScreen::HideCmdTheaterDlg()
+
530 bool
+
531 CmpnScreen::IsCmdTheaterShown()
532 {
-
533  if (IsCmdTheaterShown())
-
534  cmd_theater_dlg->Hide();
-
535 }
-
536 
-
537 // +--------------------------------------------------------------------+
-
538 
-
539 bool
-
540 CmpnScreen::IsCmdTheaterShown()
-
541 {
-
542  return cmd_theater_dlg && cmd_theater_dlg->IsShown();
+
533  return cmd_theater_dlg && cmd_theater_dlg->IsShown();
+
534 }
+
535 
+
536 // +--------------------------------------------------------------------+
+
537 
+
538 void
+
539 CmpnScreen::ShowCmpFileDlg()
+
540 {
+
541  cmp_file_dlg->Show();
+
542  Mouse::Show(true);
543 }
544 
545 // +--------------------------------------------------------------------+
546 
547 void
-
548 CmpnScreen::ShowCmpFileDlg()
+
548 CmpnScreen::HideCmpFileDlg()
549 {
-
550  cmp_file_dlg->Show();
-
551  Mouse::Show(true);
+
550  if (IsCmpFileShown())
+
551  cmp_file_dlg->Hide();
552 }
553 
554 // +--------------------------------------------------------------------+
555 
-
556 void
-
557 CmpnScreen::HideCmpFileDlg()
+
556 bool
+
557 CmpnScreen::IsCmpFileShown()
558 {
-
559  if (IsCmpFileShown())
-
560  cmp_file_dlg->Hide();
-
561 }
-
562 
-
563 // +--------------------------------------------------------------------+
-
564 
-
565 bool
-
566 CmpnScreen::IsCmpFileShown()
-
567 {
-
568  return cmp_file_dlg && cmp_file_dlg->IsShown();
+
559  return cmp_file_dlg && cmp_file_dlg->IsShown();
+
560 }
+
561 
+
562 // +--------------------------------------------------------------------+
+
563 
+
564 void
+
565 CmpnScreen::ShowCmdMsgDlg()
+
566 {
+
567  cmd_msg_dlg->Show();
+
568  Mouse::Show(true);
569 }
570 
571 // +--------------------------------------------------------------------+
572 
573 void
-
574 CmpnScreen::ShowCmdMsgDlg()
+
574 CmpnScreen::HideCmdMsgDlg()
575 {
-
576  cmd_msg_dlg->Show();
-
577  Mouse::Show(true);
+
576  if (IsCmdMsgShown())
+
577  cmd_msg_dlg->Hide();
578 }
579 
580 // +--------------------------------------------------------------------+
581 
-
582 void
-
583 CmpnScreen::HideCmdMsgDlg()
+
582 bool
+
583 CmpnScreen::IsCmdMsgShown()
584 {
-
585  if (IsCmdMsgShown())
-
586  cmd_msg_dlg->Hide();
-
587 }
-
588 
-
589 // +--------------------------------------------------------------------+
-
590 
-
591 bool
-
592 CmpnScreen::IsCmdMsgShown()
-
593 {
-
594  return cmd_msg_dlg && cmd_msg_dlg->IsShown();
+
585  return cmd_msg_dlg && cmd_msg_dlg->IsShown();
+
586 }
+
587 
+
588 // +--------------------------------------------------------------------+
+
589 
+
590 void
+
591 CmpnScreen::ShowCmpCompleteDlg()
+
592 {
+
593  cmp_end_dlg->Show();
+
594  Mouse::Show(true);
595 }
596 
597 // +--------------------------------------------------------------------+
598 
599 void
-
600 CmpnScreen::ShowCmpCompleteDlg()
+
600 CmpnScreen::HideCmpCompleteDlg()
601 {
-
602  cmp_end_dlg->Show();
-
603  Mouse::Show(true);
+
602  if (IsCmpCompleteShown())
+
603  cmp_end_dlg->Hide();
604 }
605 
606 // +--------------------------------------------------------------------+
607 
-
608 void
-
609 CmpnScreen::HideCmpCompleteDlg()
+
608 bool
+
609 CmpnScreen::IsCmpCompleteShown()
610 {
-
611  if (IsCmpCompleteShown())
-
612  cmp_end_dlg->Hide();
-
613 }
-
614 
-
615 // +--------------------------------------------------------------------+
-
616 
-
617 bool
-
618 CmpnScreen::IsCmpCompleteShown()
-
619 {
-
620  return cmp_end_dlg && cmp_end_dlg->IsShown();
+
611  return cmp_end_dlg && cmp_end_dlg->IsShown();
+
612 }
+
613 
+
614 // +--------------------------------------------------------------------+
+
615 
+
616 void
+
617 CmpnScreen::ShowCmpSceneDlg()
+
618 {
+
619  cmp_scene_dlg->Show();
+
620  Mouse::Show(false);
621 }
622 
623 // +--------------------------------------------------------------------+
624 
625 void
-
626 CmpnScreen::ShowCmpSceneDlg()
+
626 CmpnScreen::HideCmpSceneDlg()
627 {
-
628  cmp_scene_dlg->Show();
-
629  Mouse::Show(false);
+
628  if (IsCmpSceneShown())
+
629  cmp_scene_dlg->Hide();
630 }
631 
632 // +--------------------------------------------------------------------+
633 
-
634 void
-
635 CmpnScreen::HideCmpSceneDlg()
+
634 bool
+
635 CmpnScreen::IsCmpSceneShown()
636 {
-
637  if (IsCmpSceneShown())
-
638  cmp_scene_dlg->Hide();
-
639 }
-
640 
-
641 // +--------------------------------------------------------------------+
-
642 
-
643 bool
-
644 CmpnScreen::IsCmpSceneShown()
-
645 {
-
646  return cmp_scene_dlg && cmp_scene_dlg->IsShown();
-
647 }
+
637  return cmp_scene_dlg && cmp_scene_dlg->IsShown();
+
638 }