C4ViewportList Class Reference

#include <C4Viewport.h>

Collaboration diagram for C4ViewportList:

Public Member Functions
	C4ViewportList ()
	~C4ViewportList ()
void	Clear ()
void	ClearPointers (C4Object *obj)
void	Execute (bool DrawBackground)
void	SortViewportsByPlayerControl ()
void	RecalculateViewports ()
void	DisableFoW ()
void	EnableFoW ()
bool	CreateViewport (int32_t player_nr, bool silent=false)
bool	CloseViewport (int32_t player_nr, bool silent)
int32_t	GetViewportCount ()
C4Viewport *	GetViewport (int32_t player_nr, C4Viewport *prev=nullptr)
C4Viewport *	GetFirstViewport ()
bool	CloseViewport (C4Viewport *viewport)
int32_t	GetAudibility (int32_t x, int32_t y, int32_t *pan, int32_t audibility_radius=0, int32_t *out_player=nullptr)
bool	ViewportNextPlayer ()
bool	FreeScroll (C4Vec2D scroll_by)
bool	ViewportZoomOut ()
bool	ViewportZoomIn ()

Protected Member Functions
void	MouseMoveToViewport (int32_t button, int32_t x, int32_t y, DWORD key_param)
void	DrawFullscreenBackground ()

Protected Attributes
C4Viewport *	FirstViewport {nullptr}
C4Facet	ViewportArea
C4RectList	BackgroundAreas

Friends
class	C4GUI::Screen
class	C4GraphicsSystem

Detailed Description

Definition at line 144 of file C4Viewport.h.

Constructor & Destructor Documentation

C4ViewportList()

C4ViewportList::C4ViewportList

(

)

Definition at line 1027 of file C4Viewport.cpp.

{
    ViewportArea.Default();
}

References C4Facet::Default(), and ViewportArea.

Here is the call graph for this function:

~C4ViewportList()

C4ViewportList::~C4ViewportList ( )

default

Member Function Documentation

Clear()

void C4ViewportList::Clear

(

)

Definition at line 1032 of file C4Viewport.cpp.

{
    C4Viewport *next;
    while (FirstViewport)
    {
        next = FirstViewport->Next;
        delete FirstViewport;
        FirstViewport = next;
    }
    FirstViewport = nullptr;
}

References FirstViewport, and C4Viewport::Next.

Referenced by C4GraphicsSystem::Clear().

Here is the caller graph for this function:

ClearPointers()

void C4ViewportList::ClearPointers

(

C4Object *

obj

)

Definition at line 1178 of file C4Viewport.cpp.

{
    for (C4Viewport *viewport = FirstViewport; viewport; viewport = viewport->Next)
    {
        viewport->ClearPointers(obj);
    }
}

References FirstViewport, and C4Viewport::Next.

Referenced by C4Game::ClearPointers().

Here is the caller graph for this function:

CloseViewport() [1/2]

bool C4ViewportList::CloseViewport

(

C4Viewport *

viewport

)

Definition at line 1073 of file C4Viewport.cpp.

{
    if (!viewport)
    {
        return false;
    }
    // Chop the start of the chain off
    if (FirstViewport == viewport)
    {
        FirstViewport = viewport->Next;
        delete viewport;
        StartSoundEffect("UI::CloseViewport");
    }
    // Take out of the chain
    else for (C4Viewport * prev = FirstViewport; prev; prev = prev->Next)
    {
        if (prev->Next == viewport)
        {
            prev->Next = viewport->Next;
            delete viewport;
            StartSoundEffect("UI::CloseViewport");
        }
    }
    // Deleting a viewport may leave us with no context selected
    if (pDraw)
    {
        pDraw->EnsureMainContextSelected();
    }
    // Recalculate viewports
    RecalculateViewports();
    // Done
    return true;
}

References C4Draw::EnsureMainContextSelected(), FirstViewport, C4Viewport::Next, pDraw, RecalculateViewports(), and StartSoundEffect().

Here is the call graph for this function:

CloseViewport() [2/2]

bool C4ViewportList::CloseViewport	(	int32_t	player_nr,
		bool	silent
	)

Definition at line 1186 of file C4Viewport.cpp.

