# Decal Scatter

## Short Description

Scatters decals on meshes with customizable properties.

## Description

The Decal Scatter tool allows users to efficiently scatter decal assets on specified meshes in a scene. It provides a range of customizable properties to control the density, scale, rotation, and masking of the decals, ensuring flexibility and precision in decoration workflows.

## Properties

### Base Properties

* **Surface**: Meshes to scatter on
* **Decals**: Decal assets to scatter
* **Density**: Scatter density
* **Min Scale**: Minimum scale for random scale
* **Max Scale**: Maximum scale for random scale
* **Surface Align**: Adjusts the alignment of the decals to the surface.
* **Depth**: Depth of decals.
* **Scale**: Default extent of decals in cm
* **Sink**: Pushes your instanced objects downwards, very practical for trees
* **Max Count**: Maximum count of scattered decals
* **Seed**: Random seed for scattering variations

### Feature Masking

* **Slope Mask**: Masks objects by the angle of the underlying surface area under them
* **Min Height Mask**: Minimum height at which objects should be clamped
* **Max Height Mask**: Maximum height at which objects should be clamped

### Proximity Mask

* **Proximity**: Proximity meshes ensure that only scattered objects nearby are kept
* **Distance**: Controls the proximity distance
* **Sampling**: A higher value results in more precise proximity masking, but at a heavier cost
* **Width**: Width of the proximity mask, allowing for strokes/slices of your scatter setup.

### Rotation Properties

* **Incremental Spin**: Write your incremental values as ints or floats, separated by spaces.
* **Sort Increments**: If set to True, the incremental values will be applied in order, instead of randomly
* **Uniform Angle**: Adjust the spin of the decals.
* **Spin**: Give random spin to decals, ensuring great rotation variation
* **Rotation Jitter**: Additional random spin

### Noise Mask

* **Breakup**: Controls the intensity of the noise/breakup.
* **Breakup Scale**: Frequency of the noise mask; controls the scale of the noise
* **Smoothness Noise**: Controls how sharp/soft the noise mask is
* **Warp Noise**: Deforms the noise mask, creating interesting mask shapes
* **Noise Scale Multiplier**: Multiplier for noise scale
* **Noise Scale X**: Scale of noise in the X direction
* **Noise Scale Y**: Scale of noise in the Y direction
* **Noise Scale Z**: Scale of noise in the Z direction

### Border Masking

* **Border Offset**: Masks scattered objects along the surface's borders.
* **Border Min**: Minimum distance offset from the border mask value
* **Border Max**: Maximum distance offset from the border mask value
* **Border Noise**: Applies noise on the border mask
* **Border Sampling**: A higher value results in more precise border masking, but at a heavier cost

### Object Masking

* **Objects**: Samples objects near the meshes using raytracing for mesh proximity masking.
* **Distance**: Controls distance of the padding we add to the inside mask
* **Keep Inside**: When set to true, only keeps what's inside of meshes.
* **Invert**: Inverts the mask


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.polygonflow.io/dash-tools/decalscatter.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
