Torque 3D - Script Manual: DecalRoad Class Reference

TorqueScript

Main   Class List   Namespace List   Online

DecalRoad Class Reference
[Terrain]

A strip shaped decal defined by spine nodes which clips against Terrain objects. More...

Inheritance diagram for DecalRoad:

List of all members.

Public Member Functions

void postApply ()
 Intended as a helper to developers and editor scripts.
void regenerate ()
 Intended as a helper to developers and editor scripts.

Public Attributes

DecalRoad

float breakAngle
 Angle in degrees - DecalRoad will subdivided the spline if its curve is greater than this threshold.
string Material
 Material used for rendering.
int renderPriority
 DecalRoad(s) are rendered in descending renderPriority order.
float textureLength
 The length in meters of textures mapped to the DecalRoad.
Internal

string Node
 Do not modify, for internal use.

Static Public Attributes

static bool discardAll
 For use by the Decal Editor.
static bool EditorOpen
 For use by the Decal Editor.
static bool isRenderable
 Disables rendering of all instances of this type.
static bool isSelectable
 Disables selection of all instances of this type.
static bool showBatches
 For use by the Decal Editor.
static bool showRoad
 For use by the Decal Editor.
static bool showSpline
 For use by the Decal Editor.
static int updateDelay
 For use by the Decal Editor.
static bool wireframe
 For use by the Decal Editor.

Detailed Description

A strip shaped decal defined by spine nodes which clips against Terrain objects.

DecalRoad is for representing a road or path ( or other inventive things ) across a TerrainBlock. It renders as a decal and is therefore only for features that do not need geometric depth.

The Material assigned to DecalRoad should tile vertically.


Member Function Documentation

void DecalRoad::postApply (  ) 

Intended as a helper to developers and editor scripts.

Force trigger an inspectPostApply. This will transmit the material and other fields ( not including nodes ) to client objects.

void DecalRoad::regenerate (  ) 

Intended as a helper to developers and editor scripts.

Force DecalRoad to update it's spline and reclip geometry.


Member Data Documentation

Angle in degrees - DecalRoad will subdivided the spline if its curve is greater than this threshold.

bool DecalRoad::discardAll [static]

For use by the Decal Editor.

bool DecalRoad::EditorOpen [static]

For use by the Decal Editor.

Material used for rendering.

Do not modify, for internal use.

DecalRoad(s) are rendered in descending renderPriority order.

bool DecalRoad::showBatches [static]

For use by the Decal Editor.

bool DecalRoad::showRoad [static]

For use by the Decal Editor.

bool DecalRoad::showSpline [static]

For use by the Decal Editor.

The length in meters of textures mapped to the DecalRoad.

int DecalRoad::updateDelay [static]

For use by the Decal Editor.

bool DecalRoad::wireframe [static]

For use by the Decal Editor.



Copyright © GarageGames, LLC. All Rights Reserved.