CubemapData

Inheritance diagram for CubemapData ↕

Used to create static or dynamic cubemaps.

Public Attributes

filename

cubeFace [6]

The 6 cubemap face textures for a static cubemap.

filename

cubemap

Cubemap dds file.

Public Functions

string

getFilename()

Returns the script filename of where the CubemapData object was defined. This is used by the material editor.

void

save(string filename, GFXFormat format)

Returns the script filename of where the CubemapData object was defined. This is used by the material editor.

void

updateFaces()

Update the assigned cubemaps faces.

Detailed Description

Used to create static or dynamic cubemaps.

This object is used with Material, WaterObject, and other objects for cubemap reflections.

A simple declaration of a static cubemap:

singleton CubemapData( SkyboxCubemap )
{
   cubeFace[0] = "./skybox_1";
   cubeFace[1] = "./skybox_2";
   cubeFace[2] = "./skybox_3";
   cubeFace[3] = "./skybox_4";
   cubeFace[4] = "./skybox_5";
   cubeFace[5] = "./skybox_6";
};

note:
The dynamic cubemap functionality in CubemapData has been depreciated in favor of ReflectorDesc.

see:

ReflectorDesc

Public Attributes

filename cubeFace [6]

The 6 cubemap face textures for a static cubemap.

They are in the following order:

cubeFace[0] is -X
cubeFace[1] is +X
cubeFace[2] is -Z
cubeFace[3] is +Z
cubeFace[4] is -Y
cubeFace[5] is +Y

filename cubemap

Cubemap dds file.

Public Functions

getFilename()

Returns the script filename of where the CubemapData object was defined. This is used by the material editor.

save(string filename, GFXFormat format)

Returns the script filename of where the CubemapData object was defined. This is used by the material editor.

updateFaces()

Update the assigned cubemaps faces.