SCR_ShapeAnalyser Interface Reference

The Shape Analyser provides "points" (Rays/Transforms) with absolute position and vectorDir (vectorUp is not filled) if the shape is closed, the first point is added as the last point FOR THE POLYLINE ONLY (the engine already does it for the spline) More...

Public Member Functions
bool	IsClosed ()
bool	IsSpline ()
array< ref SCR_Ray >	GetPointRays ()
array< vector >	GetAbsoluteAnchorPoints ()
array< vector >	GetRelativeAnchorPoints ()
array< ref SCR_Ray >	GetMiddlePointRays ()
array< ref SCR_Ray >	GetTesselatedPointRays ()
	Tesselated positions are absolute.
array< float >	GetStats ()
void	SCR_ShapeAnalyser (notnull ShapeEntity shapeEntity)

Protected Attributes
bool	m_bIsSpline
bool	m_bIsClosed
ref array< ref SCR_Ray >	m_aAnchorRays
	points as shown by the Vector tool
ref array< ref SCR_Ray >	m_aMidPointRays
	tesselated points between two "normal" points, regardless of distance (by num of tesselated points)
ref array< ref SCR_Ray >	m_aTesselatedPointRays
	intermediate points
ref array< vector >	m_aRelativeAnchorPoints
ref array< vector >	m_aAbsoluteAnchorPoints
float	m_fLength2D
float	m_fLength3D
float	m_fSurface
float	m_fMinAltitude
float	m_fMaxAltitude
float	m_fMinSlope
float	m_fMaxSlope
	in radians

Detailed Description

The Shape Analyser provides "points" (Rays/Transforms) with absolute position and vectorDir (vectorUp is not filled) if the shape is closed, the first point is added as the last point FOR THE POLYLINE ONLY (the engine already does it for the spline)

Constructor & Destructor Documentation

SCR_ShapeAnalyser()

void SCR_ShapeAnalyser.SCR_ShapeAnalyser

(

notnull ShapeEntity

shapeEntity

)

Parameters

[in]

shapeEntity

Member Function Documentation

GetAbsoluteAnchorPoints()

array< vector > SCR_ShapeAnalyser.GetAbsoluteAnchorPoints

(

)

Returns

absolute anchor points positions

GetMiddlePointRays()

array< ref SCR_Ray > SCR_ShapeAnalyser.GetMiddlePointRays

(

)

Returns

GetPointRays()

array< ref SCR_Ray > SCR_ShapeAnalyser.GetPointRays

(

)

Returns

GetRelativeAnchorPoints()

array< vector > SCR_ShapeAnalyser.GetRelativeAnchorPoints

(

)

Returns

relative anchor points positions

GetStats()

array< float > SCR_ShapeAnalyser.GetStats

(

)

Returns

length2D, length3D, surface (-1 if shape is not closed), minAltitude, maxAltitude, minSlope, maxSlope

GetTesselatedPointRays()

array< ref SCR_Ray > SCR_ShapeAnalyser.GetTesselatedPointRays

(

)

Tesselated positions are absolute.

Returns

IsClosed()

bool SCR_ShapeAnalyser.IsClosed

(

)

Returns

IsSpline()

bool SCR_ShapeAnalyser.IsSpline

(

)

Returns

Member Data Documentation

m_aAbsoluteAnchorPoints

ref array<vector> SCR_ShapeAnalyser.m_aAbsoluteAnchorPoints

protected

m_aAnchorRays

ref array<ref SCR_Ray> SCR_ShapeAnalyser.m_aAnchorRays

protected

points as shown by the Vector tool

m_aMidPointRays

ref array<ref SCR_Ray> SCR_ShapeAnalyser.m_aMidPointRays

protected

tesselated points between two "normal" points, regardless of distance (by num of tesselated points)

m_aRelativeAnchorPoints

ref array<vector> SCR_ShapeAnalyser.m_aRelativeAnchorPoints

protected

m_aTesselatedPointRays

ref array<ref SCR_Ray> SCR_ShapeAnalyser.m_aTesselatedPointRays

protected

intermediate points

m_bIsClosed

bool SCR_ShapeAnalyser.m_bIsClosed

protected

m_bIsSpline

bool SCR_ShapeAnalyser.m_bIsSpline

protected

m_fLength2D

float SCR_ShapeAnalyser.m_fLength2D

protected

m_fLength3D

float SCR_ShapeAnalyser.m_fLength3D

protected

m_fMaxAltitude

float SCR_ShapeAnalyser.m_fMaxAltitude

protected

m_fMaxSlope

float SCR_ShapeAnalyser.m_fMaxSlope

protected

in radians

m_fMinAltitude

float SCR_ShapeAnalyser.m_fMinAltitude

protected

m_fMinSlope

float SCR_ShapeAnalyser.m_fMinSlope

protected

m_fSurface

float SCR_ShapeAnalyser.m_fSurface

protected

---

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

• Game/Generators/Common/SCR_ShapeAnalyser.c