Functions to generate and render overlay for geoscape. More...

#include "../../cl_shared.h"
#include "cp_campaign.h"
#include "cp_overlay.h"

Include dependency graph for cp_overlay.cpp:

Functions
static byte *	CP_XVIGetAlpha (int x, int y)
static byte *	CP_RadarGet (int x, int y, bool source)
static void	CP_UploadXVI (void)
void	CP_GetXVIMapDimensions (int width, int height)
void	CP_SetXVILevel (int x, int y, int value)
int	CP_GetXVILevel (int x, int y)
static void	CP_SetMinMaxOverlayRows (const vec2_t pos, float radius, const int height, int yMin, int yMax)
	Set lower and upper value of an overlay (radar, xvi) row that can be modified when tracing a circle.
static float	CP_GetCircleDeltaLongitude (const vec2_t centerPos, float radius, const float yLat)
	Return the half longitude affected when tracing a circle at a given latitude.
static void	CP_DrawXVIOverlayPixel (int xMin, int xMax, const vec2_t centerPos, int y, const float yLat, int xviLevel, float radius)
	Change the value of 1 pixel in XVI overlay, the new value is higher than old one.
static void	CP_DrawXVIOverlayRow (float latMin, float latMax, const vec2_t center, int y, float yLat, int xviLevel, float radius)
	Draw XVI overlay for a given latitude between 2 longitudes.
static void	CP_IncreaseXVILevel (const vec2_t pos, int xCenter, int yCenter, float factor)
	Applies spreading on xvi transparency channel centered on a given pos.
void	CP_DecreaseXVILevelEverywhere (void)
void	CP_ChangeXVILevel (const vec2_t pos, float factor)
	Convert the pos into degrees and increase XVI there.
void	CP_InitializeXVIOverlay (void)
	Initialize XVI overlay on geoscape.
void	CP_InitializeRadarOverlay (bool source)
	Initialize radar overlay on geoscape.
static void	CP_DrawRadarOverlayRow (float latMin, float latMax, int y, byte alpha, bool source)
	Draw radar overlay for a given latitude between 2 longitudes.
void	CP_AddRadarCoverage (const vec2_t pos, float innerRadius, float outerRadius, bool source)
	Add a radar coverage (base or aircraft) to radar overlay.
void	CP_UploadRadarCoverage (void)
	Smooth radar coverage.

Variables
static const int	MAX_ALPHA_VALUE = 200
static const int	INITIAL_ALPHA_VALUE = 60

Detailed Description

Functions to generate and render overlay for geoscape.

Todo: update the alpha values for radar like the ones for the xvi map - it's much faster like this

Definition in file cp_overlay.cpp.

Function Documentation

◆ CP_AddRadarCoverage()

void CP_AddRadarCoverage	(	const vec2_t	pos,
		float	innerRadius,
		float	outerRadius,
		bool	source )

Add a radar coverage (base or aircraft) to radar overlay.

Parameters

[in]	pos	Position of the center of radar
[in]	innerRadius	Radius of the radar coverage
[in]	outerRadius	Radius of the outer radar coverage
[in]	source	True if we must update the source of the radar coverage, false if the copy must be updated.

Precondition: We assume outerRadius is smaller than 180 degrees

< Alpha of the inner radar range

< Alpha of the outer radar range

< current position (in pixel)

< Bounding box of the inner radar zone

< Bounding box of the outer radar zone

Todo: add EQUAL_EPSILON here?

Definition at line 367 of file cp_overlay.cpp.

References CP_DrawRadarOverlayRow(), CP_GetCircleDeltaLongitude(), CP_SetMinMaxOverlayRows(), RADAR_HEIGHT, and torad.

Referenced by RADAR_DrawCoverage(), and RADAR_UpdateStaticRadarCoverage().

◆ CP_ChangeXVILevel()

void CP_ChangeXVILevel	(	const vec2_t	pos,
		float	factor )

Convert the pos into degrees and increase XVI there.

Parameters

