C4FoW Class Reference

#include <C4FoW.h>

Collaboration diagram for C4FoW:

Public Member Functions
	C4FoW ()
	~C4FoW ()
C4Shader *	GetFramebufShader ()
C4Shader *	GetRenderShader ()
void	ClearDeletedLights ()
void	Add (C4Object *pObj)
void	Remove (C4Object *pObj)
void	Update (C4Rect r, C4Player *player)
void	Invalidate (C4Rect r)
void	Render (class C4FoWRegion *pRegion, const C4TargetFacet *pOnScreen, C4Player *pPlr, const StdProjectionMatrix &projectionMatrix)

Public Attributes
C4FoWAmbient	Ambient

Detailed Description

This class holds all lights for the objects. It forwards the update, invalidation and render calls each to the lights.

Definition at line 101 of file C4FoW.h.

Constructor & Destructor Documentation

C4FoW()

C4FoW::C4FoW ( )

default

~C4FoW()

C4FoW::~C4FoW

(

)

Definition at line 26 of file C4FoW.cpp.

{
    if (deleted_lights)
    {
        ClearDeletedLights();
    }
}

References ClearDeletedLights().

Here is the call graph for this function:

Member Function Documentation

Add()

void C4FoW::Add

(

C4Object *

pObj

)

Updates the view range of the given object in its associated light or create a new light if none exists yet.

Definition at line 165 of file C4FoW.cpp.

{
#ifndef USE_CONSOLE
    // No view range? Probably want to remove instead
    if(!pObj->lightRange && !pObj->lightFadeoutRange)
    {
        Remove(pObj);
        return;
    }
 
    // Safety
    if (!pObj->Status) return;
 
    // Look for matching light
    C4FoWLight *pLight;
    for (pLight = pLights; pLight; pLight = pLight->getNext())
        if (pLight->getObj() == pObj)
            break;
 
    if (pLight)
    {
 
        // Update reach and light color
        pLight->SetReach(pObj->lightRange, pObj->lightFadeoutRange);
        pLight->SetColor(pObj->lightColor);
    }
    else
    {
        // Create new light otherwise
        pLight = new C4FoWLight(pObj);
        pLight->pNext = pLights;
        pLights = pLight;
    }
#endif
}

References C4FoWLight::getNext(), C4FoWLight::getObj(), C4Object::lightColor, C4Object::lightFadeoutRange, C4Object::lightRange, Remove(), C4FoWLight::SetColor(), C4FoWLight::SetReach(), and C4PropList::Status.

Referenced by C4Object::UpdateLight().

Here is the call graph for this function:

Here is the caller graph for this function:

ClearDeletedLights()

void C4FoW::ClearDeletedLights

(

)

Definition at line 34 of file C4FoW.cpp.

{
#ifndef USE_CONSOLE
    // Kill any dead lights
    while (deleted_lights)
    {
        C4FoWLight *light = deleted_lights;
        deleted_lights = deleted_lights->getNext();
        delete light;
    }
#endif
}

References C4FoWLight::getNext().

Referenced by Render(), and ~C4FoW().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFramebufShader()

C4Shader * C4FoW::GetFramebufShader

(

)

Definition at line 47 of file C4FoW.cpp.

