Arma Reforger Script API
Loading...
Searching...
No Matches
Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
SCR_ParallelShapeHelper Interface Reference

Static Public Member Functions

static bool GetAnchorsAndTesselatedPointsFromShape (notnull ShapeEntity shapeEntity, float offset, out notnull array< vector > offsetAnchorPoints, out notnull array< vector > offsetTesselatedPoints, out array< int > offsetAnchorIndices=null)
 
static bool GetAnchorsAndTesselatedPointsFromShape (notnull ShapeEntity shapeEntity, vector offset, bool yOffsetInShapeSpace, out notnull array< vector > offsetAnchorPoints, out notnull array< vector > offsetTesselatedPoints, out array< int > offsetAnchorIndices=null)
 
static array< vector > GetRelativeOffsetPointsFromShape (notnull ShapeEntity shapeEntity, float offset, bool isShapeClosed)
 
static bool RemovePointsCloseToShape (notnull ShapeEntity shapeEntity, float deletionRadius, inout notnull array< vector > points)
 
static bool RemovePointsCloseToShapeXZ (notnull ShapeEntity shapeEntity, float deletionRadius, inout notnull array< vector > points)
 
static bool SnapRelativePointsToGround (notnull ShapeEntity shapeEntity, inout notnull array< vector > points)
 
static bool ReducePointsDensity (float minDistanceBetweenPoints, inout notnull array< vector > points)
 
static bool ReducePointsDensityXZ (float minDistanceBetweenPoints, inout notnull array< vector > points)
 
static array< vector > GetOffsetPointsFromPoints (notnull array< vector > points, float offset, bool isShapeClosed)
 A helpful wrapper for users to get offset points easily.
 
static array< vector > GetOffsetPointsFromPoints (notnull array< vector > points, vector offset, bool yOffsetInShapeSpace, bool isShapeClosed)
 A helpful wrapper for users to get offset points easily.
 
static array< ref SCR_Ray > GetRaysFromPoints (notnull array< vector > points, bool isShapeClosed)
 
static void FlattenRays (inout notnull array< ref SCR_Ray > rays)
 Modifies the provided array and flattens rays to 2D direction (XZ plane)
 
static array< vector > GetOffsetPointsFromRays (notnull array< ref SCR_Ray > rays, float offset)
 
static array< vector > GetOffsetPointsFromRays (notnull array< ref SCR_Ray > rays, vector offset, bool yOffsetInShapeSpace)
 

Protected Member Functions

void SCR_ParallelShapeHelper ()
 

Static Protected Member Functions

static vector GetOffsetPoint (vector position, vector direction, vector offset, bool yOffsetInShapeSpace)
 

Constructor & Destructor Documentation

◆ SCR_ParallelShapeHelper()

void SCR_ParallelShapeHelper.SCR_ParallelShapeHelper ( )
protected

Member Function Documentation

◆ FlattenRays()

static void SCR_ParallelShapeHelper.FlattenRays ( inout notnull array< ref SCR_Ray > rays)
static

Modifies the provided array and flattens rays to 2D direction (XZ plane)

Parameters
[in,out]rays

◆ GetAnchorsAndTesselatedPointsFromShape() [1/2]

static bool SCR_ParallelShapeHelper.GetAnchorsAndTesselatedPointsFromShape ( notnull ShapeEntity shapeEntity,
float offset,
out notnull array< vector > offsetAnchorPoints,
out notnull array< vector > offsetTesselatedPoints,
out array< int > offsetAnchorIndices = null )
static
Parameters
[in]shapeEntity
[in]offset
[out]offsetAnchorPoints
[out]offsetTesselatedPoints
[out]offsetAnchorIndicesnot created/filled if not provided
Returns
true on success, false on failure (e.g not enough points, etc)

◆ GetAnchorsAndTesselatedPointsFromShape() [2/2]

static bool SCR_ParallelShapeHelper.GetAnchorsAndTesselatedPointsFromShape ( notnull ShapeEntity shapeEntity,
vector offset,
bool yOffsetInShapeSpace,
out notnull array< vector > offsetAnchorPoints,
out notnull array< vector > offsetTesselatedPoints,
out array< int > offsetAnchorIndices = null )
static
Parameters
[in]shapeEntity
[in]offset
[in]yOffsetInShapeSpaceoffset Y in shape's up vector, otherwise in point's up vector
[out]offsetAnchorPoints
[out]offsetTesselatedPoints
[out]offsetAnchorIndicesnot created/filled if not provided
Returns
true on success, false on failure (e.g not enough points, no out arrays provided, etc)

