C4LoaderScreen Class Reference

#include <C4LoaderScreen.h>

Collaboration diagram for C4LoaderScreen:

Public Types
enum	Flag : int {   BLACK = 0x00 , BACKGROUND = 0x01 , TITLE = 0x02 , PROGRESS = 0x04 ,   LOG = 0x08 , PROCESS = 0x0f , ALL = 0xFF }

Public Member Functions
	C4LoaderScreen ()
	~C4LoaderScreen ()
bool	Init (std::string szLoaderSpec)
void	SetBlackScreen (bool fIsBlack)
void	Draw (C4Facet &cgo, Flag options=Flag::ALL, int iProgress=0, class C4LogBuffer *pLog=nullptr, int Process=0)

Protected Member Functions
void	SeekLoaderScreens (C4Group &rFromGrp, const std::string &wildcard)

Protected Attributes
C4FacetSurface	fctBackground
char *	szInfo
bool	fBlackScreen
std::map< C4Group *, const std::string >	loaders

Detailed Description

Definition at line 24 of file C4LoaderScreen.h.

Member Enumeration Documentation

Flag

enum C4LoaderScreen::Flag : int

Enumerator
BLACK
BACKGROUND
TITLE
PROGRESS
LOG
PROCESS
ALL

Definition at line 27 of file C4LoaderScreen.h.

             : int {
        BLACK = 0x00,
        BACKGROUND = 0x01,
        TITLE = 0x02,
        PROGRESS = 0x04,
        LOG = 0x08,
        PROCESS = 0x0f,
 
        // All of the above
        ALL = 0xFF
    };

Constructor & Destructor Documentation

C4LoaderScreen()

C4LoaderScreen::C4LoaderScreen

(

)

Definition at line 29 of file C4LoaderScreen.cpp.

{
    // zero fields
    szInfo=nullptr;
    fBlackScreen = false;
}

References fBlackScreen, and szInfo.

~C4LoaderScreen()

C4LoaderScreen::~C4LoaderScreen

(

)

Definition at line 36 of file C4LoaderScreen.cpp.

{
    // clear fields
    if (szInfo) delete [] szInfo;
}

References szInfo.

Member Function Documentation

Draw()

void C4LoaderScreen::Draw	(	C4Facet &	cgo,
		Flag	options = Flag::ALL,
		int	iProgress = 0,
		class C4LogBuffer *	pLog = nullptr,
		int	Process = 0
	)

Definition at line 118 of file C4LoaderScreen.cpp.

