Difference between revisions of "Instance Painter Panel"

Latest revision as of 16:42, 3 August 2017

Description

_{This article refers to the image linked under Components}

The Instance Painter Panel is a panel which allows you to paint visuals in batches. Instances are used by surfaces (e.g. fire sprites on the fire surface, lilies on the blessed water surface) and are most commonly used for painting foliage such as grass.

To use the Instance Painter Panel:

1. Import a visual
2. Select it in the Visual List
3. Enable the Paint interaction mode
4. Begin painting!

Components

_{The Instance Painter Panel with each component numbered}

The Instance Painter Panel consists of the following components:

1. Save/Load
2. Menu
3. Visual list
4. Interaction modes
5. Visual properties
6. Tools

Menu

_{The menu with each button numbered}

The Menu , left to right, consists of:

1. Import New Visual
2. Delete Visual
3. Swap Visual
4. Set Burn Visual
5. Set Destroy Visual
6. Toggle Shadow on Visual (turns shadows on the selected visual on/off)
7. Toggle Visibility of Visual (turns visibility of the selected visual on/off)

Import New Visual

_{This article refers to the image linked under Menu}

To import a new visual to the Instance Painter panel:

1. Open the Content Browser
2. (Optional) Filter by visuals
3. Select the visual you want to import to the Instance Painter
4. Click the "Import New Visual" button (1)

Delete Visual

_{This article refers to the image linked under Menu}

To delete a visual from the Instance Painter panel:

1. Select the visual in the Visual List
2. Click the "Delete Visual" button (2) ^[1]

^{[1] Note when deleting a visual from the Instance Painter, all the painted visuals of that type in your level will disappear}

Swap Visual

_{This article refers to the image linked under Menu}

To swap a visual in the Instance Painter panel:

1. Select the visual you want to replace in the Visual List
2. Open the Content Browser
3. (Optional) Filter by visuals
4. Select the visual you want to replace your old visual with
5. Click the "Swap Visual" button (3) ^[1]

^{[1] Note when swapping a visual in the Instance Painter, all the painted visuals of that type in your level will be replaced as well}

Visual List

_{The visual list with each component numbered}

The Visual List shows all visuals that are currently imported into the Instance Painter.

The Visual List is also used to select visuals to paint or modify.

The Visual List consists of:

1. Show Visual toggle, will show or hide all instance visuals of this type (see Menu #6)
2. Shadow Visibility toggle, will show or hide the shadows of all instance visuals of this type (see Menu #5)
3. The name of the visual

Interaction Modes

_{The instaction modes with each component numbered}

The interaction modes, from left to right, consist of:

1. Checkout Cells
2. Paint
3. Align
4. Update
5. A toggle to turn on terrain-only picking
   • When turned on, your paint brush will paint only on the terrain
   • When turned off, your paint brush will paint on scenery as well
6. A slider to set the radius of your paint brush

Paint

_{This article refers to the image linked under Interaction Modes}

The paint interaction mode works the same as other brush-based interaction modes (such as the terrain- and ai grid paint tools). To activate it, toggle the Paint button. Then, with a visual selected in the visual list, start painting in the Game Render View (default LMB).

To resize the paint brush, use the slider (6) or use the '[' and ']' (default) keybinds.

Visual Properties

_{The properties section with each component numbered}

The instance visual property grid consists of the following:

1. Instance Visual Group, which contains all the visual Ids and the FileId (which is used as the file name)
2. The Paint Properties, which contains:
   1. AlignNormal
   2. Flow
   3. RandomRotX, whether to rotate painted visuals randomly around the X axis when painting with "Randomize Rotation" toggled (see Tools)
   4. RandomRotY, whether to rotate painted visuals randomly around the Y Axis when painting with "Randomize Rotation" toggled (see Tools)
   5. RandomRotZ, whether to rotate painted visuals randomly around the Z Axis when painting with "Randomize Rotation" toggled (see Tools)
   6. ScaleMax, the maximum scale when painting with "Randomize Scale" toggled (see Tools)
   7. ScaleMin, the minumum scale when painting with "Randomize Scale" toggled (see Tools)

Tools

_{The tools section with each component numbered}

The Tools section consists of:

1. "Remove Floating", will automatically remove all floating visuals up to a certain height
2. "Remove Duplicated", will automatically remove all visuals within a certain distance of each other
3. ReAlign, when toggled the "Align" interaction mode will realign instances in accordance to the paint properties
4. Randomize Rotation, when toggled will randomize the rotation of instances painted with the paint interaction mode in accordance to the paint properties
5. Randomize Scale, when toggled will randomize the scale of instances painted with the the paint interaction mode in accordance to the paint properties
6. Visualize Batches, will outline boxes around each batch in the grid (a batch is a set of instances in a 64x64 meter grid cell)