Torque 3D - Script Manual: ForestBrushElement Class Reference

TorqueScript

Main   Class List   Namespace List   Online

ForestBrushElement Class Reference
[Forest]

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

Inheritance diagram for ForestBrushElement:

List of all members.

Public Attributes

ForestBrushElement

float elevationMax
 The max world space elevation this item will be placed.
float elevationMin
 The min world space elevation this item will be placed.
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 scaleExponent
 An exponent used to bias between the minimum and maximum random sizes.
float scaleMax
 The maximum random size of each item.
float scaleMin
 The minimum random size for each item.
float sinkMax
 Max variation in the sink radius.
float sinkMin
 Min 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 slopeMax
 The max surface slope in degrees this item will be placed on.
float slopeMin
 The min surface slope in degrees this item will be placed on.

Detailed Description

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


Member Data Documentation

The max world space elevation this item will be placed.

The min world space elevation this item will be placed.

The type of ForestItem this element holds placement parameters for.

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.

The max rotation in degrees that items will be placed.

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

The maximum random size of each item.

The minimum random size for each item.

Max variation in the sink radius.

Min variation in the sink radius.

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.

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

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



Copyright © GarageGames, LLC. All Rights Reserved.