Vegetation Surface Mask Depth Filter Component

Add the Vegetation Surface Mask Depth Filter component to limit vegetation or blocker instance placement to the areas surrounding specific surface tags.

Provider

Vegetation Gem

Dependencies

Add one of the following required components when using the Vegetation Surface Mask Depth Filter component:

Vegetation Surface Mask Depth Filter properties

Vegetation Surface Mask Depth Filter component properties

PropertyDescriptionValuesDefault
Filter StageDefines if filters are applied before or after modifiers.PreProcess, PostProcess, or DefaultDefault
Allow Per-Item OverridesIf Enabled, vegetation descriptor properties that are enabled can override this component’s properties.BooleanDisabled
Upper Distance RangeSets the maximum altitude difference between the vegetation instance and the Depth Comparison Tags. Positive values correspond to altitudes above the surface tags, negative values correspond to altitudes below the surface tags.Float: -Infinity to Infinity1000.0
Lower Distance RangeSets the minimum altitude difference between the vegetation instance and the Depth Comparison Tags. Positive values correspond to altitudes above the surface tags, negative values correspond to altitudes below the surface tags.Float: -Infinity to Infinity-1000.0
Depth Comparison TagsAn array of surface tags that provide the elevation data to query altitude.Array: Surface TagsNone

SurfaceMaskDepthFilterRequestBus

Use the following request functions with the SurfaceMaskDepthFilterRequestBus EBus interface to communicate with Vegetation Surface Mask Depth Filter components in your game.

Method NameDescriptionParameterReturnScriptable
AddTagAdds a surface tag to the Depth Comparison Tags array.Surface Tag: StringNoneYes
GetAllowOverridesReturns the configuration of the Allow Per-Item Overrides property.NoneBooleanYes
GetLowerDistanceReturns the value of the Lower Distance Range property.NoneFloatYes
GetNumTagsReturns the number of surface tags in the Depth Comparison Tags array.NoneCount: IntegerYes
GetTagReturns the surface tag at the specified index of the Depth Comparison Tags array.Surface Tag Index: IntegerSurface Tag: StringYes
GetUpperDistanceReturns the value of the Upper Distance Range property.NoneFloatYes
RemoveTagRemoves the surface tag at the specified index of the Depth Comparison Tags array.Surface Tag Index: IntegerNoneYes
SetAllowOverridesSets the configuration of the Allow Per-Item Overrides property.BooleanNoneYes
SetLowerDistanceSets the value of the Lower Distance Range property.FloatNoneYes
SetUpperDistanceSets the value of the Upper Distance Range property.FloatNoneYes