DecalData Class Reference
[Special Effects]

A datablock describing an individual decal. More...

Inheritance diagram for DecalData:

Public Member Functions
void	postApply ()
	Reloads imagemap textures for this DecalData.
Public Attributes
Rendering

float	clippingAngle
	The angle in degrees used to clip geometry that faces away from the decal projection direction.
float	fadeEndPixelSize
	LOD value - size in pixels at which decals of this type are fully faded out. This should be a smaller value than fadeStartPixelSize.
float	fadeStartPixelSize
	LOD value - size in pixels at which decals of this type begin to fade out. This should be a larger value than fadeEndPixelSize. However, you may also set this to a negative value to disable lod-based fading.
char	renderPriority
	Default renderPriority for decals of this type.
Decal

int	fadeTime
	Milliseconds of sim time for decal to fade after expiration.
int	lifeSpan
	Milliseconds of sim time for decal to expire.
string	Material
	Material for this decal type.
float	size
	Width/height in meters before scale is applied.
Texturing

int	frame
	Index of texture rectangle to use for this decal.
bool	randomize
	If true, a random texture rectangle is picked for each instance of this decal.
int	texCols
	Number of columns on the supplied imagemap.
int	texRows
	Number of rows on the supplied imagemap.
int	textureCoordCount
	Number of individual frames in this imagemap.
RectF	textureCoords [16]
	A RectF in uv space - eg ( topleft.x topleft.y extent.x extent.y ).

Detailed Description

A datablock describing an individual decal.

Example:

datablock DecalData(ScorchRXDecal)
{
   Material = "DECAL_RocketEXP";
   size = "5.0";
   lifeSpan = "50000";
   randomize = "1";
   texRows = "2";
   texCols = "2";
   clippingAngle = "60";
};

Member Function Documentation

void DecalData::postApply ( )

Reloads imagemap textures for this DecalData.

Example:

// Inform the decal object to reload its imagemap and frame data.
%decalData.postApply();

Member Data Documentation

float DecalData::clippingAngle

The angle in degrees used to clip geometry that faces away from the decal projection direction.

float DecalData::fadeEndPixelSize

LOD value - size in pixels at which decals of this type are fully faded out. This should be a smaller value than fadeStartPixelSize.

float DecalData::fadeStartPixelSize

LOD value - size in pixels at which decals of this type begin to fade out. This should be a larger value than fadeEndPixelSize. However, you may also set this to a negative value to disable lod-based fading.

int DecalData::fadeTime

Milliseconds of sim time for decal to fade after expiration.

int DecalData::frame

Index of texture rectangle to use for this decal.

int DecalData::lifeSpan

Milliseconds of sim time for decal to expire.

string DecalData::Material

Material for this decal type.

bool DecalData::randomize

If true, a random texture rectangle is picked for each instance of this decal.

char DecalData::renderPriority

Default renderPriority for decals of this type.