Interface IBrushTerrainCache

An interface that represent the brush terrain caching system.

Namespace: UnityEditor.TerrainTools
Syntax
public interface IBrushTerrainCache

Properties

canUpdateTerrainUnderCursor

Checks if the cursor is currently locked and can not be updated.

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

isRaycastHitUnderCursorValid

Gets and sets the value associated to whether there is a raycast hit detecting a terrain under the cursor.

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

raycastHitUnderCursor

Gets and sets the raycast hit that was under the cursor's position.

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

terrainUnderCursor

Gets and sets the terrain in focus.

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

Methods

LockTerrainUnderCursor(Boolean)

Handles the locking of the terrain cursor in it's current position.

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

Whether the cursor is visible within the scene. When the value is true the cursor is visible.
Remarks

This method is commonly used when utilizing shortcuts.

See Also

UnlockTerrainUnderCursor()

Handles unlocking of the terrain cursor.

Declaration
void UnlockTerrainUnderCursor()
See Also