C4ViewportWindow Class Reference

#include <C4ViewportWindow.h>

Inheritance diagram for C4ViewportWindow:

Collaboration diagram for C4ViewportWindow:

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

Public Member Functions
	C4ViewportWindow (C4Viewport *cvp)
void	EditCursorMove (int X, int Y, uint32_t)
C4Window *	Init (int32_t iPlayer)
void	Close () override
void	PerformUpdate () override
virtual C4Window *	Init (WindowKind windowKind, C4AbstractApp *pApp, const char *Title, const C4Rect *size)
virtual void	Clear ()
virtual void	CharIn (const char *)
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
C4Viewport *	cvp
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 32 of file C4ViewportWindow.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

C4ViewportWindow()

C4ViewportWindow::C4ViewportWindow ( C4Viewport *  cvp )

inline

Definition at line 36 of file C4ViewportWindow.h.

: cvp(cvp) { }

Member Function Documentation

CharIn()

virtual void C4Window::CharIn ( const char *  )

inlinevirtualinherited

Reimplemented in C4FullScreen.

Definition at line 282 of file C4Window.h.

{ }

Clear()

void C4Window::Clear ( )

virtualinherited

Reimplemented in C4FullScreen, and C4Console.

Definition at line 102 of file C4AppT.cpp.

{}

Referenced by C4Console::Clear(), C4FullScreen::Clear(), C4GUI::Dialog::DestroyConsoleWindow(), and C4Window::~C4Window().

Here is the caller graph for this function:

Close()

void C4ViewportWindow::Close ( )

overridevirtual

Implements C4Window.

Definition at line 150 of file C4ViewportWindow.cpp.

{
    ::Viewports.CloseViewport(cvp);
}

References C4ViewportList::CloseViewport(), cvp, and Viewports.

Here is the call graph for this function:

EditCursorMove()

void C4ViewportWindow::EditCursorMove	(	int	X,
		int	Y,
		uint32_t	state
	)

Definition at line 154 of file C4ViewportWindow.cpp.

{
    Console.EditCursor.Move(cvp->WindowToGameX(X), cvp->WindowToGameY(Y), cvp->GetZoom(), state);
}

References Console, cvp, C4Console::EditCursor, C4Viewport::GetZoom(), C4EditCursor::Move(), C4Viewport::WindowToGameX(), C4Viewport::WindowToGameY(), and X.

Here is the call 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:

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 * C4ViewportWindow::Init

(

int32_t

iPlayer

)

Definition at line 133 of file C4ViewportWindow.cpp.

{
    C4Window* result;
    const char * Title = Player == NO_OWNER ? LoadResStr("IDS_CNS_VIEWPORT") : ::Players.Get(Player)->GetName();
    C4Rect r(0,0,800,500);
    result = C4Window::Init(C4Window::W_Viewport, &Application, Title, &r);
 
    if (!result) return result;
 
    pSurface = new C4Surface(&Application, this);
#ifndef WITH_QT_EDITOR
    // Position and size
    RestorePosition(FormatString("Viewport%i", Player+1).getData(), Config.GetSubkeyPath("Console"));
#endif
    return result;
}

References Application, Config, FormatString(), C4PlayerList::Get(), C4Player::GetName(), C4Config::GetSubkeyPath(), C4Window::Init(), LoadResStr(), NO_OWNER, Players, C4Window::pSurface, C4Window::RestorePosition(), and C4Window::W_Viewport.

Here is the call graph for this function:

Init() [2/3]

C4Window * C4Window::Init

Definition at line 322 of file C4AppT.cpp.

{return this;}

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 Init().

Here is the caller graph for this function:

PerformUpdate()

void C4ViewportWindow::PerformUpdate ( )

overridevirtual

Reimplemented from C4Window.

Definition at line 119 of file C4ViewportWindow.cpp.

{
#ifdef WITH_QT_EDITOR
    if (viewport_widget)
        viewport_widget->update();
#else
    if (cvp)
    {
        cvp->UpdateOutputSize();
        cvp->Execute();
    }
#endif
}

References cvp, C4Viewport::Execute(), and C4Viewport::UpdateOutputSize().

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

StorePosition()

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

inherited

Definition at line 153 of file C4WindowSDL.cpp.

{ return true; }

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 C4FullScreen::ViewportCheck().

cvp

C4Viewport* C4ViewportWindow::cvp

Definition at line 35 of file C4ViewportWindow.h.

Referenced by Close(), EditCursorMove(), and PerformUpdate().

eKind

WindowKind C4Window::eKind

inherited

Definition at line 276 of file C4Window.h.

pSurface

C4Surface* C4Window::pSurface {nullptr}

inherited

Definition at line 275 of file C4Window.h.

Referenced by C4ConsoleGUIPreviewWindow::C4ConsoleGUIPreviewWindow(), C4Console::Clear(), C4FullScreen::Clear(), C4GUI::Dialog::CreateConsoleWindow(), C4GUI::Dialog::DestroyConsoleWindow(), C4GraphicsSystem::DoSaveScreenshot(), C4GUI::Dialog::Draw(), C4ViewportList::DrawFullscreenBackground(), C4Viewport::Execute(), C4GraphicsSystem::FinishDrawing(), C4Draw::Init(), 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::~C4FullScreen().

---

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

• C4ViewportWindow.h
• C4ViewportWindow.cpp