Main   Class List   Namespace List   Wiki

fxFoliageReplicator Class Reference
[Foliage]

An emitter to replicate fxFoliageItem objects across an area. More...

Inheritance diagram for fxFoliageReplicator:
Inheritance graph
[legend]

List of all members.

Public Attributes

Restrictions

int AllowedTerrainSlope
 Maximum surface angle allowed for foliage instances.
bool AllowOnInteriors
 Foliage will be placed on InteriorInstances when set.
bool AllowOnStatics
 Foliage will be placed on Static shapes when set.
bool AllowOnTerrain
 Foliage will be placed on terrain when set.
bool AllowOnWater
 Foliage will be placed on/under water when set.
bool AllowWaterSurface
 Foliage will be placed on water when set. Requires AllowOnWater.
Culling

float AlphaCutoff
 Minimum alpha value allowed on foliage instances.
int CullResolution
 Minimum size of culling bins. Must be >= 8 and <= OuterRadius.
float FadeInRegion
 Region beyond ViewDistance where foliage fades in/out.
float FadeOutRegion
 Region before ViewClosest where foliage fades in/out.
float GroundAlpha
 Alpha of the foliage at ground level. 0 = transparent, 1 = opaque.
bool UseCulling
 Use culling bins when enabled.
float ViewClosest
 Minimum distance from camera where foliage appears.
float ViewDistance
 Maximum distance from camera where foliage appears.
Debugging

float DebugBoxHeight
 Height multiplier for drawn culling bins.
bool HideFoliage
 Foliage is hidden when set to true.
int PlacementAreaHeight
 Height of the placement ring in world units.
ColorF PlacementColour
 Color of the placement ring.
bool ShowPlacementArea
 Draw placement rings when set to true.
bool UseDebugInfo
 Culling bins are drawn when set to true.
Dimensions

bool FixAspectRatio
 Maintain aspect ratio of image if true. This option ignores MaxWidth.
bool FixSizeToMax
 Use only MaxWidth and MaxHeight for billboard size. Ignores MinWidth and MinHeight.
float MaxHeight
 Maximum height of foliage billboards.
float MaxWidth
 Maximum width of foliage billboards.
float MinHeight
 Minimum height of foliage billboards.
float MinWidth
 Minimum width of foliage billboards.
float OffsetZ
 Offset billboards by this amount vertically.
bool RandomFlip
 Randomly flip billboards left-to-right.
bool useTrueBillboards
 Use camera facing billboards ( including the z axis ).
Media

int FoliageCount
 Maximum foliage instance count.
filename FoliageFile
 Image file for the foliage texture.
int FoliageRetries
 Number of times to try placing a foliage instance before giving up.
int seed
 Random seed for foliage placement.
Area

int InnerRadiusX
 Placement area inner radius on the X axis.
int InnerRadiusY
 Placement area inner radius on the Y axis.
int OuterRadiusX
 Placement area outer radius on the X axis.
int OuterRadiusY
 Placement area outer radius on the Y axis.
Lighting

bool LightOn
 Foliage should be illuminated with changing lights when true.
bool LightSync
 Foliage instances have the same lighting when set and LightOn is set.
float LightTime
 Time before foliage illumination cycle repeats.
float MaxLuminance
 Maximum luminance for foliage instances.
float MinLuminance
 Minimum luminance for foliage instances.
Animation

float MaxSwayTime
 Maximum sway cycle time in seconds.
float MinSwayTime
 Minumum sway cycle time in seconds.
float SwayMagFront
 Front-to-back sway magnitude.
float SwayMagSide
 Left-to-right sway magnitude.
bool SwayOn
 Foliage should sway randomly when true.
bool SwaySync
 Foliage instances should sway together when true and SwayOn is enabled.

Static Public Attributes

static bool isRenderable
 Disables rendering of all instances of this type.
static bool isSelectable
 Disables selection of all instances of this type.

Detailed Description

An emitter to replicate fxFoliageItem objects across an area.


Member Data Documentation

Maximum surface angle allowed for foliage instances.

Foliage will be placed on InteriorInstances when set.

Foliage will be placed on Static shapes when set.

Foliage will be placed on terrain when set.

Foliage will be placed on/under water when set.

Foliage will be placed on water when set. Requires AllowOnWater.

Minimum alpha value allowed on foliage instances.

Minimum size of culling bins. Must be >= 8 and <= OuterRadius.

Height multiplier for drawn culling bins.

Region beyond ViewDistance where foliage fades in/out.

Region before ViewClosest where foliage fades in/out.

Maintain aspect ratio of image if true. This option ignores MaxWidth.

Use only MaxWidth and MaxHeight for billboard size. Ignores MinWidth and MinHeight.

Maximum foliage instance count.

Image file for the foliage texture.

Number of times to try placing a foliage instance before giving up.

Alpha of the foliage at ground level. 0 = transparent, 1 = opaque.

Foliage is hidden when set to true.

Placement area inner radius on the X axis.

Placement area inner radius on the Y axis.

Disables rendering of all instances of this type.

Reimplemented from SceneObject.

Disables selection of all instances of this type.

Reimplemented from SceneObject.

Foliage should be illuminated with changing lights when true.

Foliage instances have the same lighting when set and LightOn is set.

Time before foliage illumination cycle repeats.

Maximum height of foliage billboards.

Maximum luminance for foliage instances.

Maximum sway cycle time in seconds.

Maximum width of foliage billboards.

Minimum height of foliage billboards.

Minimum luminance for foliage instances.

Minumum sway cycle time in seconds.

Minimum width of foliage billboards.

Offset billboards by this amount vertically.

Placement area outer radius on the X axis.

Placement area outer radius on the Y axis.

Height of the placement ring in world units.

Color of the placement ring.

Randomly flip billboards left-to-right.

Random seed for foliage placement.

Draw placement rings when set to true.

Front-to-back sway magnitude.

Left-to-right sway magnitude.

Foliage should sway randomly when true.

Foliage instances should sway together when true and SwayOn is enabled.

Use culling bins when enabled.

Culling bins are drawn when set to true.

Use camera facing billboards ( including the z axis ).

Minimum distance from camera where foliage appears.

Maximum distance from camera where foliage appears.



Copyright © GarageGames, LLC. All Rights Reserved.