Class BaseBrushUIGroup
Inheritance
System.Object
BaseBrushUIGroup
Syntax
public abstract class BaseBrushUIGroup : IBrushUIGroup, IBrushEventHandler, IBrushTerrainCache
Constructors
BaseBrushUIGroup(String)
Declaration
protected BaseBrushUIGroup(string name)
Parameters
| Type |
Name |
Description |
| System.String |
name |
|
Fields
isRecording
Declaration
public static bool isRecording
Field Value
| Type |
Description |
| System.Boolean |
|
Properties
allowPaint
Declaration
public bool allowPaint { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
Implements
brushRotation
Declaration
public float brushRotation { get; set; }
Property Value
| Type |
Description |
| System.Single |
|
Implements
brushSize
Declaration
public float brushSize { get; set; }
Property Value
| Type |
Description |
| System.Single |
|
Implements
brushSpacing
Declaration
public float brushSpacing { get; }
Property Value
| Type |
Description |
| System.Single |
|
Implements
brushStrength
Declaration
public float brushStrength { get; set; }
Property Value
| Type |
Description |
| System.Single |
|
Implements
canUpdateTerrainUnderCursor
Declaration
public bool canUpdateTerrainUnderCursor { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
Implements
InvertStrength
Declaration
public bool InvertStrength { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
Implements
isInUse
Declaration
public bool isInUse { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
Implements
isRaycastHitUnderCursorValid
Declaration
public bool isRaycastHitUnderCursorValid { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
Implements
raycastHitUnderCursor
Declaration
public RaycastHit raycastHitUnderCursor { get; }
Property Value
| Type |
Description |
| RaycastHit |
|
Implements
terrainUnderCursor
Declaration
public Terrain terrainUnderCursor { get; }
Property Value
Implements
Methods
AddController<TController>(TController)
Declaration
protected TController AddController<TController>(TController newController)
where TController : IBrushController
Parameters
| Type |
Name |
Description |
| TController |
newController |
|
Returns
| Type |
Description |
| TController |
|
Type Parameters
| Name |
Description |
| TController |
|
AddModifierKeyController<TController>(TController)
Declaration
protected TController AddModifierKeyController<TController>(TController newController)
where TController : IBrushModifierKeyController
Parameters
| Type |
Name |
Description |
| TController |
newController |
|
Returns
| Type |
Description |
| TController |
|
Type Parameters
| Name |
Description |
| TController |
|
AddRotationController<TController>(TController)
Declaration
protected TController AddRotationController<TController>(TController newController)
where TController : IBrushRotationController
Parameters
| Type |
Name |
Description |
| TController |
newController |
|
Returns
| Type |
Description |
| TController |
|
Type Parameters
| Name |
Description |
| TController |
|
AddScatterController<TController>(TController)
Declaration
protected TController AddScatterController<TController>(TController newController)
where TController : IBrushScatterController
Parameters
| Type |
Name |
Description |
| TController |
newController |
|
Returns
| Type |
Description |
| TController |
|
Type Parameters
| Name |
Description |
| TController |
|
AddSizeController<TController>(TController)
Declaration
protected TController AddSizeController<TController>(TController newController)
where TController : IBrushSizeController
Parameters
| Type |
Name |
Description |
| TController |
newController |
|
Returns
| Type |
Description |
| TController |
|
Type Parameters
| Name |
Description |
| TController |
|
AddSmoothingController<TController>(TController)
Declaration
protected TController AddSmoothingController<TController>(TController newController)
where TController : IBrushSmoothController
Parameters
| Type |
Name |
Description |
| TController |
newController |
|
Returns
| Type |
Description |
| TController |
|
Type Parameters
| Name |
Description |
| TController |
|
AddSpacingController<TController>(TController)
Declaration
protected TController AddSpacingController<TController>(TController newController)
where TController : IBrushSpacingController
Parameters
| Type |
Name |
Description |
| TController |
newController |
|
Returns
| Type |
Description |
| TController |
|
Type Parameters
| Name |
Description |
| TController |
|
AddStrengthController<TController>(TController)
Declaration
protected TController AddStrengthController<TController>(TController newController)
where TController : IBrushStrengthController
Parameters
| Type |
Name |
Description |
| TController |
newController |
|
Returns
| Type |
Description |
| TController |
|
Type Parameters
| Name |
Description |
| TController |
|
AppendBrushInfo(Terrain, IOnSceneGUI, StringBuilder)
Declaration
public virtual void AppendBrushInfo(Terrain terrain, IOnSceneGUI editContext, StringBuilder builder)
Parameters
| Type |
Name |
Description |
| Terrain |
terrain |
|
| IOnSceneGUI |
editContext |
|
| System.Text.StringBuilder |
builder |
|
Implements
ConsumeEvents(Terrain, IOnSceneGUI)
Declaration
public void ConsumeEvents(Terrain terrain, IOnSceneGUI editContext)
Parameters
| Type |
Name |
Description |
| Terrain |
terrain |
|
| IOnSceneGUI |
editContext |
|
Implements
LockTerrainUnderCursor(Boolean)
Declaration
public void LockTerrainUnderCursor(bool cursorVisible)
Parameters
| Type |
Name |
Description |
| System.Boolean |
cursorVisible |
|
Implements
ModifierActive(BrushModifierKey)
Declaration
public bool ModifierActive(BrushModifierKey k)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
Implements
Declaration
public virtual void OnEnterToolMode()
Implements
Declaration
public virtual void OnExitToolMode()
Implements
OnInspectorGUI(Terrain, IOnInspectorGUI)
Declaration
public virtual void OnInspectorGUI(Terrain terrain, IOnInspectorGUI editContext)
Parameters
| Type |
Name |
Description |
| Terrain |
terrain |
|
| IOnInspectorGUI |
editContext |
|
Implements
OnPaint(Terrain, IOnPaint)
Declaration
public virtual void OnPaint(Terrain terrain, IOnPaint editContext)
Parameters
| Type |
Name |
Description |
| Terrain |
terrain |
|
| IOnPaint |
editContext |
|
Implements
OnSceneGUI(Terrain, IOnSceneGUI)
Declaration
public virtual void OnSceneGUI(Terrain terrain, IOnSceneGUI editContext)
Parameters
| Type |
Name |
Description |
| Terrain |
terrain |
|
| IOnSceneGUI |
editContext |
|
Implements
OnSceneGUI2D(Terrain, IOnSceneGUI)
Declaration
public virtual void OnSceneGUI2D(Terrain terrain, IOnSceneGUI editContext)
Parameters
| Type |
Name |
Description |
| Terrain |
terrain |
|
| IOnSceneGUI |
editContext |
|
Implements
RegisterEvent(Event)
Declaration
public void RegisterEvent(Event newEvent)
Parameters
| Type |
Name |
Description |
| Event |
newEvent |
|
Implements
RemoveAllControllers()
Declaration
protected void RemoveAllControllers()
RemoveController<TController>(TController)
Declaration
protected void RemoveController<TController>(TController controller)
where TController : IBrushController
Parameters
| Type |
Name |
Description |
| TController |
controller |
|
Type Parameters
| Name |
Description |
| TController |
|
RequestRepaint()
Declaration
public void RequestRepaint()
Implements
ScatterBrushStamp(ref Terrain, ref Vector2)
Declaration
public bool ScatterBrushStamp(ref Terrain terrain, ref Vector2 uv)
Parameters
| Type |
Name |
Description |
| Terrain |
terrain |
|
| Vector2 |
uv |
|
Returns
| Type |
Description |
| System.Boolean |
|
Implements
UnlockTerrainUnderCursor()
Declaration
public void UnlockTerrainUnderCursor()
Implements
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.