Main   Class List   Namespace List   Wiki

fxShapeReplicator Class Reference
[Foliage]

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

Inheritance diagram for fxShapeReplicator:
Inheritance graph
[legend]

List of all members.

Public Attributes

Restraints

bool AlignToTerrain
 Align shapes to surface normal when set.
int AllowedTerrainSlope
 Maximum surface angle allowed for shape instances.
bool AllowOnInteriors
 Shapes will be placed on InteriorInstances when set.
bool AllowOnStatics
 Shapes will be placed on Static shapes when set.
bool AllowOnTerrain
 Shapes will be placed on terrain when set.
bool AllowOnWater
 Shapes will be placed on/under water when set.
bool AllowWaterSurface
 Shapes will be placed on water when set. Requires AllowOnWater.
bool Interactions
 Allow physics interactions with shapes.
Point3F TerrainAlignment
 Surface normals will be multiplied by these values when AlignToTerrain is enabled.
Debugging

bool HideReplications
 Replicated shapes are 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.
Placement Radius

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.
Object Transforms

int OffsetZ
 Offset shapes by this amount vertically.
Point3F ShapeRotateMax
 Maximum shape rotation angles.
Point3F ShapeRotateMin
 Minimum shape rotation angles.
Point3F ShapeScaleMax
 Maximum shape scale.
Point3F ShapeScaleMin
 Minimum shape scale.
Replications

int seed
 Random seed for shape placement.
int ShapeCount
 Maximum shape instance count.
int ShapeRetries
 Number of times to try placing a shape instance before giving up.
Media

filename shapeFile
 Filename of shape to replicate.

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 for objects to replicate across an area.


Member Data Documentation

Align shapes to surface normal when set.

Maximum surface angle allowed for shape instances.

Shapes will be placed on InteriorInstances when set.

Shapes will be placed on Static shapes when set.

Shapes will be placed on terrain when set.

Shapes will be placed on/under water when set.

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

Replicated shapes are hidden when set to true.

Placement area inner radius on the X axis.

Placement area inner radius on the Y axis.

Allow physics interactions with shapes.

Disables rendering of all instances of this type.

Reimplemented from SceneObject.

Disables selection of all instances of this type.

Reimplemented from SceneObject.

Offset shapes 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.

Random seed for shape placement.

Maximum shape instance count.

Filename of shape to replicate.

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

Maximum shape rotation angles.

Minimum shape rotation angles.

Maximum shape scale.

Minimum shape scale.

Draw placement rings when set to true.

Surface normals will be multiplied by these values when AlignToTerrain is enabled.



Copyright © GarageGames, LLC. All Rights Reserved.