Version: 2023.2
LanguageEnglish
  • C#

Tools

class in UnityEditor

/

Inherits from:ScriptableObject

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

Class used to manipulate the tools used in Unity's Scene View.

Static Properties

currentThe tool that is currently selected for the Scene View.
handlePositionThe position of the tool handle in world space.
handleRectThe rectangle used for the rect tool.
handleRectRotationThe rotation of the rect tool handle in world space.
handleRotationThe rotation of the tool handle in world space.
hiddenHides the Tools(Move, Rotate, Resize) handles in the Scene view.
pivotModeAre we in Center or Pivot mode.
pivotRotationWhat's the rotation of the tool handle.
rectBlueprintModeIs the rect handle in blueprint mode?
viewToolThe option that is currently active for the View tool in the Scene view.
viewToolActiveReturns true if the active tool is a view or navigation tool.
visibleLayersWhich layers are visible in the Scene view.

Events

pivotModeChangedCallback triggered when the pivot mode changes.
pivotRotationChangedCallback triggered when the pivot rotation changes.
viewToolChangedCallback triggered when the view tool changes.

Inherited Members

Properties

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
CreateInstanceCreates an instance of a scriptable object.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

Messages

AwakeCalled when an instance of ScriptableObject is created.
OnDestroyThis function is called when the scriptable object will be destroyed.
OnDisableThis function is called when the scriptable object goes out of scope.
OnEnableThis function is called when the object is loaded.
OnValidateEditor-only function that Unity calls when the script is loaded or a value changes in the Inspector.
ResetReset to default values.