A Forest Generator uses the following data: More...

Inheritance diagram for ForestGeneratorEntity:

Public Member Functions
void	ForestGeneratorEntity (IEntitySource src, IEntity parent)

Public Member Functions inherited from SCR_AreaGeneratorBaseEntity
void	SCR_AreaGeneratorBaseEntity (IEntitySource src, IEntity parent)

Public Member Functions inherited from SCR_GeneratorBaseEntity
override void	_WB_OnParentChange (IEntitySource src, IEntitySource prevParentSrc)

override bool	_WB_OnKeyChanged (BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent)

override bool	_WB_CanSelect (IEntitySource src)

override void	OnShapeChangedInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, array< vector > mins, array< vector > maxes)

override void	OnShapeInitInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity)

override void	_WB_OnCreate (IEntitySource src)

void	SCR_GeneratorBaseEntity (IEntitySource src, IEntity parent)

Protected Member Functions
bool	OnLine (SCR_ForestGeneratorLine line, SCR_ForestGeneratorPoint point)

int	Direction (SCR_ForestGeneratorPoint a, SCR_ForestGeneratorPoint b, SCR_ForestGeneratorPoint c)

bool	IsIntersect (SCR_ForestGeneratorLine line1, SCR_ForestGeneratorLine line2)

bool	IsIntersect (SCR_ForestGeneratorLine line, SCR_ForestGeneratorRectangle rectangle)

bool	PreprocessTreeArray (notnull array< ref ForestGeneratorTree > trees, int groupIdx, SCR_ETreeType type, int debugGroupIdx)

void	PreprocessAllTrees ()

array< ref SCR_ForestGeneratorPoint >	GetClockWisePoints (notnull IEntitySource shapeEntitySource)
	Create a list of Forest Generator Points for each shape's vertices.

void	FillOutlineLinesAndPoints (notnull array< ref SCR_ForestGeneratorPoint > points)

void	CalculateOutlineAnglesForPoints (notnull array< ref SCR_ForestGeneratorPoint > points)

override bool	_WB_OnKeyChanged (BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent)

override void	OnShapeChangedInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, array< vector > mins, array< vector > maxes)

override void	OnShapeInitInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity)

override void	BeforeShapeTransformInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, inout vector oldTransform[4])

override void	OnShapeTransformInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, array< vector > mins, array< vector > maxes)

override void	OnPointChangedInternal (IEntitySource shapeEntitySrc, ShapeEntity shapeEntity, PointChangedSituation situation, int pointIndex, vector position)

int	GetColorForTree (int index, SCR_ETreeType type)

void	MemoryCleanup ()

void	RegenerateForest (bool forceRegeneration=false)

int	DeletePreviousEntities (notnull array< float > currentPoints2D, SCR_ForestGeneratorOutlinePositionChecker outlineChecker, bool forceRegeneration=false)
	Delete previous entities - either all of them for a full regeneration, or out of shape (hehe) ones for partial regeneration.

int	GenerateEntities (notnull array< float > previousPoints2D, SCR_ForestGeneratorOutlinePositionChecker outlineChecker, bool forceRegeneration=false)

void	PopulateGrid (array< float > polygon2D, array< vector > polygon3D)

void	Rectangulate (SCR_AABB bbox, array< float > polygon2D)

bool	NeedsCheck (SCR_ForestGeneratorLine line, SCR_ForestGeneratorRectangle rectangle)

void	GenerateForestGeneratorTrees (array< float > polygon2D, SCR_AABB bbox)

int	FindRectanglesInCircle (vector center, float radius, out array< SCR_ForestGeneratorRectangle > rectangles)

bool	GetPointOutsideOutlines (notnull array< float > polygon2D, SCR_AABB bbox, out vector clusterCenter, float additionalDistance=0)

void	GenerateCircleCluster (notnull ForestGeneratorCircleCluster cluster, notnull array< float > polygon2D, notnull SCR_AABB bbox)