{
    // Close all matching viewports
    int32_t last_count = GetViewportCount();
    C4Viewport *next;
    C4Viewport *prev = nullptr;
    for (C4Viewport *viewport = FirstViewport; viewport; viewport = next)
    {
        next = viewport->Next;
        if (viewport->Player == player_nr || (player_nr == NO_OWNER && viewport->fIsNoOwnerViewport))
        {
            delete viewport;
            if (prev)
            {
                prev->Next = next;
            }
            else
            {
                FirstViewport = next;
            }
        }
        else
        {
            prev = viewport;
        }
    }
    // Anything was done?
    if (GetViewportCount() != last_count)
    {
        // Recalculate viewports
        RecalculateViewports();
        // Action sound
        if (!silent)
        {
            StartSoundEffect("UI::CloseViewport");
        }
    }
    return true;
}

References FirstViewport, GetViewportCount(), C4Viewport::Next, NO_OWNER, RecalculateViewports(), and StartSoundEffect().

Referenced by C4ViewportWindow::Close(), C4PlayerList::Remove(), and C4FullScreen::ViewportCheck().

Here is the call graph for this function:

Here is the caller graph for this function:

CreateViewport()

bool C4ViewportList::CreateViewport	(	int32_t	player_nr,
		bool	silent = false
	)

Definition at line 1119 of file C4Viewport.cpp.

{
    // Create and init new viewport, add to viewport list
    int32_t last_count = GetViewportCount();
    C4Viewport *viewport = new C4Viewport;
    bool is_okay = viewport->Init(player_nr, false);
    if (!is_okay)
    {
        delete viewport;
        return false;
    }
    C4Viewport *last;
    for (last = FirstViewport; last && last->Next; last = last->Next)
    {
 
    }
    if (last)
    {
        last->Next = viewport;
    }
    else
    {
        FirstViewport = viewport;
    }
    // Recalculate viewports
    RecalculateViewports();
    // Viewports start off at centered position
    viewport->CenterPosition();
    // Initial player zoom values to viewport (in case they were set early in InitializePlayer, loaded from savegame, etc.)
    C4Player *player = ::Players.Get(player_nr);
    if (player)
    {
        player->ZoomToViewport(viewport, true, false, false);
        player->ZoomLimitsToViewport(viewport);
    }
    // Action sound
    if (!silent && GetViewportCount() != last_count)
    {
            StartSoundEffect("UI::CloseViewport");
    }
    return true;
}

References C4Viewport::CenterPosition(), FirstViewport, C4PlayerList::Get(), GetViewportCount(), C4Viewport::Init(), C4Viewport::Next, C4ScriptGuiWindowPropertyName::player, Players, RecalculateViewports(), and StartSoundEffect().

Referenced by ConsoleDlgProc(), C4Console::InitGame(), C4Game::InitGameFinal(), C4Game::JoinPlayer(), C4FullScreen::ViewportCheck(), and C4Console::ViewportNew().

Here is the call graph for this function:

Here is the caller graph for this function:

DisableFoW()

void C4ViewportList::DisableFoW

(

)

Definition at line 1162 of file C4Viewport.cpp.

{
    for (C4Viewport *viewport = FirstViewport; viewport; viewport = viewport->Next)
    {
        viewport->DisableFoW();
    }
}

References FirstViewport, and C4Viewport::Next.

Referenced by C4Game::LoadScenarioSection().

Here is the caller graph for this function:

DrawFullscreenBackground()

void C4ViewportList::DrawFullscreenBackground ( )

protected

Definition at line 1064 of file C4Viewport.cpp.

{
    for (int i = 0, num = BackgroundAreas.GetCount(); i < num; ++i)
    {
        const C4Rect &rc = BackgroundAreas.Get(i);
        pDraw->BlitSurfaceTile(::GraphicsResource.fctBackground.Surface, FullScreen.pSurface, rc.x, rc.y, rc.Wdt, rc.Hgt, -rc.x, -rc.y, nullptr);
    }
}

References BackgroundAreas, C4Draw::BlitSurfaceTile(), C4GraphicsResource::fctBackground, FullScreen, C4RectList::Get(), C4RectList::GetCount(), GraphicsResource, C4Rect::Hgt, pDraw, C4Window::pSurface, C4Facet::Surface, C4Rect::Wdt, C4Rect::x, and C4Rect::y.

