C4MapFolderData Class Reference

#include <C4StartupScenSelDlg.h>

Public Member Functions
	C4MapFolderData ()=default
	~C4MapFolderData ()
void	Clear ()
bool	Load (C4Group &hGroup, C4ScenarioListLoader::Folder *pScenLoaderFolder)
void	CompileFunc (StdCompiler *pComp)
void	CreateGUIElements (C4StartupScenSelDlg *pMainDlg, C4GUI::Window &rContainer)
void	ResetSelection ()
C4GUI::TextWindow *	GetSelectionInfoBox () const
C4ScenarioListLoader::Entry *	GetSelectedEntry () const

Protected Member Functions
void	OnButtonScenario (C4GUI::Control *pEl)

Friends
class	C4StartupScenSelDlg

Detailed Description

Definition at line 277 of file C4StartupScenSelDlg.h.

Constructor & Destructor Documentation

C4MapFolderData()

C4MapFolderData::C4MapFolderData ( )

default

~C4MapFolderData()

C4MapFolderData::~C4MapFolderData ( )

inline

Definition at line 349 of file C4StartupScenSelDlg.h.

{ Clear(); }

References Clear().

Here is the call graph for this function:

Member Function Documentation

Clear()

void C4MapFolderData::Clear

(

)

Definition at line 91 of file C4StartupScenSelDlg.cpp.

{
    fCoordinatesAdjusted = false;
    fctBackgroundPicture.Clear();
    pScenarioFolder = nullptr;
    pSelectedEntry = nullptr;
    pSelectionInfoBox = nullptr;
    rcScenInfoArea.Set(0,0,0,0);
    MinResX=MinResY=0;
    fUseFullscreenMap=false;
    int i;
    for (i=0; i<iScenCount; ++i) delete ppScenList[i];
    iScenCount=0;
    delete [] ppScenList; ppScenList=nullptr;
    for (i=0; i<iAccessGfxCount; ++i) delete ppAccessGfxList[i];
    iAccessGfxCount=0;
    delete [] ppAccessGfxList; ppAccessGfxList=nullptr;
    pMainDlg = nullptr;
}

References C4FacetSurface::Clear(), and C4Rect::Set().

Referenced by Load(), and ~C4MapFolderData().

Here is the call graph for this function:

Here is the caller graph for this function:

CompileFunc()

void C4MapFolderData::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 184 of file C4StartupScenSelDlg.cpp.

{
    // core values
    pComp->Value(mkNamingAdapt( rcScenInfoArea, "ScenInfoArea", C4Rect(0,0,0,0)));
    pComp->Value(mkNamingAdapt( MinResX,        "MinResX",    0));
    pComp->Value(mkNamingAdapt( MinResY,        "MinResY",    0));
    pComp->Value(mkNamingAdapt( fUseFullscreenMap,"FullscreenBG",    false));
    // compile scenario list
    int32_t iOldScenCount = iScenCount;
    pComp->Value(mkNamingCountAdapt(iScenCount,  "Scenario"));
    if (pComp->isDeserializer())
    {
        while (iOldScenCount--) delete ppScenList[iOldScenCount];
        delete [] ppScenList;
        if (iScenCount)
        {
            ppScenList = new Scenario *[iScenCount];
            memset(ppScenList, 0, sizeof(Scenario *)*iScenCount);
        }
        else
            ppScenList = nullptr;
    }
    if (iScenCount)
    {
        mkPtrAdaptNoNull(*ppScenList);
        pComp->Value(mkNamingAdapt(mkArrayAdaptMap(ppScenList, iScenCount, mkPtrAdaptNoNull<Scenario>), "Scenario"));
    }
    // compile access gfx list
    int32_t iOldAccesGfxCount = iAccessGfxCount;
    pComp->Value(mkNamingCountAdapt(iAccessGfxCount,  "AccessGfx"));
    if (pComp->isDeserializer())
    {
        while (iOldAccesGfxCount--) delete ppAccessGfxList[iOldAccesGfxCount];
        delete [] ppAccessGfxList;
        if (iAccessGfxCount)
        {
            ppAccessGfxList = new AccessGfx *[iAccessGfxCount];
            memset(ppAccessGfxList, 0, sizeof(AccessGfx *)*iAccessGfxCount);
        }
        else
            ppAccessGfxList = nullptr;
    }
    if (iAccessGfxCount)
    {
        mkPtrAdaptNoNull(*ppAccessGfxList);
        pComp->Value(mkNamingAdapt(mkArrayAdaptMap(ppAccessGfxList, iAccessGfxCount, mkPtrAdaptNoNull<AccessGfx>), "AccessGfx"));
    }
}