void	GenerateStripCluster (notnull ForestGeneratorStripCluster cluster, notnull array< float > polygon2D, notnull SCR_AABB bbox)

float	SafeRandomFloatInclusive (float min, float max)

int	SafeRandomInt (int min, int max)

vector	GeneratePointInCircle (float innerRadius, float outerRadius, vector circleCenter)

vector	GeneratePointInCircle (float innerRadius, float outerRadius, SCR_ForestGeneratorPoint point)

vector	GenerateRandomPointInRectangle (notnull SCR_ForestGeneratorRectangle rectangle)

bool	GetIsAnyTreeValid (notnull array< ref TreeGroupClass > treeGroups)

void	GenerateOutlineTrees (array< float > polygon, SCR_AABB bbox, ForestGeneratorOutline outline)

bool	IsPointInProperDistanceFromLine (vector point, SCR_ForestGeneratorLine line, float minDistance, float maxDistance)

bool	IsEntryValid (ForestGeneratorTree tree, vector pointLocal)

void	GenerateBottomTrees (array< float > polygon, SCR_AABB bbox, ForestGeneratorBottomLevel bottomLevel)

void	GenerateTopTrees (array< float > polygon, SCR_AABB bbox, ForestGeneratorTopLevel topLevel)

void	GenerateTreeInsideRectangle (SCR_ForestGeneratorRectangle rectangle, ForestGeneratorLevel level, array< float > polygon, vector worldMat[4])

ForestGeneratorTree	SelectTreeToSpawn (vector point, array< ref ForestGeneratorTree > trees)

void	SetObjectScale (SCR_ForestGeneratorTreeBase object)

bool	IsInOutline (SCR_ForestGeneratorRectangle rectangle, vector pointLocal, float additionalDistance=0)

float	CalculateAreaForOutline (SCR_ForestGeneratorLine line, ForestGeneratorOutline outline)

float	CalculateAreaForOutline (SCR_ForestGeneratorPoint point, ForestGeneratorOutline outline)

override void	OnRegenerate ()

Protected Member Functions inherited from SCR_AreaGeneratorBaseEntity
void	RefreshObstacles ()

void	SetAvoidOptions ()

bool	HasObstacle (vector worldPos, array< IEntity > exclusionList=null)

bool	HasObstaclesList ()

void	ClearObstacles ()

override void	OnIntersectingShapeChangedXZInternal (IEntitySource shapeEntitySrc, IEntitySource other, array< vector > mins, array< vector > maxes)

void	OnRegenerate ()

Protected Member Functions inherited from SCR_GeneratorBaseEntity
void	ResetGeneratorPosition (ShapeEntity shapeEntity=null)

void	DeleteAllChildren ()
	Delete all children without distinction, using WorldEditorAPI.

array< vector >	GetWorldAnchorPoints (notnull IEntitySource shapeEntitySrc)

array< vector >	GetTesselatedShapePoints (notnull IEntitySource shapeEntitySrc)

array< vector >	GetWorldTesselatedShapePoints (notnull IEntitySource shapeEntitySrc)

Color	GetColor ()

void	ColorShape ()
	Set shape's line colour to GetColor() value.

Protected Attributes
int	m_iSeed

bool	m_bAllowPartialRegeneration

bool	m_bRegenerateEntireForest
	not saved to layer (see _WB_OnKeyChanged), used as a button

bool	m_bPrintArea

bool	m_bPrintEntitiesCount

bool	m_bPrintPerformanceDetails

bool	m_bDrawDebugShapes

bool	m_bDrawDebugShapesObstacles

bool	m_bDrawDebugShapesRectangulation

bool	m_bDrawDebugShapesRegeneration

bool	m_bEntitiesFollowTerrainOnShapeMove

ref array< ref ForestGeneratorLevel >	m_aLevels

