SCR_ShapeDistanceRuler Interface Reference

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

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

Public Attributes
vector	m_aShapeMatrix [4]

Protected Member Functions
void	SCR_ShapeDistanceRuler ()

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

Constructor & Destructor Documentation

SCR_ShapeDistanceRuler()

void SCR_ShapeDistanceRuler.SCR_ShapeDistanceRuler ( )

protected

Member Function Documentation

CoordToLocal()

vector SCR_ShapeDistanceRuler.CoordToLocal

(

vector

worldPos

)

Parameters

[in]

worldPos

Returns

CreateFromShape()

static SCR_ShapeDistanceRuler SCR_ShapeDistanceRuler.CreateFromShape ( notnull ShapeEntity shapeEntity )

static

Parameters

[in]

shapeEntity

Returns

GetDistance()

float SCR_ShapeDistanceRuler.GetDistance

(

vector

relativePos

)

Parameters

[in]

relativePos

Returns

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

GetDistanceXZ()

float SCR_ShapeDistanceRuler.GetDistanceXZ

(

vector

relativePos

)

Parameters

[in]

relativePos

Returns

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

IsWithinDistance()

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

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

IsWithinDistanceXZ()

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

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

Member Data Documentation

m_aRelativeSegments

ref array<ref array<vector> > SCR_ShapeDistanceRuler.m_aRelativeSegments

protected

m_aShapeMatrix

vector SCR_ShapeDistanceRuler.m_aShapeMatrix[4]

---

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

• Game/Generators/Common/SCR_ShapeDistanceRuler.c