Base class for a compound handle to edit a bounding volume in the Scene view.
This class allows you to display a shape with up to six control handles for simultaneously editing the size and center of a bounding volume. Dragging on any one control handle will expand the volume along the control handle's axis. All classes that inherit from this class also gain the following modifier keys while a control handle is being dragged:
• Alt: Pin the center of the volume to its location at the time the control handle was clicked and grow the size in both directions along the control handle's axis of movement.
• Shift: Uniformly scale the volume along all enabled axes in proportion to its size at the time the control handle was clicked.
The handle rendered by this class's DrawHandle method is affected by global state in the Handles class, such as Handles.matrix and Handles.color.
See Also: Editor.OnSceneGUI, Handles.SetCamera.
axes | Flags specifying which axes should display control handles. |
center | Returns or specifies the center of the bounding volume for the handle. |
handleColor | Returns or specifies the color of the control handles. |
midpointHandleDrawFunction | An optional CapFunction to use when displaying the control handles. Defaults to Handles.DotHandleCap if no value is specified. |
midpointHandleSizeFunction | The SizeFunction to specify how large the midpoint control handles should be. |
wireframeColor | Returns or specifies the color of the wireframe shape. |
PrimitiveBoundsHandle | Create a new instance of the PrimitiveBoundsHandle class. |
DrawHandle | A function to display this instance in the current handle camera using its current configuration. |
SetColor | Sets handleColor and wireframeColor to the same value. |
DrawWireframe | Draw a wireframe shape for this instance. Subclasses must implement this method. |
GetSize | Gets the current size of the bounding volume for this instance. |
IsAxisEnabled | Gets a value indicating whether the specified axis is enabled for the current instance. |
OnHandleChanged | A callback for when a control handle was dragged in the Scene. |
SetSize | Sets the current size of the bounding volume for this instance. |
DefaultMidpointHandleSizeFunction | A SizeFunction that returns a fixed screen-space size. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.