C4FullScreen Class Reference

#include <C4FullScreen.h>

Inheritance diagram for C4FullScreen:

Collaboration diagram for C4FullScreen:

Public Types
enum	WindowKind {   W_GuiWindow , W_Console , W_Viewport , W_Fullscreen ,   W_Control }

Public Member Functions
	C4FullScreen ()
	~C4FullScreen () override
void	Execute ()
bool	ViewportCheck ()
bool	ShowAbortDlg ()
bool	ActivateMenuMain ()
void	CloseMenu ()
bool	MenuKeyControl (BYTE command)
C4Window *	Init (C4AbstractApp *application)
void	Close () override
void	Clear () override
void	CharIn (const char *c) override
void	PerformUpdate () override
virtual C4Window *	Init (WindowKind windowKind, C4AbstractApp *pApp, const char *Title, const C4Rect *size)
virtual bool	ReInit (C4AbstractApp *pApp)
virtual void	EnumerateMultiSamples (std::vector< int > &samples, int min_expected=0) const
bool	StorePosition (const char *szWindowName, const char *szSubKey, bool fStoreSize=true)
bool	RestorePosition (const char *szWindowName, const char *szSubKey, bool fHidden=false)
bool	GetSize (C4Rect *pRect)
void	SetSize (unsigned int cx, unsigned int cy)
void	SetTitle (const char *Title)
void	FlashWindow ()
void	GrabMouse (bool grab)
virtual void	RequestUpdate ()

Public Attributes
C4MainMenu *	MainMenu
bool	Active {false}
C4Surface *	pSurface {nullptr}
WindowKind	eKind

Protected Member Functions
virtual C4Window *	Init (WindowKind windowKind, C4AbstractApp *pApp, const char *Title, const C4Rect *size)

Detailed Description

Definition at line 27 of file C4FullScreen.h.

Member Enumeration Documentation

WindowKind

enum C4Window::WindowKind

inherited

Enumerator
W_GuiWindow
W_Console
W_Viewport
W_Fullscreen
W_Control

Definition at line 263 of file C4Window.h.

    {
        W_GuiWindow,
        W_Console,
        W_Viewport,
        W_Fullscreen,
        W_Control // wrapper to a render target control inside a window
    };

Constructor & Destructor Documentation

C4FullScreen()

C4FullScreen::C4FullScreen

(

)

Definition at line 36 of file C4FullScreen.cpp.

{
    MainMenu = nullptr;
}

References MainMenu.

~C4FullScreen()

C4FullScreen::~C4FullScreen ( )

override

Definition at line 41 of file C4FullScreen.cpp.

{
    if (MainMenu)
    {
        delete MainMenu;
    }
    if (pSurface)
    {
        delete pSurface;
    }
}

References MainMenu, and C4Window::pSurface.

Member Function Documentation

ActivateMenuMain()

bool C4FullScreen::ActivateMenuMain

(

)

Definition at line 181 of file C4FullScreen.cpp.

{
    // Not during game over dialog
    if (C4GameOverDlg::IsShown())
    {
        return false;
    }
    // Close previous
    CloseMenu();
    // Open menu
    MainMenu = new C4MainMenu();
    return MainMenu->ActivateMain(NO_OWNER);
}

References C4MainMenu::ActivateMain(), CloseMenu(), C4GameOverDlg::IsShown(), MainMenu, and NO_OWNER.

Referenced by C4Game::InitKeyboard().

Here is the call graph for this function:

Here is the caller graph for this function:

CharIn()

void C4FullScreen::CharIn ( const char *  c )

overridevirtual

Reimplemented from C4Window.

Definition at line 34 of file C4FullScreen.cpp.

{ ::pGUI->CharIn(c); }

References C4GUI::Screen::CharIn(), and pGUI.

Here is the call graph for this function:

Clear()

void C4FullScreen::Clear ( )

overridevirtual

Reimplemented from C4Window.

Definition at line 72 of file C4FullScreen.cpp.

{
    if (pSurface)
    {
        delete pSurface;
    }
    pSurface = nullptr;
    C4Window::Clear();
}

References C4Window::Clear(), and C4Window::pSurface.

Referenced by C4Application::Clear().

Here is the call graph for this function:

Here is the caller graph for this function:

Close()

void C4FullScreen::Close ( )

overridevirtual

Implements C4Window.

