GetPath
Gets a path from the Collider by its index.
Read time 2 minutesLast updated 6 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.Physics2DModule
GetPath(int, Vector2[])
Gets a path from the Collider by its index.
public int GetPath(int index, Vector2[] points)
Parameters
The index of the path from 0 to CompositeCollider2D.pathCount minus 1.
An ordered array of the vertices (points) in the selected path.
Returns
Type | Description |
|---|---|
| int | Returns the number of points placed in the |
Remarks
A path is a cyclic sequence of line segments between points that define the outline of the Collider. Since the Collider can have holes and discontinuous parts, its shape is not necessarily defined by a single path.
Returns the number of points placed in the array.
pointsAdditional Resources: CompositeCollider2D.GetPathPointCount & CompositeCollider2D.pathCount.
GetPath(int, List<Vector2>)
Gets a path from the Collider by its index.
public int GetPath(int index, List<Vector2> points)
Parameters
The index of the path from 0 to CompositeCollider2D.pathCount minus 1.
An ordered list of the vertices (points) in the selected path.
Returns
Type | Description |
|---|---|
| int | Returns the number of points placed in the |
Remarks
A path is a cyclic sequence of line segments between points that define the outline of the Collider. Since the Collider can have holes and discontinuous parts, its shape is not necessarily defined by a single path.
The integer return value is the number of results written into the list. The results list will be resized if it doesn't contain enough elements to report all the results. This prevents memory from being allocated for results when the list does not need to be resized, and improves garbage collection performance when the query is performed frequently.
resultsresultsAdditional Resources: CompositeCollider2D.GetPathPointCount & CompositeCollider2D.pathCount.
GetPath(int, Allocator)
Gets a path from the Collider by its index.
public NativeArray<Vector2> GetPath(int index, Allocator allocator = Allocator.Temp)
Parameters
The index of the path from 0 to CompositeCollider2D.pathCount minus 1.
The memory allocator to use for the results. This can only be Allocator.Temp, Allocator.TempJob or Allocator.Persistent.
Returns
Type | Description |
|---|---|
| NativeArray<Vector2> | The NativeArray that contains an ordered list of the vertices (points) in the selected path. This must be disposed of unless it contains no results. |
Remarks
A path is a cyclic sequence of line segments between points that define the outline of the Collider. Since the Collider can have holes and discontinuous parts, its shape is not necessarily defined by a single path.
Additional Resources: CompositeCollider2D.GetPathPointCount & CompositeCollider2D.pathCount.