Class BaseBrushUIGroup

Inheritance
Object
BaseBrushUIGroup
DefaultBrushUIGroup
MeshBrushUIGroup
WindBrushUIGroup
Namespace: UnityEditor.Experimental.TerrainAPI
Syntax
public abstract class BaseBrushUIGroup : IBrushUIGroup, IBrushEventHandler, IBrushTerrainCache

Constructors

BaseBrushUIGroup(String, Func<TerrainToolsAnalytics.IBrushParameter[]>)

Declaration
protected BaseBrushUIGroup(string name, Func<TerrainToolsAnalytics.IBrushParameter[]> analyticsCall = null)
Parameters
Type Name Description
String name
Func<TerrainToolsAnalytics.IBrushParameter[]> analyticsCall

Fields

isRecording

Declaration
public static bool isRecording
Field Value
Type Description
Boolean

Properties

allowPaint

Declaration
public bool allowPaint { get; }
Property Value
Type Description
Boolean
Implements

brushMaskFilterStack

Declaration
public FilterStack brushMaskFilterStack { get; }
Property Value
Type Description
FilterStack
Implements

brushMaskFilterStackView

Declaration
public FilterStackView brushMaskFilterStackView { get; }
Property Value
Type Description
FilterStackView
Implements

brushName

Declaration
public string brushName { get; }
Property Value
Type Description
String

brushRotation

Declaration
public float brushRotation { get; set; }
Property Value
Type Description
Single
Implements

brushScatter

Declaration
public float brushScatter { get; }
Property Value
Type Description
Single

brushSize

Declaration
public float brushSize { get; set; }
Property Value
Type Description
Single
Implements

brushSpacing

Declaration
public float brushSpacing { get; }
Property Value
Type Description
Single
Implements

brushStrength

Declaration
public float brushStrength { get; set; }
Property Value
Type Description
Single
Implements

canUpdateTerrainUnderCursor

Declaration
public bool canUpdateTerrainUnderCursor { get; }
Property Value
Type Description
Boolean
Implements

InvertStrength

Declaration
public bool InvertStrength { get; }
Property Value
Type Description
Boolean
Implements

isInUse

Declaration
public bool isInUse { get; }
Property Value
Type Description
Boolean
Implements

isRaycastHitUnderCursorValid

Declaration
public bool isRaycastHitUnderCursorValid { get; }
Property Value
Type Description
Boolean
Implements

raycastHitUnderCursor

Declaration
public RaycastHit raycastHitUnderCursor { get; }
Property Value
Type Description
RaycastHit
Implements

terrainUnderCursor

Declaration
public Terrain terrainUnderCursor { get; }
Property Value
Type Description
Terrain
Implements

validationMessage

Declaration
public virtual string validationMessage { get; set; }
Property Value
Type Description
String
Implements

Methods

AddController<TController>(TController)

Declaration
protected TController AddController<TController>(TController newController)
    where TController : IBrushController
Parameters
Type Name Description
TController newController
Returns
Type Description
TController
Type Parameters
Name Description
TController

AddModifierKeyController<TController>(TController)

Declaration
protected TController AddModifierKeyController<TController>(TController newController)
    where TController : IBrushModifierKeyController
Parameters
Type Name Description
TController newController
Returns
Type Description
TController
Type Parameters
Name Description
TController

AddRotationController<TController>(TController)

Declaration
protected TController AddRotationController<TController>(TController newController)
    where TController : IBrushRotationController
Parameters
Type Name Description
TController newController
Returns
Type Description
TController
Type Parameters
Name Description
TController

AddScatterController<TController>(TController)

Declaration
protected TController AddScatterController<TController>(TController newController)
    where TController : IBrushScatterController
Parameters
Type Name Description
TController newController
Returns
Type Description
TController
Type Parameters
Name Description
TController

AddSizeController<TController>(TController)

Declaration
protected TController AddSizeController<TController>(TController newController)
    where TController : IBrushSizeController
Parameters
Type Name Description
TController newController
Returns
Type Description
TController
Type Parameters
Name Description
TController

AddSmoothingController<TController>(TController)

Declaration
protected TController AddSmoothingController<TController>(TController newController)
    where TController : IBrushSmoothController
Parameters
Type Name Description
TController newController
Returns
Type Description
TController
Type Parameters
Name Description
TController

AddSpacingController<TController>(TController)

Declaration
protected TController AddSpacingController<TController>(TController newController)
    where TController : IBrushSpacingController
