View source for Brush

The brush is a tool in the [[editor]], which allows you to make a 2 dimensional selection in the [[3D Visualization]] of your [[project detail area|project]] for a specific selected [[Item]]. Once satisfied with the selection, it has to be applied to add it to, or remove it from, the current 2 dimensional geometry of the selected item. While drawing a selection, feedback is given in form of colors, which are explained in the selection legend.

==Brush Panel==
[[File:brush-bottom.jpg|framed|left|The Brush panel]]The brush panel is not directly visible in the editor. Instead, it appears when it is required while using the editor. The brush options that are available for configuration depend on the type of [[Item]], or component of an Item, you are using the brush for.
{{clear}}

==Brush options==
The brush panel offers a number of options, which will allow you to accurately draw a selection in the 3D visualization.
<br clear=all>
====Selection Type====
[[File:Brush-bottom-type.jpg|frame|right|The type of brush used for drawing.]]
: ''The type of selection you wish to make. This influences the shapes you draw in the 3D visualization. By using the right selection type, it is possible to make intricate selections, exactly reflecting your intentions.''<br clear=right>

====Size====
[[File:Brush-bottom-size.jpg|frame|right|The size for drawing.]]
: ''The size of the selection you are drawing. Depending the current selection type, the size will influence how large your selection will be. A higher size allows you to draw greater selections more quickly, while a smaller size allows you to make your selection more detailed.''{{clear|right}}

====Operator====
[[File:Brush-bottom-operator.jpg|frame|right|The operation to perform.]]
: ''The operation you wish to perform with your selection. Depending on what you are currently drawing a selection for, you may have the option to append to the existing spatial element, or to remove from it. For example, you can add to or remove from a building, but you cannot remove ownership, only overwrite it. By setting the operator to "Add", the selection (when applied) will be added to the spatial element. By setting it to "Remove", the selection (when applied) will be subtracted from the spatial element.''{{clear|right}}

====Options====
[[File:Brush-bottom-options.jpg|frame|right|The miscellaneous options.]]
: ''The options offer ways to make drawing easier. The currently available option is "Hide buildings", which will remove building from view. This allows you to draw your selection on the 3D visualization without obstructions.''{{clear|right}}

