Version: 2023.2
LanguageEnglish
  • C#

SphereBoundsHandle

class in UnityEditor.IMGUI.Controls

/

Inherits from:IMGUI.Controls.PrimitiveBoundsHandle

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

A compound handle to edit a sphere-shaped bounding volume in the Scene view.

A sphere volume is defined by only a radius parameter, and so dragging a handle will always scale the volume uniformly.

2D and 3D SphereBoundsHandle in the Scene View.

Additional resources: PrimitiveBoundsHandle.

Properties

radiusReturns or specifies the radius of the sphere bounding volume.

Constructors

SphereBoundsHandleCreate a new instance of the SphereBoundsHandle class.

Protected Methods

DrawWireframeDraw a wireframe sphere for this instance.
OnHandleChangedA callback for when a control handle was dragged in the Scene.

Inherited Members

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.

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

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.
SetSizeSets the current size of the bounding volume for this instance.

Static Methods

DefaultMidpointHandleSizeFunctionA SizeFunction that returns a fixed screen-space size.