pos	The x/y-location in the flat XVI map
factor	The factor of the XVI raise

Note: xvi rate is null when alpha = 0, max when alpha = maxAlpha

Definition at line 257 of file cp_overlay.cpp.

References CP_IncreaseXVILevel(), XVI_HEIGHT, and XVI_WIDTH.

Referenced by CP_SpreadXVIAtPos().

◆ CP_DecreaseXVILevelEverywhere()

void CP_DecreaseXVILevelEverywhere ( void )

See also: R_IncreaseXVILevel

x,y: current position (in pixel)

Definition at line 237 of file cp_overlay.cpp.

References CP_GetXVILevel(), CP_SetXVILevel(), CP_UploadXVI(), XVI_HEIGHT, and XVI_WIDTH.

Referenced by CP_ReduceXVIEverywhere().

◆ CP_DrawRadarOverlayRow()

void CP_DrawRadarOverlayRow	(	float	latMin,
		float	latMax,
		int	y,
		byte	alpha,
		bool	source )

static

Draw radar overlay for a given latitude between 2 longitudes.

Parameters

[in]	latMin,latMax	Minimum and maximum latitude.
[in]	y	current row in radar overlay.
[in]	alpha	The value for the alpha channel (creates the different look).
[in]	source	True if we must update the source of the radar coverage, false if the copy must be updated.

Precondition: We assume latMax - latMin <= 360 degrees.

Definition at line 309 of file cp_overlay.cpp.

References CP_RadarGet(), dest, EQUAL_EPSILON, and RADAR_WIDTH.

Referenced by CP_AddRadarCoverage().

◆ CP_DrawXVIOverlayPixel()

void CP_DrawXVIOverlayPixel	(	int	xMin,
		int	xMax,
		const vec2_t	centerPos,
		int	y,
		const float	yLat,
		int	xviLevel,
		float	radius )

static

Change the value of 1 pixel in XVI overlay, the new value is higher than old one.

Parameters