ref array< ref ForestGeneratorCluster >	m_aClusters

ref Curve	m_aGlobalOutlineScaleCurve

float	m_fGlobalOutlineScaleCurveDistance

ref ForestGeneratorGrid	m_Grid

ref RandomGenerator	m_RandomGenerator

ref array< vector >	m_aShapePoints

ref array< ref SCR_ForestGeneratorLine >	m_aLines = {}

ref array< ref SCR_ForestGeneratorPoint >	m_aMiddleOutlinePoints = {}

ref array< ref SCR_ForestGeneratorLine >	m_aSmallOutlineLines = {}

ref array< ref SCR_ForestGeneratorPoint >	m_aSmallOutlinePoints = {}

ref array< ref SCR_ForestGeneratorLine >	m_aMiddleOutlineLines = {}

ref array< ref SCR_ForestGeneratorRectangle >	m_aRectangles = {}

ref array< ref SCR_ForestGeneratorRectangle >	m_aOutlineRectangles = {}

ref array< ref SCR_ForestGeneratorRectangle >	m_aNonOutlineRectangles = {}

ref array< ref ForestGeneratorTreeBase >	m_aGridEntries = {}

ref array< ref ForestGeneratorOutline >	m_aOutlines = {}

float	m_fMaxOutlinesWidth

float	m_fArea

ref map< IEntitySource, float >	m_mEntitySourceATLHeights

Protected Attributes inherited from SCR_AreaGeneratorBaseEntity
bool	m_bAvoidObjects

bool	m_bAvoidRoads

bool	m_bAvoidRivers

bool	m_bAvoidPowerLines

bool	m_bAvoidTracks

bool	m_bAvoidLakes

bool	m_bRegenerateByObstacleChanges

Protected Attributes inherited from SCR_GeneratorBaseEntity
IEntitySource	m_Source

IEntitySource	m_ParentShapeSource

bool	m_bIsChangingWorkbenchKey

Static Protected Attributes
static const float	SCALE_CURVE_MAX_VALUE = 1

static const float	SCALE_CURVE_MIN_VALUE = 0

static ref array< float >	s_aPreviousPoints2D

static ref SCR_TimeMeasurementHelper	s_Benchmark

static ref SCR_DebugShapeManager	s_DebugShapeManager

static const int	REGENERATION_DELETION_COLOUR = Color.RED

static const int	REGENERATION_CREATION_COLOUR = Color.GREEN

static const vector	DEBUG_VERTICAL_LINE = "0 30 0"

static const float	RECTANGULATION_SIZE = 50

static const float	HECTARE_CONVERSION_FACTOR = 0.0001

static const float	MIN_POSSIBLE_SCALE_VALUE = 0.001

static const string	POINTDATA_CLASSNAME = ((TypeName)ForestGeneratorPointData).ToString()

Static Protected Attributes inherited from SCR_AreaGeneratorBaseEntity
static ref SCR_ObstacleDetector	s_ObstacleDetector

static const float	BBOX_CHECK_HEIGHT = 100.0

static const float	AVOID_OBJECTS_CHECK_RADIUS = 0.1

Static Protected Attributes inherited from SCR_GeneratorBaseEntity
static const ref Color	BASE_GENERATOR_COLOR = Color.White

Additional Inherited Members
Static Protected Member Functions inherited from SCR_GeneratorBaseEntity
static array< vector >	GetPoints (notnull IEntitySource shapeEntitySrc)

Detailed Description

A Forest Generator uses the following data:

Levels (Top trees, Middle trees, Outlines)
Clusters (Circles, Strips) These are loaded, processed (data check) Then trees are "generated" in a grid, managed C++ side Finally, the grid is used to create entities

Constructor & Destructor Documentation

◆ ForestGeneratorEntity()

void ForestGeneratorEntity.ForestGeneratorEntity	(	IEntitySource	src,
		IEntity	parent
	)

Member Function Documentation

