Drag[en]gine Script Module DragonScript Script API  1.0
DecalBuilder Class Reference

Create decals based on a decal definition for each visited element using a visitor. More...

Inheritance diagram for DecalBuilder:
ColliderListener

Public Member Functions

bool canHitCollider (Collider owner, Collider collider)
 Colliders can hit each other. More...
 
void colliderChanged (Collider owner)
 Collider changed which does not happen for this use of the listener. More...
 
void collisionResponse (Collider owner, CollisionInfo info)
 Collision detected. More...
 
void createDecals (World world)
 Create decals from stored decal definition for matching elements in the world. More...
 
CollisionFilter getCollisionFilter ()
 Collision filter limiting the elements to attach decals to. More...
 
DMatrix getMatrix ()
 Projection matrix constructed from position and orientation. More...
 
Quaternion getOrientation ()
 Orientation of projection. More...
 
DVector getPosition ()
 Position from to project. More...
 
bool getPropertyBoolFor (String key, bool default)
 Boolean property value or default value if absent. More...
 
int getPropertyCount ()
 Number of properties. More...
 
float getPropertyFloatFor (String key, float default)
 Floating point property value or default value if absent. More...
 
int getPropertyIntFor (String key, int default)
 Integer property value or default value if absent. More...
 
Array getPropertyKeys ()
 Property keys (String array). More...
 
String getPropertyValueFor (String key, String default)
 Value of property or default value if absent. More...
 
Vector getSize ()
 Size of projection. More...
 
Skin getSkin ()
 Skin to use for create decals. More...
 
TexMatrix2 getTransform ()
 
bool getVisible ()
 Decal is visible after being created. More...
 
ElementVisitor getVisitor ()
 Visitor to use to create the decals. More...
 
bool hasPropertyWithKey (String key)
 Property key is present. More...
 
DecalBuilder new ()
 Create decal builder. More...
 
void removeAllProperties ()
 Remove all properties. More...
 
void setCollisionFilter (CollisionFilter collisionFilter)
 Set collision filter limiting the elements to attach decals to. More...
 
void setPositionAndOrientation (DVector position, Quaternion orientation)
 Set projection position and orientation. More...
 
void setPropertyValueFor (String key, String value)
 Set property. More...
 
void setSize (Vector size)
 Set size of projection. More...
 
void setSkin (Skin skin)
 Set skin to use for create decals. More...
 
void setTransform (TexMatrix2 transform)
 Transform to set for created decals. More...
 
void setVisible (bool visible)
 Set if decal is visible after being created. More...
 
void setVisitor (ElementVisitor visitor)
 Set visitor to use to create the decals. More...
 
Notifications.

Detailed Description

Create decals based on a decal definition for each visited element using a visitor.

Member Function Documentation

§ canHitCollider()

bool canHitCollider ( Collider  owner,
Collider  collider 
)

Colliders can hit each other.

Implements ColliderListener.

§ colliderChanged()

void colliderChanged ( Collider  owner)

Collider changed which does not happen for this use of the listener.

Implements ColliderListener.

§ collisionResponse()

void collisionResponse ( Collider  owner,
CollisionInfo  info 
)

Collision detected.

Uses visitor on hit colliders. For height terrain calls hitHeightTerrain method.

Implements ColliderListener.

§ createDecals()

void createDecals ( World  world)

Create decals from stored decal definition for matching elements in the world.

§ getCollisionFilter()

CollisionFilter getCollisionFilter ( )

Collision filter limiting the elements to attach decals to.

§ getMatrix()

DMatrix getMatrix ( )

Projection matrix constructed from position and orientation.

§ getOrientation()

Quaternion getOrientation ( )

Orientation of projection.

§ getPosition()

DVector getPosition ( )

Position from to project.

§ getPropertyBoolFor()

bool getPropertyBoolFor ( String  key,
bool  default 
)

Boolean property value or default value if absent.

§ getPropertyCount()

int getPropertyCount ( )

Number of properties.

§ getPropertyFloatFor()

float getPropertyFloatFor ( String  key,
float  default 
)

Floating point property value or default value if absent.

§ getPropertyIntFor()

int getPropertyIntFor ( String  key,
int  default 
)

Integer property value or default value if absent.

§ getPropertyKeys()

Array getPropertyKeys ( )

Property keys (String array).

§ getPropertyValueFor()

String getPropertyValueFor ( String  key,
String  default 
)

Value of property or default value if absent.

§ getSize()

Vector getSize ( )

Size of projection.

§ getSkin()

Skin getSkin ( )

Skin to use for create decals.

§ getTransform()

TexMatrix2 getTransform ( )

Retrieves the texture coordinates transformation.

§ getVisible()

bool getVisible ( )

Decal is visible after being created.

§ getVisitor()

ElementVisitor getVisitor ( )

Visitor to use to create the decals.

§ hasPropertyWithKey()

bool hasPropertyWithKey ( String  key)

Property key is present.

§ new()

DecalBuilder new ( )

Create decal builder.

§ removeAllProperties()

void removeAllProperties ( )

Remove all properties.

§ setCollisionFilter()

void setCollisionFilter ( CollisionFilter  collisionFilter)

Set collision filter limiting the elements to attach decals to.

§ setPositionAndOrientation()

void setPositionAndOrientation ( DVector  position,
Quaternion  orientation 
)

Set projection position and orientation.

§ setPropertyValueFor()

void setPropertyValueFor ( String  key,
String  value 
)

Set property.

§ setSize()

void setSize ( Vector  size)

Set size of projection.

§ setSkin()

void setSkin ( Skin  skin)

Set skin to use for create decals.

§ setTransform()

void setTransform ( TexMatrix2  transform)

Transform to set for created decals.

§ setVisible()

void setVisible ( bool  visible)

Set if decal is visible after being created.

§ setVisitor()

void setVisitor ( ElementVisitor  visitor)

Set visitor to use to create the decals.


The documentation for this class was generated from the following file: