SCR_BIKIExportTerrainStatisticsPlugin Interface Reference

Inheritance diagram for SCR_BIKIExportTerrainStatisticsPlugin:

Public Member Functions
override void	Run ()

Static Public Member Functions
static map< string, float >	GetEntityStatistics ()

Protected Member Functions
string	GetTerrainInfobox ()
string	FormatDistance (float distanceM)
string	FormatSurface (float surfaceM2)
Protected Member Functions inherited from SCR_BIKIExportBasePlugin
void	ShowResult (string result)
int	ButtonOK ()
int	ButtonCancel ()

Static Protected Member Functions
static bool	GetTimeAndWeatherInfo (out string defaultDateTime, out string season, out string coords)
static string	GetClosestLocationName (vector worldPos, float searchRadius)
static void	AddToMapResult (notnull map< string, float > result, string key, float value)
static void	SetBiggestValue (notnull map< string, float > result, string key, float value)
static float	GetPolylineShapeArea (notnull IEntitySource shapeEntitySource)
static float	GetShapeLength (notnull IEntitySource shapeEntitySource)

Protected Attributes
float	m_fTerrainMeasurementResolution
float	m_fMapDescriptorSearchRadius
bool	m_bEnableEntityStatistics

Static Protected Attributes
static const string	KEY_FORESTAREA = "forestArea"
static const string	KEY_LAKESCOUNT = "lakesCount"
static const string	KEY_RIVERSCOUNT = "riversCount"
static const string	KEY_RIVERSLENGTH = "riversLength"
static const string	KEY_LONGESTRIVER = "longestRiver"
static const string	KEY_ROADSCOUNT = "roadsCount"
static const string	KEY_ROADSLENGTH = "roadsLength"
static const string	KEY_LONGESTROAD = "longestRoad"
static const string	PLUGIN_NAME = "Export Terrain Statistics"

Member Function Documentation

AddToMapResult()

static void SCR_BIKIExportTerrainStatisticsPlugin.AddToMapResult ( notnull map< string, float > result, string key, float value )

staticprotected

FormatDistance()

string SCR_BIKIExportTerrainStatisticsPlugin.FormatDistance ( float distanceM )

protected

FormatSurface()

string SCR_BIKIExportTerrainStatisticsPlugin.FormatSurface ( float surfaceM2 )

protected

GetClosestLocationName()

static string SCR_BIKIExportTerrainStatisticsPlugin.GetClosestLocationName ( vector worldPos, float searchRadius )

staticprotected

Parameters

[in]	worldPos
[in]	searchRadius

Returns

GetEntityStatistics()

static map< string, float > SCR_BIKIExportTerrainStatisticsPlugin.GetEntityStatistics ( )

static

Returns

GetPolylineShapeArea()

static float SCR_BIKIExportTerrainStatisticsPlugin.GetPolylineShapeArea ( notnull IEntitySource shapeEntitySource )

staticprotected

GetShapeLength()

static float SCR_BIKIExportTerrainStatisticsPlugin.GetShapeLength ( notnull IEntitySource shapeEntitySource )

staticprotected

GetTerrainInfobox()

string SCR_BIKIExportTerrainStatisticsPlugin.GetTerrainInfobox ( )

protected

GetTimeAndWeatherInfo()

static bool SCR_BIKIExportTerrainStatisticsPlugin.GetTimeAndWeatherInfo ( out string defaultDateTime, out string season, out string coords )

staticprotected

Parameters

[out]	defaultDateTime
[out]	season
[out]	coords

Returns

Run()

override void SCR_BIKIExportTerrainStatisticsPlugin.Run

(

)

Implements SCR_BIKIExportBasePlugin.

SetBiggestValue()

static void SCR_BIKIExportTerrainStatisticsPlugin.SetBiggestValue ( notnull map< string, float > result, string key, float value )

staticprotected

Member Data Documentation

KEY_FORESTAREA

const string SCR_BIKIExportTerrainStatisticsPlugin.KEY_FORESTAREA = "forestArea"

staticprotected

KEY_LAKESCOUNT

const string SCR_BIKIExportTerrainStatisticsPlugin.KEY_LAKESCOUNT = "lakesCount"

staticprotected

KEY_LONGESTRIVER

const string SCR_BIKIExportTerrainStatisticsPlugin.KEY_LONGESTRIVER = "longestRiver"

staticprotected

KEY_LONGESTROAD

const string SCR_BIKIExportTerrainStatisticsPlugin.KEY_LONGESTROAD = "longestRoad"

staticprotected

KEY_RIVERSCOUNT

const string SCR_BIKIExportTerrainStatisticsPlugin.KEY_RIVERSCOUNT = "riversCount"

staticprotected

KEY_RIVERSLENGTH

const string SCR_BIKIExportTerrainStatisticsPlugin.KEY_RIVERSLENGTH = "riversLength"

staticprotected

KEY_ROADSCOUNT

const string SCR_BIKIExportTerrainStatisticsPlugin.KEY_ROADSCOUNT = "roadsCount"

staticprotected

KEY_ROADSLENGTH

const string SCR_BIKIExportTerrainStatisticsPlugin.KEY_ROADSLENGTH = "roadsLength"

staticprotected

m_bEnableEntityStatistics

bool SCR_BIKIExportTerrainStatisticsPlugin.m_bEnableEntityStatistics

protected

m_fMapDescriptorSearchRadius

float SCR_BIKIExportTerrainStatisticsPlugin.m_fMapDescriptorSearchRadius

protected

m_fTerrainMeasurementResolution

float SCR_BIKIExportTerrainStatisticsPlugin.m_fTerrainMeasurementResolution

protected

PLUGIN_NAME

const string SCR_BIKIExportTerrainStatisticsPlugin.PLUGIN_NAME = "Export Terrain Statistics"

staticprotected

---

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

• WorkbenchGame/ResourceManager/BIKI/SCR_BIKIExportTerrainStatisticsPlugin.c