Tools

class in UnityEditor

Leave feedback

Suggest a change

Description

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

Static Properties

Property	Description
current	The tool that is currently selected for the Scene View.
handlePosition	The position of the tool handle in world space.
handleRect	The rectangle used for the rect tool.
handleRectRotation	The rotation of the rect tool handle in world space.
handleRotation	The rotation of the tool handle in world space.
hidden	Hides the Tools(Move, Rotate, Resize) handles in the Scene view.
pivotMode	Are we in Center or Pivot mode.
pivotRotation	What's the rotation of the tool handle.
rectBlueprintMode	Is the rect handle in blueprint mode?
viewTool	The option that is currently active for the View tool in the Scene view.
viewToolActive	Returns true if the active tool is a view or navigation tool.
visibleLayers	Which layers are visible in the Scene view.

Events

Event	Description
pivotModeChanged	Callback triggered when the pivot mode changes.
pivotRotationChanged	Callback triggered when the pivot rotation changes.
viewToolChanged	Callback triggered when the view tool changes.

Inherited Members

Properties

Property	Description
hideFlags	Controls whether the object is hidden, saved with the scene, and editable by the user.
name	The name of the object.

Public Methods

Method	Description
GetEntityId	Gets the EntityId of the object.
GetHashCode	Returns the hash code for the object.
ToString	Returns the name of the object.

Static Methods

Method	Description
Destroy	Removes a GameObject, component, or asset.
DestroyImmediate	Destroys the specified object immediately. Use with caution and in Edit mode only.
DontDestroyOnLoad	Do not destroy the target Object when loading a new Scene.
FindAnyObjectByType	Retrieves any active loaded object of Type T.
FindObjectsByType	Retrieves a list of all loaded objects of Type type.
Instantiate	Clones the object original and returns the clone.
InstantiateAsync	Captures a snapshot of the original object that's related to another GameObject and obtains an AsyncInstantiateOperation instance of the resulting objects.
CreateInstance	Creates an instance of a scriptable object.

Operators

Operator	Description
bool	Determines whether the object exists.
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

Message	Description
Awake	Called when an instance of ScriptableObject is created.
OnDestroy	This function is called when the scriptable object will be destroyed.
OnDisable	This function is called when the scriptable object goes out of scope.
OnEnable	This function is called when the object is loaded.
OnValidate	Editor-only function that Unity calls when the script is loaded or a value changes in the Inspector.
Reset	Reset to default values.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Scripting API