Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


CreateChainGeometry

Create ChainGeometry from the composition by iterating all the layers added to the composition in the layer order specified, applying each operation specified. A limit is imposed on small vertex distances so be aware that this overload uses a vertex scale of _one so consider using the overload which allows you to increase this if required.
Read time 2 minutesLast updated 10 days ago

Definition

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

CreateChainGeometry(NativeArray<Vector2>, Allocator)

Create ChainGeometry from the composition by iterating all the layers added to the composition in the layer order specified, applying each operation specified. A limit is imposed on small vertex distances so be aware that this overload uses a vertex scale of _one so consider using the overload which allows you to increase this if required.
public NativeArray<ChainGeometry> CreateChainGeometry(out NativeArray<Vector2> vertices, Allocator allocator = Allocator.Temp)

Parameters

The total set of vertices that the chain geometry uses. This must be disposed.

allocator

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

Returns

Type

Description

NativeArray<ChainGeometry>A NativeArray containing the Chain Geometry created from the composer. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.

CreateChainGeometry(NativeArray<Vector2>, Vector2, Allocator)

Create ChainGeometry from the composition by iterating all the layers added to the composition in the layer order specified, applying each operation specified. A limit is imposed on small vertex distances so it is recommended that scaling is applied here rather than on the returned geometry so geometry is not discarded due to it being invalid.
public NativeArray<ChainGeometry> CreateChainGeometry(out NativeArray<Vector2> vertices, Vector2 vertexScale, Allocator allocator = Allocator.Temp)

Parameters

The total set of vertices that the chain geometry uses. This must be disposed.

vertexScale

The scaling to be applied to the composer vertices.

allocator

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

Returns

Type

Description

NativeArray<ChainGeometry>A NativeArray containing the Chain Geometry created from the composer. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.