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

    Class ToolboxHelper

    Inheritance
    Object
    ToolboxHelper
    Namespace: UnityEditor.Experimental.TerrainAPI
    Syntax
    public class ToolboxHelper

    Fields

    GizmoEnabled

    Declaration
    public static bool GizmoEnabled
    Field Value
    Type Description
    Boolean

    GizmoGO

    Declaration
    public static GameObject GizmoGO
    Field Value
    Type Description
    GameObject

    GizmoSettings

    Declaration
    public static TerrainGizmos GizmoSettings
    Field Value
    Type Description
    TerrainGizmos

    GUIHeightmapResolutionNames

    Declaration
    public static string[] GUIHeightmapResolutionNames
    Field Value
    Type Description
    String[]

    GUIHeightmapResolutions

    Declaration
    public static int[] GUIHeightmapResolutions
    Field Value
    Type Description
    Int32[]

    GUITextureResolutionNames

    Declaration
    public static string[] GUITextureResolutionNames
    Field Value
    Type Description
    String[]

    GUITextureResolutions

    Declaration
    public static int[] GUITextureResolutions
    Field Value
    Type Description
    Int32[]

    LibraryPath

    Declaration
    public static string LibraryPath
    Field Value
    Type Description
    String

    ToolboxPrefsCreate

    Declaration
    public static string ToolboxPrefsCreate
    Field Value
    Type Description
    String

    ToolboxPrefsSettings

    Declaration
    public static string ToolboxPrefsSettings
    Field Value
    Type Description
    String

    ToolboxPrefsUtility

    Declaration
    public static string ToolboxPrefsUtility
    Field Value
    Type Description
    String

    ToolboxPrefsVisualization

    Declaration
    public static string ToolboxPrefsVisualization
    Field Value
    Type Description
    String

    ToolboxPrefsWindow

    Declaration
    public static string ToolboxPrefsWindow
    Field Value
    Type Description
    String

    Properties

    kNormalizedHeightScale

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

    Methods

    CalculateAdjacencies(Terrain[], Int32, Int32)

    Declaration
    public static void CalculateAdjacencies(Terrain[] terrains, int tilesX, int tilesZ)
    Parameters
    Type Name Description
    Terrain[] terrains
    Int32 tilesX
    Int32 tilesZ

    CopyActiveRenderTextureToTexture(Texture2D, RectInt, Vector2Int, Boolean)

    Declaration
    public static void CopyActiveRenderTextureToTexture(Texture2D dstTexture, RectInt sourceRect, Vector2Int dest, bool allowDelayedCPUSync)
    Parameters
    Type Name Description
    Texture2D dstTexture
    RectInt sourceRect
    Vector2Int dest
    Boolean allowDelayedCPUSync

    CopyTextureToTerrainHeight(TerrainData, Texture2D, Vector2Int, Int32, Int32, Single, Single)

    Declaration
    public static void CopyTextureToTerrainHeight(TerrainData terrainData, Texture2D heightmap, Vector2Int indexOffset, int resolution, int numTiles, float baseLevel, float remap)
    Parameters
    Type Name Description
    TerrainData terrainData
    Texture2D heightmap
    Vector2Int indexOffset
    Int32 resolution
    Int32 numTiles
    Single baseLevel
    Single remap

    ExportTerrainHeightsToRawFile(TerrainData, String, Heightmap.Depth, Boolean, ToolboxHelper.ByteOrder, Vector2)

    Declaration
    public static void ExportTerrainHeightsToRawFile(TerrainData terrainData, string path, Heightmap.Depth depth, bool flipVertical, ToolboxHelper.ByteOrder byteOrder, Vector2 inputLevelsRange)
    Parameters
    Type Name Description
    TerrainData terrainData
    String path
    Heightmap.Depth depth
    Boolean flipVertical
    ToolboxHelper.ByteOrder byteOrder
    Vector2 inputLevelsRange

    ExportTerrainHeightsToTexture(TerrainData, Heightmap.Format, String, Boolean, Vector2)

    Declaration
    public static void ExportTerrainHeightsToTexture(TerrainData terrainData, Heightmap.Format format, string path, bool flipVertical, Vector2 inputLevelsRange)
    Parameters
    Type Name Description
    TerrainData terrainData
    Heightmap.Format format
    String path
    Boolean flipVertical
    Vector2 inputLevelsRange

    FlipTexture(Texture2D, Boolean)

    Declaration
    public static void FlipTexture(Texture2D texture, bool isHorizontal)
    Parameters
    Type Name Description
    Texture2D texture
    Boolean isHorizontal

    GetAllTerrainsInScene()

    Declaration
    public static Terrain[] GetAllTerrainsInScene()
    Returns
    Type Description
    Terrain[]

    GetBitDepth(Heightmap.Depth)

    Declaration
    public static string GetBitDepth(Heightmap.Depth depth)
    Parameters
    Type Name Description
    Heightmap.Depth depth
    Returns
    Type Description
    String

    GetGizmo()

    Declaration
    public static GameObject GetGizmo()
    Returns
    Type Description
    GameObject

    GetGizmoPosition()

    Declaration
    public static Vector3 GetGizmoPosition()
    Returns
    Type Description
    Vector3

    GetHeightBlitMaterial()

    Declaration
    public static Material GetHeightBlitMaterial()
    Returns
    Type Description
    Material

    GetPartialTexture(Texture2D, Vector2Int, Vector2Int)

    Declaration
    public static Texture2D GetPartialTexture(Texture2D sourceTexture, Vector2Int resolution, Vector2Int offset)
    Parameters
    Type Name Description
    Texture2D sourceTexture
    Vector2Int resolution
    Vector2Int offset
    Returns
    Type Description
    Texture2D

    GetPrefFilePath(String)

    Declaration
    public static string GetPrefFilePath(string prefType)
    Parameters
    Type Name Description
    String prefType
    Returns
    Type Description
    String

    GetRenderPipeline()

    Declaration
    public static ToolboxHelper.RenderPipeline GetRenderPipeline()
    Returns
    Type Description
    ToolboxHelper.RenderPipeline

    GetSelectedTerrainsInScene()

    Declaration
    public static Terrain[] GetSelectedTerrainsInScene()
    Returns
    Type Description
    Terrain[]

    HideGizmo()

    Declaration
    public static void HideGizmo()

    IsInteger(Double)

    Declaration
    public static bool IsInteger(double x)
    Parameters
    Type Name Description
    Double x
    Returns
    Type Description
    Boolean

    IsPowerOfTwo(Int32)

    Declaration
    public static bool IsPowerOfTwo(int x)
    Parameters
    Type Name Description
    Int32 x
    Returns
    Type Description
    Boolean

    ResizeControlTexture(TerrainData, Int32)

    Declaration
    public static void ResizeControlTexture(TerrainData terrainData, int resolution)
    Parameters
    Type Name Description
    TerrainData terrainData
    Int32 resolution

    ResizeHeightmap(TerrainData, Int32)

    Declaration
    public static void ResizeHeightmap(TerrainData terrainData, int resolution)
    Parameters
    Type Name Description
    TerrainData terrainData
    Int32 resolution

    SetGizmoColor(Color, Color)

    Declaration
    public static void SetGizmoColor(Color cubeColor, Color wireColor)
    Parameters
    Type Name Description
    Color cubeColor
    Color wireColor

    ShowGizmo()

    Declaration
    public static void ShowGizmo()

    UpdateGizmos(Single, Single, Single, Vector3, Int32)

    Declaration
    public static void UpdateGizmos(float width, float height, float length, Vector3 position, int id)
    Parameters
    Type Name Description
    Single width
    Single height
    Single length
    Vector3 position
    Int32 id
    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