fxLensFlare for TGEA

Download Code File

I found no LensFlare for TGEA, so I made this and submitted it as a resource. fxLensFlare is based
on a GameObject, and so can be attached to other objects, or added directly to a mission.

I have not included textures I used. You can find them anywhere on the web. I have included a FlareDataBlock.cs with 2 sample Flares, as well as the fxLensFlare.cpp and fxLensFlare.h.

Note: in fxLensFlare::renderFlare, you may have to change PlayGui to what you called your GuiTSCtrl.

Below is the definition of the fxLensFlareData used with fxLensFlare.

Radius - The overall radius in TGEA units
BorderAmount - The number of Pixels used for determining Border Fading
CenterAmount - The number of Pixels used for determining Off-Center Fading
ApplyWhiteout - Should this flare white out the screen when directly in front?

Currently, you can have up to 15 glows per Flare
GlowSize - Scale of the Glow in both width and height
GlowWidth - Overrides the width Scale (Default is zero which is disabled)
GlowRotate - Rotation in degrees
GlowColour - Color to be applied
GlowOffset - Distance offset (0 being source location, 1 being center of screen)
GlowTexture - Texture to be applied
Glow3D - Should this use 3D location for the Glow
GlowBlendMode - (0-2) Check code for what blending it does
BorderAffectToInScale - Should the Border distance affect the scale?
BorderAffectToIntensity - Should the Border distance affect the intensity?
OffCenterAffectToIntensity - Should the how far from center affect the intensity?
ZAffectToIntensity - Should the distance affect the intensity?
(Source - Destination) / VisibleDistance
ZAffectToScale - Should the distance affect the scale?
Source - Destination) / VisibleDistance


fxLensFlare has some fields as well

UseAzimuthElevation - Will place the flare visibleDistance away at the
supplied Azimuth & Elevation
Azimuth - -360/+360 in degrees
Elevation - -90 or +90 in degrees



===================
renderinstance/renderInstMgr.h

add between RIT_Translucent and RIT_Begin

RIT_Flare,

You will also need to add the whiteout ability back into TGEA by following these steps.

============================
game/GameConnection.h

Add right after F32 getWhiteOut() { return mWhiteOut; }

void setWhiteOut(const F32 flash) {mWhiteOut = flash;}

===================
game/Game.h

Add after void GameRenderWorld();

/// Renders overlays such as damage flashes, white outs, and water masks.  These are usually a color applied over the entire screen.
void GameRenderFilters(const CameraQuery& camq);

===================
game/Game.cpp

Add after the last include

#include "gfx/primBuilder.h"

Add after the function GameProcessCameraQuery

void GameRenderFilters(const CameraQuery& camq)
{
	// first get the game connection for this player
	GameConnection* connection = GameConnection::getConnectionToServer();
 
	F32 maxDamageFilter  = 0.77f;
	F32 damageFlash      = 0.f; ColorF damageFilterColor(1.f, 0.f, 0.f, 0.f);
	F32 whiteOut         = 0.f; ColorF whiteoutFilterColor(1.f, 1.f, 1.f, 0.f);
 
	// final color and alpha of filter + an adder
	ColorF Xcolor(0.f, 0.f, 0.f, 1.f);
 
	if(connection)
	{
		// grab the damage flash alpha value
		damageFlash = connection->getDamageFlash();
		if( damageFlash > maxDamageFilter )
			damageFlash = maxDamageFilter;
 
		damageFilterColor.alpha = damageFlash;
 
		// grab the whiteout value
		whiteoutFilterColor.alpha = connection->getWhiteOut();
 
		// compute the final color and alpha
		Xcolor         = ( Xcolor * ( 1.0f - damageFilterColor.alpha ) ) + ( damageFilterColor * damageFilterColor.alpha );
		Xcolor.alpha   =   Xcolor.alpha * ( 1.0f - damageFilterColor.alpha  );
 
		Xcolor         = ( Xcolor * ( 1.0f - whiteoutFilterColor.alpha ) ) + ( whiteoutFilterColor * whiteoutFilterColor.alpha );
		Xcolor.alpha   =   Xcolor.alpha * ( 1.0f - whiteoutFilterColor.alpha  );
 
 
		MatrixF projection = GFX->getProjectionMatrix();
 
		GFX->setProjectionMatrix( MatrixF( true ) );
		GFX->pushWorldMatrix();
		GFX->setWorldMatrix( MatrixF( true ) );
 
		GFX->setZEnable(false);
		GFX->setZWriteEnable(false);
 
		GFX->setAlphaBlendEnable(true);
		GFX->setSrcBlend(GFXBlendSrcAlpha);
		GFX->setDestBlend(GFXBlendOne);
 
		PrimBuild::color(Xcolor);
 
		PrimBuild::begin(GFXTriangleFan, 4);
			PrimBuild::vertex3f(-1, -1, 1);
			PrimBuild::vertex3f(-1,  1, 1);
			PrimBuild::vertex3f( 1,  1, 1);
			PrimBuild::vertex3f( 1, -1, 1);
		PrimBuild::end();
 
		GFX->popWorldMatrix();
 
		GFX->setProjectionMatrix(projection);
	}
}

