CubemapData Class Reference
[GFX]

Used to create static or dynamic cubemaps. More...

Inheritance diagram for CubemapData:

[legend]

List of all members.

Public Member Functions
string	getFilename ()
	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.
Public Attributes
filename	cubeFace [6]
	The 6 cubemap face textures for a static cubemap.
bool	dynamic
	Set to true if this is a dynamic cubemap. The default is false.
float	dynamicFarDist
	The far clip distance used when rendering to the dynamic cubemap.
float	dynamicNearDist
	The near clip distance used when rendering to the dynamic cubemap.
int	dynamicObjectTypeMask
	The typemask used to filter the objects rendered to the dynamic cubemap.
int	dynamicSize
	The size of each dynamic cubemap face in pixels.

---

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:

Example:

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 also:

ReflectorDesc

---

Member Function Documentation

string CubemapData::getFilename

(

)

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

Reimplemented from SimObject.

void CubemapData::updateFaces

(

)

Update the assigned cubemaps faces.

---

Member Data Documentation

filename CubemapData::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

bool CubemapData::dynamic

Set to true if this is a dynamic cubemap. The default is false.

float CubemapData::dynamicFarDist

The far clip distance used when rendering to the dynamic cubemap.

float CubemapData::dynamicNearDist

The near clip distance used when rendering to the dynamic cubemap.

int CubemapData::dynamicObjectTypeMask

The typemask used to filter the objects rendered to the dynamic cubemap.

int CubemapData::dynamicSize

The size of each dynamic cubemap face in pixels.