C4Sky Class Reference

#include <C4Sky.h>

Collaboration diagram for C4Sky:

Public Member Functions
	C4Sky ()
	~C4Sky ()
void	Default ()
bool	Init (bool fSavegame, std::string names="")
void	Clear ()
void	SetColor (int32_t iIndex, int32_t iRed, int32_t iGreen, int32_t iBlue)
void	SetFadePalette (int32_t *ipColors)
void	Draw (C4TargetFacet &cgo)
DWORD	GetSkyFadeClr (int32_t iY)
void	Execute ()
bool	SetModulation (DWORD dwWithClr, DWORD dwBackClr)
DWORD	GetModulation (bool fBackClr)
void	CompileFunc (StdCompiler *pComp)

Public Attributes
class C4Surface *	Surface
C4Shader	Shader
C4Shader	ShaderLight
C4Real	xdir
C4Real	ydir
C4Real	x
C4Real	y
int32_t	ParX
int32_t	ParY
uint32_t	FadeClr1
uint32_t	FadeClr2
int32_t	ParallaxMode

Protected Attributes
int32_t	Width
int32_t	Height
uint32_t	Modulation
int32_t	BackClr
bool	BackClrEnabled

Detailed Description

Definition at line 28 of file C4Sky.h.

Constructor & Destructor Documentation

C4Sky()

C4Sky::C4Sky ( )

inline

Definition at line 31 of file C4Sky.h.

{ Default(); }

References Default().

Here is the call graph for this function:

~C4Sky()

C4Sky::~C4Sky

(

)

Definition at line 154 of file C4Sky.cpp.

{
    Clear();
}

References Clear().

Here is the call graph for this function:

Member Function Documentation

Clear()

void C4Sky::Clear

(

)

Definition at line 159 of file C4Sky.cpp.

{
    Shader.Clear();
    ShaderLight.Clear();
    delete Surface; Surface=nullptr;
    Modulation=0xffffffff;
}

References C4Shader::Clear(), Modulation, Shader, ShaderLight, and Surface.

Referenced by ~C4Sky().

Here is the call graph for this function:

Here is the caller graph for this function:

CompileFunc()

void C4Sky::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 237 of file C4Sky.cpp.

{
    pComp->Value(mkNamingAdapt(mkCastIntAdapt(x),   "X",                     Fix0));
    pComp->Value(mkNamingAdapt(mkCastIntAdapt(y),   "Y",                     Fix0));
    pComp->Value(mkNamingAdapt(mkCastIntAdapt(xdir),"XDir",                  Fix0));
    pComp->Value(mkNamingAdapt(mkCastIntAdapt(ydir),"YDir",                  Fix0));
    pComp->Value(mkNamingAdapt(Modulation,      "Modulation",            0xffffffffU));
    pComp->Value(mkNamingAdapt(ParX,            "ParX",                  10));
    pComp->Value(mkNamingAdapt(ParY,            "ParY",                  10));
    pComp->Value(mkNamingAdapt(ParallaxMode,    "ParMode",               C4SkyPM_Fixed));
    pComp->Value(mkNamingAdapt(BackClr,         "BackClr",               0));
    pComp->Value(mkNamingAdapt(BackClrEnabled,  "BackClrEnabled",        false));
}

References BackClr, BackClrEnabled, C4SkyPM_Fixed, Fix0, mkCastIntAdapt(), mkNamingAdapt(), Modulation, ParallaxMode, ParX, ParY, StdCompiler::Value(), x, xdir, y, and ydir.

Here is the call graph for this function:

Default()

void C4Sky::Default

(

)

Definition at line 142 of file C4Sky.cpp.

{
    Width=Height=0;
    Surface=nullptr;
    x=y=xdir=ydir=0;
    Modulation=0xffffffff;
    ParX=ParY=10;
    ParallaxMode=C4SkyPM_Fixed;
    BackClr=0;
    BackClrEnabled=false;
}

References BackClr, BackClrEnabled, C4SkyPM_Fixed, Height, Modulation, ParallaxMode, ParX, ParY, Surface, Width, x, xdir, y, and ydir.

Referenced by C4Sky().

Here is the caller graph for this function:

Draw()

void C4Sky::Draw

(

C4TargetFacet &

cgo

)

Definition at line 180 of file C4Sky.cpp.