◆ _WB_OnKeyChanged()

override bool ForestGeneratorEntity._WB_OnKeyChanged	(	BaseContainer	src,
		string	key,
		BaseContainerList	ownerContainers,
		IEntity	parent
	)

protected

Implements SCR_GeneratorBaseEntity.

◆ BeforeShapeTransformInternal()

override void ForestGeneratorEntity.BeforeShapeTransformInternal	(	IEntitySource	shapeEntitySrc,
		ShapeEntity	shapeEntity,
		inout vector	oldTransform[4]
	)

protected

◆ CalculateAreaForOutline() [1/2]

float ForestGeneratorEntity.CalculateAreaForOutline	(	SCR_ForestGeneratorLine	line,
		ForestGeneratorOutline	outline
	)

protected

◆ CalculateAreaForOutline() [2/2]

float ForestGeneratorEntity.CalculateAreaForOutline	(	SCR_ForestGeneratorPoint	point,
		ForestGeneratorOutline	outline
	)

protected

◆ CalculateOutlineAnglesForPoints()

void ForestGeneratorEntity.CalculateOutlineAnglesForPoints ( notnull array< ref SCR_ForestGeneratorPoint > points )

protected

◆ DeletePreviousEntities()

int ForestGeneratorEntity.DeletePreviousEntities	(	notnull array< float >	currentPoints2D,
		SCR_ForestGeneratorOutlinePositionChecker	outlineChecker,
		bool	forceRegeneration = `false`
	)

protected

Delete previous entities - either all of them for a full regeneration, or out of shape (hehe) ones for partial regeneration.

◆ Direction()

int ForestGeneratorEntity.Direction	(	SCR_ForestGeneratorPoint	a,
		SCR_ForestGeneratorPoint	b,
		SCR_ForestGeneratorPoint	c
	)

protected

Returns: 0 for colinear, 2 for counter-clockwise, 1 for clockwise

◆ FillOutlineLinesAndPoints()

void ForestGeneratorEntity.FillOutlineLinesAndPoints ( notnull array< ref SCR_ForestGeneratorPoint > points )

protected

◆ FindRectanglesInCircle()

int ForestGeneratorEntity.FindRectanglesInCircle	(	vector	center,
		float	radius,
		out array< SCR_ForestGeneratorRectangle >	rectangles
	)

protected

◆ GenerateBottomTrees()

void ForestGeneratorEntity.GenerateBottomTrees	(	array< float >	polygon,
		SCR_AABB	bbox,
		ForestGeneratorBottomLevel	bottomLevel
	)

protected

◆ GenerateCircleCluster()

void ForestGeneratorEntity.GenerateCircleCluster	(	notnull ForestGeneratorCircleCluster	cluster,
		notnull array< float >	polygon2D,
		notnull SCR_AABB	bbox
	)

protected

◆ GenerateEntities()

int ForestGeneratorEntity.GenerateEntities	(	notnull array< float >	previousPoints2D,
		SCR_ForestGeneratorOutlinePositionChecker	outlineChecker,
		bool	forceRegeneration = `false`
	)

protected

◆ GenerateForestGeneratorTrees()

void ForestGeneratorEntity.GenerateForestGeneratorTrees	(	array< float >	polygon2D,
		SCR_AABB	bbox
	)

protected

◆ GenerateOutlineTrees()

void ForestGeneratorEntity.GenerateOutlineTrees	(	array< float >	polygon,
		SCR_AABB	bbox,
		ForestGeneratorOutline	outline
	)

protected

◆ GeneratePointInCircle() [1/2]

vector ForestGeneratorEntity.GeneratePointInCircle	(	float	innerRadius,
		float	outerRadius,
		SCR_ForestGeneratorPoint	point
	)

protected

◆ GeneratePointInCircle() [2/2]

vector ForestGeneratorEntity.GeneratePointInCircle	(	float	innerRadius,
		float	outerRadius,
		vector	circleCenter
	)

