C4FoWLight Class Reference

#include <C4FoWLight.h>

Public Member Functions
	C4FoWLight (C4Object *pObj)
	~C4FoWLight ()
int32_t	getX () const
int32_t	getY () const
int32_t	getReach () const
int32_t	getFadeout () const
int32_t	getTotalReach () const
int32_t	getSize () const
int32_t	getNormalSize () const
float	getBrightness () const
float	getR () const
float	getG () const
float	getB () const
float	getValue () const
float	getLightness () const
C4FoWLight *	getNext () const
C4Object *	getObj () const
void	SetReach (int32_t iReach, int32_t iFadeout)
void	SetColor (uint32_t iValue)
void	Invalidate (C4Rect r)
void	Update (C4Rect r)
void	Render (class C4FoWRegion *pRegion, const C4TargetFacet *pOnScreen, C4ShaderCall &call)
bool	IsVisibleForPlayer (C4Player *player) const

Friends
class	C4FoW

Detailed Description

This class represents one light source. A light source has an associated object with which the light source moves and one light section that handles the light beams for each direction (up, down, left, right).

Furthermore, each light source has a size. This is usually the object's lightRange. See SetReach.

Definition at line 34 of file C4FoWLight.h.

Constructor & Destructor Documentation

C4FoWLight()

C4FoWLight::C4FoWLight

(

C4Object *

pObj

)

Definition at line 29 of file C4FoWLight.cpp.

    : iX(fixtoi(pObj->fix_x)),
      iY(fixtoi(pObj->fix_y)),
      iReach(pObj->lightRange),
      iFadeout(pObj->lightFadeoutRange),
      iSize(20), gBright(0.5), colorR(1.0), colorG(1.0), colorB(1.0),
      colorV(1.0), colorL(1.0),
      pNext(nullptr),
      pObj(pObj),
      sections(4)
{
    sections[0] = new C4FoWLightSection(this,0);
    sections[1] = new C4FoWLightSection(this,90);
    sections[2] = new C4FoWLightSection(this,180);
    sections[3] = new C4FoWLightSection(this,270);
}

~C4FoWLight()

C4FoWLight::~C4FoWLight

(

)

Definition at line 46 of file C4FoWLight.cpp.

{
    for(auto & section : sections)
        delete section;
}

Member Function Documentation

getB()

float C4FoWLight::getB ( ) const

inline

Definition at line 68 of file C4FoWLight.h.

{ return colorB; }

getBrightness()

float C4FoWLight::getBrightness ( ) const

inline

Definition at line 65 of file C4FoWLight.h.

{ return colorV * gBright; }

getFadeout()

int32_t C4FoWLight::getFadeout ( ) const

inline

Definition at line 61 of file C4FoWLight.h.

{ return iFadeout; }

getG()

float C4FoWLight::getG ( ) const

inline

Definition at line 67 of file C4FoWLight.h.

{ return colorG; }

getLightness()

float C4FoWLight::getLightness ( ) const

inline

Definition at line 70 of file C4FoWLight.h.

{ return colorL; }

getNext()

C4FoWLight* C4FoWLight::getNext ( ) const

inline

Definition at line 71 of file C4FoWLight.h.

{ return pNext; }

Referenced by C4FoW::Add(), C4FoW::ClearDeletedLights(), C4FoW::Invalidate(), C4FoW::Remove(), C4FoW::Render(), and C4FoW::Update().

Here is the caller graph for this function:

getNormalSize()

int32_t C4FoWLight::getNormalSize ( ) const

inline

Definition at line 64 of file C4FoWLight.h.

{ return iSize * 2; }

References iSize.

getObj()

C4Object* C4FoWLight::getObj ( ) const

inline

Definition at line 72 of file C4FoWLight.h.

{ return pObj; }

Referenced by C4FoW::Add().

Here is the caller graph for this function:

getR()

float C4FoWLight::getR ( ) const

inline

Definition at line 66 of file C4FoWLight.h.

{ return colorR; }

getReach()

int32_t C4FoWLight::getReach ( ) const

inline

Definition at line 60 of file C4FoWLight.h.

{ return iReach; }

Referenced by C4FoWLightSection::Update().

Here is the caller graph for this function:

getSize()

int32_t C4FoWLight::getSize ( ) const

inline

Definition at line 63 of file C4FoWLight.h.

{ return iSize; }

References iSize.

Referenced by C4FoWLightSection::Update().

Here is the caller graph for this function:

getTotalReach()

int32_t C4FoWLight::getTotalReach ( ) const

inline

Definition at line 62 of file C4FoWLight.h.

{ return iReach + iFadeout; }

Referenced by C4FoWLightSection::Update().

Here is the caller graph for this function:

getValue()

float C4FoWLight::getValue ( ) const

inline

Definition at line 69 of file C4FoWLight.h.

{ return colorV; }

getX()

int32_t C4FoWLight::getX ( ) const

inline

Definition at line 58 of file C4FoWLight.h.

{ return iX; }

getY()

int32_t C4FoWLight::getY ( ) const

inline

Definition at line 59 of file C4FoWLight.h.

{ return iY; }

Invalidate()

void C4FoWLight::Invalidate

(

C4Rect

r

)

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

Definition at line 52 of file C4FoWLight.cpp.