◆ GetOffsetPoint()

static vector SCR_ParallelShapeHelper.GetOffsetPoint ( vector position,
vector direction,
vector offset,
bool yOffsetInShapeSpace )
staticprotected
Parameters
[in]position
[in]direction
[in]offset
[in]yOffsetInShapeSpaceoffset Y in absolute vector up, otherwise in direction's up
Returns

◆ GetOffsetPointsFromPoints() [1/2]

static array< vector > SCR_ParallelShapeHelper.GetOffsetPointsFromPoints ( notnull array< vector > points,
float offset,
bool isShapeClosed )
static

A helpful wrapper for users to get offset points easily.

Parameters
[in]points
[in]offset
[in]isShapeClosed
Returns

◆ GetOffsetPointsFromPoints() [2/2]

static array< vector > SCR_ParallelShapeHelper.GetOffsetPointsFromPoints ( notnull array< vector > points,
vector offset,
bool yOffsetInShapeSpace,
bool isShapeClosed )
static

A helpful wrapper for users to get offset points easily.

Parameters
[in]points
[in]offset
[in]yOffsetInShapeSpaceoffset Y in shape's up vector, otherwise in point's up vector
[in]isShapeClosed
Returns

◆ GetOffsetPointsFromRays() [1/2]

static array< vector > SCR_ParallelShapeHelper.GetOffsetPointsFromRays ( notnull array< ref SCR_Ray > rays,
float offset )
static
Parameters
[in]rayscan be of any size
[in]offset
Returns

◆ GetOffsetPointsFromRays() [2/2]

static array< vector > SCR_ParallelShapeHelper.GetOffsetPointsFromRays ( notnull array< ref SCR_Ray > rays,
vector offset,
bool yOffsetInShapeSpace )
static
Parameters
[in]rayscan be of any size
[in]offset
[in]yOffsetInShapeSpaceoffset Y in shape's up vector, otherwise in point's up vector
Returns

◆ GetRaysFromPoints()

static array< ref SCR_Ray > SCR_ParallelShapeHelper.GetRaysFromPoints ( notnull array< vector > points,
bool isShapeClosed )
static
Parameters
[in]pointsa minimum of two points is required
[in]isShapeClosed
Returns
array of point rays or null on less than two points

◆ GetRelativeOffsetPointsFromShape()

static array< vector > SCR_ParallelShapeHelper.GetRelativeOffsetPointsFromShape ( notnull ShapeEntity shapeEntity,
float offset,
bool isShapeClosed )
static
Parameters
[in]shapeEntity
[in]offset
[in]isShapeClosed
Returns
relative offset points

◆ ReducePointsDensity()

static bool SCR_ParallelShapeHelper.ReducePointsDensity ( float minDistanceBetweenPoints,
inout notnull array< vector > points )
static
Parameters
[in]minDistanceBetweenPoints3D distance between consecutive points
[in,out]pointsmin 3 points
Returns
true on success, false on wrong input (less than 3 points)

◆ ReducePointsDensityXZ()

static bool SCR_ParallelShapeHelper.ReducePointsDensityXZ ( float minDistanceBetweenPoints,
inout notnull array< vector > points )
static
Parameters
[in]minDistanceBetweenPoints2D distance between consecutive points
[in,out]points
Returns
true on success, false on wrong input (less than 3 points)

◆ RemovePointsCloseToShape()

static bool SCR_ParallelShapeHelper.RemovePointsCloseToShape ( notnull ShapeEntity shapeEntity,
float deletionRadius,
inout notnull array< vector > points )
static
Parameters
[in]shapeEntity
[in]deletionRadius3D deletion radius - must be greater than zero
[in,out]pointspoints relative to the shape
Returns
true on success, false on failure (wrong points, etc)

◆ RemovePointsCloseToShapeXZ()

static bool SCR_ParallelShapeHelper.RemovePointsCloseToShapeXZ ( notnull ShapeEntity shapeEntity,
float deletionRadius,
inout notnull array< vector > points )
static
Parameters
[in]shapeEntity
[in]deletionRadius2D deletion radius - must be greater than zero
[in,out]points
Returns
true on success, false on failure (wrong points, deletionRadius <= 0 etc)

◆ SnapRelativePointsToGround()

static bool SCR_ParallelShapeHelper.SnapRelativePointsToGround ( notnull ShapeEntity shapeEntity,
inout notnull array< vector > points )
static
Parameters
[in]shapeEntity
[in,out]points
Returns
The documentation for this interface was generated from the following file:
Generated by doxygen 1.11.0