[in]	xMin	Minimum column (this volumn will be reached).
[in]	xMax	Maximum column (this volumn won't be reached).
[in]	centerPos	Position of the center of the circle.
[in]	y	current row in XVI overlay.
[in]	yLat	Latitude (in degree) of the current Row.
[in]	xviLevel	Level of XVI at the center of the circle (ie at `center` ).
[in]	radius	Radius of the circle.

Definition at line 138 of file cp_overlay.cpp.

References CP_GetXVILevel(), CP_SetXVILevel(), GetDistanceOnGlobe(), and XVI_WIDTH.

Referenced by CP_DrawXVIOverlayRow().

◆ CP_DrawXVIOverlayRow()

void CP_DrawXVIOverlayRow	(	float	latMin,
		float	latMax,
		const vec2_t	center,
		int	y,
		float	yLat,
		int	xviLevel,
		float	radius )

static

Draw XVI overlay for a given latitude between 2 longitudes.

Parameters

[in]	latMin,latMax	Minimum and maximum latitude (in degree).
[in]	center	Position of the center of the circle.
[in]	y	current row in XVI overlay.
[in]	yLat	Latitude (in degree) of the current Row.
[in]	xviLevel	Level of XVI at the center of the circle (ie at `center` ).
[in]	radius	Radius of the circle.

Precondition: We assume latMax - latMin <= 360 degrees.

Definition at line 168 of file cp_overlay.cpp.

References CP_DrawXVIOverlayPixel(), EQUAL_EPSILON, RADAR_WIDTH, and XVI_WIDTH.

Referenced by CP_IncreaseXVILevel().

◆ CP_GetCircleDeltaLongitude()

float CP_GetCircleDeltaLongitude	(	const vec2_t	centerPos,
		float	radius,
		const float	yLat )

inlinestatic

Return the half longitude affected when tracing a circle at a given latitude.

Parameters

[in]	centerPos	center of the circle (radar coverage, XVI infection zone).
[in]	radius	radius of the circle.
[in]	yLat	latitude of current point (in radians).

Note

This is an implementation of the following facts:

the distance (on a sphere) between the center of the circle and the border of the circle at current latitude is equal to radius
the border of the circle on a row has the same latitude than current latitude.

Definition at line 122 of file cp_overlay.cpp.

References todeg, and torad.

Referenced by CP_AddRadarCoverage(), and CP_IncreaseXVILevel().

◆ CP_GetXVILevel()

int CP_GetXVILevel	(	int	x,
		int	y )

Definition at line 71 of file cp_overlay.cpp.

References CP_XVIGetAlpha(), INITIAL_ALPHA_VALUE, XVI_HEIGHT, and XVI_WIDTH.

Referenced by CP_DecreaseXVILevelEverywhere(), CP_DrawXVIOverlayPixel(), CP_IncreaseXVILevel(), CP_UpdateNationXVIInfection(), and XVI_SaveXML().

◆ CP_GetXVIMapDimensions()

void CP_GetXVIMapDimensions	(	int *	width,
		int *	height )

Definition at line 52 of file cp_overlay.cpp.

References XVI_HEIGHT, and XVI_WIDTH.

Referenced by CP_UpdateNationXVIInfection(), and XVI_SaveXML().

◆ CP_IncreaseXVILevel()

void CP_IncreaseXVILevel	(	const vec2_t	pos,
		int	xCenter,
		int	yCenter,
		float	factor )

static

Applies spreading on xvi transparency channel centered on a given pos.

Parameters

	pos	The x/y-location in the flat XVI map
[in]	xCenter,yCenter	Position of the center of XVI spreading (in degrees)
	factor	The factor of the XVI raise

See also: R_DecreaseXVILevel

Note: xvi rate is null when alpha = 0, max when alpha = maxAlpha XVI spreads in circle, and the alpha value of one pixel indicates the XVI level of infection. This is necessary to take into account a new event that would spread in the zone where XVI is already spread.

< XVI level rate at position pos

< current position (in pixel)

< Bounding box of the XVI zone to be drawn (circle)

< radius of the new XVI circle (in degree)

Definition at line 207 of file cp_overlay.cpp.

References CP_DrawXVIOverlayRow(), CP_GetCircleDeltaLongitude(), CP_GetXVILevel(), CP_SetMinMaxOverlayRows(), CP_UploadXVI(), INITIAL_ALPHA_VALUE, MAX_ALPHA_VALUE, torad, and XVI_HEIGHT.

Referenced by CP_ChangeXVILevel().

◆ CP_InitializeRadarOverlay()

void CP_InitializeRadarOverlay ( bool source )

Initialize radar overlay on geoscape.

Parameters

[in] source Initialize the source texture if true: if you are updating base radar overlay. false if you are updating aircraft radar overlay (base radar overlay will be copied to aircraft radar overlay)

Definition at line 292 of file cp_overlay.cpp.

References cgi, INITIAL_ALPHA_VALUE, RADAR_HEIGHT, and RADAR_WIDTH.

Referenced by RADAR_UpdateStaticRadarCoverage(), and RADAR_UpdateWholeRadarOverlay().

◆ CP_InitializeXVIOverlay()

void CP_InitializeXVIOverlay ( void )

Initialize XVI overlay on geoscape.

Note: xvi rate is null when alpha = 0, max when alpha = maxAlpha

Definition at line 269 of file cp_overlay.cpp.

References cgi, CP_UploadXVI(), XVI_HEIGHT, and XVI_WIDTH.

Referenced by CP_CampaignInit(), CP_InitStartup(), and XVI_LoadXML().

◆ CP_RadarGet()

byte * CP_RadarGet	(	int	x,
		int	y,
		bool	source )

inlinestatic

Definition at line 40 of file cp_overlay.cpp.

References cgi, and RADAR_WIDTH.

Referenced by CP_DrawRadarOverlayRow().

◆ CP_SetMinMaxOverlayRows()

void CP_SetMinMaxOverlayRows	(	const vec2_t	pos,
		float	radius,
		const int	height,
		int *	yMin,
		int *	yMax )

static

Set lower and upper value of an overlay (radar, xvi) row that can be modified when tracing a circle.

Parameters

[in]	pos	Position of the center of circle.
[in]	radius	Radius of the circle to be drawn.
[in]	height	Height of the overlay (in pixel).
[out]	yMin	Pointer to the lower row of the overlay that should be changed.
[out]	yMax	Pointer to the higher row of the overlay that should be changed.

Note: circle will be drawn between yMin (included) and yMin (excluded). So yMin and yMax are rounded respectively by lower and upper value.

Definition at line 91 of file cp_overlay.cpp.

Referenced by CP_AddRadarCoverage(), and CP_IncreaseXVILevel().

◆ CP_SetXVILevel()

void CP_SetXVILevel	(	int	x,
		int	y,
		int	value )

Definition at line 58 of file cp_overlay.cpp.

References CP_XVIGetAlpha(), INITIAL_ALPHA_VALUE, MAX_ALPHA_VALUE, XVI_HEIGHT, and XVI_WIDTH.

Referenced by CP_DecreaseXVILevelEverywhere(), CP_DrawXVIOverlayPixel(), and XVI_LoadXML().

◆ CP_UploadRadarCoverage()

void CP_UploadRadarCoverage ( void )

Smooth radar coverage.

Note: allows to make texture pixels less visible.

Definition at line 422 of file cp_overlay.cpp.

References cgi, RADAR_HEIGHT, and RADAR_WIDTH.

Referenced by RADAR_UpdateStaticRadarCoverage(), and RADAR_UpdateWholeRadarOverlay().

◆ CP_UploadXVI()

void CP_UploadXVI ( void )

inlinestatic

Definition at line 47 of file cp_overlay.cpp.

References cgi.

Referenced by CP_DecreaseXVILevelEverywhere(), CP_IncreaseXVILevel(), and CP_InitializeXVIOverlay().

◆ CP_XVIGetAlpha()

byte * CP_XVIGetAlpha	(	int	x,
		int	y )

inlinestatic

Definition at line 35 of file cp_overlay.cpp.

References cgi, and XVI_WIDTH.

Referenced by CP_GetXVILevel(), and CP_SetXVILevel().

Variable Documentation

◆ INITIAL_ALPHA_VALUE

const int INITIAL_ALPHA_VALUE = 60

static

Definition at line 33 of file cp_overlay.cpp.

Referenced by CP_GetXVILevel(), CP_IncreaseXVILevel(), CP_InitializeRadarOverlay(), and CP_SetXVILevel().

◆ MAX_ALPHA_VALUE

const int MAX_ALPHA_VALUE = 200

static

Max alpha level - don't set this to 255 or nothing else will be visible below the mask

Definition at line 32 of file cp_overlay.cpp.

Referenced by CP_IncreaseXVILevel(), and CP_SetXVILevel().

Functions

Variables

Detailed Description

Function Documentation

◆ CP_AddRadarCoverage()

◆ CP_ChangeXVILevel()

◆ CP_DecreaseXVILevelEverywhere()

◆ CP_DrawRadarOverlayRow()

◆ CP_DrawXVIOverlayPixel()

◆ CP_DrawXVIOverlayRow()

◆ CP_GetCircleDeltaLongitude()

◆ CP_GetXVILevel()

◆ CP_GetXVIMapDimensions()

◆ CP_IncreaseXVILevel()

◆ CP_InitializeRadarOverlay()

◆ CP_InitializeXVIOverlay()

◆ CP_RadarGet()

◆ CP_SetMinMaxOverlayRows()

◆ CP_SetXVILevel()

◆ CP_UploadRadarCoverage()

◆ CP_UploadXVI()

◆ CP_XVIGetAlpha()

Variable Documentation

◆ INITIAL_ALPHA_VALUE

◆ MAX_ALPHA_VALUE