SCR_ShapeAreaTool Interface Reference

Inheritance diagram for SCR_ShapeAreaTool:

Protected Member Functions
void	CreatePolyline ()
void	CreateSpline ()
void	ConvertSelectedShapes ()
void	CreateShape (bool isSpline)
array< IEntitySource >	GetSelectedShapeEntitySources ()
void	ConvertShapes (notnull array< IEntitySource > shapeEntitySources)
	Convert the provided shapes to the wanted shape.
array< vector >	GetShapePoints ()
array< vector >	GetCirclePoints ()
array< vector >	GetRectanglePoints ()
array< vector >	GetStarPoints ()
void	SetShapePoints (notnull IEntitySource entitySource, notnull array< vector > points)

Protected Attributes
int	m_iShapeType
float	m_fWidth
float	m_fLength
int	m_iCircleSegmentsCount
int	m_iRectangleSegmentsPerSide
int	m_iStarBranchesCount
float	m_fStarInnerRadiusRatio
bool	m_bSnapToTerrain
bool	m_bCentreOnPosition
int	m_iShapeClosing

Member Function Documentation

ConvertSelectedShapes()

void SCR_ShapeAreaTool.ConvertSelectedShapes ( )

protected

ConvertShapes()

void SCR_ShapeAreaTool.ConvertShapes ( notnull array< IEntitySource > shapeEntitySources )

protected

Convert the provided shapes to the wanted shape.

Parameters

[in]

shapeEntitySources

CreatePolyline()

void SCR_ShapeAreaTool.CreatePolyline ( )

protected

CreateShape()

void SCR_ShapeAreaTool.CreateShape ( bool isSpline )

protected

Parameters

[in]

isSpline

true if spline, false if polyline

CreateSpline()

void SCR_ShapeAreaTool.CreateSpline ( )

protected

GetCirclePoints()

array< vector > SCR_ShapeAreaTool.GetCirclePoints ( )

protected

GetRectanglePoints()

array< vector > SCR_ShapeAreaTool.GetRectanglePoints ( )

protected

GetSelectedShapeEntitySources()

array< IEntitySource > SCR_ShapeAreaTool.GetSelectedShapeEntitySources ( )

protected

GetShapePoints()

array< vector > SCR_ShapeAreaTool.GetShapePoints ( )

protected

GetStarPoints()

array< vector > SCR_ShapeAreaTool.GetStarPoints ( )

protected

SetShapePoints()

void SCR_ShapeAreaTool.SetShapePoints ( notnull IEntitySource entitySource, notnull array< vector > points )

protected

Parameters

[in]	entitySource
[in]	points

Member Data Documentation

m_bCentreOnPosition

bool SCR_ShapeAreaTool.m_bCentreOnPosition

protected

m_bSnapToTerrain

bool SCR_ShapeAreaTool.m_bSnapToTerrain

protected

m_fLength

float SCR_ShapeAreaTool.m_fLength

protected

m_fStarInnerRadiusRatio

float SCR_ShapeAreaTool.m_fStarInnerRadiusRatio

protected

m_fWidth

float SCR_ShapeAreaTool.m_fWidth

protected

m_iCircleSegmentsCount

int SCR_ShapeAreaTool.m_iCircleSegmentsCount

protected

m_iRectangleSegmentsPerSide

int SCR_ShapeAreaTool.m_iRectangleSegmentsPerSide

protected

m_iShapeClosing

int SCR_ShapeAreaTool.m_iShapeClosing

protected

m_iShapeType

int SCR_ShapeAreaTool.m_iShapeType

protected

• 0 = circle
• 1 = rectangle
• 2 = star

m_iStarBranchesCount

int SCR_ShapeAreaTool.m_iStarBranchesCount

protected

---

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

• WorkbenchGame/WorldEditor/SCR_ShapeAreaTool.c