CubeMapDefinition

class HPS.CubeMapDefinition : public HPS.Definition

The CubeMapDefinition class is a smart pointer to a database object. It is a handle to a cube map defined within a portfolio.

Public Functions

CubeMapDefinition ()

The default constructor creates an uninitialized CubeMapDefinition object. The Type() function will return Type.None.

CubeMapDefinition (HPS.CubeMapDefinition in_that)

The copy constructor creates a CubeMapDefinition object that shares the underlying smart-pointer of the source CubeMapDefinition.

Param in_that

The source CubeMapDefinition to copy.

CubeMapDefinition (HPS.Definition in_that)

This constructor creates a CubeMapDefinition object that shares the underlying smart-pointer of the source Definition. The copy will only be successful if the source definition is really an upcast of a cube map definition. Otherwise the copy will fail and the resulting CubeMapDefinition will be invalid.

Param in_that

The source Definition to copy.

override void Dispose ()

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return

The declared type of the object in question, which may differ from the true, underlying type.

void SetOptions (HPS.TextureOptionsKit in_options)

Redefine the texture options for this CubeMapDefinition.

Param in_options

The new texture options for this CubeMapDefinition.

void SetSource (HPS.ImageDefinition in_negative_z, HPS.ImageDefinition in_positive_z, HPS.ImageDefinition in_negative_x, HPS.ImageDefinition in_positive_x, HPS.ImageDefinition in_negative_y, HPS.ImageDefinition in_positive_y)

Redefine the images for this CubeMapDefinition.

Param in_negative_z

The new image for the negative z-axis.

Param in_positive_z

The new image for the positive z-axis.

Param in_negative_x

The new image for the negative x-axis.

Param in_positive_x

The new image for the positive x-axis.

Param in_negative_y

The new image for the negative y-axis.

Param in_positive_y

The new image for the positive y-axis.

void ShowOptions (out HPS.TextureOptionsKit out_options)

Show the texture options for this CubeMapDefinition.

Param out_options

The texture options for this CubeMapDefinition.

void ShowSource (out HPS.ImageDefinition out_negative_z, out HPS.ImageDefinition out_positive_z, out HPS.ImageDefinition out_negative_x, out HPS.ImageDefinition out_positive_x, out HPS.ImageDefinition out_negative_y, out HPS.ImageDefinition out_positive_y)

Show the images for this CubeMapDefinition.

Param out_negative_z

The image for the negative z-axis.

Param out_positive_z

The image for the positive z-axis.

Param out_negative_x

The image for the negative x-axis.

Param out_positive_x

The image for the positive x-axis.

Param out_negative_y

The image for the negative y-axis.

Param out_positive_y

The image for the positive y-axis.

void ShowSource (out HPS.ImageDefinition[] out_image_sources)

Show the images for this CubeMapDefinition.

Param out_image_sources

The source images packed as: negative z-axis, positive z-axis, negative x-axis, positive x-axis, negative y-axis, positive y-axis.