protected

◆ GenerateRandomPointInRectangle()

vector ForestGeneratorEntity.GenerateRandomPointInRectangle ( notnull SCR_ForestGeneratorRectangle rectangle )

protected

◆ GenerateStripCluster()

void ForestGeneratorEntity.GenerateStripCluster	(	notnull ForestGeneratorStripCluster	cluster,
		notnull array< float >	polygon2D,
		notnull SCR_AABB	bbox
	)

protected

◆ GenerateTopTrees()

void ForestGeneratorEntity.GenerateTopTrees	(	array< float >	polygon,
		SCR_AABB	bbox,
		ForestGeneratorTopLevel	topLevel
	)

protected

◆ GenerateTreeInsideRectangle()

void ForestGeneratorEntity.GenerateTreeInsideRectangle	(	SCR_ForestGeneratorRectangle	rectangle,
		ForestGeneratorLevel	level,
		array< float >	polygon,
		vector	worldMat[4]
	)

protected

◆ GetClockWisePoints()

array< ref SCR_ForestGeneratorPoint > ForestGeneratorEntity.GetClockWisePoints ( notnull IEntitySource shapeEntitySource )

protected

Create a list of Forest Generator Points for each shape's vertices.

Parameters

shapeEntitySource an IEntitySource from a ShapeEntity (spline or polyline)

Returns: created Forest Generator Points or null if the provided IEntitySource is not a shape (has no Points object array)

◆ GetColorForTree()

int ForestGeneratorEntity.GetColorForTree	(	int	index,
		SCR_ETreeType	type
	)

protected

◆ GetIsAnyTreeValid()

bool ForestGeneratorEntity.GetIsAnyTreeValid ( notnull array< ref TreeGroupClass > treeGroups )

protected

◆ GetPointOutsideOutlines()

bool ForestGeneratorEntity.GetPointOutsideOutlines	(	notnull array< float >	polygon2D,
		SCR_AABB	bbox,
		out vector	clusterCenter,
		float	additionalDistance = `0`
	)

protected

◆ IsEntryValid()

bool ForestGeneratorEntity.IsEntryValid	(	ForestGeneratorTree	tree,
		vector	pointLocal
	)

protected

◆ IsInOutline()

bool ForestGeneratorEntity.IsInOutline	(	SCR_ForestGeneratorRectangle	rectangle,
		vector	pointLocal,
		float	additionalDistance = `0`
	)

protected

◆ IsIntersect() [1/2]

bool ForestGeneratorEntity.IsIntersect	(	SCR_ForestGeneratorLine	line,
		SCR_ForestGeneratorRectangle	rectangle
	)

protected

◆ IsIntersect() [2/2]

bool ForestGeneratorEntity.IsIntersect	(	SCR_ForestGeneratorLine	line1,
		SCR_ForestGeneratorLine	line2
	)

protected

◆ IsPointInProperDistanceFromLine()

bool ForestGeneratorEntity.IsPointInProperDistanceFromLine	(	vector	point,
		SCR_ForestGeneratorLine	line,
		float	minDistance,
		float	maxDistance
	)

protected

◆ MemoryCleanup()

void ForestGeneratorEntity.MemoryCleanup ( )

protected

◆ NeedsCheck()

bool ForestGeneratorEntity.NeedsCheck	(	SCR_ForestGeneratorLine	line,
		SCR_ForestGeneratorRectangle	rectangle
	)

protected

◆ OnLine()

bool ForestGeneratorEntity.OnLine	(	SCR_ForestGeneratorLine	line,
		SCR_ForestGeneratorPoint	point
	)

protected

◆ OnPointChangedInternal()

override void ForestGeneratorEntity.OnPointChangedInternal	(	IEntitySource	shapeEntitySrc,
		ShapeEntity	shapeEntity,
		PointChangedSituation	situation,
		int	pointIndex,
		vector	position
	)

