Torque3D Documentation / _generateds / ReflectionProbe

ReflectionProbe

consoledoc.h

An example scene object which renders a mesh.

More...

Rendering

bool

Is the probe enabled or not.

Reflection

float

The name of the material used to render the mesh.

bool

Toggle Edit Pos Offset Mode.

Point3F

The reference positional offset for the probe. This is used for adjusting the perceived center and area of influence.

Point3F

The reference scale for the probe. This is used for adjusting the perceived center and area of influence.

Used to dictate what sort of cubemap the probes use when using IBL.

string

This is used when a static cubemap is used. The name of the cubemap is looked up and loaded for the IBL calculations.

bool

Bake Probe Reflections.

Public Static Attributes

bool

Disables rendering of all instances of this type.

bool

Disables selection of all instances of this type.

Public Functions

void
Bake()

Bakes the cubemaps for a reflection probe.

void

A utility method for forcing a network update.

Detailed Description

An example scene object which renders a mesh.

This class implements a basic SceneObject that can exist in the world at a 3D position and render itself. There are several valid ways to render an object in Torque. This class implements the preferred rendering method which is to submit a MeshRenderInst along with a Material, vertex buffer, primitive buffer, and transform and allow the RenderMeshMgr handle the actual setup and rendering for you.

See the C++ code for implementation details.

Rendering

bool Enabled 

Is the probe enabled or not.

Reflection

float radius 

The name of the material used to render the mesh.

bool EditPosOffset 

Toggle Edit Pos Offset Mode.

Point3F refOffset 

The reference positional offset for the probe. This is used for adjusting the perceived center and area of influence.

Helpful in adjusting parallax issues

Point3F refScale 

The reference scale for the probe. This is used for adjusting the perceived center and area of influence.

Helpful in adjusting parallax issues

ReflectionModeEnum ReflectionMode 

Used to dictate what sort of cubemap the probes use when using IBL.

string StaticCubemap 

This is used when a static cubemap is used. The name of the cubemap is looked up and loaded for the IBL calculations.

bool Bake 

Bake Probe Reflections.

Public Static Attributes

bool isRenderable 

Disables rendering of all instances of this type.

bool isSelectable 

Disables selection of all instances of this type.

Public Functions

Bake()

Bakes the cubemaps for a reflection probe.

postApply()

A utility method for forcing a network update.