Torque 3D - Script Manual: ReflectorDesc Class Reference

TorqueScript

Main   Class List   Namespace List   Online

ReflectorDesc Class Reference
[Miscellaneous]

A datablock which defines performance and quality properties for dynamic reflections. More...

Inheritance diagram for ReflectorDesc:

List of all members.

Public Attributes

ReflectorDesc

float detailAdjust
 Scale applied to lod calculation of objects rendering into this reflection ( modulates $pref::TS::detailAdjust ).
float farDist
 Far plane distance to use when rendering reflections.
int maxRateMs
 If less than maxRateMs has elapsed since this relfection was last updated, then do not update it again. This 'skip' can be disabled by setting maxRateMs to zero.
float nearDist
 Near plane distance to use when rendering this reflection. Adjust this to limit self-occlusion artifacts.
int objectTypeMask
 Object types which render into this reflection.
float priority
 Priority for updating this reflection, relative to others.
int texSize
 Size in pixels of the (square) reflection texture. For a cubemap this value is interpreted as size of each face.
bool useOcclusionQuery
 If available on the device use HOQs to determine if the reflective object is visible before updating its reflection.

Detailed Description

A datablock which defines performance and quality properties for dynamic reflections.

ReflectorDesc is not itself a reflection and does not render reflections. It is a dummy class for holding and exposing to the user a set of reflection related properties. Objects which support dynamic reflections may then reference a ReflectorDesc.

Example:
datablock ReflectorDesc( ExampleReflectorDesc )
{
   texSize = 256;
   nearDist = 0.1;
   farDist = 500;
   objectTypeMask = 0xFFFFFFFF;
   detailAdjust = 1.0;
   priority = 1.0;
   maxRateMs = 0;
   useOcclusionQuery = true;
};
See also:
ShapeBaseData::cubeReflectorDesc

Member Data Documentation

Scale applied to lod calculation of objects rendering into this reflection ( modulates $pref::TS::detailAdjust ).

Far plane distance to use when rendering reflections.

If less than maxRateMs has elapsed since this relfection was last updated, then do not update it again. This 'skip' can be disabled by setting maxRateMs to zero.

Near plane distance to use when rendering this reflection. Adjust this to limit self-occlusion artifacts.

Object types which render into this reflection.

Priority for updating this reflection, relative to others.

Size in pixels of the (square) reflection texture. For a cubemap this value is interpreted as size of each face.

If available on the device use HOQs to determine if the reflective object is visible before updating its reflection.



Copyright © GarageGames, LLC. All Rights Reserved.