Version:

# Vegetation Distance Between Filter Component

Add the Vegetation Distance Between Filter component to set a minimum distance between vegetation instances.

Vegetation Gem

## Dependencies

Add one of the following required components when using the Vegetation Distance Between Filter component:

## Vegetation Distance Between Filter properties

PropertyDescriptionValuesDefault
Allow Per-Item OverridesIf Enabled, vegetation descriptor properties that are enabled can override this component’s properties.BooleanDisabled
Bound ModeIf set to Radius, Radius Min defines the minimum radius between vegetation instances. If set to MeshRadius, the radius of an attached Mesh component defines the radius of the filter.Radius or MeshRadiusRadius
Radius MinSets the minimum radius between vegetation instances.Float: 0.0 to Infinity0.0

## DistanceBetweenFilterRequestBus

Use the following request functions with the DistanceBetweenFilterRequestBus EBus interface to communicate with Vegetation Distance Between Filter components in your game.

Method NameDescriptionParameterReturnScriptable
GetAllowOverridesReturns the configuration of the Allow Per-Item Overrides property.NoneBooleanYes
GetBoundModeReturns the value of the Bound Mode property. Returns 0 for Radius and 1 for MeshRadius.NoneIntegerYes
GetRadiusMinReturns the value of the Radius Min property.NoneFloatYes
GetShapeEntityIdReturns the Pin To Shape Entity Id property of a distance between filter.NoneEntityIdYes
SetAllowOverridesSets the configuration of the Allow Per-Item Overrides property.BooleanNoneYes
SetBoundModeSets the value of the Bound Mode property. 0 for Radius and 1 for MeshRadius.IntegerNoneYes
SetRadiusMinSets the value of the Radius Min property.FloatNoneYes
SetShapeEntityIdSets the Pin To Shape Entity Id property of a distance between filter.EntityIdNoneYes