References StdCompiler::isDeserializer(), mkArrayAdaptMap(), mkNamingAdapt(), mkNamingCountAdapt(), mkPtrAdaptNoNull(), and StdCompiler::Value().

Here is the call graph for this function:

CreateGUIElements()

void C4MapFolderData::CreateGUIElements	(	C4StartupScenSelDlg *	pMainDlg,
		C4GUI::Window &	rContainer
	)

Definition at line 300 of file C4StartupScenSelDlg.cpp.

{
    this->pMainDlg = pMainDlg;
    // convert all coordinates to match the container sizes
    // do this only once; assume container won't change between loads
    if (!fCoordinatesAdjusted)
    {
        if (!fUseFullscreenMap)
            ConvertFacet2ScreenCoord(rContainer.GetClientRect(), true);
        else
        {
            C4Rect rcMapRect = pMainDlg->GetBounds();
            rContainer.ClientPos2ScreenPos(rcMapRect.x, rcMapRect.y);
            ConvertFacet2ScreenCoord(rcMapRect, false);
        }
    }
    // empty any previous stuff in container
    while (rContainer.GetFirst()) delete rContainer.GetFirst();
    // create background image
    if (!fUseFullscreenMap)
        rContainer.AddElement(new MapPic(rcfBG, fctBackgroundPicture));
    else
    {
        pMainDlg->SetBackground(&fctBackgroundPicture);
    }
    // create mission access overlays
    int i;
    for (i=0; i<iAccessGfxCount; ++i)
    {
        AccessGfx *pGfx = ppAccessGfxList[i];
        const char *szPassword = pGfx->sPassword.getData();
        if (!szPassword || !*szPassword || SIsModule(Config.General.MissionAccess, szPassword))
        {
            // ACCESS TO GFX GRANTED: draw it
            rContainer.AddElement(new MapPic(pGfx->rcfOverlayPos, pGfx->fctOverlay));
        }
    }
    // create buttons for scenarios
    C4GUI::Button *pBtnFirst = nullptr;
    for (i=0; i<iScenCount; ++i)
    {
        Scenario *pScen = ppScenList[i];
        if (pScen->pScenEntry && !pScen->pScenEntry->HasMissionAccess())
        {
            // no access to this scenario: Do not create a button at all; not even base image. The scenario is "invisible".
        }
        else
        {
            C4GUI::CallbackButtonEx<C4StartupScenSelDlg, C4GUI::FacetButton> *pBtn = new C4GUI::CallbackButtonEx<C4StartupScenSelDlg, C4GUI::FacetButton>
            (pScen->fctBase, pScen->fctOverlay, pScen->rcfOverlayPos, 0, pMainDlg, &C4StartupScenSelDlg::OnButtonScenario);
            ppScenList[i]->pBtn = pBtn;
            if (pScen->pScenEntry)
                pBtn->SetToolTip(FormatString(LoadResStr("IDS_MSG_MAP_STARTSCEN"), pScen->pScenEntry->GetName().getData()).getData());
            if (pScen->sTitle.getLength()>0)
            {
                pBtn->SetText(pScen->sTitle.getData());
                pBtn->SetTextColors(pScen->dwTitleInactClr, pScen->dwTitleActClr);
                pBtn->SetTextPos(pScen->iTitleOffX, pScen->iTitleOffY, pScen->byTitleAlign);
                CStdFont *pUseFont; float fFontZoom=1.0f;
                if (pScen->fTitleBookFont)
                    pUseFont = &(C4Startup::Get()->Graphics.GetBlackFontByHeight(pScen->iTitleFontSize, &fFontZoom));
                else
                    pUseFont = &(::GraphicsResource.GetFontByHeight(pScen->iTitleFontSize, &fFontZoom));
                if (Inside<float>(fFontZoom, 0.8f, 1.25f)) fFontZoom = 1.0f; // some tolerance for font zoom
                pBtn->SetTextFont(pUseFont, fFontZoom);
            }
            rContainer.AddElement(pBtn);
            if (!pBtnFirst) pBtnFirst = pBtn;
        }
    }
    // create scenario info listbox
    pSelectionInfoBox = new C4GUI::TextWindow(rcScenInfoArea,
        C4StartupScenSel_TitlePictureWdt+2*C4StartupScenSel_TitleOverlayMargin, C4StartupScenSel_TitlePictureHgt+2*C4StartupScenSel_TitleOverlayMargin,
        C4StartupScenSel_TitlePicturePadding, 100, 4096, nullptr, true, &C4Startup::Get()->Graphics.fctScenSelTitleOverlay, C4StartupScenSel_TitleOverlayMargin);
    pSelectionInfoBox->SetDecoration(false, false, &C4Startup::Get()->Graphics.sfctBookScroll, true);
    rContainer.AddElement(pSelectionInfoBox);
}

