SCR_ShapeDistanceRuler Class Reference

Protected Member Functions
float	GetDistance (vector relativePos)
float	GetDistanceXZ (vector relativePos)
bool	IsWithinDistance (vector relativePos, float distance, bool equalCounts=true)
bool	IsWithinDistanceXZ (vector relativePos, float distance, bool equalCounts=true)
vector	CoordToLocal (vector worldPos)
void	SCR_ShapeDistanceRuler ()

Static Protected Member Functions
static SCR_ShapeDistanceRuler	CreateFromShape (notnull ShapeEntity shapeEntity)

Protected Attributes
ref array< ref array< vector > >	m_aRelativeSegments

Detailed Description

Definition at line 1 of file SCR_ShapeDistanceRuler.c.

Constructor & Destructor Documentation

SCR_ShapeDistanceRuler()

void SCR_ShapeDistanceRuler::SCR_ShapeDistanceRuler ( )

protected

Member Function Documentation

CoordToLocal()

vector SCR_ShapeDistanceRuler::CoordToLocal ( vector worldPos )

inlineprotected

Parameters

[in]

worldPos

Returns

Definition at line 112 of file SCR_ShapeDistanceRuler.c.

CreateFromShape()

SCR_ShapeDistanceRuler SCR_ShapeDistanceRuler::CreateFromShape ( notnull ShapeEntity shapeEntity )

inlinestaticprotected

Parameters

[in]

shapeEntity

Returns

Definition at line 121 of file SCR_ShapeDistanceRuler.c.

GetDistance()

float SCR_ShapeDistanceRuler::GetDistance ( vector relativePos )

inlineprotected

Parameters

[in]

relativePos

Returns

the 3D distance from shape, -1 on error (e.g no shape points)

Definition at line 9 of file SCR_ShapeDistanceRuler.c.

GetDistanceXZ()

float SCR_ShapeDistanceRuler::GetDistanceXZ ( vector relativePos )

inlineprotected

Parameters

[in]

relativePos

Returns

the 2D distance from shape, -1 on error (e.g no shape points)

Definition at line 28 of file SCR_ShapeDistanceRuler.c.

IsWithinDistance()

bool SCR_ShapeDistanceRuler::IsWithinDistance ( vector relativePos, float distance, bool equalCounts = true )

inlineprotected

Parameters

[in]	relativePos	the world position to check
[in]	distance	the checked distance
[in]	equalCounts	makes the less than < check into a less than or equal <= check

Returns

true if provided relativePos is within shape distance, false otherwise

Definition at line 56 of file SCR_ShapeDistanceRuler.c.

IsWithinDistanceXZ()

bool SCR_ShapeDistanceRuler::IsWithinDistanceXZ ( vector relativePos, float distance, bool equalCounts = true )

inlineprotected

Parameters

[in]	relativePos	the relative position to check
[in]	distance	the checked distance
[in]	equalCounts	makes the less than < check into a less than or equal <= check

Returns

true if provided relativePos is within shape distance, false otherwise

Definition at line 81 of file SCR_ShapeDistanceRuler.c.

Member Data Documentation

m_aRelativeSegments

ref array<ref array<vector> > SCR_ShapeDistanceRuler::m_aRelativeSegments

protected

Definition at line 4 of file SCR_ShapeDistanceRuler.c.

---

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

• scripts/Game/Generators/Common/SCR_ShapeDistanceRuler.c