Definition at line 60 of file C4FullScreen.cpp.

{
    if (Game.IsRunning)
    {
        ShowAbortDlg();
    }
    else
    {
        Application.Quit();
    }
}

References Application, Game, C4Game::IsRunning, C4Application::Quit(), and ShowAbortDlg().

Here is the call graph for this function:

CloseMenu()

void C4FullScreen::CloseMenu

(

)

Definition at line 195 of file C4FullScreen.cpp.

{
    if (MainMenu)
    {
        if (MainMenu->IsActive())
        {
            MainMenu->Close(false);
        }
        delete MainMenu;
        MainMenu = nullptr;
    }
}

References C4GUI::Dialog::Close(), C4Menu::IsActive(), and MainMenu.

Referenced by ActivateMenuMain(), C4Game::Clear(), C4Game::Init(), C4GameOverDlg::OnShown(), and ViewportCheck().

Here is the call graph for this function:

Here is the caller graph for this function:

EnumerateMultiSamples()

void C4Window::EnumerateMultiSamples ( std::vector< int > &  samples, int  min_expected = 0  ) const

virtualinherited

Definition at line 105 of file C4AppT.cpp.

{}

Referenced by C4StartupOptionsDlg::C4StartupOptionsDlg().

Here is the caller graph for this function:

Execute()

void C4FullScreen::Execute

(

)

Definition at line 82 of file C4FullScreen.cpp.

{
    // Execute menu
    if (MainMenu)
    {
        MainMenu->Execute();
    }
    // Draw
    RequestUpdate();
}

References C4Menu::Execute(), MainMenu, and C4Window::RequestUpdate().

Referenced by C4Application::Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

FlashWindow()

void C4Window::FlashWindow ( )

inherited

Definition at line 75 of file C4AppMac.mm.

{
    [NSApp requestUserAttention:NSCriticalRequest];
}

Referenced by C4AbstractApp::NotifyUserIfInactive().

Here is the caller graph for this function:

GetSize()

bool C4Window::GetSize ( C4Rect *  pRect )

inherited

Definition at line 108 of file C4AppT.cpp.

{return false;}

Referenced by C4Application::OnResolutionChanged(), C4GUI::DialogWindow::PerformUpdate(), and C4Game::PreInit().

Here is the caller graph for this function:

GrabMouse()

void C4Window::GrabMouse ( bool  grab )

inherited

Definition at line 107 of file C4AppT.cpp.

{}

Referenced by C4Application::GameTick().

Here is the caller graph for this function:

Init() [1/3]

C4Window * C4FullScreen::Init

(

C4AbstractApp *

application

)

Definition at line 54 of file C4FullScreen.cpp.

{
    C4Rect r(0, 0, Application.GetConfigWidth(), Application.GetConfigHeight());
    return Init(C4Window::W_Fullscreen, application, C4ENGINECAPTION, &r);
}

References Application, C4Application::GetConfigHeight(), C4Application::GetConfigWidth(), Init(), and C4Window::W_Fullscreen.

Referenced by C4Application::DoInit().

Here is the call graph for this function:

Here is the caller graph for this function:

Init() [2/3]

C4Window * C4Window::Init

Definition at line 322 of file C4AppT.cpp.

{return this;}

Referenced by Init().

Here is the caller graph for this function:

Init() [3/3]

C4Window * C4Window::Init ( C4Window::WindowKind  windowKind, C4AbstractApp *  pApp, const char *  Title, const C4Rect *  size  )

protectedvirtualinherited

Definition at line 109 of file C4AppT.cpp.

{return this;}

Referenced by C4ConsoleGUIPreviewWindow::C4ConsoleGUIPreviewWindow(), C4ConsoleGUI::CreateConsoleWindow(), C4GUI::DialogWindow::Init(), and C4ViewportWindow::Init().

Here is the caller graph for this function:

MenuKeyControl()

bool C4FullScreen::MenuKeyControl

(

BYTE

command

)

Definition at line 213 of file C4FullScreen.cpp.

{
    if (MainMenu)
    {
        return MainMenu->KeyControl(command);
    }
    return false;
}

References C4Menu::KeyControl(), and MainMenu.

Referenced by C4Game::InitKeyboard().

Here is the call graph for this function:

Here is the caller graph for this function:

PerformUpdate()

void C4FullScreen::PerformUpdate ( )

overridevirtual