===================
game/GameTSCtrl.cpp

Go to the function GameTSCtrl::onRender

Add after GFX->setViewport( updateRect );

CameraQuery camq = mLastCameraQuery;
   if(GameProcessCameraQuery(&camq))
      GameRenderFilters(camq);

Need to do the following to add fxLensFlare to the editor

===================
creator/objectBuilderGui.gui

after

//------------------------------------------------------------------------------
// Environment
//------------------------------------------------------------------------------

Add

function ObjectBuilderGui::buildfxLensFlare(%this){	
     %this.className = "fxLensFlare";	
     %this.addField("dataBlock", "TypeDataBlock", "fxLensFlare Data", "fxLensFlareData");
     %this.process();
}

===================
creator/EditorGui.cs

go to the function Creator::init

Scroll down until you see

%Environment_Item[0] = "Sky";
%Environment_Item[1] = "Sun";
%Environment_Item[2] = "Lightning";
%Environment_Item[3] = "Water";
%Environment_Item[4] = "Terrain";
%Environment_Item[5] = "AudioEmitter";
%Environment_Item[6] = "Precipitation";
%Environment_Item[7] = "ParticleEmitter";
%Environment_Item[8] = "fxSunLight";
%Environment_Item[9] = "fxShapeReplicator";
%Environment_Item[10] = "fxFoliageReplicator";
%Environment_Item[11] = "fxLight";
 
%Environment_Item[12] = "sgLightObject";
%Environment_Item[13] = "VolumeLight";
%Environment_Item[14] = "sgMissionLightingFilter";
%Environment_Item[15] = "sgDecalProjector";

I placed mine after fxLight because I wanted them close.

%Environment_Item[0]  = "Sky";   
%Environment_Item[1]  = "Sun";   
%Environment_Item[2]  = "Lightning";  
%Environment_Item[3]  = "Water";   
%Environment_Item[4]  = "Terrain";   
%Environment_Item[5]  = "AudioEmitter";   
%Environment_Item[6]  = "Precipitation";   
%Environment_Item[7]  = "ParticleEmitter";  
%Environment_Item[8]  = "fxSunLight";  
%Environment_Item[9]  = "fxShapeReplicator";   
%Environment_Item[10] = "fxFoliageReplicator";   
%Environment_Item[11] = "fxLight";   
%Environment_Item[12] = "fxLensFlare";      
 
%Environment_Item[13] = "sgLightObject";   
%Environment_Item[14] = "VolumeLight";   
%Environment_Item[15] = "sgMissionLightingFilter";   
%Environment_Item[16] = "sgDecalProjector";

It should be noted, that in the screenshot the flare on the right of the planet, is the new type. It will stay in that position realtive to the position of the camera. In this case, it's used to simulate a bright but far away star.

Edit: Updated code to reflect changes below