SCR_HeatmapHelper Interface Reference

Static Public 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 Public Attributes
static const int	COLOUR_MODE_GREYSCALE = 0
static const int	COLOUR_MODE_THERMAL = 1
static const int	COLOUR_MODE_ALPHA = 2
static const int	MAX_MODE_RAW = 0
static const int	MAX_MODE_2AVG = 1
static const int	MAX_MODE_2MEDIAN = 2
static const int	MAX_RESOLUTION = 8192

Static Protected Attributes
static const int	MIN_GRADIENT_RGB = 8

Member Function Documentation

CreateHeatmapImageFromData()

static 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 )

static

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

GetResolutionFactorEnum()

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

static

Parameters

[in]

multipliers

default { 1, 2, 4, 8 }

Returns

a string to be used with SCR_ParamEnumArray.FromString

Member Data Documentation

COLOUR_MODE_ALPHA

const int SCR_HeatmapHelper.COLOUR_MODE_ALPHA = 2

static

COLOUR_MODE_GREYSCALE

const int SCR_HeatmapHelper.COLOUR_MODE_GREYSCALE = 0

static

COLOUR_MODE_THERMAL

const int SCR_HeatmapHelper.COLOUR_MODE_THERMAL = 1

static

MAX_MODE_2AVG

const int SCR_HeatmapHelper.MAX_MODE_2AVG = 1

static

MAX_MODE_2MEDIAN

const int SCR_HeatmapHelper.MAX_MODE_2MEDIAN = 2

static

MAX_MODE_RAW

const int SCR_HeatmapHelper.MAX_MODE_RAW = 0

static

MAX_RESOLUTION

const int SCR_HeatmapHelper.MAX_RESOLUTION = 8192

static

MIN_GRADIENT_RGB

const int SCR_HeatmapHelper.MIN_GRADIENT_RGB = 8

staticprotected

---

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

• WorkbenchGame/WorldEditor/Helpers/SCR_HeatmapHelper.c