Class BrushRenderWithTerrainUiGroup | Terrain Tools | 3.0.2-preview.3
docs.unity3d.com
    Show / Hide Table of Contents

    Class BrushRenderWithTerrainUiGroup

    Inheritance
    Object
    BrushRenderWithTerrainUiGroup
    BrushRenderPreviewWithTerrainUiGroup
    Namespace: UnityEditor.Experimental.TerrainAPI
    Syntax
    public class BrushRenderWithTerrainUiGroup : IBrushRenderWithTerrain, IPaintContextRender, IDisposable

    Constructors

    BrushRenderWithTerrainUiGroup(IBrushUIGroup, String, Texture)

    Declaration
    public BrushRenderWithTerrainUiGroup(IBrushUIGroup uiGroup, string name, Texture brushTexture)
    Parameters
    Type Name Description
    IBrushUIGroup uiGroup
    String name
    Texture brushTexture

    Properties

    brushTexture

    Declaration
    public Texture brushTexture { get; }
    Property Value
    Type Description
    Texture

    uiGroup

    Declaration
    public IBrushUIGroup uiGroup { get; }
    Property Value
    Type Description
    IBrushUIGroup

    Methods

    AcquireHeightmap(Boolean, Terrain, Rect, Int32)

    Declaration
    public PaintContext AcquireHeightmap(bool writable, Terrain terrain, Rect boundsInTerrainSpace, int extraBorderPixels = 0)
    Parameters
    Type Name Description
    Boolean writable
    Terrain terrain
    Rect boundsInTerrainSpace
    Int32 extraBorderPixels
    Returns
    Type Description
    PaintContext
    Implements
    IBrushRenderWithTerrain.AcquireHeightmap(Boolean, Terrain, Rect, Int32)

    AcquireHolesTexture(Boolean, Terrain, Rect, Int32)

    Declaration
    public PaintContext AcquireHolesTexture(bool writable, Terrain terrain, Rect boundsInTerrainSpace, int extraBorderPixels = 0)
    Parameters
    Type Name Description
    Boolean writable
    Terrain terrain
    Rect boundsInTerrainSpace
    Int32 extraBorderPixels
    Returns
    Type Description
    PaintContext
    Implements
    IBrushRenderWithTerrain.AcquireHolesTexture(Boolean, Terrain, Rect, Int32)

    AcquireNormalmap(Boolean, Terrain, Rect, Int32)

    Declaration
    public PaintContext AcquireNormalmap(bool writable, Terrain terrain, Rect boundsInTerrainSpace, int extraBorderPixels = 0)
    Parameters
    Type Name Description
    Boolean writable
    Terrain terrain
    Rect boundsInTerrainSpace
    Int32 extraBorderPixels
    Returns
    Type Description
    PaintContext
    Implements
    IBrushRenderWithTerrain.AcquireNormalmap(Boolean, Terrain, Rect, Int32)

    AcquireTexture(Boolean, Terrain, Rect, TerrainLayer, Int32)

    Declaration
    public PaintContext AcquireTexture(bool writable, Terrain terrain, Rect boundsInTerrainSpace, TerrainLayer layer, int extraBorderPixels = 0)
    Parameters
    Type Name Description
    Boolean writable
    Terrain terrain
    Rect boundsInTerrainSpace
    TerrainLayer layer
    Int32 extraBorderPixels
    Returns
    Type Description
    PaintContext
    Implements
    IBrushRenderWithTerrain.AcquireTexture(Boolean, Terrain, Rect, TerrainLayer, Int32)

    CalculateBrushTransform(Terrain, Vector2, Single, Single, out BrushTransform)

    Declaration
    public virtual bool CalculateBrushTransform(Terrain terrain, Vector2 uv, float size, float rotation, out BrushTransform brushTransform)
    Parameters
    Type Name Description
    Terrain terrain
    Vector2 uv
    Single size
    Single rotation
    BrushTransform brushTransform
    Returns
    Type Description
    Boolean
    Implements
    IBrushRenderWithTerrain.CalculateBrushTransform(Terrain, Vector2, Single, Single, out BrushTransform)

    CalculateBrushTransform(Terrain, Vector2, Single, out BrushTransform)

    Declaration
    public bool CalculateBrushTransform(Terrain terrain, Vector2 uv, float size, out BrushTransform brushTransform)
    Parameters
    Type Name Description
    Terrain terrain
    Vector2 uv
    Single size
    BrushTransform brushTransform
    Returns
    Type Description
    Boolean
    Implements
    IBrushRenderWithTerrain.CalculateBrushTransform(Terrain, Vector2, Single, out BrushTransform)

    CalculateBrushTransform(Terrain, Vector2, out BrushTransform)

    Declaration
    public bool CalculateBrushTransform(Terrain terrain, Vector2 uv, out BrushTransform brushTransform)
    Parameters
    Type Name Description
    Terrain terrain
    Vector2 uv
    BrushTransform brushTransform
    Returns
    Type Description
    Boolean
    Implements
    IBrushRenderWithTerrain.CalculateBrushTransform(Terrain, Vector2, out BrushTransform)

    Dispose()

    Declaration
    public void Dispose()

    Release(PaintContext)

    Declaration
    public void Release(PaintContext paintContext)
    Parameters
    Type Name Description
    PaintContext paintContext
    Implements
    IBrushRenderWithTerrain.Release(PaintContext)

    RenderBrush(PaintContext, Material, Int32)

    Declaration
    public void RenderBrush(PaintContext paintContext, Material material, int pass)
    Parameters
    Type Name Description
    PaintContext paintContext
    Material material
    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)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023