protected

◆ OnRegenerate()

override void ForestGeneratorEntity.OnRegenerate ( )

protected

Implements SCR_AreaGeneratorBaseEntity.

◆ OnShapeChangedInternal()

override void ForestGeneratorEntity.OnShapeChangedInternal	(	IEntitySource	shapeEntitySrc,
		ShapeEntity	shapeEntity,
		array< vector >	mins,
		array< vector >	maxes
	)

protected

Implements SCR_GeneratorBaseEntity.

◆ OnShapeInitInternal()

override void ForestGeneratorEntity.OnShapeInitInternal	(	IEntitySource	shapeEntitySrc,
		ShapeEntity	shapeEntity
	)

protected

Implements SCR_GeneratorBaseEntity.

◆ OnShapeTransformInternal()

override void ForestGeneratorEntity.OnShapeTransformInternal	(	IEntitySource	shapeEntitySrc,
		ShapeEntity	shapeEntity,
		array< vector >	mins,
		array< vector >	maxes
	)

protected

◆ PopulateGrid()

void ForestGeneratorEntity.PopulateGrid	(	array< float >	polygon2D,
		array< vector >	polygon3D
	)

protected

◆ PreprocessAllTrees()

void ForestGeneratorEntity.PreprocessAllTrees ( )

protected

◆ PreprocessTreeArray()

bool ForestGeneratorEntity.PreprocessTreeArray	(	notnull array< ref ForestGeneratorTree >	trees,
		int	groupIdx,
		SCR_ETreeType	type,
		int	debugGroupIdx
	)

protected

◆ Rectangulate()

void ForestGeneratorEntity.Rectangulate	(	SCR_AABB	bbox,
		array< float >	polygon2D
	)

protected

◆ RegenerateForest()

void ForestGeneratorEntity.RegenerateForest ( bool forceRegeneration = false )

protected

◆ SafeRandomFloatInclusive()

float ForestGeneratorEntity.SafeRandomFloatInclusive	(	float	min,
		float	max
	)

protected

◆ SafeRandomInt()

int ForestGeneratorEntity.SafeRandomInt	(	int	min,
		int	max
	)

protected

◆ SelectTreeToSpawn()

ForestGeneratorTree ForestGeneratorEntity.SelectTreeToSpawn	(	vector	point,
		array< ref ForestGeneratorTree >	trees
	)

protected

◆ SetObjectScale()

void ForestGeneratorEntity.SetObjectScale ( SCR_ForestGeneratorTreeBase object )

protected

Member Data Documentation

◆ DEBUG_VERTICAL_LINE

const vector ForestGeneratorEntity.DEBUG_VERTICAL_LINE = "0 30 0"

staticprotected

◆ HECTARE_CONVERSION_FACTOR

const float ForestGeneratorEntity.HECTARE_CONVERSION_FACTOR = 0.0001

staticprotected

◆ m_aClusters

ref array<ref ForestGeneratorCluster> ForestGeneratorEntity.m_aClusters

protected

◆ m_aGlobalOutlineScaleCurve

ref Curve ForestGeneratorEntity.m_aGlobalOutlineScaleCurve

protected

◆ m_aGridEntries

ref array<ref ForestGeneratorTreeBase> ForestGeneratorEntity.m_aGridEntries = {}

protected

◆ m_aLevels

ref array<ref ForestGeneratorLevel> ForestGeneratorEntity.m_aLevels

protected

◆ m_aLines

ref array<ref SCR_ForestGeneratorLine> ForestGeneratorEntity.m_aLines = {}

protected

◆ m_aMiddleOutlineLines

ref array<ref SCR_ForestGeneratorLine> ForestGeneratorEntity.m_aMiddleOutlineLines = {}

protected

◆ m_aMiddleOutlinePoints

ref array<ref SCR_ForestGeneratorPoint> ForestGeneratorEntity.m_aMiddleOutlinePoints = {}