Referenced by Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

EnableFoW()

void C4ViewportList::EnableFoW

(

)

Definition at line 1170 of file C4Viewport.cpp.

{
    for (C4Viewport *viewport = FirstViewport; viewport; viewport = viewport->Next)
    {
        viewport->EnableFoW();
    }
}

References FirstViewport, and C4Viewport::Next.

Referenced by C4Game::LoadScenarioSection().

Here is the caller graph for this function:

Execute()

void C4ViewportList::Execute

(

bool

DrawBackground

)

Definition at line 1044 of file C4Viewport.cpp.

{
    // Background redraw
    if (draw_background)
    {
        DrawFullscreenBackground();
    }
    for (C4Viewport *viewport = FirstViewport; viewport; viewport = viewport->Next)
    {
        if (viewport->GetWindow())
        {
            viewport->GetWindow()->RequestUpdate();
        }
        else
        {
            viewport->Execute();
        }
    }
}

References DrawFullscreenBackground(), FirstViewport, and C4Viewport::Next.

Referenced by C4GraphicsSystem::Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

FreeScroll()

bool C4ViewportList::FreeScroll

(

C4Vec2D

scroll_by

)

Definition at line 1421 of file C4Viewport.cpp.

{
    // safety: move valid?
    if ((!Game.C4S.Head.Replay || !Game.C4S.Head.Film) && !GetViewport(NO_OWNER))
    {
        return false;
    }
    C4Viewport *viewport = GetFirstViewport();
    if (!viewport)
    {
        return false;
    }
    // move then (old static code crap...)
    static int32_t vp_vx = 0;
    static int32_t vp_vy = 0;
    static int32_t vp_vf = 0;
    int32_t dx = scroll_by.x;
    int32_t dy = scroll_by.y;
    if (Game.FrameCounter-vp_vf < 5)
    {
        dx += vp_vx;
        dy += vp_vy;
    }
    vp_vx = dx;
    vp_vy = dy;
    vp_vf = Game.FrameCounter;
    viewport->ScrollView(dx, dy);
    return true;
}

References C4Game::C4S, C4SHead::Film, C4Game::FrameCounter, Game, GetFirstViewport(), GetViewport(), C4Scenario::Head, NO_OWNER, C4SHead::Replay, C4Viewport::ScrollView(), C4Vec2D::x, and C4Vec2D::y.

Referenced by C4Game::InitKeyboard().

Here is the call graph for this function:

Here is the caller graph for this function:

GetAudibility()

int32_t C4ViewportList::GetAudibility	(	int32_t	x,
		int32_t	y,
		int32_t *	pan,
		int32_t	audibility_radius = 0,
		int32_t *	out_player = nullptr
	)

Definition at line 1340 of file C4Viewport.cpp.

{
    // default audibility radius
    if (!audibility_radius)
    {
        audibility_radius = C4AudibilityRadius;
    }
    // Accumulate audibility by viewports
    int32_t audible = 0;
    *pan = 0;
    for (C4Viewport *viewport = FirstViewport; viewport; viewport = viewport->Next)
    {
        float distanceToCenterOfViewport = Distance(viewport->GetViewCenterX(), viewport->GetViewCenterY(), x, y);
        int32_t audibility = Clamp<int32_t>(100 - 100 * distanceToCenterOfViewport / C4AudibilityRadius, 0, 100);
        if (audibility > audible)
        {
            audible = audibility;
            if (out_player)
            {
                *out_player = viewport->Player;
            }
        }
        *pan += (x-(viewport->GetViewCenterX())) / 5;
    }
    *pan = Clamp<int32_t>(*pan, -100, 100);
    return audible;
}

References C4AudibilityRadius, Distance(), FirstViewport, and C4Viewport::Next.

Referenced by C4Object::Init(), and C4SoundInstance::SetVolumeByPos().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFirstViewport()

C4Viewport* C4ViewportList::GetFirstViewport ( )

inline

Definition at line 159 of file C4Viewport.h.

{ return FirstViewport; }

References FirstViewport.