{
#ifndef USE_CONSOLE
    // Not created yet?
    if (!FramebufShader.Initialised())
    {
        // Create the frame buffer shader. The details are in C4FoWRegion, but
        // this is about how to utilise old frame buffer data in the lights texture.
        // Or put in other words: This shader is responsible for fading lights out.
        const char* FramebufVertexShader =
            "in vec2 oc_Position;\n"
            "in vec2 oc_TexCoord;\n"
            "out vec2 texcoord;\n"
            "uniform mat4 projectionMatrix;\n"
            "\n"
            "slice(position)\n"
            "{\n"
            "  gl_Position = projectionMatrix * vec4(oc_Position, 0.0, 1.0);\n"
            "}\n"
            "\n"
            "slice(texcoord)\n"
            "{\n"
            "  texcoord = oc_TexCoord;\n"
            "}";
 
        const char* FramebufFragmentShader =
            "in vec2 texcoord;\n"
            "uniform sampler2D tex;\n"
            "out vec4 fragColor;\n"
            "\n"
            "slice(color)\n"
            "{\n"
            "  fragColor = texture(tex, texcoord);\n"
            "}";
 
        FramebufShader.AddVertexSlices("built-in FoW framebuf shader", FramebufVertexShader);
        FramebufShader.AddFragmentSlices("built-in FoW framebuf shader", FramebufFragmentShader);
 
        const char *szUniforms[C4FoWFSU_Count + 1];
        szUniforms[C4FoWFSU_ProjectionMatrix] = "projectionMatrix";
        szUniforms[C4FoWFSU_Texture] = "tex";
        szUniforms[C4FoWFSU_Count] = nullptr;
 
        const char *szAttributes[C4FoWFSA_Count + 1];
        szAttributes[C4FoWFSA_Position] = "oc_Position";
        szAttributes[C4FoWFSA_TexCoord] = "oc_TexCoord";
        szAttributes[C4FoWFSA_Count] = nullptr;
 
        if (!FramebufShader.Init("framebuf", szUniforms, szAttributes)) {
            FramebufShader.ClearSlices();
            return nullptr;
        }
    }
    return &FramebufShader;
#else
    return nullptr;
#endif
}

References C4Shader::AddFragmentSlices(), C4Shader::AddVertexSlices(), C4FoWFSA_Count, C4FoWFSA_Position, C4FoWFSA_TexCoord, C4FoWFSU_Count, C4FoWFSU_ProjectionMatrix, C4FoWFSU_Texture, C4Shader::ClearSlices(), C4Shader::Init(), and C4Shader::Initialised().

Referenced by C4FoWRegion::Render().

Here is the call graph for this function:

Here is the caller graph for this function:

GetRenderShader()

C4Shader * C4FoW::GetRenderShader

(

)

Definition at line 106 of file C4FoW.cpp.

{
#ifndef USE_CONSOLE
    // Not created yet?
    if (!RenderShader.Initialised())
    {
        // Create the render shader. Fairly simple pass-through.
        const char* RenderVertexShader =
            "in vec2 oc_Position;\n"
            "in vec4 oc_Color;\n"
            "out vec4 vtxColor;\n"
            "uniform mat4 projectionMatrix;\n"
            "uniform vec2 vertexOffset;\n"
            "\n"
            "slice(position)\n"
            "{\n"
            "  gl_Position = projectionMatrix * vec4(oc_Position + vertexOffset, 0.0, 1.0);\n"
            "}\n"
            "\n"
            "slice(color)\n"
            "{\n"
            "  vtxColor = oc_Color;\n"
            "}";
 
        const char* RenderFragmentShader =
            "in vec4 vtxColor;\n"
            "out vec4 fragColor;\n"
            "\n"
            "slice(color)\n"
            "{\n"
            "  fragColor = vtxColor;\n"
            "}";
 
        RenderShader.AddVertexSlices("built-in FoW render shader", RenderVertexShader);
        RenderShader.AddFragmentSlices("built-in FoW render shader", RenderFragmentShader);
 
        const char* szUniforms[C4FoWRSU_Count + 1];
        szUniforms[C4FoWRSU_ProjectionMatrix] = "projectionMatrix";
        szUniforms[C4FoWRSU_VertexOffset] = "vertexOffset";
        szUniforms[C4FoWRSU_Count] = nullptr;
 
        const char* szAttributes[C4FoWRSA_Count + 1];
        szAttributes[C4FoWRSA_Position] = "oc_Position";
        szAttributes[C4FoWRSA_Color] = "oc_Color";
        szAttributes[C4FoWRSA_Count] = nullptr;
 
        if (!RenderShader.Init("fowRender", szUniforms, szAttributes)) {
            RenderShader.ClearSlices();
            return nullptr;
        }
 
    }
    return &RenderShader;
#else
    return nullptr;
#endif
}