{
    for(auto & section : sections)
        section->Invalidate(r);
}

IsVisibleForPlayer()

bool C4FoWLight::IsVisibleForPlayer

(

C4Player *

player

)

const

Definition at line 364 of file C4FoWLight.cpp.

{
    // check if attached to an object that is not hostile to the given player
    if (!pObj || !player) return true;
    return !::Hostile(pObj->Owner,player->Number);
}

References Hostile(), C4Object::Owner, and C4ScriptGuiWindowPropertyName::player.

Here is the call graph for this function:

Render()

void C4FoWLight::Render	(	class C4FoWRegion *	pRegion,
		const C4TargetFacet *	pOnScreen,
		C4ShaderCall &	call
	)

Render this light

Definition at line 120 of file C4FoWLight.cpp.

{
    TriangleList triangles;
 
    bool clip = false;
    
    for(auto & section : sections)
    {
        TriangleList sectionTriangles = section->CalculateTriangles(region);
 
        // if the triangles of one section are clipped completely, the neighbouring triangles
        // must be marked as clipped
        if(!triangles.empty()) triangles.rbegin()->clipRight |= clip;
        if(!sectionTriangles.empty()) sectionTriangles.begin()->clipLeft |= clip;
 
        clip = sectionTriangles.empty();
        triangles.splice(triangles.end(), sectionTriangles);
    }
 
    CalculateFanMaxed(triangles);
    CalculateIntermediateFadeTriangles(triangles);
 
    std::unique_ptr<C4FoWDrawStrategy>& strategy = onScreen ? OnScreenStrategy : OffScreenStrategy;
    if (!strategy.get())
    {
        if (onScreen)
            strategy = std::make_unique<C4FoWDrawWireframeStrategy>(this, onScreen);
        else
            strategy = std::make_unique<C4FoWDrawLightTextureStrategy>(this);
    }
 
    strategy->Begin(region);
 
    DrawFan(strategy.get(), triangles);
    DrawFanMaxed(strategy.get(), triangles);
    DrawFade(strategy.get(), triangles);
    DrawIntermediateFadeTriangles(strategy.get(), triangles);
 
    strategy->End(call);
}

SetColor()

void C4FoWLight::SetColor

(

uint32_t

iValue

)

Sets the light's color in rgba format.

Definition at line 81 of file C4FoWLight.cpp.

{
    colorR = GetRedValue(iValue) / 255.0f;
    colorG = GetGreenValue(iValue) / 255.0f;
    colorB = GetBlueValue(iValue) / 255.0f;
 
    float min = std::min(colorR, std::min(colorG, colorB));
    colorV = std::max(std::max(colorR, std::max(colorG, colorB)), 1e-3f); // prevent division by 0
    colorL = (min + colorV) / 2.0f;
 
    // maximize color, so that dark colors will not be desaturated after normalization
    colorR = std::min(colorR / colorV, 1.0f);
    colorG = std::min(colorG / colorV, 1.0f);
    colorB = std::min(colorB / colorV, 1.0f);
}

References GetBlueValue, GetGreenValue, and GetRedValue.

Referenced by C4FoW::Add().

Here is the caller graph for this function:

SetReach()

void C4FoWLight::SetReach	(	int32_t	iReach,
		int32_t	iFadeout
	)

Sets the light's size in pixels. The reach is the total radius of the light while the fadeout is the number of pixels after which the light should dim down

Definition at line 58 of file C4FoWLight.cpp.

{
    // Fadeout changes don't matter
    iFadeout = iFadeout2;
 
    if (iReach == iReach2) return;
 
    if (iReach2 < iReach)
    {
        // Reach decreased? Prune beams
        iReach = iReach2;
        for(auto & section : sections)
            section->Prune(iReach);
 
    } else {
 
        // Reach increased? Dirty beams that might get longer now
        iReach = iReach2;
        for(auto & section : sections)
            section->Dirty(iReach);
    }
}

Referenced by C4FoW::Add().

Here is the caller graph for this function:

Update()

void C4FoWLight::Update

(

C4Rect

r

)

Update all light beams within the given rectangle for this light

Definition at line 97 of file C4FoWLight.cpp.

{
    // Update position from object.
    int32_t iNX = fixtoi(pObj->fix_x), iNY = fixtoi(pObj->fix_y);
    // position may be affected by LightOffset property
    C4ValueArray *light_offset = pObj->GetPropertyArray(P_LightOffset);
    if (light_offset)
    {
        iNX += light_offset->GetItem(0).getInt();
        iNY += light_offset->GetItem(1).getInt();
    }
    // Clear if we moved in any way
    if (iNX != iX || iNY != iY)
    {
        for(auto & section : sections)
            section->Prune(0);
        iX = iNX; iY = iNY;
    }
 
    for(auto & section : sections)
        section->Update(Rec);
}

References C4Object::fix_x, C4Object::fix_y, fixtoi(), C4Value::getInt(), C4ValueArray::GetItem(), C4PropList::GetPropertyArray(), and P_LightOffset.

Here is the call graph for this function:

Friends And Related Function Documentation

C4FoW

friend class C4FoW

friend

Definition at line 36 of file C4FoWLight.h.

---

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

• C4FoWLight.h
• C4FoWLight.cpp