Torque3D Documentation / _generateds / LightAnimData::AnimValue

LightAnimData::AnimValue

Engine/source/T3D/lightAnimData.h

Helper class used to keyframe light parameters.

More...

Public Attributes

keyLen [COUNT]

The calculated length of the keyframe string.

keys [COUNT]

The keyframe keys as a string of letters A to Z.

period [COUNT]

The period of the full keyframe sequence.

bool
smooth [COUNT]

If true the transition between keyframes will be smooth.

timeScale [COUNT]

The scale used to convert time into a keyframe position.

value1 [COUNT]

The first value associated with the A keyframe.

value2 [COUNT]

The second value associated with the Z keyframe.

Public Functions

Constructor.

bool
animate(F32 time, F32 * output, bool multiply)

Performs the animation returning the results in the output if the time scale is greater than zero.

read(BitStream * stream)

Read the animation data from the bitstream.

Called when the key string is changed to update the key length and time scale.

write(BitStream * stream)

Write the animation data to the bitstream.

Detailed Description

Helper class used to keyframe light parameters.

It is templatized on the number of parameters to store.

Public Attributes

U32 keyLen [COUNT]

The calculated length of the keyframe string.

StringTableEntry keys [COUNT]

The keyframe keys as a string of letters A to Z.

F32 period [COUNT]

The period of the full keyframe sequence.

bool smooth [COUNT]

If true the transition between keyframes will be smooth.

F32 timeScale [COUNT]

The scale used to convert time into a keyframe position.

F32 value1 [COUNT]

The first value associated with the A keyframe.

F32 value2 [COUNT]

The second value associated with the Z keyframe.

Public Functions

AnimValue()

Constructor.

animate(F32 time, F32 * output, bool multiply)

Performs the animation returning the results in the output if the time scale is greater than zero.

return:

Returns true if the animation was performed.

read(BitStream * stream)

Read the animation data from the bitstream.

updateKey()

Called when the key string is changed to update the key length and time scale.

write(BitStream * stream)

Write the animation data to the bitstream.