Version: 2022.1
LanguageEnglish
  • C#

TerrainPaintTool<T0>.OnRenderBrushPreview

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

Declaration

public void OnRenderBrushPreview(Terrain terrain, TerrainTools.IOnSceneGUI editContext);

Parameters

terrain Active Terrain object.
editContext Interface for communication between Editor and Paint tools.

Description

Use this method to implement custom tool preview and UI behavior that will only render while the mouse is within the SceneView bounds or while you're actively using this tool.

Unity calls this method when the mouse is within the SceneView viewport bounds, and the EditorGUIUtility.hotControl is set to 0 or to the Terrain control ID provided by the IOnSceneGUI context instance. This is usually when no other tools are active, or when you're actively using this tool.

See Also: Editor.OnSceneGUI, SceneView, TerrainPaintTool_1.OnSceneGUI, EditorGUIUtility.hotControl, GUIUtility.hotControl.