Class FoliageTools

Foliage tools for editor. Allows to spawn and modify foliage instances.

Inheritance

System.Object

FoliageTools

Namespace: FlaxEditor

Assembly: FlaxEngine.CSharp.dll

Syntax

[Unmanaged]
public static class FoliageTools : Object

Methods

Paint(Foliage, Int32[], Vector3, Single, Boolean, Single)

Paints the foliage instances using the given foliage types selection and the brush location.

Declaration

[Unmanaged]
public static void Paint(Foliage foliage, int[] foliageTypesIndices, Vector3 brushPosition, float brushRadius, bool additive, float densityScale = 1F)

Parameters

Foliage foliage The foliage actor.

System.Int32[] foliageTypesIndices The foliage types indices to use for painting.

Vector3 brushPosition The brush position.

System.Single brushRadius The brush radius.

System.Boolean additive True if paint using additive mode, false if remove foliage instances.

System.Single densityScale The additional scale for foliage density when painting. Can be used to increase or decrease foliage density during painting.

Paint(Foliage, Int32[], Vector3, Single, Single)

Paints the foliage instances using the given foliage types selection and the brush location.

Declaration

[Unmanaged]
public static void Paint(Foliage foliage, int[] foliageTypesIndices, Vector3 brushPosition, float brushRadius, float densityScale = 1F)

Parameters

Foliage foliage The foliage actor.

System.Int32[] foliageTypesIndices The foliage types indices to use for painting.

Vector3 brushPosition The brush position.

System.Single brushRadius The brush radius.

System.Single densityScale The additional scale for foliage density when painting. Can be used to increase or decrease foliage density during painting.

Remove(Foliage, Int32[], Vector3, Single)

Removes the foliage instances using the given foliage types selection and the brush location.

Declaration

[Unmanaged]
public static void Remove(Foliage foliage, int[] foliageTypesIndices, Vector3 brushPosition, float brushRadius)

Parameters

Foliage foliage The foliage actor.

System.Int32[] foliageTypesIndices The foliage types indices to use for painting.

Vector3 brushPosition The brush position.

System.Single brushRadius The brush radius.