SCR_HeatmapHelper Class Reference

Static Protected Member Functions
static bool	CreateHeatmapImageFromData (string imagePath, notnull array< int > imageData, int colourMode=COLOUR_MODE_GREYSCALE, bool invertColour=false, int maxValueMode=MAX_MODE_RAW, bool highlightValuesAboveMax=false, int resolutionFactor=1)
static string	GetResolutionFactorEnum (array< int > multipliers=null)

Static Protected Attributes
static const int	MIN_GRADIENT_RGB = 8

Detailed Description

Definition at line 1 of file SCR_HeatmapHelper.c.

Member Function Documentation

CreateHeatmapImageFromData()

bool SCR_HeatmapHelper::CreateHeatmapImageFromData ( string imagePath, notnull array< int > imageData, int colourMode = COLOUR_MODE_GREYSCALE, bool invertColour = false, int maxValueMode = MAX_MODE_RAW, bool highlightValuesAboveMax = false, int resolutionFactor = 1 )

inlinestaticprotected

Parameters

[in]	imagePath
[in]	imageData	array values in range -0..maxToUse+ - resolution is deduced from this value (image is expected to be square)
[in]	colourMode
[in]	maxValueMode
[in]	highlightValuesAboveMax
[in]	resolutionFactor

Returns

true on success, false otherwise

Definition at line 26 of file SCR_HeatmapHelper.c.

GetResolutionFactorEnum()

string SCR_HeatmapHelper::GetResolutionFactorEnum ( array< int > multipliers = null )

inlinestaticprotected

Parameters

[in]

multipliers

default { 1, 2, 4, 8 }

Returns

a string to be used with SCR_ParamEnumArray.FromString

Definition at line 300 of file SCR_HeatmapHelper.c.

Member Data Documentation

MIN_GRADIENT_RGB

const int SCR_HeatmapHelper::MIN_GRADIENT_RGB = 8

staticprotected

Definition at line 14 of file SCR_HeatmapHelper.c.

---

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

• scripts/WorkbenchGame/WorldEditor/Helpers/SCR_HeatmapHelper.c