SCR_ForestGeneratorOutlinePositionChecker Class Reference

Protected Member Functions
bool	IsPosDistanceEqualOrCloserThan (vector pos, float distance)
bool	IsPosWithinSetDistance (vector pos)
void	SCR_ForestGeneratorOutlinePositionChecker (notnull array< float > oldPoints, notnull array< float > newPoints, float setDistance)

Static Protected Member Functions
static array< float >	GetOutlineDiffLines (notnull array< float > oldPoints, notnull array< float > newPoints)
static array< float >	GetOutlineDiffLines_PointsRemoved (notnull array< float > oldPoints, notnull array< float > newPoints)
static array< float >	GetOutlineDiffLines_PointsMoved (notnull array< float > oldPoints, notnull array< float > newPoints)
static array< float >	GetOutlineDiffLines_PointAdded (notnull array< float > oldPoints, notnull array< float > newPoints)

Protected Attributes
ref array< ref array< vector > >	m_aOutlineSegments = {}
float	m_fSetDistanceSq

Detailed Description

Definition at line 1 of file SCR_ForestGeneratorOutlinePositionChecker.c.

Constructor & Destructor Documentation

SCR_ForestGeneratorOutlinePositionChecker()

void SCR_ForestGeneratorOutlinePositionChecker::SCR_ForestGeneratorOutlinePositionChecker ( notnull array< float > oldPoints, notnull array< float > newPoints, float setDistance )

inlineprotected

Parameters

[in]	oldPoints
[in]	newPoints
[in]	setDistance

Definition at line 329 of file SCR_ForestGeneratorOutlinePositionChecker.c.

Member Function Documentation

GetOutlineDiffLines()

array< float > SCR_ForestGeneratorOutlinePositionChecker::GetOutlineDiffLines ( notnull array< float > oldPoints, notnull array< float > newPoints )

inlinestaticprotected

Returns

two arrays of outline difference "lines" (four floats, x0y0-x1y1) around which the area must be cleared - old and new shape

Definition at line 44 of file SCR_ForestGeneratorOutlinePositionChecker.c.

GetOutlineDiffLines_PointAdded()

array< float > SCR_ForestGeneratorOutlinePositionChecker::GetOutlineDiffLines_PointAdded ( notnull array< float > oldPoints, notnull array< float > newPoints )

inlinestaticprotected

Returns

eight floats representing FOUR points (old-1 to old, old+1 to old, old-1 to new, old+1 to new

Definition at line 265 of file SCR_ForestGeneratorOutlinePositionChecker.c.

GetOutlineDiffLines_PointsMoved()

array< float > SCR_ForestGeneratorOutlinePositionChecker::GetOutlineDiffLines_PointsMoved ( notnull array< float > oldPoints, notnull array< float > newPoints )

inlinestaticprotected

Returns

all p-1→vertice / vertice→p+1 (multiple of 4) for old and new points; cannot return null

Definition at line 187 of file SCR_ForestGeneratorOutlinePositionChecker.c.

GetOutlineDiffLines_PointsRemoved()

array< float > SCR_ForestGeneratorOutlinePositionChecker::GetOutlineDiffLines_PointsRemoved ( notnull array< float > oldPoints, notnull array< float > newPoints )

inlinestaticprotected

Definition at line 70 of file SCR_ForestGeneratorOutlinePositionChecker.c.

IsPosDistanceEqualOrCloserThan()

bool SCR_ForestGeneratorOutlinePositionChecker::IsPosDistanceEqualOrCloserThan ( vector pos, float distance )

inlineprotected

Parameters

[in]	pos	the position to check
[in]	distance	the checked distance

Returns

true if provided pos is <= distance from diff outline, false otherwise

Definition at line 12 of file SCR_ForestGeneratorOutlinePositionChecker.c.

IsPosWithinSetDistance()

bool SCR_ForestGeneratorOutlinePositionChecker::IsPosWithinSetDistance ( vector pos )

inlineprotected

Parameters

[in]

pos

the position to check

Returns

true if provided pos is <= distance from diff outline, false otherwise

Definition at line 29 of file SCR_ForestGeneratorOutlinePositionChecker.c.

Member Data Documentation

m_aOutlineSegments

ref array<ref array<vector> > SCR_ForestGeneratorOutlinePositionChecker::m_aOutlineSegments = {}

protected

Definition at line 3 of file SCR_ForestGeneratorOutlinePositionChecker.c.

m_fSetDistanceSq

float SCR_ForestGeneratorOutlinePositionChecker::m_fSetDistanceSq

protected

Definition at line 6 of file SCR_ForestGeneratorOutlinePositionChecker.c.

---

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

• scripts/Game/Generators/ForestGenerator/SCR_ForestGeneratorOutlinePositionChecker.c