This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Brush-Based Placement of Meshes

Cluster Editor is a convenient tool for brush-based placement of meshes baked into Mesh Clusters directly in the scene. It allows editing the existing Mesh Clusters and creating new ones.

Cluster Editor is available when the Cluster Paint Mode is selected on the toolbar.

Notice
To learn how to use the tool, watch this video tutorial.

Switching to Cluster Paint Mode opens the Active Tool window:

In the Objects section, there is a list of all Mesh Cluster objects available in the world. Similarly to the World Hierarchy window, you can organize the nodes:

  • Select one or several nodes.
  • Toggle the nodes on and off.
  • Filter nodes by name.
  • Rename a node by double-clicking on it.
  • Toggle the Spawn When Drawing flag.

To edit the required Mesh Clusters (one or many), select them either in the Objects section or in the World Hierarchy window and specify the Objects settings.

For convenience, the Create New Cluster button, a shortcut to manual creation of Mesh Clusters, is available right in the Active Tool window.

See Also#

Editing Mesh Clusters with Cluster Editor#

As soon as you have at least one Mesh Cluster with the Spawn When Drawing flag enabled, brush painting is available in the Editor Viewport. Select the required tool and start editing the cluster directly in the scene:

Available tools:

  • Replace Density — replace meshes within the Brush Radius with new ones spawned in accordance with the current density values.
  • Single Object — place a single mesh at the desired point.
  • Erase — remove meshes.

Brush Settings#

Radius Size of the brush. The size change is non-linear - the standard increment changes depending on the current brush value:
  • 0.01 for values in range from 0.1 to 1.0
  • 0.1 for values in range from 1.0 to 10.0
  • 1.0 for values in range from 10.0 to 100.0
  • etc.
You can also control the current step by holding hotkeys while scrolling the mouse wheel: the Shift key increases the step 10 times, while the Ctrl key enables a 10-fold decrease.
Density Multiplier Global multiplier for density. The value can be increased above 1.
Filter Allows specifying the type of object on which you can paint. You can select multiple values, but some of them cannot be combined (see details below). The following values are available:
  • Mesh Static
  • Mesh Skinned
  • Mesh Dynamic
  • Mesh Cluster
    Notice
    Painting over a Mesh Cluster object is available only if the Spawn When Drawing flag is disabled for it.
  • Mesh Clutter
  • Terrain
  • Water
  • Clouds

In addition, there are 2 filters that can only be used in combination with one or more object type filters listed above:

  • Draw Only On Immovable Nodes, i.e. on nodes that have the Immovable flag enabled. This filter can be used only with the Mesh Static and/or Mesh Cluster filters.
  • Draw Only On Surfaces With Intersection, i.e. on surfaces that have the Intersection flag and any bit of the Intersection Mask enabled.
Notice
The filters aren't applied for the Erase tool.

Controls#

  • To draw with a brush, click LMB and drag the mouse.
  • To change the brush radius, use the mouse wheel.
  • To switch to the Replace Density tool, press B.
  • To switch to the Erase tool, press E.
Notice
You can adjust the controls in the Cluster Paint Mode tab of the Editor Hotkeys settings.

Objects Settings#

The following settings are saved for each Mesh Cluster in the scene:

Spawn When Drawing

Flag indicating if the Mesh Cluster is editable.

Notice
You should disable this flag to paint over the Mesh Cluster object.
Seed

Pseudo-random seed that defines the distribution of spawned meshes. Click the Randomize button to generate a new Seed.

Notice
If the same Seed value is set for several Mesh Clusters, their new meshes will spawn at the same points during one stroke.
Density The target density of meshes of the Mesh Cluster.
Normal Orientation Flag indicating whether new meshes should orient along the normals of surfaces under the brush.
Local Offset Minimum and maximum offset values for new meshes with regard to normal orientation.
World Offset Minimum and maximum offset for new meshes in world coordinates.
Local Rotation Minimum and maximum rotation values for new meshes with regard to normal orientation.
World Rotation Minimum and maximum rotation values for new meshes in world coordinates.
Scale

Minimum and maximum scale values for new meshes. Click the gear icon to choose the scale mode:

  • Uniform — meshes are scaled uniformly along all axes.
  • Nonuniform — scale is random along each axis.

Video Tutorial#

Watch the video below to learn the basics of mesh placement with the Cluster Brush Editor.

Last update: 2023-06-23
Build: ()