{
    // simple black screen loader?
    if (fBlackScreen || options == Flag::BLACK)
    {
        pDraw->FillBG();
        return;
    }
    // cgo.X/Y is assumed 0 here...
    // fixed positions for now
    int iHIndent=20;
    int iVIndent=20;
    int iLogBoxHgt=84;
    int iLogBoxMargin=2;
    int iVMargin=5;
    int iProgressBarHgt=15;
    CStdFont &LogFont=::GraphicsResource.FontTiny, &rProgressBarFont=::GraphicsResource.FontRegular;
    CStdFont &TitleFont = ::GraphicsResource.FontTitle;
    float fLogBoxFontZoom=1.0f;
 
    if (options & Flag::BACKGROUND) {
        // Background (loader)
        fctBackground.DrawFullScreen(cgo);
    }
 
    if (options & Flag::TITLE) {
        // draw scenario title
        pDraw->StringOut(Game.ScenarioTitle.getData(), TitleFont, 1.0f, cgo.Surface, cgo.Wdt - iHIndent, cgo.Hgt - iVIndent - iLogBoxHgt - iVMargin - iProgressBarHgt - iVMargin - TitleFont.GetLineHeight(), 0xdddddddd, ARight, false);
    }
 
    if (options & Flag::PROGRESS) {
        // draw progress bar
        pDraw->DrawBoxDw(cgo.Surface, iHIndent, cgo.Hgt - iVIndent - iLogBoxHgt - iVMargin - iProgressBarHgt, cgo.Wdt - iHIndent, cgo.Hgt - iVIndent - iLogBoxHgt - iVMargin, 0xb0000000);
        int iProgressBarWdt = cgo.Wdt - iHIndent * 2 - 2;
        if (::GraphicsResource.fctProgressBar.Surface)
        {
            ::GraphicsResource.fctProgressBar.DrawX(cgo.Surface, iHIndent + 1, cgo.Hgt - iVIndent - iLogBoxHgt - iVMargin - iProgressBarHgt + 1, iProgressBarWdt*iProgress / 100, iProgressBarHgt - 2);
        }
        else
        {
            pDraw->DrawBoxDw(cgo.Surface, iHIndent + 1, cgo.Hgt - iVIndent - iLogBoxHgt - iVMargin - iProgressBarHgt + 1, iHIndent + 1 + iProgressBarWdt*iProgress / 100, cgo.Hgt - iVIndent - iLogBoxHgt - iVMargin - 1, 0xb0ff0000);
        }
        pDraw->StringOut(FormatString("%i%%", iProgress).getData(), rProgressBarFont, 1.0f, cgo.Surface,
            cgo.Wdt / 2, cgo.Hgt - iVIndent - iLogBoxHgt - iVMargin - rProgressBarFont.GetLineHeight() / 2 - iProgressBarHgt / 2, 0xffffffff,
            ACenter, true);
    }
 
    if (options & Flag::LOG) {
        // draw log box
        if (pLog)
        {
            pDraw->DrawBoxDw(cgo.Surface, iHIndent, cgo.Hgt - iVIndent - iLogBoxHgt, cgo.Wdt - iHIndent, cgo.Hgt - iVIndent, 0x7f000000);
            int iLineHgt = int(fLogBoxFontZoom*LogFont.GetLineHeight()); if (!iLineHgt) iLineHgt = 5;
            int iLinesVisible = (iLogBoxHgt - 2 * iLogBoxMargin) / iLineHgt;
            int iX = iHIndent + iLogBoxMargin;
            int iY = cgo.Hgt - iVIndent - iLogBoxHgt + iLogBoxMargin;
            int32_t w, h;
            for (int i = -iLinesVisible; i < 0; ++i)
            {
                const char *szLine = pLog->GetLine(i, nullptr, nullptr, nullptr);
                if (!szLine || !*szLine) continue;
                LogFont.GetTextExtent(szLine, w, h, true);
                pDraw->TextOut(szLine, LogFont, fLogBoxFontZoom, cgo.Surface, iX, iY);
                iY += h;
            }
 
            if (options & Flag::PROCESS) {
                // append process text
                if (Process)
                {
                    iY -= h; iX += w;
                    pDraw->TextOut(FormatString("%i%%", (int)Process).getData(), LogFont, fLogBoxFontZoom, cgo.Surface, iX, iY);
                }
            }
        }
    }
}

References ACenter, ARight, C4Draw::DrawBoxDw(), C4Facet::DrawFullScreen(), C4Facet::DrawX(), fBlackScreen, fctBackground, C4GraphicsResource::fctProgressBar, C4Draw::FillBG(), C4GraphicsResource::FontRegular, C4GraphicsResource::FontTiny, C4GraphicsResource::FontTitle, FormatString(), Game, StdStrBuf::getData(), C4LogBuffer::GetLine(), CStdFont::GetLineHeight(), CStdFont::GetTextExtent(), GraphicsResource, C4Facet::Hgt, pDraw, C4Game::ScenarioTitle, C4Draw::StringOut(), C4Facet::Surface, C4Draw::TextOut(), and C4Facet::Wdt.

Referenced by C4MessageBoard::Draw(), and C4GUI::Screen::Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

Init()

bool C4LoaderScreen::Init

(

std::string

szLoaderSpec

)

Definition at line 42 of file C4LoaderScreen.cpp.

