Interface IBrushUIGroup
Syntax
public interface IBrushUIGroup
Properties
allowPaint
Are we allowed to paint with this brush?
Declaration
Property Value
| Type |
Description |
| System.Boolean |
|
brushMaskFilterStack
Declaration
FilterStack brushMaskFilterStack { get; }
Property Value
brushMaskFilterStackView
Declaration
FilterStackView brushMaskFilterStackView { get; }
Property Value
brushRotation
The rotation of the brush (in degrees).
Declaration
float brushRotation { get; }
Property Value
| Type |
Description |
| System.Single |
|
brushSize
The normalized size of the brush.
Declaration
Property Value
| Type |
Description |
| System.Single |
|
brushSpacing
The spacing used when applying certain brushes.
Declaration
float brushSpacing { get; }
Property Value
| Type |
Description |
| System.Single |
|
brushStrength
The normalized strength of the brush when applied.
Declaration
float brushStrength { get; }
Property Value
| Type |
Description |
| System.Single |
|
InvertStrength
Declaration
bool InvertStrength { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
isInUse
Declaration
Property Value
| Type |
Description |
| System.Boolean |
|
isRaycastHitUnderCursorValid
Declaration
bool isRaycastHitUnderCursorValid { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
raycastHitUnderCursor
Declaration
RaycastHit raycastHitUnderCursor { get; }
Property Value
| Type |
Description |
| RaycastHit |
|
terrainUnderCursor
Declaration
Terrain terrainUnderCursor { get; }
Property Value
validationMessage
Declaration
string validationMessage { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Methods
AppendBrushInfo(Terrain, IOnSceneGUI, StringBuilder)
Declaration
void AppendBrushInfo(Terrain terrain, IOnSceneGUI editContext, StringBuilder builder)
Parameters
| Type |
Name |
Description |
| Terrain |
terrain |
|
| IOnSceneGUI |
editContext |
|
| System.Text.StringBuilder |
builder |
|
GetBrushMask(FilterContext, RenderTexture)
Declaration
RenderTexture GetBrushMask(FilterContext fc, RenderTexture heightContext)
Parameters
| Type |
Name |
Description |
| FilterContext |
fc |
|
| RenderTexture |
heightContext |
|
Returns
| Type |
Description |
| RenderTexture |
|
ModifierActive(BrushModifierKey)
Declaration
bool ModifierActive(BrushModifierKey k)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
Declaration
Declaration
OnInspectorGUI(Terrain, IOnInspectorGUI)
Declaration
void OnInspectorGUI(Terrain terrain, IOnInspectorGUI editContext)
Parameters
| Type |
Name |
Description |
| Terrain |
terrain |
|
| IOnInspectorGUI |
editContext |
|
OnPaint(Terrain, IOnPaint)
Declaration
void OnPaint(Terrain terrain, IOnPaint editContext)
Parameters
| Type |
Name |
Description |
| Terrain |
terrain |
|
| IOnPaint |
editContext |
|
OnSceneGUI(Terrain, IOnSceneGUI)
Declaration
void OnSceneGUI(Terrain terrain, IOnSceneGUI editContext)
Parameters
| Type |
Name |
Description |
| Terrain |
terrain |
|
| IOnSceneGUI |
editContext |
|
OnSceneGUI2D(Terrain, IOnSceneGUI)
Declaration
void OnSceneGUI2D(Terrain terrain, IOnSceneGUI editContext)
Parameters
| Type |
Name |
Description |
| Terrain |
terrain |
|
| IOnSceneGUI |
editContext |
|
ScatterBrushStamp(ref Terrain, ref Vector2)
Scatters the brush around the specified UV on the specified terrain. If the scattered UV leaves
the current terrain then the terrain AND UV are modified for the terrain the UV is now over.
Declaration
bool ScatterBrushStamp(ref Terrain terrain, ref Vector2 uv)
Parameters
| Type |
Name |
Description |
| Terrain |
terrain |
The terrain the scattered UV co-ordinate is actually on.
|
| Vector2 |
uv |
The UV co-ordinate passed in transformed into the UV co-ordinate relative to the scattered terrain.
|
Returns
| Type |
Description |
| System.Boolean |
"true" if we scattered to a terrain, "false" if we fell off ALL terrains.
|
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.