protected

◆ m_aNonOutlineRectangles

ref array<ref SCR_ForestGeneratorRectangle> ForestGeneratorEntity.m_aNonOutlineRectangles = {}

protected

◆ m_aOutlineRectangles

ref array<ref SCR_ForestGeneratorRectangle> ForestGeneratorEntity.m_aOutlineRectangles = {}

protected

◆ m_aOutlines

ref array<ref ForestGeneratorOutline> ForestGeneratorEntity.m_aOutlines = {}

protected

◆ m_aRectangles

ref array<ref SCR_ForestGeneratorRectangle> ForestGeneratorEntity.m_aRectangles = {}

protected

◆ m_aShapePoints

ref array<vector> ForestGeneratorEntity.m_aShapePoints

protected

◆ m_aSmallOutlineLines

ref array<ref SCR_ForestGeneratorLine> ForestGeneratorEntity.m_aSmallOutlineLines = {}

protected

◆ m_aSmallOutlinePoints

ref array<ref SCR_ForestGeneratorPoint> ForestGeneratorEntity.m_aSmallOutlinePoints = {}

protected

◆ m_bAllowPartialRegeneration

bool ForestGeneratorEntity.m_bAllowPartialRegeneration

protected

◆ m_bDrawDebugShapes

bool ForestGeneratorEntity.m_bDrawDebugShapes

protected

◆ m_bDrawDebugShapesObstacles

bool ForestGeneratorEntity.m_bDrawDebugShapesObstacles

protected

◆ m_bDrawDebugShapesRectangulation

bool ForestGeneratorEntity.m_bDrawDebugShapesRectangulation

protected

◆ m_bDrawDebugShapesRegeneration

bool ForestGeneratorEntity.m_bDrawDebugShapesRegeneration

protected

◆ m_bEntitiesFollowTerrainOnShapeMove

bool ForestGeneratorEntity.m_bEntitiesFollowTerrainOnShapeMove

protected

◆ m_bPrintArea

bool ForestGeneratorEntity.m_bPrintArea

protected

◆ m_bPrintEntitiesCount

bool ForestGeneratorEntity.m_bPrintEntitiesCount

protected

◆ m_bPrintPerformanceDetails

bool ForestGeneratorEntity.m_bPrintPerformanceDetails

protected

◆ m_bRegenerateEntireForest

bool ForestGeneratorEntity.m_bRegenerateEntireForest

protected

not saved to layer (see _WB_OnKeyChanged), used as a button

◆ m_fArea

float ForestGeneratorEntity.m_fArea

protected

◆ m_fGlobalOutlineScaleCurveDistance

float ForestGeneratorEntity.m_fGlobalOutlineScaleCurveDistance

protected

◆ m_fMaxOutlinesWidth

float ForestGeneratorEntity.m_fMaxOutlinesWidth

protected

◆ m_Grid

ref ForestGeneratorGrid ForestGeneratorEntity.m_Grid

protected

◆ m_iSeed

int ForestGeneratorEntity.m_iSeed

protected

◆ m_mEntitySourceATLHeights

ref map<IEntitySource, float> ForestGeneratorEntity.m_mEntitySourceATLHeights

protected

◆ m_RandomGenerator

ref RandomGenerator ForestGeneratorEntity.m_RandomGenerator

protected

◆ MIN_POSSIBLE_SCALE_VALUE

const float ForestGeneratorEntity.MIN_POSSIBLE_SCALE_VALUE = 0.001

staticprotected

◆ POINTDATA_CLASSNAME

const string ForestGeneratorEntity.POINTDATA_CLASSNAME = ((TypeName)ForestGeneratorPointData).ToString()

staticprotected

◆ RECTANGULATION_SIZE

const float ForestGeneratorEntity.RECTANGULATION_SIZE = 50

staticprotected

◆ REGENERATION_CREATION_COLOUR