Referenced by C4GraphicsSystem::DoSaveScreenshot(), FreeScroll(), C4Menu::GetViewport(), and ViewportNextPlayer().

Here is the caller graph for this function:

GetViewport()

C4Viewport * C4ViewportList::GetViewport	(	int32_t	player_nr,
		C4Viewport *	prev = nullptr
	)

Definition at line 1328 of file C4Viewport.cpp.

{
    for (C4Viewport *viewport = prev ? prev->Next : FirstViewport; viewport ; viewport = viewport ->Next)
    {
        if (viewport->Player == player || (player == NO_OWNER && viewport ->fIsNoOwnerViewport))
        {
            return viewport;
        }
    }
    return nullptr;
}

References FirstViewport, C4Viewport::Next, NO_OWNER, and C4ScriptGuiWindowPropertyName::player.

Referenced by C4MainMenu::ActivateObserver(), C4Game::DoKeyboardInput(), C4MainMenu::DoRefillInternal(), FreeScroll(), C4MainMenu::MenuCommand(), C4MouseControl::Move(), C4ScriptGuiWindow::OnMouseIn(), C4Player::SetViewMode(), C4MouseControl::UpdateClip(), C4FullScreen::ViewportCheck(), ViewportNextPlayer(), ViewportWinProc(), C4Player::ZoomLimitsToViewports(), and C4Player::ZoomToViewports().

Here is the caller graph for this function:

GetViewportCount()

int32_t C4ViewportList::GetViewportCount

(

)

Definition at line 1318 of file C4Viewport.cpp.

{
    int32_t amount = 0;
    for (C4Viewport *viewport = FirstViewport; viewport; viewport = viewport->Next)
    {
        amount++;
    }
    return amount;
}

References FirstViewport, and C4Viewport::Next.

Referenced by CloseViewport(), CreateViewport(), C4GraphicsSystem::FlashMessage(), and C4FullScreen::ViewportCheck().

Here is the caller graph for this function:

MouseMoveToViewport()

void C4ViewportList::MouseMoveToViewport ( int32_t  button, int32_t  x, int32_t  y, DWORD  key_param  )

protected

Definition at line 1463 of file C4Viewport.cpp.

{
    // Pass on to mouse controlled viewport
    for (C4Viewport *viewport = FirstViewport; viewport; viewport = viewport->Next)
    {
        if (::MouseControl.IsViewport(viewport))
        {
            ::MouseControl.Move( button,
                                 Clamp<int32_t>(x-viewport->OutX,0,viewport->ViewWdt-1),
                                 Clamp<int32_t>(y-viewport->OutY,0,viewport->ViewHgt-1),
                                 key_param );
        }
    }
}

References FirstViewport, C4MouseControl::IsViewport(), MouseControl, C4MouseControl::Move(), and C4Viewport::Next.

Referenced by C4GUI::Screen::MouseMove(), and C4GUI::Screen::SetMouseInGUI().

Here is the call graph for this function:

Here is the caller graph for this function:

RecalculateViewports()

void C4ViewportList::RecalculateViewports

(

)

Definition at line 1226 of file C4Viewport.cpp.