{
    // background color?
    if (BackClrEnabled) pDraw->DrawBoxDw(cgo.Surface, cgo.X, cgo.Y, cgo.X+cgo.Wdt, cgo.Y+cgo.Hgt, BackClr);
    // sky surface?
    if (Modulation != 0xffffffff) pDraw->ActivateBlitModulation(Modulation);
    C4ShaderCall call(pDraw->GetFoW() ? &ShaderLight : &Shader); // call is started in C4Draw
    if (Surface)
    {
        // blit parallax sky
        float zoom = cgo.Zoom;
        float targetx = cgo.TargetX; float targety = cgo.TargetY;
 
        float parx = 10.0f / ParX; float pary = 10.0f / ParY;
        float par = parx; //todo: pary?
 
        // Step 1: project to landscape coordinates
        float resultzoom = 1.0 / (1.0 - (par - par/zoom));
 
        float rx = ((1 - parx) * targetx) * resultzoom + fixtof(x) / (parx + zoom - parx * zoom);
        float ry = ((1 - pary) * targety) * resultzoom + fixtof(y) / (pary + zoom - pary * zoom);
 
        // Step 2: convert to screen coordinates
        float resultx = (rx - targetx) * zoom / resultzoom;
        float resulty = (ry - targety) * zoom / resultzoom;
 
        ZoomDataStackItem zdsi(resultzoom);
 
        pDraw->BlitSurfaceTile(Surface, cgo.Surface, cgo.X, cgo.Y, cgo.Wdt * zoom / resultzoom, cgo.Hgt * zoom / resultzoom, -resultx, -resulty, &call);
    }
    else
    {
        // no sky surface: blit sky fade
        DWORD dwClr1=GetSkyFadeClr(cgo.TargetY);
        DWORD dwClr2=GetSkyFadeClr(cgo.TargetY+cgo.Hgt);
        pDraw->DrawBoxFade(cgo.Surface, cgo.X, cgo.Y, cgo.Wdt, cgo.Hgt, dwClr1, dwClr1, dwClr2, dwClr2, &call);
    }
    if (Modulation != 0xffffffff) pDraw->DeactivateBlitModulation();
    // done
}

References C4Draw::ActivateBlitModulation(), BackClr, BackClrEnabled, C4Draw::BlitSurfaceTile(), C4Draw::DeactivateBlitModulation(), C4Draw::DrawBoxDw(), C4Draw::DrawBoxFade(), fixtof(), C4Draw::GetFoW(), GetSkyFadeClr(), C4Facet::Hgt, Modulation, ParX, ParY, pDraw, Shader, ShaderLight, C4Facet::Surface, Surface, C4TargetFacet::TargetX, C4TargetFacet::TargetY, C4Facet::Wdt, C4Facet::X, x, C4Facet::Y, y, and C4TargetFacet::Zoom.

Referenced by C4Viewport::Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

Execute()

void C4Sky::Execute

(

)

Definition at line 167 of file C4Sky.cpp.

{
    // surface exists?
    if (!Surface) return;
    // advance pos
    x+=xdir; y+=ydir;
    // clip by bounds
    if (x>=itofix(Width)) x-=itofix(Width);
    if (y>=itofix(Height)) y-=itofix(Height);
    // update speed
    if (ParallaxMode == C4SkyPM_Wind) xdir=C4REAL100(::Weather.Wind);
}

References C4REAL100(), C4SkyPM_Wind, Height, itofix(), ParallaxMode, Surface, Weather, Width, C4Weather::Wind, x, xdir, y, and ydir.

Here is the call graph for this function:

GetModulation()

DWORD C4Sky::GetModulation ( bool  fBackClr )

inline

Definition at line 43 of file C4Sky.h.

    { return fBackClr ? BackClr : Modulation; }

References BackClr, and Modulation.

GetSkyFadeClr()

DWORD C4Sky::GetSkyFadeClr

(

int32_t

iY

)

Definition at line 221 of file C4Sky.cpp.

{
    int32_t iPos2=(iY*256)/::Landscape.GetHeight(); int32_t iPos1=256-iPos2;
    return (((((FadeClr1&0xff00ff)*iPos1 + (FadeClr2&0xff00ff)*iPos2) & 0xff00ff00)
             | (((FadeClr1&0x00ff00)*iPos1 + (FadeClr2&0x00ff00)*iPos2) & 0x00ff0000))>>8)
           | (FadeClr1 & 0xff000000);
}