Reimplemented from C4Window.

Definition at line 208 of file C4FullScreen.cpp.

{
    GraphicsSystem.Execute();
}

References C4GraphicsSystem::Execute(), and GraphicsSystem.

Here is the call graph for this function:

ReInit()

bool C4Window::ReInit ( C4AbstractApp *  pApp )

virtualinherited

Definition at line 110 of file C4AppT.cpp.

{return false;}

RequestUpdate()

void C4Window::RequestUpdate ( )

virtualinherited

Definition at line 112 of file C4AppT.cpp.

{}

Referenced by Execute().

Here is the caller graph for this function:

RestorePosition()

bool C4Window::RestorePosition ( const char *  szWindowName, const char *  szSubKey, bool  fHidden = false  )

inherited

Definition at line 111 of file C4AppT.cpp.

{return false;}

Referenced by C4GUI::DialogWindow::Init(), and C4ViewportWindow::Init().

Here is the caller graph for this function:

SetSize()

void C4Window::SetSize ( unsigned int  cx, unsigned int  cy  )

inherited

Definition at line 113 of file C4AppT.cpp.

{}

Referenced by C4Application::DoInit(), C4GUI::DialogWindow::Init(), C4AbstractApp::SetVideoMode(), and C4GUI::Dialog::UpdateSize().

Here is the caller graph for this function:

SetTitle()

void C4Window::SetTitle ( const char *  Title )

inherited

Definition at line 114 of file C4AppT.cpp.

{}

Referenced by C4Console::CloseGame(), C4Console::SetCaptionToFilename(), and C4GUI::Dialog::SetTitle().

Here is the caller graph for this function:

ShowAbortDlg()

bool C4FullScreen::ShowAbortDlg

(

)

Definition at line 165 of file C4FullScreen.cpp.

{
    // abort dialog already shown
    if (C4AbortGameDialog::IsShown())
    {
        return false;
    }
    // not while game over dialog is open
    if (C4GameOverDlg::IsShown())
    {
        return false;
    }
    // show abort dialog
    return ::pGUI->ShowRemoveDlg(new C4AbortGameDialog());
}

References C4AbortGameDialog::IsShown(), C4GameOverDlg::IsShown(), pGUI, and C4GUI::Screen::ShowRemoveDlg().

Referenced by Close(), C4Game::InitKeyboard(), and C4MainMenu::MenuCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

StorePosition()

bool C4Window::StorePosition ( const char *  szWindowName, const char *  szSubKey, bool  fStoreSize = true  )

inherited

Definition at line 153 of file C4WindowSDL.cpp.

{ return true; }

ViewportCheck()

bool C4FullScreen::ViewportCheck

(

)

Definition at line 93 of file C4FullScreen.cpp.

{
    // Not active
    if (!Active)
    {
        return false;
    }
 
 
    // Determine film mode
    bool is_film_mode = (Game.C4S.Head.Replay && Game.C4S.Head.Film);
 
    // Check viewports
    C4Player *player;
    switch (::Viewports.GetViewportCount())
    {
        // No viewports: create no-owner viewport
    case 0:
        {
            int player_count = NO_OWNER;
            // Film mode: create viewport for first player (instead of no-owner)
            if (is_film_mode)
            {
                if ((player = ::Players.First))
                {
                    player_count = player->Number;
                }
            }
            // Create viewport
            ::Viewports.CreateViewport(player_count, player_count == NO_OWNER);
            // Non-film (observer mode)
            if (!is_film_mode)
            {
                // Activate mouse control
                ::MouseControl.Init(player_count);
                // Display message for how to open observer menu (this message will be cleared if any owned viewport opens)
                StdStrBuf key;
                key.Format("<c ffff00><%s></c>", Game.KeyboardInput.GetKeyCodeNameByKeyName("FullscreenMenuOpen", false).getData());
                ::GraphicsSystem.FlashMessage(FormatString(LoadResStr("IDS_MSG_PRESSORPUSHANYGAMEPADBUTT"), key.getData()).getData());
            }
        }
        break;
        // One viewport: do nothing
    case 1:
        break;
        // More than one viewport: remove all no-owner viewports
    default:
        ::Viewports.CloseViewport(NO_OWNER, true);
        break;
    }
    // Look for no-owner viewport
    C4Viewport *no_owner_viewport = ::Viewports.GetViewport(NO_OWNER);
    // No no-owner viewport found
    if (!no_owner_viewport)
    {
        // Close any open fullscreen menu
        CloseMenu();
    }
    // No-owner viewport present
    else
    {
        // movie mode: player present, and no valid viewport assigned?
        if (Game.C4S.Head.Replay && Game.C4S.Head.Film && (player = ::Players.First))
        {
            // assign viewport to joined player
            no_owner_viewport->Init(player->Number, true);
        }
    }
    // Done
    return true;
}

