Interface IBrushUIGroup

Namespace: UnityEditor.Experimental.TerrainAPI

Syntax

public interface IBrushUIGroup

Properties

allowPaint

Are we allowed to paint with this brush?

Declaration

bool allowPaint { get; }

Property Value

Type	Description
Boolean

brushMaskFilterStack

Declaration

FilterStack brushMaskFilterStack { get; }

Property Value

Type	Description
FilterStack

brushMaskFilterStackView

Declaration

FilterStackView brushMaskFilterStackView { get; }

Property Value

Type	Description
FilterStackView

brushRotation

The rotation of the brush (in degrees).

Declaration

float brushRotation { get; }

Property Value

Type	Description
Single

brushSize

The normalized size of the brush.

Declaration

float brushSize { get; }

Property Value

Type	Description
Single

brushSpacing

The spacing used when applying certain brushes.

Declaration

float brushSpacing { get; }

Property Value

Type	Description
Single

brushStrength

The normalized strength of the brush when applied.

Declaration

float brushStrength { get; }

Property Value

Type	Description
Single

InvertStrength

Declaration

bool InvertStrength { get; }

Property Value

Type	Description
Boolean

isInUse

Declaration

bool isInUse { get; }

Property Value

Type	Description
Boolean

isRaycastHitUnderCursorValid

Declaration

bool isRaycastHitUnderCursorValid { get; }

Property Value

Type	Description
Boolean

raycastHitUnderCursor

Declaration

RaycastHit raycastHitUnderCursor { get; }

Property Value

Type	Description
RaycastHit

terrainUnderCursor

Declaration

Terrain terrainUnderCursor { get; }

Property Value

Type	Description
Terrain

validationMessage

Declaration

string validationMessage { get; set; }

Property Value

Type	Description
String

Methods

AppendBrushInfo(Terrain, IOnSceneGUI, StringBuilder)

Declaration

void AppendBrushInfo(Terrain terrain, IOnSceneGUI editContext, StringBuilder builder)

Parameters

Type	Name	Description
Terrain	terrain
IOnSceneGUI	editContext
StringBuilder	builder

GetBrushMask(RenderTexture, RenderTexture)

Declaration

void GetBrushMask(RenderTexture sourceRenderTexture, RenderTexture destinationRenderTexture)

Parameters

Type	Name	Description
RenderTexture	sourceRenderTexture
RenderTexture	destinationRenderTexture

GetBrushMask(Terrain, RenderTexture, RenderTexture)

Declaration

void GetBrushMask(Terrain terrain, RenderTexture sourceRenderTexture, RenderTexture destinationRenderTexture)

Parameters

Type	Name	Description
Terrain	terrain
RenderTexture	sourceRenderTexture
RenderTexture	destinationRenderTexture

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

Declaration

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

ModifierActive(BrushModifierKey)

Declaration

bool ModifierActive(BrushModifierKey k)

Parameters

Type	Name	Description
BrushModifierKey	k

Returns

Type	Description
Boolean

OnEnterToolMode()

Declaration

void OnEnterToolMode()

OnExitToolMode()

Declaration

void OnExitToolMode()

OnInspectorGUI(Terrain, IOnInspectorGUI)

Declaration

void OnInspectorGUI(Terrain terrain, IOnInspectorGUI editContext)

Parameters

Type	Name	Description
Terrain	terrain
IOnInspectorGUI	editContext

OnPaint(Terrain, IOnPaint)

Declaration

void OnPaint(Terrain terrain, IOnPaint editContext)

Parameters

Type	Name	Description
Terrain	terrain
IOnPaint	editContext

OnSceneGUI(Terrain, IOnSceneGUI)

Declaration

void OnSceneGUI(Terrain terrain, IOnSceneGUI editContext)

Parameters

Type	Name	Description
Terrain	terrain
IOnSceneGUI	editContext

OnSceneGUI2D(Terrain, IOnSceneGUI)

Declaration

void OnSceneGUI2D(Terrain terrain, IOnSceneGUI editContext)

Parameters

Type	Name	Description
Terrain	terrain
IOnSceneGUI	editContext

ScatterBrushStamp(ref Terrain, ref Vector2)

Scatters the brush around the specified UV on the specified terrain. If the scattered UV leaves the current terrain then the terrain AND UV are modified for the terrain the UV is now over.

Declaration

bool ScatterBrushStamp(ref Terrain terrain, ref Vector2 uv)

Parameters

Type	Name	Description
Terrain	terrain	The terrain the scattered UV co-ordinate is actually on.
Vector2	uv	The UV co-ordinate passed in transformed into the UV co-ordinate relative to the scattered terrain.

Returns

Type	Description
Boolean	"true" if we scattered to a terrain, "false" if we fell off ALL terrains.