References FadeClr1, FadeClr2, C4Landscape::GetHeight(), and Landscape.

Referenced by Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

Init()

bool C4Sky::Init	(	bool	fSavegame,
		std::string	names = ""
	)

Definition at line 46 of file C4Sky.cpp.

{
    // reset scrolling pos+speed
    // not in savegame, because it will have been loaded from game data there
    if (!fSavegame)
    {
        x=y=xdir=ydir=0; ParX=ParY=10; ParallaxMode=0;
    }
 
    // Check for sky bitmap in scenario file
    Surface = new C4Surface();
    bool loaded = false;
    if (names.empty())
    {
        loaded = !!Surface->LoadAny(Game.ScenarioFile,C4CFN_Sky,true,true, C4SF_Tileable | C4SF_MipMap);
    }
 
    // Else, evaluate scenario core landscape sky default list
    if (!loaded)
    {
        if (names.empty()) names = Game.C4S.Landscape.SkyDef;
        static std::regex separator(R"([,;\s]+)");
        std::vector<std::string> parts;
        std::copy(
                std::sregex_token_iterator(names.begin(), names.end(), separator, -1),
                std::sregex_token_iterator(),
                std::back_inserter(parts));
 
        auto name = parts.at(SeededRandom(Game.RandomSeed, parts.size()));
        // Sky tile specified, try load
        if (name != "Default")
        {
            // Check for sky tile in scenario file
            loaded = !!Surface->LoadAny(Game.ScenarioFile, name.c_str(), true, true, C4SF_Tileable | C4SF_MipMap);
            if (!loaded)
            {
                loaded = !!Surface->LoadAny(::GraphicsResource.Files, name.c_str(), true, false, C4SF_Tileable | C4SF_MipMap);
            }
        }
    }
 
    if (loaded)
    {
        // surface loaded, store first color index
        FadeClr1=FadeClr2=0xffffffff;
 
        // set parallax scroll mode
        switch (Game.C4S.Landscape.SkyScrollMode)
        {
        case 0: // default: no scrolling
            break;
        case 1: // go with the wind in xdir, and do some parallax scrolling in ydir
            ParallaxMode=C4SkyPM_Wind;
            ParY=20;
            break;
        case 2: // parallax in both directions
            ParX=ParY=20;
            break;
        }
 
    }
 
 
    // Else, try creating default Surface
    if (!loaded)
    {
        SetFadePalette(Game.C4S.Landscape.SkyDefFade);
        delete Surface;
        Surface = nullptr;
    }
 
    // Load sky shaders: regular sprite shaders with OC_SKY define
    const char* const SkyDefines[] = { "OC_SKY", nullptr };
    if (!pDraw->PrepareSpriteShader(Shader, "Sky", Surface ? C4SSC_BASE : 0, &::GraphicsResource.Files, SkyDefines, nullptr))
        return false;
    if (!pDraw->PrepareSpriteShader(ShaderLight, "SkyLight", (Surface ? C4SSC_BASE : 0) | C4SSC_LIGHT, &::GraphicsResource.Files, SkyDefines, nullptr))
        return false;
 
    // no sky - using fade in newgfx
    if (!Surface)
        return true;
 
    // Store size
    if (Surface)
    {
        int iWdt,iHgt;
        if (Surface->GetSurfaceSize(iWdt, iHgt))
        {
            Width = iWdt; Height = iHgt;
        }
    }
 
    // Success
    return true;
}

References C4CFN_Sky, C4Game::C4S, C4SF_MipMap, C4SF_Tileable, C4SkyPM_Wind, FadeClr1, FadeClr2, C4GraphicsResource::Files, Game, GraphicsResource, C4Scenario::Landscape, C4Surface::LoadAny(), ParallaxMode, ParX, ParY, pDraw, C4Draw::PrepareSpriteShader(), C4Game::RandomSeed, C4Game::ScenarioFile, SeededRandom(), SetFadePalette(), Shader, C4SLandscape::SkyDef, C4SLandscape::SkyDefFade, C4SLandscape::SkyScrollMode, Surface, x, xdir, y, and ydir.

Here is the call graph for this function:

SetColor()

void C4Sky::SetColor	(	int32_t	iIndex,
		int32_t	iRed,
		int32_t	iGreen,
		int32_t	iBlue
	)

SetFadePalette()