References C4Window::Active, C4Game::C4S, CloseMenu(), C4ViewportList::CloseViewport(), C4ViewportList::CreateViewport(), C4SHead::Film, C4PlayerList::First, C4GraphicsSystem::FlashMessage(), StdStrBuf::Format(), FormatString(), Game, StdStrBuf::getData(), C4KeyboardInput::GetKeyCodeNameByKeyName(), C4ViewportList::GetViewport(), C4ViewportList::GetViewportCount(), GraphicsSystem, C4Scenario::Head, C4Viewport::Init(), C4MouseControl::Init(), C4Game::KeyboardInput, LoadResStr(), MouseControl, NO_OWNER, C4ScriptGuiWindowPropertyName::player, Players, C4SHead::Replay, and Viewports.

Referenced by C4Game::InitGameFinal(), C4Game::JoinPlayer(), and C4PlayerList::Remove().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Active

bool C4Window::Active {false}

inherited

Definition at line 274 of file C4Window.h.

Referenced by AddMenuItem(), C4Console::C4Console(), C4Console::ClearNetMenu(), C4Console::ClearViewportMenu(), C4Console::CloseGame(), ConsoleDlgProc(), C4Game::DoKeyboardInput(), C4Network2::DoLobby(), C4ConsoleGUI::EnableControls(), C4Console::In(), C4Console::InitGame(), C4Game::InitPlayers(), C4Console::Message(), C4Game::OnResolutionChanged(), C4PlayerInfoList::RestoreSavegameInfos(), C4Network2::RetrieveRes(), C4Console::SaveScenario(), C4GraphicsSystem::ToggleShow8BitSurface(), C4GraphicsSystem::ToggleShowAction(), C4GraphicsSystem::ToggleShowVertices(), C4ConsoleGUI::UpdateHaltCtrls(), C4Console::UpdateMenus(), C4ConsoleGUI::State::UpdateMenuText(), C4Console::UpdateNetMenu(), C4Console::UpdatePlayerMenu(), C4Console::UpdateStatusBars(), C4Console::UpdateViewportMenu(), and ViewportCheck().

eKind

WindowKind C4Window::eKind

inherited

Definition at line 276 of file C4Window.h.

MainMenu

C4MainMenu* C4FullScreen::MainMenu

Definition at line 30 of file C4FullScreen.h.

Referenced by ActivateMenuMain(), C4FullScreen(), CloseMenu(), C4Game::DoKeyboardInput(), C4Viewport::DrawMenu(), Execute(), C4Viewport::IsViewportMenu(), MenuKeyControl(), and ~C4FullScreen().

pSurface

C4Surface* C4Window::pSurface {nullptr}

inherited

Definition at line 275 of file C4Window.h.

Referenced by C4ConsoleGUIPreviewWindow::C4ConsoleGUIPreviewWindow(), C4Console::Clear(), Clear(), C4GUI::Dialog::CreateConsoleWindow(), C4GUI::Dialog::DestroyConsoleWindow(), C4GraphicsSystem::DoSaveScreenshot(), C4GUI::Dialog::Draw(), C4ViewportList::DrawFullscreenBackground(), C4Viewport::Execute(), C4GraphicsSystem::FinishDrawing(), C4Draw::Init(), C4ViewportWindow::Init(), C4Game::InitFullscreenComponents(), C4MessageBoard::LogNotify(), C4Application::OnResolutionChanged(), C4GUI::DialogWindow::PerformUpdate(), C4Application::PreInit(), C4ViewportList::RecalculateViewports(), C4GUI::Screen::Render(), CStdGL::RestoreDeviceObjects(), C4Game::SaveGameTitle(), C4ConsoleGUIPreviewWindow::~C4ConsoleGUIPreviewWindow(), and ~C4FullScreen().

---

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

• C4FullScreen.h
• C4FullScreen.cpp