Torque3D Documentation / _generateds / afxZodiacPlaneData

afxZodiacPlaneData

consoledoc.h

A datablock that specifies a Zodiac Plane effect.

More...

Public Attributes

A blending style for the zodiac. Possible values: normal, additive, or subtractive.

LinearColorF

A color value for the zodiac.

bool

Controls whether the zodiac-plane's polygons are rendered when viewed from either side. If set to false, the zodiac-plane will only be seen when viewed from the direction it is facing (according to faceDir).

Specifies which direction the zodiac-plane's polygons face. Possible values: up, down, front, back, right, or left.

float

A duration of time in seconds over which the zodiac grows from a zero size to its full size as specified by the radius.

float

A rate in meters-per-second at which the zodiac grows in size. A negative value will shrink the zodiac.

float

The zodiac's radius in scene units.

float

The rate of rotation in degrees-per-second. Zodiacs with a positive rotationRate rotate clockwise, while those with negative values turn counter-clockwise.

float

A duration of time in seconds over which the zodiac shrinks from full size to invisible.

float

The starting angle in degrees of the zodiac's rotation.

filename

An image to use as the zodiac's texture.

bool

Specifies if the zodiac's rotation should be defined by its constrained transformation.

bool

Normal zodiacs have only one degree of freedom, a rotation around the z-axis. Depending on the setting for trackOrientConstraint, this means that the effect's orientation is either ignored or is limited to influencing the zodiac's angle of rotation. By default, zodiac-plane reproduces this limited behavior in order to match normal zodiacs. When useFullTransform is set to true, the zodiac can be arbitrarily oriented.

Detailed Description

A datablock that specifies a Zodiac Plane effect.

afxZodiacData describes a zodiac-like effect called a zodiac plane. It reproduces most of the behavior of normal zodiacs but unlike zodiac decals, it is represented as a flat plane of geometry that can be more flexibly positioned and oriented.

Public Attributes

afxZodiacPlane_BlendType blend 

A blending style for the zodiac. Possible values: normal, additive, or subtractive.

LinearColorF color 

A color value for the zodiac.

bool doubleSided 

Controls whether the zodiac-plane's polygons are rendered when viewed from either side. If set to false, the zodiac-plane will only be seen when viewed from the direction it is facing (according to faceDir).

afxZodiacPlane_FacingType faceDir 

Specifies which direction the zodiac-plane's polygons face. Possible values: up, down, front, back, right, or left.

float growInTime 

A duration of time in seconds over which the zodiac grows from a zero size to its full size as specified by the radius.

float growthRate 

A rate in meters-per-second at which the zodiac grows in size. A negative value will shrink the zodiac.

float radius 

The zodiac's radius in scene units.

float rotationRate 

The rate of rotation in degrees-per-second. Zodiacs with a positive rotationRate rotate clockwise, while those with negative values turn counter-clockwise.

float shrinkOutTime 

A duration of time in seconds over which the zodiac shrinks from full size to invisible.

float startAngle 

The starting angle in degrees of the zodiac's rotation.

filename texture 

An image to use as the zodiac's texture.

bool trackOrientConstraint 

Specifies if the zodiac's rotation should be defined by its constrained transformation.

bool useFullTransform 

Normal zodiacs have only one degree of freedom, a rotation around the z-axis. Depending on the setting for trackOrientConstraint, this means that the effect's orientation is either ignored or is limited to influencing the zodiac's angle of rotation. By default, zodiac-plane reproduces this limited behavior in order to match normal zodiacs. When useFullTransform is set to true, the zodiac can be arbitrarily oriented.