Torque 3D - Script Manual: GroundPlane Class Reference

TorqueScript

Main   Class List   Namespace List   Online

GroundPlane Class Reference
[Terrain]

An infinite plane extending in all direction. More...

Inheritance diagram for GroundPlane:

List of all members.

Public Member Functions

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

Public Attributes

Plane

string Material
 Name of Material used to render GroundPlane's surface.
float scaleU
 Scale of texture repeat in the U direction.
float scaleV
 Scale of texture repeat in the V direction.
float squareSize
 Square size in meters to which GroundPlane subdivides its geometry.

Static Public Attributes

static bool isRenderable
 Disables rendering of all instances of this type.
static bool isSelectable
 Disables selection of all instances of this type.

Detailed Description

An infinite plane extending in all direction.

GroundPlane is useful for setting up simple testing scenes, or it can be placed under an existing scene to keep objects from falling into 'nothing'.

GroundPlane may not be moved or rotated, it is always at the world origin.


Member Function Documentation

void GroundPlane::postApply (  ) 

Intended as a helper to developers and editor scripts.

Force trigger an inspectPostApply. This will transmit material and other fields to client objects.


Member Data Documentation

Name of Material used to render GroundPlane's surface.

Scale of texture repeat in the U direction.

Scale of texture repeat in the V direction.

Square size in meters to which GroundPlane subdivides its geometry.



Copyright © GarageGames, LLC. All Rights Reserved.