SCR_ParallelShapeTool Interface Reference

Inheritance diagram for SCR_ParallelShapeTool:

Static Public Member Functions
static IEntitySource	CreateParallelOffsetShape (notnull ShapeEntity shapeEntity, float offset, SCR_ParallelShapeToolSettings settings=null)
	Single offset version of CreateParallelOffsetShapes.
static array< IEntitySource >	CreateParallelOffsetShapes (notnull ShapeEntity shapeEntity, notnull array< float > offsets, SCR_ParallelShapeToolSettings settings=null)
	Create parallel shapes from the provided shape.

Protected Member Functions
void	Run ()

Protected Attributes
float	m_fOffsetSafetyMargin
float	m_fMinDistanceBetweenPoints
bool	m_bShowDebugLog
bool	m_bSnapToGround
bool	m_bUseSplineIfPossible
bool	m_bCreateShapeAsChild
bool	m_bSymmetricalShapes
bool	m_bRemoveDuplicates
ref array< float >	m_aOffsets

Static Protected Attributes
static const ref array< float >	DEFAULT_OFFSETS = { -10.0, 10.0 }
static const TypeName	POLYLINE_TYPENAME = PolylineShapeEntity
static const TypeName	SPLINE_TYPENAME = SplineShapeEntity
static const string	POLYLINE_CLASSNAME = POLYLINE_TYPENAME.ToString()
static const string	SPLINE_CLASSNAME = SPLINE_TYPENAME.ToString()

Member Function Documentation

CreateParallelOffsetShape()

static IEntitySource SCR_ParallelShapeTool.CreateParallelOffsetShape ( notnull ShapeEntity shapeEntity, float offset, SCR_ParallelShapeToolSettings settings = null )

static

Single offset version of CreateParallelOffsetShapes.

See also

CreateParallelOffsetShapes

CreateParallelOffsetShapes()

static array< IEntitySource > SCR_ParallelShapeTool.CreateParallelOffsetShapes ( notnull ShapeEntity shapeEntity, notnull array< float > offsets, SCR_ParallelShapeToolSettings settings = null )

static

Create parallel shapes from the provided shape.

The created shapes are created in the active layer if they are not children

Parameters

[in]	shapeEntity	the model to use
[in]	offsets	array of wanted offset - batch process is more efficient
[in]	settings

Returns

the created shape sources, null on error (e.g provided shape only has one point, etc)

Run()

void SCR_ParallelShapeTool.Run ( )

protected

Member Data Documentation

DEFAULT_OFFSETS

const ref array<float> SCR_ParallelShapeTool.DEFAULT_OFFSETS = { -10.0, 10.0 }

staticprotected

m_aOffsets

ref array<float> SCR_ParallelShapeTool.m_aOffsets

protected

m_bCreateShapeAsChild

bool SCR_ParallelShapeTool.m_bCreateShapeAsChild

protected

m_bRemoveDuplicates

bool SCR_ParallelShapeTool.m_bRemoveDuplicates

protected

m_bShowDebugLog

bool SCR_ParallelShapeTool.m_bShowDebugLog

protected

m_bSnapToGround

bool SCR_ParallelShapeTool.m_bSnapToGround

protected

m_bSymmetricalShapes

bool SCR_ParallelShapeTool.m_bSymmetricalShapes

protected

m_bUseSplineIfPossible

bool SCR_ParallelShapeTool.m_bUseSplineIfPossible

protected

m_fMinDistanceBetweenPoints

float SCR_ParallelShapeTool.m_fMinDistanceBetweenPoints

protected

m_fOffsetSafetyMargin

float SCR_ParallelShapeTool.m_fOffsetSafetyMargin

protected

POLYLINE_CLASSNAME

const string SCR_ParallelShapeTool.POLYLINE_CLASSNAME = POLYLINE_TYPENAME.ToString()

staticprotected

POLYLINE_TYPENAME

const TypeName SCR_ParallelShapeTool.POLYLINE_TYPENAME = PolylineShapeEntity

staticprotected

SPLINE_CLASSNAME

const string SCR_ParallelShapeTool.SPLINE_CLASSNAME = SPLINE_TYPENAME.ToString()

staticprotected

SPLINE_TYPENAME

const TypeName SCR_ParallelShapeTool.SPLINE_TYPENAME = SplineShapeEntity

staticprotected

---

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

• WorkbenchGame/WorldEditor/SCR_ParallelShapeTool.c