{
 
    // Fullscreen only
    if (Application.isEditor) return;
 
    // Sort viewports
    SortViewportsByPlayerControl();
 
    // Viewport area
    int32_t border_top = 0;
    if (Config.Graphics.UpperBoard)
    {
        border_top = C4UpperBoardHeight;
    }
    ViewportArea.Set(FullScreen.pSurface, 0, border_top, C4GUI::GetScreenWdt(), C4GUI::GetScreenHgt() - border_top);
 
    // Redraw flag
    ::GraphicsSystem.InvalidateBg();
#ifdef _WIN32
    // reset mouse clipping
    ClipCursor(nullptr);
#else
    // StdWindow handles this.
#endif
    // reset GUI dlg pos
    ::pGUI->SetPreferredDlgRect(C4Rect(ViewportArea.X, ViewportArea.Y, ViewportArea.Wdt, ViewportArea.Hgt));
 
    // fullscreen background: First, cover all of screen
    BackgroundAreas.Clear();
    BackgroundAreas.AddRect(C4Rect(ViewportArea.X, ViewportArea.Y, ViewportArea.Wdt, ViewportArea.Hgt));
 
    // Viewports
    C4Viewport *viewport;
    int32_t view_count = 0;
    for (viewport = FirstViewport; viewport; viewport = viewport->Next)
    {
        view_count++;
    }
    if (!view_count)
    {
        return;
    }
    int32_t iViewsH = (int32_t) sqrt(float(view_count));
    int32_t iViewsX = view_count / iViewsH;
    int32_t iViewsL = view_count % iViewsH;
    int32_t cViewH, cViewX, ciViewsX;
    int32_t cViewWdt, cViewHgt, cOffWdt, cOffHgt, cOffX, cOffY;
    viewport=FirstViewport;
    for (cViewH = 0; cViewH < iViewsH; cViewH++)
    {
        ciViewsX = iViewsX;
        if (cViewH < iViewsL)
        {
            ciViewsX++;
        }
        for (cViewX=0; cViewX < ciViewsX; cViewX++)
        {
            cViewWdt = ViewportArea.Wdt/ciViewsX;
            cViewHgt = ViewportArea.Hgt/iViewsH;
            cOffX = ViewportArea.X;
            cOffY = ViewportArea.Y;
            cOffWdt = cOffHgt = 0;
            if (ciViewsX * cViewWdt < ViewportArea.Wdt)
            {
                cOffX = (ViewportArea.Wdt - ciViewsX * cViewWdt) / 2;
            }
            if (iViewsH * cViewHgt < ViewportArea.Hgt)
            {
                cOffY = (ViewportArea.Hgt - iViewsH * cViewHgt) / 2 + ViewportArea.Y;
            }
            if (Config.Graphics.SplitscreenDividers)
            {
                if (cViewX < ciViewsX - 1) cOffWdt=4;
                if (cViewH < iViewsH - 1) cOffHgt=4;
            }
            int32_t coViewWdt = cViewWdt-cOffWdt;
            int32_t coViewHgt = cViewHgt-cOffHgt;
            C4Rect rcOut(cOffX+cViewX*cViewWdt, cOffY+cViewH*cViewHgt, coViewWdt, coViewHgt);
            viewport->SetOutputSize(rcOut.x,rcOut.y,rcOut.x,rcOut.y,rcOut.Wdt,rcOut.Hgt);
            viewport = viewport->Next;
            // clip down area avaiable for background drawing
            BackgroundAreas.ClipByRect(rcOut);
        }
    }
    // and finally recalculate script menus
    if (::Game.ScriptGuiRoot)
    {
        ::Game.ScriptGuiRoot->RequestLayoutUpdate();
    }
}

References C4RectList::AddRect(), Application, BackgroundAreas, C4UpperBoardHeight, C4RectList::Clear(), C4RectList::ClipByRect(), Config, FirstViewport, FullScreen, Game, C4GUI::GetScreenHgt(), C4GUI::GetScreenWdt(), C4Config::Graphics, GraphicsSystem, C4Facet::Hgt, C4Rect::Hgt, C4GraphicsSystem::InvalidateBg(), C4Application::isEditor, C4Viewport::Next, pGUI, C4Window::pSurface, C4Game::ScriptGuiRoot, C4Facet::Set(), C4Viewport::SetOutputSize(), C4GUI::Screen::SetPreferredDlgRect(), SortViewportsByPlayerControl(), C4ConfigGraphics::SplitscreenDividers, C4ConfigGraphics::UpperBoard, ViewportArea, C4Facet::Wdt, C4Rect::Wdt, C4Facet::X, C4Rect::x, C4Facet::Y, and C4Rect::y.

Referenced by CloseViewport(), CreateViewport(), C4GraphicsSystem::DoSaveScreenshot(), C4Game::InitFullscreenComponents(), C4Game::LoadScenarioSection(), C4MainMenu::MenuCommand(), and C4Game::OnResolutionChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

SortViewportsByPlayerControl()

void C4ViewportList::SortViewportsByPlayerControl

(

)

Definition at line 1368 of file C4Viewport.cpp.

