Class Overview

Decal Framework

User Manual >
Class Overview

Class Overview

DecalCreator


This is the main class for creating Dynamic and Dynamic Skinned decals. By creating scripts using the decals you always will be use his static methods. There are four main methods.

  1. CreateDecalMesh(...) - This function creates a mesh (not the real object) of decals with all texture coordinates and tangent. After creating all the components of the mesh are in world space, thus easier for us to bring the mesh in any other space.
  2. CreateDynamicDecal(...) - This function creates a real object decal . Any decal and Expeditors are always the child objects of the object from which they were born.
  3. CreateDynamicSkinnedDecal(...) - This function the same as previous but creates decals on skinned objects.Because creating skinned decals not the same as creating usual decals.
  4. CreateCombinedStaticDecalInGame() - This is helper function allow combine all uncombined Static decals before scene start.

 

DecalType


Main decal class. Here contains all setups for static and dynamic decals. In editor used for creating Static and Static Skinned decals.

 

DecalHolder


Helper class for dynamic decals. The component is added to each object from which decal created. Contains dictionary DecalType->DecalExpeditor. And access methods to Expeditors.

  1. GetExpeditor(...) - Get decal Expeditor certain DecalType.
  2. GetAllExpeditors() - Get all Expeditors for all DecalTypes.

 

DynamicDecalExpeditor


Component controls the behavior of a certain type of decal on the object. It difines creation, combinning,  deleting decals under settings DecalType , and memory clearing. In most of cases component carry out all you work. Mesh of this object always consist from all combinned decal meshes. All uncombined or sended to destroy decals will be child of this object.

 

SkinnedDecalExpeditor


Component similar to the previous but manages skinned decals .

 

DecalDestroyer


Component manages decal wich will be destroyed soon.


Copyright 2010 Frameshift