class in UnityEditor.TerrainTools
/
Inherits from:EditorTools.EditorTool
The abstract class that TerrainPaintToolWithOverlays inherits from.
Contains fields that can be overridden when you implement your own terrain painting tools to display in Terrain overlays. When you create custom Terrain Tools, they must inherit from the TerrainPaintToolWithOverlays<T0> class rather than this class.
| Category | The TerrainCategory that the Terrain Tool belongs to. |
| HasBrushAttributes | True if the Terrain Tool has brush attributes, false otherwise. |
| HasBrushMask | True if Terrain Tool has brush masks, false otherwise. |
| HasToolSettings | True if Terrain Tool has custom settings, false otherwise. |
| IconIndex | The index at which you should place the Terrain Tool in the Terrain Tools overlay. |
| OffIcon | The icon displayed in the Terrain Tools overlay when the Terrain Tool isn't selected. |
| OnIcon | The icon displayed in the Terrain Tools overlay when the terrain tool is selected. |
| Terrain | The last hit terrain or the last active instance of a terrain object. |
| GetDescription | Description of the Terrain Tool. |
| GetName | Name of the Terrain Tool. |
| OnActivated | This function is called when the tool is activated. |
| OnDisable | Called when the tool is destroyed. |
| OnEnable | Called when the tool is created. |
| OnEnterToolMode | This function is called when the Terrain Tool is activated. |
| OnExitToolMode | This function is called when the Terrain Tool becomes inactive. |
| OnInspectorGUI | Custom Terrain Tool OnInspectorGUI callback. |
| OnPaint | Custom Terrain Tool paint callback. |
| OnRenderBrushPreview | Use this method to implement custom tool preview and UI behavior that only renders while the mouse is within the SceneView bounds or while you're actively using this tool. |
| OnSceneGUI | Custom Terrain Tool OnSceneGUI callback. |
| OnToolGUI | This method is used to implement the custom terrain editor paint tool. |
| OnToolSettingsGUI | Contains the IMGUI code for custom settings beyond the common settings. |
| OnWillBeDeactivated | Invoked before the terrain paint tool with overlays stops being the active tool. |
| gridSnapEnabled | Use this property to allow the current EditorTool to enable/disable grid snapping. |
| target | The object being inspected. |
| targets | An array of the objects being inspected. |
| toolbarIcon | The icon and tooltip for this custom editor tool. If this function is not implemented, the toolbar displays the Inspector icon for the target type. If no target type is defined, the toolbar displays the Tool Mode icon. |
| hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
| name | The name of the object. |
| IsAvailable | Checks whether the custom editor tool is available based on the state of the editor. |
| PopulateMenu | Adds menu items to Scene view context menu. |
| GetInstanceID | Gets the instance ID of the object. |
| ToString | Returns the name of the object. |
| Destroy | Removes a GameObject, component or asset. |
| DestroyImmediate | Destroys the object obj immediately. You are strongly recommended to use Destroy instead. |
| DontDestroyOnLoad | Do not destroy the target Object when loading a new Scene. |
| FindAnyObjectByType | Retrieves any active loaded object of Type type. |
| FindFirstObjectByType | Retrieves the first active loaded object of Type type. |
| 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 must be related to some GameObject) and returns the AsyncInstantiateOperation. |
| CreateInstance | Creates an instance of a scriptable object. |
| bool | Does 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. |
| Awake | Called when an instance of ScriptableObject is created. |
| OnDestroy | This function is called when the scriptable object will be destroyed. |
| OnValidate | Editor-only function that Unity calls when the script is loaded or a value changes in the Inspector. |
| Reset | Reset to default values. |