GetPhysicsShape
Gets a physics shape from the Sprite by its index.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
GetPhysicsShape(int, List<Vector2>)
Gets a physics shape from the Sprite by its index.
public int GetPhysicsShape(int shapeIdx, List<Vector2> physicsShape)
Parameters
The index of the physics shape to retrieve.
An ordered list of the points in the selected physics shape to store points in.
Returns
Type | Description |
|---|---|
| int | The number of points stored in the given list. |
Remarks
A physics shape is a cyclic sequence of line segments between points that define the outline of the Sprite used for physics. Since the Sprite can have holes and discontinuous parts, its outline is not necessarily defined by a single physics shape.
GetPhysicsShape(int)
Gets a physics shape from the Sprite by its index.
public ReadOnlySpan<Vector2> GetPhysicsShape(int shapeIdx)
Parameters
The index of the physics shape to retrieve.
Returns
Type | Description |
|---|---|
| ReadOnlySpan<Vector2> | The physics shape as a span of vertices. It is recommended that you immediately extract what information you need and not directly reference the returned data as any subsequent change to the physics shape(s) could result in a crash when iterating the span. |
Remarks
A physics shape is a cyclic sequence of line segments between points that define the outline of the Sprite used for physics. Since the Sprite can have holes and discontinuous parts, its outline is not necessarily defined by a single physics shape.