Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


ToPolygons

Creates multiple PolygonGeometry from the specified geometry. A limit is imposed on small vertex distances so it is recommended that the geometry is scaled appropriately rather than on the returned geometry so geometry is not discarded due to it being invalid.
Read time 2 minutesLast updated 12 days ago

Definition

  • Type: Method
  • Namespace: Unity.U2D.Physics
  • Assembly: UnityEngine.PhysicsCore2DModule

ToPolygons(CircleGeometry, PhysicsTransform, float, Allocator)

Creates multiple PolygonGeometry from the specified geometry. A limit is imposed on small vertex distances so it is recommended that the geometry is scaled appropriately rather than on the returned geometry so geometry is not discarded due to it being invalid.
public static NativeArray<PolygonGeometry> ToPolygons(CircleGeometry geometry, PhysicsTransform transform, float curveStride = 0.06, Allocator allocator = Allocator.Temp)

Parameters

The geometry to convert to polygon geometry.

The transform used to specify where the geometry is positioned.

curveStride

The curve stride only used when creating curves i.e. shapes with a non-zero radius. Lower values produce more vertices, larger values fewer vertices. The valid range is [PhysicsComposer.MinCurveStride, 1.0].

allocator

The memory allocator to use for the results. This can only be Allocator.Temp, Allocator.TempJob or Allocator.Persistent.

Returns

Type

Description

NativeArray<PolygonGeometry>The created polygon geometries. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.

ToPolygons(CapsuleGeometry, PhysicsTransform, float, Allocator)

Creates multiple PolygonGeometry from the specified geometry. A limit is imposed on small vertex distances so it is recommended that the geometry is scaled appropriately rather than on the returned geometry so geometry is not discarded due to it being invalid.
public static NativeArray<PolygonGeometry> ToPolygons(CapsuleGeometry geometry, PhysicsTransform transform, float curveStride = 0.06, Allocator allocator = Allocator.Temp)

Parameters

The geometry to convert to polygon geometry.

The transform used to specify where the geometry is positioned.

curveStride

The curve stride only used when creating curves i.e. shapes with a non-zero radius. Lower values produce more vertices, larger values fewer vertices. The valid range is [PhysicsComposer.MinCurveStride, 1.0].

allocator

The memory allocator to use for the results. This can only be Allocator.Temp, Allocator.TempJob or Allocator.Persistent.

Returns

Type

Description

NativeArray<PolygonGeometry>The created polygon geometries. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.