UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1

Decal Class

Decal class is used for base decals operation. To create, modify or get information on special types of the decals, use decal-related classes.

Decal Class

This class inherits from Node

Members


float getFadeTime ()

Returns a time period during which the decal will fade away (after its life time exceeds).

Return value

Time in seconds.

float getInitTime ()

Returns a time period of render initialization.

Return value

Time in seconds.

float getLifeTime ()

Returns a time period during which the decal will be projected.

Return value

Time in seconds. If a negative value is returned, the decal is permanent.

Material getMaterialInherit ()

Inherits material for the decal (i.e. creates a material instance). Modifications made in a new material instance will not affect the source material.

Return value

The inherited material.

string getMaterialName ()

Returns the name of a decal material.

Return value

Material name.

Material getMaterial ()

Returns a material used for the decal.

Return value

Material used for the decal.

float getMaxFadeDistance ()

Returns a maximum fade-out distance, across which the decal smoothly becomes invisible due to the alpha fading. It is counted starting from the maximum visibility distance value.

Return value

Distance value, in units.

float getMaxVisibleDistance ()

Returns a maximum visibility distance, starting at which the decal begins to fade out until becomes completely invisible.

Return value

Distance value, in units.

float getMinFadeDistance ()

Returns a minimum fade-in distance, across which the decal smoothly becomes visible due to the alpha fading. It is counted starting from the minimum visibility distance value.

Return value

Distance value, in units.

float getMinVisibleDistance ()

Returns a minimum visibility distance, starting at which the decal begins to fade in and then becomes completely visible.

Return value

Distance value, in units.

vec4 getTexCoord ()

Returns the texture coordinates for the decal (a texture atlas can be used).
  • The first pair of coordinates (x and y) set texture scale by X and Y axes. For example, by the scale of 2 the texture is repeated twice on one decal.
  • The second pair (z and w) set texture offset along X and Y axes. For example, by the offset of 0.5 along X axis the texture is repositioned to the right (so that the edge of the texture is rendered in the center).

Return value

Texture coordinates for the decal.

int getViewportMask ()

Returns the current bit mask for rendering into the viewport. The decal is rendered, if its mask matches the camera viewport mask and the viewport mask of the decal's material.

Return value

The integer value, each bit of which is used to set a mask.

int isMaterialInherited ()

Returns a value indicating if a given material is inherited (instanced). Modifications made in a material instance do not affect the source material.

Return value

Positive number if the material is inherited; otherwise, 0.

void setFadeTime (float time)

Sets a time period during which the decal will fade away (after its life time exceeds). Fade time is ignored if the decal does not disappear.

Arguments

  • float time - Time in seconds.

void setInitTime (float time)

Sets a time period during which the decal will be projected.

Arguments

  • float time - Time in seconds. If a negative value is provided, the decal will be permanent.

void setLifeTime (float time)

Sets a time period of render initialization.

Arguments

  • float time - Time in seconds.

int setMaterial (string material)

Sets a material for the decal.

Arguments

  • string material - Name of the material.

Return value

1 if the material is set correctly; otherwise - 0.

void setMaxFadeDistance (float distance)

Updates a maximum fade-out distance, across which the decal smoothly becomes invisible due to the alpha fading. It is counted starting from the maximum visibility distance value.

Arguments

  • float distance - A minimum fade-out distance, in units. If a negative value is provided, 0 will be used instead.

void setMaxVisibleDistance (float distance)

Updates the maximum visibility distance, starting at which the decal begins to fade out until becomes completely invisible.

Arguments

  • float distance - A maximum visibility distance, in units. If a negative value is provided, 0 will be used instead.

void setMinFadeDistance (float distance)

Updates a minimum fade-in distance, across which the decal smoothly becomes visible due to the alpha fading. It is counted starting from the minimum visibility distance value.

Arguments

  • float distance - A minimum fade-in distance, in units. If a negative value is provided, 0 will be used instead.

void setMinVisibleDistance (float distance)

Updates a minimum visibility distance, starting at which the decal begins to fade in and then becomes completely visible.

Arguments

  • float distance - A minimum visibility distance, in units. If a negative value is provided, 0 will be used instead.

void setTexCoord (vec4 texcoord)

Sets texture coordinates for the decal (a texture atlas can be used).
  • The first pair of coordinates (x and y) set texture scale by X and Y axes. For example, by the scale of 2 the texture is repeated twice on one decal.
  • The second pair (z and w) set texture offset along X and Y axes. For example, by the offset of 0.5 along X axis the texture is repositioned to the right (so that the edge of the texture is rendered in the center).

Arguments

  • vec4 texcoord - Texture coordinates for the decal.

void setViewportMask (int mask)

Sets a bit mask for rendering into the viewport. The decal is rendered, if its mask matches the camera viewport mask and the viewport mask of the decal's material.

Arguments

  • int mask - An integer value, each bit of which is used to set a mask.
Last update: 2017-07-03