Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

GridBrushEditor

class in UnityEditor

/

Inherits from:GridBrushEditorBase

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

Editor for GridBrush.

Properties

brushThe GridBrush that is the target for this editor.
validTargetsReturns all valid targets that the brush can edit.

Public Methods

BoxFillPreviewDoes a preview of what happens when a GridBrush.BoxFill is done with the same parameters.
ClearPreviewClears any preview drawn previously by the GridBrushEditor.
FloodFillPreviewDoes a preview of what happens when a GridBrush.FloodFill is done with the same parameters.
OnPaintSceneGUICallback for painting the GUI for the GridBrush in the Scene View.
OnSelectionInspectorGUICallback for drawing the Inspector GUI when there is an active GridSelection made in a Tilemap.
PaintPreviewPaints preview data into a cell of a grid given the coordinates of the cell.
RegisterUndoCallback for registering an Undo action before the GridBrushBase does the current GridBrushBase.Tool action.

Inherited Members

Properties

serializedObjectA SerializedObject representing the object or objects being inspected.
targetThe object being inspected.
targetsAn array of all the object being inspected.
validTargetsReturns all valid targets that the brush can edit.
hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Methods

DrawDefaultInspectorDraw the built-in inspector.
DrawHeaderCall this function to draw the header of the editor.
DrawPreviewThe first entry point for Preview Drawing.
GetInfoStringImplement this method to show asset information on top of the asset preview.
GetPreviewTitleOverride this method if you want to change the label of the Preview area.
HasPreviewGUIOverride this method in subclasses if you implement OnPreviewGUI.
OnInspectorGUIImplement this function to make a custom inspector.
OnInteractivePreviewGUIImplement to create your own interactive custom preview. Interactive custom previews are used in the preview area of the inspector and the object selector.
OnPreviewGUIImplement to create your own custom preview for the preview area of the inspector, primary editor headers and the object selector.
OnPreviewSettingsOverride this method if you want to show custom controls in the preview header.
RenderStaticPreviewOverride this method if you want to render a static preview.
RepaintRepaint any inspectors that shows this editor.
RequiresConstantRepaintDoes this edit require to be repainted constantly in its current state?
UseDefaultMarginsOverride this method in subclasses to return false if you don't want default margins.
OnMouseEnterCallback when the mouse cursor enters a paintable region.
OnMouseLeaveCallback when the mouse cursor leaves a paintable region.
OnPaintInspectorGUICallback for painting the inspector GUI for the GridBrush in the tilemap palette.
OnToolActivatedCallback when a Tool is activated.
OnToolDeactivatedCallback when a Tool is deactivated.
GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the GameObject.

Protected Methods

ShouldHideOpenButtonReturns the visibility setting of the "open" button in the Inspector.

Static Methods

CreateCachedEditorOn return previousEditor is an editor for targetObject or targetObjects. The function either returns if the editor is already tracking the objects, or Destroys the previous editor and creates a new one.
CreateCachedEditorWithContextCreates a cached editor using a context object.
CreateEditorMake a custom editor for targetObject or targetObjects.
CreateEditorWithContextMake a custom editor for targetObject or targetObjects with a context object.
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.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active 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

OnSceneGUIEnables the Editor to handle an event in the scene view.
AwakeThis function is called when the ScriptableObject script is started.
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.