Parameters
Type Name Description
TController newController
Returns
Type Description
TController
Type Parameters
Name Description
TController

AddStrengthController<TController>(TController)

Declaration
protected TController AddStrengthController<TController>(TController newController)
    where TController : IBrushStrengthController
Parameters
Type Name Description
TController newController
Returns
Type Description
TController
Type Parameters
Name Description
TController

AppendBrushInfo(Terrain, IOnSceneGUI, StringBuilder)

Declaration
public virtual void AppendBrushInfo(Terrain terrain, IOnSceneGUI editContext, StringBuilder builder)
Parameters
Type Name Description
Terrain terrain
IOnSceneGUI editContext
StringBuilder builder
Implements

ConsumeEvents(Terrain, IOnSceneGUI)

Declaration
public void ConsumeEvents(Terrain terrain, IOnSceneGUI editContext)
Parameters
Type Name Description
Terrain terrain
IOnSceneGUI editContext
Implements

GetBrushMask(RenderTexture, RenderTexture)

Declaration
public void GetBrushMask(RenderTexture sourceRenderTexture, RenderTexture destinationRenderTexture)
Parameters
Type Name Description
RenderTexture sourceRenderTexture
RenderTexture destinationRenderTexture
Implements

GetBrushMask(Terrain, RenderTexture, RenderTexture)

Declaration
public void GetBrushMask(Terrain terrain, RenderTexture sourceRenderTexture, RenderTexture destinationRenderTexture)
Parameters
Type Name Description
Terrain terrain
RenderTexture sourceRenderTexture
RenderTexture destinationRenderTexture
Implements

GetBrushMask(Terrain, RenderTexture, RenderTexture, Vector3, Single, Single)

Declaration
public void GetBrushMask(Terrain terrain, RenderTexture sourceRenderTexture, RenderTexture destinationRenderTexture, Vector3 position, float scale, float rotation)
Parameters
Type Name Description
Terrain terrain
RenderTexture sourceRenderTexture
RenderTexture destinationRenderTexture
Vector3 position
Single scale
Single rotation
Implements

LockTerrainUnderCursor(Boolean)

Declaration
public void LockTerrainUnderCursor(bool cursorVisible)
Parameters
Type Name Description
Boolean cursorVisible
Implements

ModifierActive(BrushModifierKey)

Declaration
public bool ModifierActive(BrushModifierKey k)
Parameters
Type Name Description
BrushModifierKey k
Returns
Type Description
Boolean
Implements

OnEnterToolMode()

Declaration
public virtual void OnEnterToolMode()
Implements

OnExitToolMode()

Declaration
public virtual void OnExitToolMode()
Implements

OnInspectorGUI(Terrain, IOnInspectorGUI)

Declaration
public virtual void OnInspectorGUI(Terrain terrain, IOnInspectorGUI editContext)
Parameters
Type Name Description
Terrain terrain
IOnInspectorGUI editContext
Implements

OnPaint(Terrain, IOnPaint)

Declaration
public virtual void OnPaint(Terrain terrain, IOnPaint editContext)
Parameters
Type Name Description
Terrain terrain
IOnPaint editContext
Implements

OnSceneGUI(Terrain, IOnSceneGUI)

Declaration
public virtual void OnSceneGUI(Terrain terrain, IOnSceneGUI editContext)
Parameters
Type Name Description
Terrain terrain
IOnSceneGUI editContext
Implements

OnSceneGUI2D(Terrain, IOnSceneGUI)

Declaration
public virtual void OnSceneGUI2D(Terrain terrain, IOnSceneGUI editContext)
Parameters
Type Name Description
Terrain terrain
IOnSceneGUI editContext
Implements

RegisterEvent(Event)

Declaration
public void RegisterEvent(Event newEvent)
Parameters
Type Name Description
Event newEvent
Implements

RemoveAllControllers()

Declaration
protected void RemoveAllControllers()

RemoveController<TController>(TController)

Declaration
protected void RemoveController<TController>(TController controller)
    where TController : IBrushController
Parameters
Type Name Description
TController controller
Type Parameters
Name Description
TController

RequestRepaint()

Declaration
public void RequestRepaint()
Implements

ScatterBrushStamp(ref Terrain, ref Vector2)

Declaration
public bool ScatterBrushStamp(ref Terrain terrain, ref Vector2 uv)
Parameters
Type Name Description
Terrain terrain
Vector2 uv
Returns
Type Description
Boolean
Implements

UnlockTerrainUnderCursor()

Declaration
public void UnlockTerrainUnderCursor()
Implements