Class FoliageType

Foliage mesh instances type descriptor. Defines the shared properties of the spawned mesh instances.

System.Object
Object
FoliageType
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public sealed class FoliageType : Object, ISerializable

Constructors

FoliageType()

Initializes a new instance of the FoliageType.

Declaration
public FoliageType()

Properties

CullDistance

The per-instance cull distance.

Declaration
[Unmanaged]
public float CullDistance { get; set; }
Property Value
System.Single

CullDistanceRandomRange

The per-instance cull distance randomization range (randomized per instance and added to master CullDistance value).

Declaration
[Unmanaged]
public float CullDistanceRandomRange { get; set; }
Property Value
System.Single

DensityScalingScale

The density scaling scale applied to the global scale for the foliage instances of this type. Can be used to boost or reduce density scaling effect on this foliage type. Default is 1.

Declaration
[Unmanaged]
public float DensityScalingScale { get; set; }
Property Value
System.Single

DrawModes

The draw passes to use for rendering this foliage type.

Declaration
[Unmanaged]
public DrawPass DrawModes { get; set; }
Property Value
DrawPass

Foliage

The parent foliage actor.

Declaration
[Unmanaged]
public Foliage Foliage { get; }
Property Value
Foliage

Index

The foliage type index.

Declaration
[Unmanaged]
public int Index { get; }
Property Value
System.Int32

Materials

Gets or sets the foliage instance type materials buffer (overrides).

Declaration
[Unmanaged]
public MaterialBase[] Materials { get; set; }
Property Value
MaterialBase[]

Model

The model to draw by the instances.

Declaration
[Unmanaged]
public Model Model { get; set; }
Property Value
Model

PaintDensity

The foliage instances density defined in instances count per 1000x1000 units area.

Declaration
[Unmanaged]
public float PaintDensity { get; set; }
Property Value
System.Single

PaintGroundSlopeAngleMax

The maximum ground slope angle to paint foliage on it (in degrees).

Declaration
[Unmanaged]
public float PaintGroundSlopeAngleMax { get; set; }
Property Value
System.Single

PaintGroundSlopeAngleMin

The minimum ground slope angle to paint foliage on it (in degrees).

Declaration
[Unmanaged]
public float PaintGroundSlopeAngleMin { get; set; }
Property Value
System.Single

PaintRadius

The minimum radius between foliage instances.

Declaration
[Unmanaged]
public float PaintRadius { get; set; }
Property Value
System.Single

PaintScaleMax

The scale maximum values per axis.

Declaration
[Unmanaged]
public Float3 PaintScaleMax { get; set; }
Property Value
Float3

PaintScaleMin

The scale minimum values per axis.

Declaration
[Unmanaged]
public Float3 PaintScaleMin { get; set; }
Property Value
Float3

PaintScaling

The scaling mode.

Declaration
[Unmanaged]
public FoliageScalingModes PaintScaling { get; set; }
Property Value
FoliageScalingModes

PlacementAlignToNormal

If checked, instances will be aligned to normal of the placed surface.

Declaration
[Unmanaged]
public bool PlacementAlignToNormal { get; set; }
Property Value
System.Boolean

PlacementOffsetY

The per-instance random offset range on axis Y.

Declaration
[Unmanaged]
public Float2 PlacementOffsetY { get; set; }
Property Value
Float2

PlacementRandomPitchAngle

The random pitch angle range (uniform in both ways around normal vector).

Declaration
[Unmanaged]
public float PlacementRandomPitchAngle { get; set; }
Property Value
System.Single

PlacementRandomRollAngle

The random roll angle range (uniform in both ways around normal vector).

Declaration
[Unmanaged]
public float PlacementRandomRollAngle { get; set; }
Property Value
System.Single

PlacementRandomYaw

If checked, instances will use randomized yaw when placed. Random yaw uses will rotation range over the Y axis.

Declaration
[Unmanaged]
public bool PlacementRandomYaw { get; set; }
Property Value
System.Boolean

ReceiveDecals

Determines whenever this meshes can receive decals.

Declaration
[Unmanaged]
public bool ReceiveDecals { get; set; }
Property Value
System.Boolean

ScaleInLightmap

The scale in lightmap (for instances of this foliage type). Can be used to adjust static lighting quality for the foliage instances.

Declaration
[Unmanaged]
public float ScaleInLightmap { get; set; }
Property Value
System.Single

ShadowsMode

The shadows casting mode.

Declaration
[Unmanaged]
public ShadowsCastingMode ShadowsMode { get; set; }
Property Value
ShadowsCastingMode

UseDensityScaling

Flag used to determinate whenever use global foliage density scaling for instances of this foliage type.

Declaration
[Unmanaged]
public bool UseDensityScaling { get; set; }
Property Value
System.Boolean

Extension Methods