RibbonData

Engine/source/T3D/fx/ribbon.h

More...

Public Types

enum
Constants {  NumFields = 4
}

Private Types

Parent 

Public Attributes

mColours [NumFields]

The colour of the ribbon for each keyframe.

How quickly the ribbons is faded away after deletion.

bool

If true, texcoords will stay the same over the lifetime for each segment.

The material for the ribbon.

The amount of segments that will make up the ribbon.

The amount of segments to skip each time segments are added.

mSizes [NumFields]

The radius for each keyframe.

bool

If true, texcoords will not be stretched if the distance between 2 segments are long.

A scalar to scale the texcoord.

mTimes [NumFields]

The relative time for each keyframe.

bool

If true, the ribbon will fade away after deletion.

Amount of segments to add each update.

Protected Functions

bool

Called when the object is added to the sim.

Public Functions

bool
preload(bool server, String & errorStr)

Called to prepare the datablock for use, after it has been unpacked.

Public Static Functions

Detailed Description

Public Types

Constants

Enumerator

NumFields = 4

Private Types

typedef GameBaseData Parent 

Public Attributes

LinearColorF mColours [NumFields]

The colour of the ribbon for each keyframe.

F32 mFadeAwayStep 

How quickly the ribbons is faded away after deletion.

bool mFixedTexcoords 

If true, texcoords will stay the same over the lifetime for each segment.

StringTableEntry mMatName 

The material for the ribbon.

U32 mRibbonLength 

The amount of segments that will make up the ribbon.

S32 mSegmentSkipAmount 

The amount of segments to skip each time segments are added.

F32 mSizes [NumFields]

The radius for each keyframe.

bool mTexcoordsRelativeToDistance 

If true, texcoords will not be stretched if the distance between 2 segments are long.

F32 mTileScale 

A scalar to scale the texcoord.

F32 mTimes [NumFields]

The relative time for each keyframe.

bool mUseFadeOut 

If true, the ribbon will fade away after deletion.

S32 segmentsPerUpdate 

Amount of segments to add each update.

Protected Functions

onAdd()

Reimplemented from: SimDataBlock

Public Functions

RibbonData()

DECLARE_CONOBJECT(RibbonData )

packData(BitStream * )

Reimplemented from: SimDataBlock

preload(bool server, String & errorStr)

Reimplemented from: SimDataBlock

unpackData(BitStream * )

Reimplemented from: SimDataBlock

Public Static Functions

initPersistFields()