CubeMapDefinition
-
class
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(CubeMapDefinition &&in_that) The move constructor creates a CubeMapDefinition by transferring the underlying impl of the rvalue reference to this CubeMapDefinition thereby avoiding a copy and allocation.
Parameters: in_that – An rvalue reference to a CubeMapDefinition to take the impl from.
-
CubeMapDefinition(CubeMapDefinition const &in_that) The copy constructor creates a CubeMapDefinition object that shares the underlying smart-pointer of the source CubeMapDefinition.
Parameters: in_that – The source CubeMapDefinition to copy.
-
CubeMapDefinition(Definition const &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.
Parameters: in_that – The source Definition to copy.
-
inline virtual HPS::Type
ObjectType() const 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).
Returns: The declared type of the object in question, which may differ from the true, underlying type.
-
CubeMapDefinition &
operator=(CubeMapDefinition &&in_that) The move assignment operator transfers the underlying impl of the rvalue reference to this CubeMapDefinition thereby avoiding a copy.
Parameters: in_that – An rvalue reference to a CubeMapDefinition to take the impl from. Returns: A reference to this CubeMapDefinition.
-
CubeMapDefinition &
operator=(CubeMapDefinition const &in_that) Associate this CubeMapDefinition with the same underlying impl as the source CubeMapDefinition.
Parameters: in_that – The source CubeMapDefinition for the assignment. Returns: A reference to this CubeMapDefinition.
-
void
SetOptions(TextureOptionsKit const &in_options) Redefine the texture options for this CubeMapDefinition.
Parameters: in_options – The new texture options for this CubeMapDefinition.
-
void
SetSource(ImageDefinition const &in_negative_z, ImageDefinition const &in_positive_z, ImageDefinition const &in_negative_x, ImageDefinition const &in_positive_x, ImageDefinition const &in_negative_y, ImageDefinition const &in_positive_y) Redefine the images for this CubeMapDefinition.
Parameters: - in_negative_z – The new image for the negative z-axis.
- in_positive_z – The new image for the positive z-axis.
- in_negative_x – The new image for the negative x-axis.
- in_positive_x – The new image for the positive x-axis.
- in_negative_y – The new image for the negative y-axis.
- in_positive_y – The new image for the positive y-axis.
-
void
ShowOptions(TextureOptionsKit &out_options) const Show the texture options for this CubeMapDefinition.
Parameters: out_options – The texture options for this CubeMapDefinition.
-
void
ShowSource(ImageDefinition &out_negative_z, ImageDefinition &out_positive_z, ImageDefinition &out_negative_x, ImageDefinition &out_positive_x, ImageDefinition &out_negative_y, ImageDefinition &out_positive_y) const Show the images for this CubeMapDefinition.
Parameters: - out_negative_z – The image for the negative z-axis.
- out_positive_z – The image for the positive z-axis.
- out_negative_x – The image for the negative x-axis.
- out_positive_x – The image for the positive x-axis.
- out_negative_y – The image for the negative y-axis.
- out_positive_y – The image for the positive y-axis.
-
void
ShowSource(ImageDefinitionArray &out_image_sources) const Show the images for this CubeMapDefinition.
Parameters: 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.
-
~CubeMapDefinition()
-
