Version: 2023.2
LanguageEnglish
  • C#

PrimitiveBoundsHandle

class in UnityEditor.IMGUI.Controls

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

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.

Additional resources: Editor.OnSceneGUI, Handles.SetCamera.

Properties

axesFlags specifying which axes should display control handles.
centerReturns or specifies the center of the bounding volume for the handle.
handleColorReturns or specifies the color of the control handles.
midpointHandleDrawFunctionAn optional CapFunction to use when displaying the control handles. Defaults to Handles.DotHandleCap if no value is specified.
midpointHandleSizeFunctionThe SizeFunction to specify how large the midpoint control handles should be.
wireframeColorReturns or specifies the color of the wireframe shape.

Constructors

PrimitiveBoundsHandleCreate a new instance of the PrimitiveBoundsHandle class.

Public Methods

DrawHandleA function to display this instance in the current handle camera using its current configuration.
SetColorSets handleColor and wireframeColor to the same value.

Protected Methods

DrawWireframeDraw a wireframe shape for this instance. Subclasses must implement this method.
GetSizeGets the current size of the bounding volume for this instance.
IsAxisEnabledGets a value indicating whether the specified axis is enabled for the current instance.
OnHandleChangedA callback for when a control handle was dragged in the Scene.
SetSizeSets the current size of the bounding volume for this instance.

Static Methods

DefaultMidpointHandleSizeFunctionA SizeFunction that returns a fixed screen-space size.