Torque3D Documentation / _generateds / fxShapeReplicator

fxShapeReplicator

consoledoc.h

An emitter for objects to replicate across an area.

More...

Debugging

bool

Replicated shapes are hidden when set to true.

bool

Draw placement rings when set to true.

int

Height of the placement ring in world units.

LinearColorF

Color of the placement ring.

Media

filename

Filename of shape to replicate.

Replications

int

Random seed for shape placement.

int

Maximum shape instance count.

int

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

Placement Radius

int

Placement area inner radius on the X axis.

int

Placement area inner radius on the Y axis.

int

Placement area outer radius on the X axis.

int

Placement area outer radius on the Y axis.

Restraints

bool

Shapes will be placed on terrain when set.

bool

Shapes will be placed on Static shapes when set.

bool

Shapes will be placed on/under water when set.

bool

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

bool

Align shapes to surface normal when set.

bool

Allow physics interactions with shapes.

int

Maximum surface angle allowed for shape instances.

Point3F

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

Object Transforms

Point3F

Minimum shape scale.

Point3F

Maximum shape scale.

Point3F

Minimum shape rotation angles.

Point3F

Maximum shape rotation angles.

int

Offset shapes by this amount vertically.

Public Static Attributes

bool

Disables rendering of all instances of this type.

bool

Disables selection of all instances of this type.

Detailed Description

An emitter for objects to replicate across an area.

Debugging

bool HideReplications 

Replicated shapes are hidden when set to true.

bool ShowPlacementArea 

Draw placement rings when set to true.

int PlacementAreaHeight 

Height of the placement ring in world units.

LinearColorF PlacementColour 

Color of the placement ring.

Media

filename shapeFile 

Filename of shape to replicate.

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.

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.

Restraints

bool AllowOnTerrain 

Shapes will be placed on terrain when set.

bool AllowOnStatics 

Shapes will be placed on Static shapes 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 AlignToTerrain 

Align shapes to surface normal when set.

bool Interactions 

Allow physics interactions with shapes.

int AllowedTerrainSlope 

Maximum surface angle allowed for shape instances.

Point3F TerrainAlignment 

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

Object Transforms

Point3F ShapeScaleMin 

Minimum shape scale.

Point3F ShapeScaleMax 

Maximum shape scale.

Point3F ShapeRotateMin 

Minimum shape rotation angles.

Point3F ShapeRotateMax 

Maximum shape rotation angles.

int OffsetZ 

Offset shapes by this amount vertically.

Public Static Attributes

bool isRenderable 

Disables rendering of all instances of this type.

bool isSelectable 

Disables selection of all instances of this type.