Struct FoliageInstance

Foliage instanced mesh instance. Packed data with very little of logic. Managed by the foliage chunks and foliage actor itself.

Assembly: FlaxEngine.dll

File: Engine/Foliage/FoliageInstance.h

Syntax

public struct FoliageInstance

Fields

Bounds

The cached instance bounds (in world space).

Declaration

public BoundingSphere Bounds

Field Value

BoundingSphere

CullDistance

The cull distance for this instance.

Declaration

public float CullDistance

Field Value

float

DrawState

The model drawing state.

Declaration

public GeometryDrawStateData DrawState

Field Value

GeometryDrawStateData

Lightmap

The lightmap entry for the foliage instance.

Declaration

public LightmapEntry Lightmap

Field Value

LightmapEntry

Random

The per-instance random value from range [0;1].

Declaration

public float Random

Field Value

float

Transform

The local-space transformation of the mesh relative to the foliage actor.

Declaration

public Transform Transform

Field Value

Transform

Type

The foliage type index. Foliage types are hold in foliage actor and shared by instances using the same model.

Declaration

public int32 Type

Field Value

int32

Methods

HasLightmap()

Determines whether this foliage instance has valid lightmap data.

Declaration

public bool HasLightmap() const

Returns

bool

operator==(const FoliageInstance& v)

Declaration

public bool operator==(const FoliageInstance& v) const

Parameters

FoliageInstance v

Returns

bool

RemoveLightmap()

Removes the lightmap data from the foliage instance.

Declaration

public void RemoveLightmap()

Returns

void