void C4Sky::SetFadePalette

(

int32_t *

ipColors

)

Definition at line 30 of file C4Sky.cpp.

{
    // If colors all zero, use game palette default blue
    if (ipColors[0]+ipColors[1]+ipColors[2]+ipColors[3]+ipColors[4]+ipColors[5]==0)
    {
        FadeClr1=C4RGB(0x1c, 0x40, 0x99);
        FadeClr2=C4RGB(0xc2, 0xc6, 0xff);
    }
    else
    {
        // set colors
        FadeClr1=C4RGB(ipColors[0], ipColors[1], ipColors[2]);
        FadeClr2=C4RGB(ipColors[3], ipColors[4], ipColors[5]);
    }
}

References C4RGB, FadeClr1, and FadeClr2.

Referenced by Init().

Here is the caller graph for this function:

SetModulation()

bool C4Sky::SetModulation	(	DWORD	dwWithClr,
		DWORD	dwBackClr
	)

Definition at line 229 of file C4Sky.cpp.

{
    Modulation=dwWithClr;
    BackClr=dwBackClr;
    BackClrEnabled=(Modulation>>24 != 0xff) ? true : false;
    return true;
}

References BackClr, BackClrEnabled, and Modulation.

Member Data Documentation

BackClr

int32_t C4Sky::BackClr

protected

Definition at line 49 of file C4Sky.h.

Referenced by CompileFunc(), Default(), Draw(), GetModulation(), and SetModulation().

BackClrEnabled

bool C4Sky::BackClrEnabled

protected

Definition at line 50 of file C4Sky.h.

Referenced by CompileFunc(), Default(), Draw(), and SetModulation().

FadeClr1

uint32_t C4Sky::FadeClr1

Definition at line 58 of file C4Sky.h.

Referenced by GetSkyFadeClr(), Init(), and SetFadePalette().

FadeClr2

uint32_t C4Sky::FadeClr2

Definition at line 58 of file C4Sky.h.

Referenced by GetSkyFadeClr(), Init(), and SetFadePalette().

Height

int32_t C4Sky::Height

protected

Definition at line 47 of file C4Sky.h.

Referenced by Default(), and Execute().

Modulation

uint32_t C4Sky::Modulation

protected

Definition at line 48 of file C4Sky.h.

Referenced by Clear(), CompileFunc(), Default(), Draw(), GetModulation(), and SetModulation().

ParallaxMode

int32_t C4Sky::ParallaxMode

Definition at line 59 of file C4Sky.h.

Referenced by CompileFunc(), Default(), Execute(), and Init().

ParX

int32_t C4Sky::ParX

Definition at line 57 of file C4Sky.h.

Referenced by CompileFunc(), Default(), C4GraphicsSystem::DoSaveScreenshot(), Draw(), and Init().

ParY

int32_t C4Sky::ParY

Definition at line 57 of file C4Sky.h.

Referenced by CompileFunc(), Default(), C4GraphicsSystem::DoSaveScreenshot(), Draw(), and Init().

Shader

C4Shader C4Sky::Shader

Definition at line 53 of file C4Sky.h.

Referenced by Clear(), Draw(), and Init().

ShaderLight

C4Shader C4Sky::ShaderLight

Definition at line 54 of file C4Sky.h.

Referenced by Clear(), and Draw().

Surface

class C4Surface* C4Sky::Surface

Definition at line 52 of file C4Sky.h.

Referenced by Clear(), Default(), Draw(), Execute(), and Init().

Width

int32_t C4Sky::Width

protected

Definition at line 47 of file C4Sky.h.

Referenced by Default(), and Execute().

x

C4Real C4Sky::x

Definition at line 56 of file C4Sky.h.

Referenced by CompileFunc(), Default(), Draw(), Execute(), and Init().

xdir

C4Real C4Sky::xdir

Definition at line 55 of file C4Sky.h.

Referenced by CompileFunc(), Default(), Execute(), and Init().

y

C4Real C4Sky::y

Definition at line 56 of file C4Sky.h.

Referenced by CompileFunc(), Default(), Draw(), Execute(), and Init().

ydir

C4Real C4Sky::ydir

Definition at line 55 of file C4Sky.h.

Referenced by CompileFunc(), Default(), Execute(), and Init().

---

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

• C4Sky.h
• C4Sky.cpp
• stub-handle.cpp