SCR_ShapeAnalyser Class Reference

Protected Member Functions
bool	IsClosed ()
bool	IsSpline ()
array< ref SCR_Ray >	GetAbsoluteAnchorPointRays ()
array< vector >	GetAbsoluteAnchorPoints ()
array< vector >	GetRelativeAnchorPoints ()
array< vector >	GetAbsoluteTesselatedPoints ()
array< vector >	GetRelativeTesselatedPoints ()
array< ref SCR_Ray >	GetAbsoluteMiddlePointRays ()
array< ref SCR_Ray >	GetAbsoluteTesselatedPointRays ()
array< float >	GetStats ()
void	SCR_ShapeAnalyser ()

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

Protected Attributes
bool	m_bIsSpline
bool	m_bIsClosed
ref array< ref SCR_Ray >	m_aAbsoluteAnchorRays
	points as shown by the Vector tool
ref array< ref SCR_Ray >	m_aAbsoluteMidPointRays
	tesselated points between two "normal" points, regardless of distance (by num of tesselated points)
ref array< ref SCR_Ray >	m_aAbsoluteTesselatedPointRays
	intermediate points
ref array< vector >	m_aRelativeAnchorPoints
ref array< vector >	m_aAbsoluteAnchorPoints
ref array< vector >	m_aRelativeTesselatedPoints
ref array< vector >	m_aAbsoluteTesselatedPoints
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)

Definition at line 3 of file SCR_ShapeAnalyser.c.

Constructor & Destructor Documentation

SCR_ShapeAnalyser()

void SCR_ShapeAnalyser::SCR_ShapeAnalyser ( )

protected

Member Function Documentation

CreateFromShape()

SCR_ShapeAnalyser SCR_ShapeAnalyser::CreateFromShape ( notnull ShapeEntity shapeEntity )

inlinestaticprotected

Parameters

[in]

shapeEntity

Definition at line 109 of file SCR_ShapeAnalyser.c.

GetAbsoluteAnchorPointRays()

array< ref SCR_Ray > SCR_ShapeAnalyser::GetAbsoluteAnchorPointRays ( )

inlineprotected

Returns

Definition at line 39 of file SCR_ShapeAnalyser.c.

GetAbsoluteAnchorPoints()

array< vector > SCR_ShapeAnalyser::GetAbsoluteAnchorPoints ( )

inlineprotected

Returns

absolute anchor points positions

Definition at line 51 of file SCR_ShapeAnalyser.c.

GetAbsoluteMiddlePointRays()

array< ref SCR_Ray > SCR_ShapeAnalyser::GetAbsoluteMiddlePointRays ( )

inlineprotected

Returns

Definition at line 87 of file SCR_ShapeAnalyser.c.

GetAbsoluteTesselatedPointRays()

array< ref SCR_Ray > SCR_ShapeAnalyser::GetAbsoluteTesselatedPointRays ( )

inlineprotected

Returns

Definition at line 94 of file SCR_ShapeAnalyser.c.

GetAbsoluteTesselatedPoints()

array< vector > SCR_ShapeAnalyser::GetAbsoluteTesselatedPoints ( )

inlineprotected

Returns

absolute tesselated points positions

Definition at line 69 of file SCR_ShapeAnalyser.c.

GetRelativeAnchorPoints()

array< vector > SCR_ShapeAnalyser::GetRelativeAnchorPoints ( )

inlineprotected

Returns

relative anchor points positions

Definition at line 60 of file SCR_ShapeAnalyser.c.

GetRelativeTesselatedPoints()

array< vector > SCR_ShapeAnalyser::GetRelativeTesselatedPoints ( )

inlineprotected

Returns

relative tesselated points positions

Definition at line 78 of file SCR_ShapeAnalyser.c.

GetStats()

array< float > SCR_ShapeAnalyser::GetStats ( )

inlineprotected

Returns

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

Definition at line 102 of file SCR_ShapeAnalyser.c.

IsClosed()

bool SCR_ShapeAnalyser::IsClosed ( )

inlineprotected

Returns

Definition at line 25 of file SCR_ShapeAnalyser.c.

IsSpline()

bool SCR_ShapeAnalyser::IsSpline ( )

inlineprotected

Returns

Definition at line 32 of file SCR_ShapeAnalyser.c.

Member Data Documentation

m_aAbsoluteAnchorPoints

ref array<vector> SCR_ShapeAnalyser::m_aAbsoluteAnchorPoints

protected

Definition at line 12 of file SCR_ShapeAnalyser.c.

m_aAbsoluteAnchorRays

ref array<ref SCR_Ray> SCR_ShapeAnalyser::m_aAbsoluteAnchorRays

protected

points as shown by the Vector tool

Definition at line 8 of file SCR_ShapeAnalyser.c.

m_aAbsoluteMidPointRays

ref array<ref SCR_Ray> SCR_ShapeAnalyser::m_aAbsoluteMidPointRays

protected

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

Definition at line 9 of file SCR_ShapeAnalyser.c.

m_aAbsoluteTesselatedPointRays

ref array<ref SCR_Ray> SCR_ShapeAnalyser::m_aAbsoluteTesselatedPointRays

protected

intermediate points

Definition at line 10 of file SCR_ShapeAnalyser.c.

m_aAbsoluteTesselatedPoints

ref array<vector> SCR_ShapeAnalyser::m_aAbsoluteTesselatedPoints

protected

Definition at line 14 of file SCR_ShapeAnalyser.c.

m_aRelativeAnchorPoints

ref array<vector> SCR_ShapeAnalyser::m_aRelativeAnchorPoints

protected

Definition at line 11 of file SCR_ShapeAnalyser.c.

m_aRelativeTesselatedPoints

ref array<vector> SCR_ShapeAnalyser::m_aRelativeTesselatedPoints

protected

Definition at line 13 of file SCR_ShapeAnalyser.c.

m_bIsClosed

bool SCR_ShapeAnalyser::m_bIsClosed

protected

Definition at line 6 of file SCR_ShapeAnalyser.c.

m_bIsSpline

bool SCR_ShapeAnalyser::m_bIsSpline

protected

Definition at line 5 of file SCR_ShapeAnalyser.c.

m_fLength2D

float SCR_ShapeAnalyser::m_fLength2D

protected

Definition at line 17 of file SCR_ShapeAnalyser.c.

m_fLength3D

float SCR_ShapeAnalyser::m_fLength3D

protected

Definition at line 18 of file SCR_ShapeAnalyser.c.

m_fMaxAltitude

float SCR_ShapeAnalyser::m_fMaxAltitude

protected

Definition at line 20 of file SCR_ShapeAnalyser.c.

m_fMaxSlope

float SCR_ShapeAnalyser::m_fMaxSlope

protected

in radians

Definition at line 21 of file SCR_ShapeAnalyser.c.

m_fMinAltitude

float SCR_ShapeAnalyser::m_fMinAltitude

protected

Definition at line 20 of file SCR_ShapeAnalyser.c.

m_fMinSlope

float SCR_ShapeAnalyser::m_fMinSlope

protected

Definition at line 21 of file SCR_ShapeAnalyser.c.

m_fSurface

float SCR_ShapeAnalyser::m_fSurface

protected

Definition at line 19 of file SCR_ShapeAnalyser.c.

---

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

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