References C4GUI::Container::AddElement(), C4StartupScenSel_TitleOverlayMargin, C4StartupScenSel_TitlePictureHgt, C4StartupScenSel_TitlePicturePadding, C4StartupScenSel_TitlePictureWdt, C4GUI::Element::ClientPos2ScreenPos(), Config, FormatString(), C4Config::General, C4Startup::Get(), C4StartupGraphics::GetBlackFontByHeight(), C4GUI::Element::GetBounds(), C4GUI::Window::GetClientRect(), StdStrBuf::getData(), C4GUI::Container::GetFirst(), C4GraphicsResource::GetFontByHeight(), C4Startup::Graphics, GraphicsResource, LoadResStr(), C4ConfigGeneral::MissionAccess, C4StartupScenSelDlg::OnButtonScenario(), C4StartupScenSelDlg::SetBackground(), C4GUI::TextWindow::SetDecoration(), C4GUI::Button::SetText(), C4GUI::Element::SetToolTip(), SIsModule(), C4Rect::x, and C4Rect::y.

Here is the call graph for this function:

GetSelectedEntry()

C4ScenarioListLoader::Entry* C4MapFolderData::GetSelectedEntry ( ) const

inline

Definition at line 369 of file C4StartupScenSelDlg.h.

{ return pSelectedEntry; }

GetSelectionInfoBox()

C4GUI::TextWindow* C4MapFolderData::GetSelectionInfoBox ( ) const

inline

Definition at line 368 of file C4StartupScenSelDlg.h.

{ return pSelectionInfoBox; }

Load()

bool C4MapFolderData::Load	(	C4Group &	hGroup,
		C4ScenarioListLoader::Folder *	pScenLoaderFolder
	)

Definition at line 111 of file C4StartupScenSelDlg.cpp.