{
    // Determine loader specification
    if (loaderSpec.empty())
        loaderSpec = "Loader*";
 
    C4Group *pGroup = nullptr;
    // query groups of equal priority in set
    while ((pGroup=Game.GroupSet.FindGroup(C4GSCnt_Loaders, pGroup, true)))
    {
        SeekLoaderScreens(*pGroup, loaderSpec);
    }
    // nothing found? seek in main gfx grp
    C4Group GfxGrp;
    if (loaders.empty())
    {
        // open it
        GfxGrp.Close();
        if (!Reloc.Open(GfxGrp, C4CFN_Graphics))
        {
            LogFatal(FormatString(LoadResStr("IDS_PRC_NOGFXFILE"),C4CFN_Graphics,GfxGrp.GetError()).getData());
            return false;
        }
        // seek for loaders
        SeekLoaderScreens(GfxGrp, loaderSpec);
 
        // Still nothing found: fall back to general loader spec in main graphics group
        if (loaders.empty())
        {
            SeekLoaderScreens(GfxGrp, "Loader*");
        }
        // Not even default loaders available? Fail.
        if (loaders.empty())
        {
            LogFatal(FormatString("No loaders found for loader specification: %s", loaderSpec.c_str()).getData());
            return false;
        }
    }
 
    // choose random loader
    auto entry = loaders.begin();
    std::advance(entry, UnsyncedRandom(loaders.size()));
 
    // load loader
    fctBackground.GetFace().SetBackground();
    if (!fctBackground.Load(*(entry->first), entry->second.c_str(), C4FCT_Full, C4FCT_Full, true, 0)) return false;
 
    // load info
    if (szInfo) { delete [] szInfo; szInfo=nullptr; }
 
    // done, success!
    return true;
}

References C4CFN_Graphics, C4FCT_Full, C4GSCnt_Loaders, C4Group::Close(), fctBackground, C4GroupSet::FindGroup(), FormatString(), Game, StdStrBuf::getData(), C4Group::GetError(), C4FacetSurface::GetFace(), C4Game::GroupSet, C4FacetSurface::Load(), loaders, LoadResStr(), LogFatal(), C4Reloc::Open(), Reloc, SeekLoaderScreens(), C4Surface::SetBackground(), szInfo, and UnsyncedRandom().

Referenced by C4GraphicsSystem::InitLoaderScreen().

Here is the call graph for this function:

Here is the caller graph for this function:

SeekLoaderScreens()

void C4LoaderScreen::SeekLoaderScreens ( C4Group &  rFromGrp, const std::string &  wildcard  )

protected

Definition at line 103 of file C4LoaderScreen.cpp.

{
    // seek for png, jpg, jpeg, bmp
    char filename[_MAX_PATH_LEN];
    for (bool found = rFromGrp.FindEntry(wildcard.c_str(), filename); found; found = rFromGrp.FindNextEntry(wildcard.c_str(), filename))
    {
        // potential candidate - check file extension
        std::string extension{ GetExtension(filename) };
        std::transform(extension.begin(), extension.end(), extension.begin(), ::tolower);
        if (extension == "png" || extension == "jpg" || extension == "jpeg" || extension == "bmp") {
            loaders.emplace(&rFromGrp, std::string(filename));
        }
    }
}

References _MAX_PATH_LEN, C4Group::FindEntry(), C4Group::FindNextEntry(), GetExtension(), and loaders.

Referenced by Init().

Here is the call graph for this function:

Here is the caller graph for this function:

SetBlackScreen()

void C4LoaderScreen::SetBlackScreen

(

bool

fIsBlack

)

Definition at line 96 of file C4LoaderScreen.cpp.

{
    // enabled/disables drawing of loader screen
    fBlackScreen = fIsBlack;
    // will be updated when drawn next time
}

References fBlackScreen.

Referenced by C4GraphicsSystem::EnableLoaderDrawing(), and C4GraphicsSystem::InitLoaderScreen().

Here is the caller graph for this function:

Member Data Documentation

fBlackScreen

bool C4LoaderScreen::fBlackScreen

protected

Definition at line 42 of file C4LoaderScreen.h.

Referenced by C4LoaderScreen(), Draw(), and SetBlackScreen().

fctBackground

C4FacetSurface C4LoaderScreen::fctBackground

protected

Definition at line 40 of file C4LoaderScreen.h.

Referenced by Draw(), and Init().

loaders

std::map<C4Group*, const std::string> C4LoaderScreen::loaders

protected

Definition at line 44 of file C4LoaderScreen.h.

Referenced by Init(), and SeekLoaderScreens().

szInfo

char* C4LoaderScreen::szInfo

protected

Definition at line 41 of file C4LoaderScreen.h.

Referenced by C4LoaderScreen(), Init(), and ~C4LoaderScreen().

---

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

• C4LoaderScreen.h
• C4LoaderScreen.cpp