Class BaseBrushRenderUIGroupUnderCursor<TBase>

Inheritance

System.Object

BaseBrushRenderUIGroupUnderCursor<TBase>

BrushRenderPreviewUIGroupUnderCursor

BrushRenderUIGroupUnderCursor

Namespace: UnityEditor.Experimental.TerrainAPI

Syntax

public abstract class BaseBrushRenderUIGroupUnderCursor<TBase> : IBrushRenderUnderCursor, IPaintContextRender, IDisposable where TBase : BrushRenderWithTerrainUiGroup

Type Parameters

Name	Description
TBase

Constructors

BaseBrushRenderUIGroupUnderCursor(IBrushUIGroup, String, Texture)

Declaration

protected BaseBrushRenderUIGroupUnderCursor(IBrushUIGroup uiGroup, string name, Texture brushTexture)

Parameters

Type	Name	Description
IBrushUIGroup	uiGroup
System.String	name
Texture	brushTexture

Fields

m_BrushRenderWithTerrain

Declaration

protected readonly TBase m_BrushRenderWithTerrain

Field Value

Type	Description
TBase

m_BrushTransformAtCreation

Declaration

protected readonly BrushTransform m_BrushTransformAtCreation

Field Value

Type	Description
BrushTransform

m_TerrainAtCreation

Declaration

protected readonly Terrain m_TerrainAtCreation

Field Value

Type	Description
Terrain

m_ValidBrushTransform

Declaration

protected readonly bool m_ValidBrushTransform

Field Value

Type	Description
System.Boolean

Properties

brushTexture

Declaration

public Texture brushTexture { get; }

Property Value

Type	Description
Texture

raycastHitUnderCursor

Declaration

protected RaycastHit raycastHitUnderCursor { get; }

Property Value

Type	Description
RaycastHit

terrainUnderCursor

Declaration

protected Terrain terrainUnderCursor { get; }

Property Value

Type	Description
Terrain

textureCoordUnderCursor

Declaration

protected Vector2 textureCoordUnderCursor { get; }

Property Value

Type	Description
Vector2

uiGroup

Declaration

public IBrushUIGroup uiGroup { get; }

Property Value

Type	Description
IBrushUIGroup

Methods

AcquireHeightmap(Boolean, Rect, Int32)

Declaration

public PaintContext AcquireHeightmap(bool writable, Rect boundsInTerrainSpace, int extraBorderPixels = 0)

Parameters

Type	Name	Description
System.Boolean	writable
Rect	boundsInTerrainSpace
System.Int32	extraBorderPixels

Returns

Type	Description
PaintContext

Implements

IBrushRenderUnderCursor.AcquireHeightmap(Boolean, Rect, Int32)

AcquireNormalmap(Boolean, Rect, Int32)

Declaration

public PaintContext AcquireNormalmap(bool writable, Rect boundsInTerrainSpace, int extraBorderPixels = 0)

Parameters

Type	Name	Description
System.Boolean	writable
Rect	boundsInTerrainSpace
System.Int32	extraBorderPixels

Returns

Type	Description
PaintContext

Implements

IBrushRenderUnderCursor.AcquireNormalmap(Boolean, Rect, Int32)

AcquireTexture(Boolean, Rect, TerrainLayer, Int32)

Declaration

public PaintContext AcquireTexture(bool writable, Rect boundsInTerrainSpace, TerrainLayer layer, int extraBorderPixels = 0)

Parameters

Type	Name	Description
System.Boolean	writable
Rect	boundsInTerrainSpace
TerrainLayer	layer
System.Int32	extraBorderPixels

Returns

Type	Description
PaintContext

Implements

IBrushRenderUnderCursor.AcquireTexture(Boolean, Rect, TerrainLayer, Int32)

CalculateBrushTransform(out BrushTransform)

Declaration

public bool CalculateBrushTransform(out BrushTransform brushTransform)

Parameters

Type	Name	Description
BrushTransform	brushTransform

Returns

Type	Description
System.Boolean

Implements

IBrushRenderUnderCursor.CalculateBrushTransform(out BrushTransform)

CalculateTransform(ref Terrain, out BrushTransform)

Declaration

protected virtual bool CalculateTransform(ref Terrain terrain, out BrushTransform brushTransform)

Parameters

Type	Name	Description
Terrain	terrain
BrushTransform	brushTransform

Returns

Type	Description
System.Boolean

Dispose()

Declaration

public void Dispose()

Release(PaintContext)

Declaration

public void Release(PaintContext paintContext)

Parameters

Type	Name	Description
PaintContext	paintContext

Implements

IBrushRenderUnderCursor.Release(PaintContext)

RenderBrush(PaintContext, Material, Int32)

Declaration

public void RenderBrush(PaintContext paintContext, Material material, int pass)

Parameters

Type	Name	Description
PaintContext	paintContext
Material	material
System.Int32	pass

Implements

IPaintContextRender.RenderBrush(PaintContext, Material, Int32)

SetupTerrainToolMaterialProperties(PaintContext, BrushTransform, Material)

Declaration

public void SetupTerrainToolMaterialProperties(PaintContext paintContext, BrushTransform brushTransform, Material material)

Parameters

Type	Name	Description
PaintContext	paintContext
BrushTransform	brushTransform
Material	material

Implements

IPaintContextRender.SetupTerrainToolMaterialProperties(PaintContext, BrushTransform, Material)