Torque3D Documentation / _generateds / ForestBrushElement

ForestBrushElement

consoledoc.h

Represents a type of ForestItem and parameters for how it is placed when painting with a ForestBrush that contains it.

More...

ForestBrushElement

The type of ForestItem this element holds placement parameters for.

float

The probability that this element will be created during an editor brush stroke is the sum of all element probabilities in the brush divided by the probability of this element.

float

The max rotation in degrees that items will be placed.

float

The minimum random size for each item.

float

The maximum random size of each item.

float

An exponent used to bias between the minimum and maximum random sizes.

float

Min variation in the sink radius.

float

Max variation in the sink radius.

float

This is the radius used to calculate how much to sink the trunk at its base and is used to sink the tree into the ground when its on a slope.

float

The min surface slope in degrees this item will be placed on.

float

The max surface slope in degrees this item will be placed on.

float

The min world space elevation this item will be placed.

float

The max world space elevation this item will be placed.

Detailed Description

Represents a type of ForestItem and parameters for how it is placed when painting with a ForestBrush that contains it.

ForestBrushElement

ForestItemData ForestItemData 

The type of ForestItem this element holds placement parameters for.

float probability 

The probability that this element will be created during an editor brush stroke is the sum of all element probabilities in the brush divided by the probability of this element.

float rotationRange 

The max rotation in degrees that items will be placed.

float scaleMin 

The minimum random size for each item.

float scaleMax 

The maximum random size of each item.

float scaleExponent 

An exponent used to bias between the minimum and maximum random sizes.

float sinkMin 

Min variation in the sink radius.

float sinkMax 

Max variation in the sink radius.

float sinkRadius 

This is the radius used to calculate how much to sink the trunk at its base and is used to sink the tree into the ground when its on a slope.

float slopeMin 

The min surface slope in degrees this item will be placed on.

float slopeMax 

The max surface slope in degrees this item will be placed on.

float elevationMin 

The min world space elevation this item will be placed.

float elevationMax 

The max world space elevation this item will be placed.