{
 
    // Sort
    bool is_sorted;
    C4Player *player_a, *player_b;
    C4Viewport *viewport, *next, *prev;
    do
    {
        is_sorted = true;
        for (prev = nullptr, viewport = FirstViewport; viewport && (next = viewport->Next); viewport=next)
        {
            // Get players
            player_a = ::Players.Get(viewport->Player);
            player_b = ::Players.Get(next->Player);
            // Swap order
            if (player_a && player_b && player_a->ControlSet && player_b->ControlSet && ( player_a->ControlSet->GetLayoutOrder() > player_b->ControlSet->GetLayoutOrder() ))
            {
                if (prev) prev->Next = next; else FirstViewport = next;
                viewport->Next = next->Next;
                next->Next = viewport;
                prev = next;
                next = viewport;
                is_sorted = false;
            }
            // Don't swap
            else
            {
                prev = viewport;
            }
        }
    }
    while (!is_sorted);
 
}

References C4Player::ControlSet, FirstViewport, C4PlayerList::Get(), C4PlayerControlAssignmentSet::GetLayoutOrder(), C4Viewport::Next, and Players.

Referenced by RecalculateViewports().

Here is the call graph for this function:

Here is the caller graph for this function:

ViewportNextPlayer()

bool C4ViewportList::ViewportNextPlayer

(

)

Definition at line 1404 of file C4Viewport.cpp.

{
    // safety: switch valid?
    if ((!Game.C4S.Head.Film || !Game.C4S.Head.Replay) && !GetViewport(NO_OWNER))
    {
        return false;
    }
    // do switch then
    C4Viewport *viewport = GetFirstViewport();
    if (!viewport)
    {
        return false;
    }
    viewport->NextPlayer();
    return true;
}

References C4Game::C4S, C4SHead::Film, Game, GetFirstViewport(), GetViewport(), C4Scenario::Head, C4Viewport::NextPlayer(), NO_OWNER, and C4SHead::Replay.

Referenced by C4Game::InitKeyboard().

Here is the call graph for this function:

Here is the caller graph for this function:

ViewportZoomIn()

bool C4ViewportList::ViewportZoomIn

(

)

Definition at line 1457 of file C4Viewport.cpp.

{
    for (C4Viewport *viewport = FirstViewport; viewport; viewport = viewport->Next) viewport->ChangeZoom(C4GFX_ZoomStep);
    return true;
}

References C4GFX_ZoomStep, FirstViewport, and C4Viewport::Next.

Referenced by C4Game::InitKeyboard().

Here is the caller graph for this function:

ViewportZoomOut()

bool C4ViewportList::ViewportZoomOut

(

)

Definition at line 1451 of file C4Viewport.cpp.

{
    for (C4Viewport *viewport = FirstViewport; viewport; viewport = viewport->Next) viewport->ChangeZoom(1.0f/C4GFX_ZoomStep);
    return true;
}

References C4GFX_ZoomStep, FirstViewport, and C4Viewport::Next.

Referenced by C4Game::InitKeyboard().

Here is the caller graph for this function:

Friends And Related Function Documentation

C4GraphicsSystem

friend class C4GraphicsSystem

friend

Definition at line 177 of file C4Viewport.h.

C4GUI::Screen

friend class C4GUI::Screen

friend

Definition at line 176 of file C4Viewport.h.

Member Data Documentation

BackgroundAreas

C4RectList C4ViewportList::BackgroundAreas

protected

Definition at line 175 of file C4Viewport.h.

Referenced by DrawFullscreenBackground(), and RecalculateViewports().

FirstViewport

C4Viewport* C4ViewportList::FirstViewport {nullptr}

protected

Definition at line 173 of file C4Viewport.h.

Referenced by Clear(), ClearPointers(), CloseViewport(), CreateViewport(), DisableFoW(), EnableFoW(), Execute(), GetAudibility(), GetFirstViewport(), GetViewport(), GetViewportCount(), MouseMoveToViewport(), RecalculateViewports(), SortViewportsByPlayerControl(), ViewportZoomIn(), and ViewportZoomOut().

ViewportArea

C4Facet C4ViewportList::ViewportArea

protected

Definition at line 174 of file C4Viewport.h.

Referenced by C4ViewportList(), and RecalculateViewports().

---

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

• C4Viewport.h
• C4Viewport.cpp