fxShapeReplicator Class Reference
[Foliage]

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

Inheritance diagram for fxShapeReplicator:

[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

bool fxShapeReplicator::AlignToTerrain

Align shapes to surface normal when set.

int fxShapeReplicator::AllowedTerrainSlope

Maximum surface angle allowed for shape instances.

bool fxShapeReplicator::AllowOnInteriors

Shapes will be placed on InteriorInstances when set.

bool fxShapeReplicator::AllowOnStatics

Shapes will be placed on Static shapes when set.

bool fxShapeReplicator::AllowOnTerrain

Shapes will be placed on terrain when set.

bool fxShapeReplicator::AllowOnWater

Shapes will be placed on/under water when set.

bool fxShapeReplicator::AllowWaterSurface

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

bool fxShapeReplicator::HideReplications

Replicated shapes are hidden when set to true.

int fxShapeReplicator::InnerRadiusX

Placement area inner radius on the X axis.

int fxShapeReplicator::InnerRadiusY

Placement area inner radius on the Y axis.

bool fxShapeReplicator::Interactions

Allow physics interactions with shapes.

bool fxShapeReplicator::isRenderable [static]

Disables rendering of all instances of this type.

Reimplemented from SceneObject.

bool fxShapeReplicator::isSelectable [static]

Disables selection of all instances of this type.

Reimplemented from SceneObject.

int fxShapeReplicator::OffsetZ

Offset shapes by this amount vertically.

int fxShapeReplicator::OuterRadiusX

Placement area outer radius on the X axis.

int fxShapeReplicator::OuterRadiusY

Placement area outer radius on the Y axis.

int fxShapeReplicator::PlacementAreaHeight

Height of the placement ring in world units.

ColorF fxShapeReplicator::PlacementColour

Color of the placement ring.

int fxShapeReplicator::seed

Random seed for shape placement.

int fxShapeReplicator::ShapeCount

Maximum shape instance count.

filename fxShapeReplicator::shapeFile

Filename of shape to replicate.

int fxShapeReplicator::ShapeRetries

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

Point3F fxShapeReplicator::ShapeRotateMax

Maximum shape rotation angles.

Point3F fxShapeReplicator::ShapeRotateMin

Minimum shape rotation angles.

Point3F fxShapeReplicator::ShapeScaleMax

Maximum shape scale.

Point3F fxShapeReplicator::ShapeScaleMin

Minimum shape scale.

bool fxShapeReplicator::ShowPlacementArea

Draw placement rings when set to true.

Point3F fxShapeReplicator::TerrainAlignment

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