Torque 3D - Script Manual: LightAnimData Class Reference

TorqueScript

Main   Class List   Namespace List   Online

LightAnimData Class Reference
[Special EffectsLighting]

A datablock which defines and performs light animation, such as rotation, brightness fade, and colorization. More...

Inheritance diagram for LightAnimData:

List of all members.

Public Attributes

Brightness

The brightness animation state.

float brightnessA
 The value of the A key in the keyframe sequence.
string brightnessKeys
 The keyframe sequence encoded into a string where characters from A to Z define a position between the two animation values.
float brightnessPeriod
 The animation time for keyframe sequence.
bool brightnessSmooth
 If true the transition between keyframes will be smooth.
float brightnessZ
 The value of the Z key in the keyframe sequence.
Color

The RGB color animation state.

float colorA [3]
 The value of the A key in the keyframe sequence.
string colorKeys [3]
 The keyframe sequence encoded into a string where characters from A to Z define a position between the two animation values.
float colorPeriod [3]
 The animation time for keyframe sequence.
bool colorSmooth [3]
 If true the transition between keyframes will be smooth.
float colorZ [3]
 The value of the Z key in the keyframe sequence.
Offset

The XYZ translation animation state relative to the light position.

float offsetA [3]
 The value of the A key in the keyframe sequence.
string offsetKeys [3]
 The keyframe sequence encoded into a string where characters from A to Z define a position between the two animation values.
float offsetPeriod [3]
 The animation time for keyframe sequence.
bool offsetSmooth [3]
 If true the transition between keyframes will be smooth.
float OffsetZ [3]
 The value of the Z key in the keyframe sequence.
Rotation

The XYZ rotation animation state relative to the light orientation.

float rotA [3]
 The value of the A key in the keyframe sequence.
string rotKeys [3]
 The keyframe sequence encoded into a string where characters from A to Z define a position between the two animation values.
float rotPeriod [3]
 The animation time for keyframe sequence.
bool rotSmooth [3]
 If true the transition between keyframes will be smooth.
float rotZ [3]
 The value of the Z key in the keyframe sequence.

Detailed Description

A datablock which defines and performs light animation, such as rotation, brightness fade, and colorization.

Example:
datablock LightAnimData( SubtlePulseLightAnim )
{
   brightnessA = 0.5;
   brightnessZ = 1;
   brightnessPeriod = 1;
   brightnessKeys = "aza";
   brightnessSmooth = true;
};
See also:
LightBase
LightDescription

Member Data Documentation

The value of the A key in the keyframe sequence.

The keyframe sequence encoded into a string where characters from A to Z define a position between the two animation values.

The animation time for keyframe sequence.

If true the transition between keyframes will be smooth.

The value of the Z key in the keyframe sequence.

The value of the A key in the keyframe sequence.

The keyframe sequence encoded into a string where characters from A to Z define a position between the two animation values.

The animation time for keyframe sequence.

If true the transition between keyframes will be smooth.

The value of the Z key in the keyframe sequence.

The value of the A key in the keyframe sequence.

The keyframe sequence encoded into a string where characters from A to Z define a position between the two animation values.

The animation time for keyframe sequence.

If true the transition between keyframes will be smooth.

The value of the Z key in the keyframe sequence.

The value of the A key in the keyframe sequence.

The keyframe sequence encoded into a string where characters from A to Z define a position between the two animation values.

The animation time for keyframe sequence.

If true the transition between keyframes will be smooth.

The value of the Z key in the keyframe sequence.



Copyright © GarageGames, LLC. All Rights Reserved.