const int ForestGeneratorEntity.REGENERATION_CREATION_COLOUR = Color.GREEN

staticprotected

◆ REGENERATION_DELETION_COLOUR

const int ForestGeneratorEntity.REGENERATION_DELETION_COLOUR = Color.RED

staticprotected

◆ s_aPreviousPoints2D

ref array<float> ForestGeneratorEntity.s_aPreviousPoints2D

staticprotected

◆ s_Benchmark

ref SCR_TimeMeasurementHelper ForestGeneratorEntity.s_Benchmark

staticprotected

◆ s_DebugShapeManager

ref SCR_DebugShapeManager ForestGeneratorEntity.s_DebugShapeManager

staticprotected

◆ SCALE_CURVE_MAX_VALUE

const float ForestGeneratorEntity.SCALE_CURVE_MAX_VALUE = 1

staticprotected

◆ SCALE_CURVE_MIN_VALUE

const float ForestGeneratorEntity.SCALE_CURVE_MIN_VALUE = 0

staticprotected

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

Game/Generators/ForestGeneratorEntity.c

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ForestGeneratorEntity()

Member Function Documentation

◆ _WB_OnKeyChanged()

◆ BeforeShapeTransformInternal()

◆ CalculateAreaForOutline() [1/2]

◆ CalculateAreaForOutline() [2/2]

◆ CalculateOutlineAnglesForPoints()

◆ DeletePreviousEntities()

◆ Direction()

◆ FillOutlineLinesAndPoints()

◆ FindRectanglesInCircle()

◆ GenerateBottomTrees()

◆ GenerateCircleCluster()

◆ GenerateEntities()

◆ GenerateForestGeneratorTrees()

◆ GenerateOutlineTrees()

◆ GeneratePointInCircle() [1/2]

◆ GeneratePointInCircle() [2/2]

◆ GenerateRandomPointInRectangle()

◆ GenerateStripCluster()

◆ GenerateTopTrees()

◆ GenerateTreeInsideRectangle()

◆ GetClockWisePoints()

◆ GetColorForTree()

◆ GetIsAnyTreeValid()

◆ GetPointOutsideOutlines()

◆ IsEntryValid()

◆ IsInOutline()

◆ IsIntersect() [1/2]

◆ IsIntersect() [2/2]

◆ IsPointInProperDistanceFromLine()

◆ MemoryCleanup()

◆ NeedsCheck()

◆ OnLine()

◆ OnPointChangedInternal()

◆ OnRegenerate()

◆ OnShapeChangedInternal()

◆ OnShapeInitInternal()

◆ OnShapeTransformInternal()

◆ PopulateGrid()

◆ PreprocessAllTrees()

◆ PreprocessTreeArray()

◆ Rectangulate()

◆ RegenerateForest()

◆ SafeRandomFloatInclusive()

◆ SafeRandomInt()

◆ SelectTreeToSpawn()

◆ SetObjectScale()

Member Data Documentation

◆ DEBUG_VERTICAL_LINE

◆ HECTARE_CONVERSION_FACTOR

◆ m_aClusters

◆ m_aGlobalOutlineScaleCurve

◆ m_aGridEntries

◆ m_aLevels

◆ m_aLines

◆ m_aMiddleOutlineLines

◆ m_aMiddleOutlinePoints

◆ m_aNonOutlineRectangles

◆ m_aOutlineRectangles

◆ m_aOutlines

◆ m_aRectangles

◆ m_aShapePoints

◆ m_aSmallOutlineLines

◆ m_aSmallOutlinePoints

◆ m_bAllowPartialRegeneration

◆ m_bDrawDebugShapes

◆ m_bDrawDebugShapesObstacles

◆ m_bDrawDebugShapesRectangulation

◆ m_bDrawDebugShapesRegeneration

◆ m_bEntitiesFollowTerrainOnShapeMove

◆ m_bPrintArea

◆ m_bPrintEntitiesCount