{
    // clear previous
    Clear();
    // load localization info
    C4LangStringTable LangTable;
    bool fHasLangTable = C4Language::LoadComponentHost(&LangTable, hGroup, C4CFN_ScriptStringTbl, Config.General.LanguageEx);
    // load core data
    StdStrBuf Buf;
    if (!hGroup.LoadEntryString(C4CFN_MapFolderData, &Buf)) return false;
    if (fHasLangTable) LangTable.ReplaceStrings(Buf);
    if (!CompileFromBuf_LogWarn<StdCompilerINIRead>(mkNamingAdapt(*this, "FolderMap"), Buf, C4CFN_MapFolderData)) return false;
    // check resolution requirement
    if (MinResX && MinResX>C4GUI::GetScreenWdt()) return false;
    if (MinResY && MinResY>C4GUI::GetScreenHgt()) return false;
    // load images
    if (!fctBackgroundPicture.Load(hGroup, C4CFN_MapFolderBG, C4FCT_Full, C4FCT_Full, false, 0))
    {
        DebugLogF(R"(C4MapFolderData::Load(%s): Could not load background graphic "%s")", hGroup.GetName(), C4CFN_MapFolderBG);
        return false;
    }
    int i;
    for (i=0; i<iScenCount; ++i)
    {
        // init scenario entry stuff
        Scenario *pScen = ppScenList[i];
        pScen->pScenEntry = pScenLoaderFolder->FindEntryByName(pScen->sFilename.getData());
        pScen->pBtn = nullptr;
        pScen->sTitle.Replace("TITLE", pScen->pScenEntry ? pScen->pScenEntry->GetName().getData() : "<c ff0000>ERROR</c>" /* scenario not loaded; title cannot be referenced */);
        // developer image dump
        if (pScen->fImgDump)
        {
            C4FacetSurface fctDump; bool fSuccess=false;
            if (fctDump.Create(pScen->rcOverlayPos.Wdt, pScen->rcOverlayPos.Hgt, C4FCT_Full, C4FCT_Full))
            {
                pDraw->Blit(fctBackgroundPicture.Surface,
                              (float) pScen->rcOverlayPos.x, (float) pScen->rcOverlayPos.y,
                              (float) pScen->rcOverlayPos.Wdt, (float) pScen->rcOverlayPos.Hgt,
                              fctDump.Surface,
                              0, 0,
                              fctDump.Wdt, fctDump.Hgt);
                fSuccess = fctDump.Surface->SavePNG(pScen->sBaseImage.getData(), true, false, false);
            }
            if (!fSuccess)
                DebugLogF(R"(C4MapFolderData::Load(%s): Could not dump graphic "%s")", hGroup.GetName(), pScen->sBaseImage.getData());
            continue;
        }
        // load images
        if (pScen->sBaseImage.getLength()>0) if (!pScen->fctBase.Load(hGroup, pScen->sBaseImage.getData(), C4FCT_Full, C4FCT_Full, false, 0))
            {
                DebugLogF(R"(C4MapFolderData::Load(%s): Could not load base graphic "%s")", hGroup.GetName(), pScen->sBaseImage.getData());
                return false;
            }
        if (pScen->sOverlayImage.getLength()>0) if (!pScen->fctOverlay.Load(hGroup, pScen->sOverlayImage.getData(), C4FCT_Full, C4FCT_Full, false, 0))
            {
                DebugLogF(R"(C4MapFolderData::Load(%s): Could not load graphic "%s")", hGroup.GetName(), pScen->sOverlayImage.getData());
                return false;
            }
    }
    for (i=0; i<iAccessGfxCount; ++i)
    {
        AccessGfx *pGfx= ppAccessGfxList[i];
        if (pGfx->sOverlayImage.getLength()>0) if (!pGfx->fctOverlay.Load(hGroup, pGfx->sOverlayImage.getData(), C4FCT_Full, C4FCT_Full, false, 0))
            {
                DebugLogF(R"(C4MapFolderData::Load(%s): Could not load graphic "%s")", hGroup.GetName(), pGfx->sOverlayImage.getData());
                return false;
            }
    }
    // all loaded
    pScenarioFolder = pScenLoaderFolder;
    return true;
}

References C4Draw::Blit(), C4CFN_MapFolderBG, C4CFN_MapFolderData, C4CFN_ScriptStringTbl, C4FCT_Full, Clear(), Config, C4FacetSurface::Create(), DebugLogF(), C4ScenarioListLoader::Folder::FindEntryByName(), C4Config::General, C4Group::GetName(), C4GUI::GetScreenHgt(), C4GUI::GetScreenWdt(), C4Facet::Hgt, C4ConfigGeneral::LanguageEx, C4FacetSurface::Load(), C4Language::LoadComponentHost(), C4Group::LoadEntryString(), mkNamingAdapt(), pDraw, C4LangStringTable::ReplaceStrings(), C4Surface::SavePNG(), C4Facet::Surface, C4Facet::Wdt, and C4Surface::Wdt.

Here is the call graph for this function:

OnButtonScenario()

void C4MapFolderData::OnButtonScenario ( C4GUI::Control *  pEl )

protected

Definition at line 378 of file C4StartupScenSelDlg.cpp.

{
    // get associated scenario entry
    int i;
    for (i=0; i<iScenCount; ++i)
        if (pEl == ppScenList[i]->pBtn)
            break;
    if (i == iScenCount) return;
    // select the associated entry
    pSelectedEntry = ppScenList[i]->pScenEntry;
}

Referenced by C4StartupScenSelDlg::OnButtonScenario().

Here is the caller graph for this function:

ResetSelection()

void C4MapFolderData::ResetSelection

(

)

Definition at line 390 of file C4StartupScenSelDlg.cpp.

{
    pSelectedEntry = nullptr;
}

Referenced by C4StartupScenSelDlg::DeselectAll().

Here is the caller graph for this function:

Friends And Related Function Documentation

C4StartupScenSelDlg

friend class C4StartupScenSelDlg

friend

Definition at line 359 of file C4StartupScenSelDlg.h.

---

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

• C4StartupScenSelDlg.h
• C4StartupScenSelDlg.cpp