CapsuleBoundsHandle
A compound handle to edit a capsule-shaped bounding volume in the Scene view.
Read time 2 minutesLast updated 12 days ago
Definition
- Type: Class
- Namespace: UnityEditor.IMGUI.Controls
- Assembly: UnityEditor.CoreModule
- Inherits from: PrimitiveBoundsHandle
public class CapsuleBoundsHandle : PrimitiveBoundsHandle
Remarks
A capsule volume is defined by two parameters. The CapsuleBoundsHandle.height specifies the upper and lower bounds along the CapsuleBoundsHandle.heightAxis, while the CapsuleBoundsHandle.radius specifies the radius of the capsule's cross section between the upper and lower points on its height axis.
2D and 3D CapsuleBoundsHandle in the Scene View.
Additional Resources: PrimitiveBoundsHandle.
Constructors
Constructor | Description |
|---|---|
| CapsuleBoundsHandle() | Create a new instance of the CapsuleBoundsHandle class. |
Properties
Property | Description |
|---|---|
| height | Returns or specifies the height of the capsule bounding volume. |
| heightAxis | Returns or specifies the axis in the handle's space to which CapsuleBoundsHandle.height maps. The CapsuleBoundsHandle.radius maps to the remaining axes. |
| radius | Returns or specifies the radius of the capsule bounding volume. |
Methods
Method | Description |
|---|---|
| DrawWireframe | Draw a wireframe capsule for this instance. |
| OnHandleChanged | A callback for when a control handle was dragged in the Scene. |
Enums
Enum | Description |
|---|---|
| CapsuleBoundsHandle.HeightAxis | An enumeration for specifying which axis on a CapsuleBoundsHandle object maps to the CapsuleBoundsHandle.height parameter. |