==How to use the brush==
The brush panel will appear automatically when you need to draw in the 3D visualization. Depending on what you wish to draw, the brush will have several options available.
{{Editor steps|title=draw with the brush|Select the [[#Drawing modes|drawing mode]] you wish to use.|If you wish to [[#Removing|remove]] something, set "Remove" to "On".|In the 3D visualization, click and hold down the left mouse button in a single location.|While holding down the left mouse button, drag the cursor to another location in the 3D visualization.|Release the mouse button to finish the selection.|Press "[[#Applying|Apply selection]]".}}

==Brush functions explained==
The brush panel will appear automatically when you need to draw in the 3D visualization. The Brush will automatically have certain options available or unavailable based on the specific thing you wish to draw. For example, if you wish to draw a road, you will only be able to do so in lines. If you wish to draw terrain, you do not have the option to remove the terrain, etc.

===Drawing===
There are several ways to draw using the brush. Depending on what you are drawing, the following options may be available.
('''Note that in the following description, selections are visualized on the client, but not yet applied to the project data. There will be no actual effect on the 3D visualization until the selection is explicitly applied.''')

====Selection Types====
Several selection types exist to allow you to draw in the 3D visualization. The default type depends on what you wish to draw. For example, when drawing a road, by default the brush will be set to "Line" mode.
=====Block=====
: ''Use this mode to draw rectangular areas consisting of square blocks. When moving the cursor in the 3D visualization, a grid will become visible. This grid will align with nearby spatial elements, such as roads, allowing the user to draw a selection parallel or perpendicular to things already present in the project. Click a first time with the left mouse button to start the selection of a rectangle. Move the mouse to expand the rectangle in the desired direction. Click a second time to add the created rectangle to the current selection. Adjusting the size in the brush panel will make the grid larger or smaller.''
<gallery widths=100px heights=100px>
File:Brush-block-first.png| First click
File:Brush-block-second.png| Second click after cursor moved
</gallery>

=====Line=====
: ''The default drawing mode for roads. This mode allows you to draw rectangular areas based on a line between two selected points. Click a first time with the left mouse button in one part of the 3D visualization to start the selection. Move the mouse around in any direction and distance from the first clicked point to create the desired line. Click a second time to confirm the drawn rectangle. Adjusting the size in the brush panel will make the rectangle thicker or thinner.''
<gallery widths=100px heights=100px>
File:Brush-line-first.png| First click
File:Brush-line-second.png| Second click after cursor moved
</gallery>
=====Poly=====
: ''Use this mode to create polygons. Click with the left mouse button in a part of the 3D visualization to start the selection. Move the cursor and consecutively click with the left mouse button to add more points. To remove a previous point, click on a blue point. Finalize the polygon by clicking on or near the first point indicated with a red color.''
<gallery widths=100px heights=100px>
File:Brush-poly-first.png| First click
File:Brush-poly-second.png| Second click after cursor moved
File:Brush-poly-third.png| Third click. Notice the blue point
File:Brush-poly-fourth.png| Fourth click
File:Brush-poly-fifth.png| Fifth click
File:Brush-poly-final.png| Final click near the red point.
</gallery>

=====Circle=====
: ''Use this mode to create circles. Holding down the left mouse button in one part of the 3D visualization and releasing it in another will create a circle-shaped selection, with the center where the mouse button was pressed. The radius of the circle is the distance between where the mouse button was pressed and where it was released.''
<gallery widths=100px heights=100px>
File:Brush-circle-first.png| First click
File:Brush-circle-second.png| Second click after cursor moved
</gallery>

=====Ellipse=====
[[File:Brush-ellipse.jpg|100px|right]]
: ''Use this mode to create ellipses based on a line segment and two distances to it, along and perpendicular. Click with the left mouse button in one part of the 3D visualization to place the first point. Move the cursor and click a second time to place the second point. This defines the line segment the ellipse will be based on. Move the cursor again away from the line segment to create an ellipse and click a third time to confirm.''
:''The line segment can also be reset by clicking near the blue point. Resetting the line 's original, indicated with the red point, is also possible by clicking near it, but only when the blue point is not present.''
<gallery widths=100px heights=100px>
File:Brush-ellipse-first.png| First click as red point
File:Brush-ellipse-second.png| Second click as blue point after cursor moved.
File:Brush-ellipse-move.png| Moving the mouse after the second click
File:Brush-ellipse-first.png| Clicking near the blue point cancels the second click
File:Brush-ellipse-third.png| Otherwise, click third time to confirm ellipse
</gallery>

=====Quad=====
[[File:Brush-quad.jpg|100px|right]]
: ''Use this mode to create a parallelogram. Holding down the left mouse button in one part of the 3D visualization and moving it in a straight line defines the length and direction of two opposing sides of the shape. By continuing the hold down the left mouse button and moving the cursor at an angle to the first side, the length and direction of the other two sides are defined.''{{clear}}
=====Polygon pick=====
[[File:Brush-polygon.jpg|100px|right]]
: ''Use this mode to create selections based on existing buildings. Clicking on a building in the 3D visualization will add the shape of that building to the selection.''{{clear}}

=====Single=====
[[File:Brush-single.jpg|100px|right]]
: ''This mode is automatically used when a point needs to be selected. Clicking anywhere in the 3D visualization will place the point there. Only a single point can be placed.''{{clear}}

====Fine-tuning your selection====
While making a selection, if you wish to make a selection composed of multiples of the same shape (for example, a large rectangle with an adjacent square), you can draw these shapes consecutively. When you begin drawing the second shape, the first shape remains drawn as selection. 

You may also wish to combine some of the available drawing modes to create a more complex shape. By switching between drawing modes, without applying or clearing your selection in between, it is possible to preserve a selection made with one drawing mode and add to it with another. For example, to create a square building with a rounded front, you can draw the rectangular area in block mode, switch to circle mode, and draw a circle overlapping the square.

Besides adding to your selection, it is also possible to subtract. By starting to draw a new part of your selection in an unselected part of the 3D visualization, the newly drawn selection is added to the current selection. By starting to draw a new part of your selection in a part of the 3D visualization which is already selected, the new selection is actually subtracted from the existing selection. For example, to create a square selection with a concave circular front, you can first draw a square selection, and then draw a circle on the existing selection, making it subtract instead. (Please note that this is different from "{{inlink|Removing}}".)

<gallery mode="nolines">
File:Brush-combine.jpg|Combining selection types
File:Brush-subtract.jpg|Subtracting a selection
</gallery>

====Validity====
{{:Drawing_validity}}<!--transclusion, because this part is shared with interface-->

===Applying===
[[File:Brush-bottom-apply.jpg|frameless|right]]
When you have made a selection, you can use the "Apply Selection" button. At this point, the selection is used to place the [[Building]], [[Zone]], [[Area]], ownership or anything else you might have been drawing, in the [[3D Visualization]].

===Removing===
The brush can often also be used to remove elements or properties from the 3D visualization. To do this, you can set the "Operator" setting to "Remove". You will notice your area for valid selections will be (partially) inverted. Places where you were unable to create a valid selection could now be valid, and places where you could make a valid selection will likely be invalid. This is because when you wish to remove something, you must be able to make a valid selection of it. While usually, when you wish to draw something, it cannot be placed again in the same place.
<gallery mode="nolines">
File:brush_construction_validity_add.jpg|Validity of a selection when adding a building.
File:brush_construction_validity_remove.jpg|Validity of a selection when removing the building.
</gallery>

===Clearing a selection===
[[File:Brush-bottom-clear.jpg|frameless|right]]
If you feel it necessary to cancel your current selection entirely and draw anew, you can use the "Clear Selection" button. This undoes the selection you have made and will not be applied, thus having no effect.

{{editor ui nav}}