References C4Shader::AddFragmentSlices(), C4Shader::AddVertexSlices(), C4FoWRSA_Color, C4FoWRSA_Count, C4FoWRSA_Position, C4FoWRSU_Count, C4FoWRSU_ProjectionMatrix, C4FoWRSU_VertexOffset, C4Shader::ClearSlices(), C4Shader::Init(), and C4Shader::Initialised().

Referenced by Render().

Here is the call graph for this function:

Here is the caller graph for this function:

Invalidate()

void C4FoW::Invalidate

(

C4Rect

r

)

Triggers the recalculation of all light beams within the given rectangle because the landscape changed.

Definition at line 221 of file C4FoW.cpp.

{
#ifndef USE_CONSOLE
    for (C4FoWLight *pLight = pLights; pLight; pLight = pLight->getNext())
        pLight->Invalidate(r);
#endif
}

References C4FoWLight::getNext().

Here is the call graph for this function:

Remove()

void C4FoW::Remove

(

C4Object *

pObj

)

Removes the light associated with the given object, if any

Definition at line 201 of file C4FoW.cpp.

{
#ifndef USE_CONSOLE
    // Look for matching light
    C4FoWLight *pPrev = nullptr, *pLight;
    for (pLight = pLights; pLight; pPrev = pLight, pLight = pLight->getNext())
        if (pLight->getObj() == pObj)
            break;
    if (!pLight)
        return;
 
    // Remove from list
    (pPrev ? pPrev->pNext : pLights) = pLight->getNext();
 
    // Delete on next render pass
    pLight->pNext = deleted_lights;
    deleted_lights = pLight;
#endif
}

References C4FoWLight::getNext().

Referenced by Add(), and C4Object::StatusDeactivate().

Here is the call graph for this function:

Here is the caller graph for this function:

Render()

void C4FoW::Render	(	class C4FoWRegion *	pRegion,
		const C4TargetFacet *	pOnScreen,
		C4Player *	pPlr,
		const StdProjectionMatrix &	projectionMatrix
	)

Definition at line 238 of file C4FoW.cpp.

{
#ifndef USE_CONSOLE
    // Delete any dead lights
    ClearDeletedLights();
    // Set up shader. If this one doesn't work, we're really in trouble.
    C4Shader *pShader = GetRenderShader();
    assert(pShader);
    if (!pShader) return;
 
    C4ShaderCall Call(pShader);
    Call.Start();
    Call.SetUniformMatrix4x4(C4FoWRSU_ProjectionMatrix, projectionMatrix);
 
    for (C4FoWLight *pLight = pLights; pLight; pLight = pLight->getNext())
        if (pLight->IsVisibleForPlayer(pPlr))
            pLight->Render(pRegion, pOnScreen, Call);
 
    Call.Finish();
#endif
}

References C4FoWRSU_ProjectionMatrix, C4ScriptGuiWindowActionID::Call, ClearDeletedLights(), C4FoWLight::getNext(), and GetRenderShader().

Referenced by C4FoWRegion::Render().

Here is the call graph for this function:

Here is the caller graph for this function:

Update()

void C4FoW::Update	(	C4Rect	r,
		C4Player *	player
	)

Update all light beams within the given rectangle

Definition at line 229 of file C4FoW.cpp.

{
#ifndef USE_CONSOLE
    for (C4FoWLight *pLight = pLights; pLight; pLight = pLight->getNext())
        if (pLight->IsVisibleForPlayer(pPlr))
            pLight->Update(r);
#endif
}

References C4FoWLight::getNext().

Referenced by C4FoWRegion::Render().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Ambient

C4FoWAmbient C4FoW::Ambient

Definition at line 115 of file C4FoW.h.

Referenced by C4LandscapeRenderGL::Draw(), and CStdGL::SetupMultiBlt().

---

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

• C4FoW.h
• C4FoW.cpp