HPS::CubeMapDefinition Class Reference

#include <hps.h>

Inheritance diagram for HPS::CubeMapDefinition:
HPS::Definition HPS::Object

Public Member Functions

 CubeMapDefinition ()
 
 CubeMapDefinition (Definition const &in_that)
 
 CubeMapDefinition (CubeMapDefinition const &in_that)
 
 CubeMapDefinition (CubeMapDefinition &&in_that)
 
HPS::Type ObjectType () const
 
CubeMapDefinitionoperator= (CubeMapDefinition const &in_that)
 
CubeMapDefinitionoperator= (CubeMapDefinition &&in_that)
 
void SetOptions (TextureOptionsKit const &in_options)
 
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)
 
void ShowOptions (TextureOptionsKit &out_options) const
 
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
 
void ShowSource (ImageDefinitionArray &out_image_sources) const
 
- Public Member Functions inherited from HPS::Definition
virtual void Assign (Definition const &in_that)
 
 Definition ()
 
 Definition (Definition const &in_that)
 
 Definition (Definition &&in_that)
 
bool Equals (Definition const &in_that) const
 
UTF8 Name () const
 
bool operator!= (Definition const &in_that) const
 
Definitionoperator= (Definition const &in_that)
 
Definitionoperator= (Definition &&in_that)
 
bool operator== (Definition const &in_that) const
 
PortfolioKey Owner () const
 
void Undefine ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::CubeMapDefinition
 
- Static Public Attributes inherited from HPS::Definition
static const HPS::Type staticType = HPS::Type::Definition
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

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

Constructor & Destructor Documentation

◆ CubeMapDefinition() [1/4]

HPS::CubeMapDefinition::CubeMapDefinition ( )

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

◆ CubeMapDefinition() [2/4]

HPS::CubeMapDefinition::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_thatThe source Definition to copy.

◆ CubeMapDefinition() [3/4]

HPS::CubeMapDefinition::CubeMapDefinition ( CubeMapDefinition const &  in_that)

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

Parameters
in_thatThe source CubeMapDefinition to copy.

◆ CubeMapDefinition() [4/4]

HPS::CubeMapDefinition::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_thatAn rvalue reference to a CubeMapDefinition to take the impl from.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::CubeMapDefinition::ObjectType ( ) const
inlinevirtual

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.

Reimplemented from HPS::Definition.

◆ operator=() [1/2]

CubeMapDefinition& HPS::CubeMapDefinition::operator= ( CubeMapDefinition const &  in_that)

Associate this CubeMapDefinition with the same underlying impl as the source CubeMapDefinition.

Parameters
in_thatThe source CubeMapDefinition for the assignment.
Returns
A reference to this CubeMapDefinition.

◆ operator=() [2/2]

CubeMapDefinition& HPS::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_thatAn rvalue reference to a CubeMapDefinition to take the impl from.
Returns
A reference to this CubeMapDefinition.

◆ SetOptions()

void HPS::CubeMapDefinition::SetOptions ( TextureOptionsKit const &  in_options)

Redefine the texture options for this CubeMapDefinition.

Parameters
in_optionsThe new texture options for this CubeMapDefinition.

◆ SetSource()

void HPS::CubeMapDefinition::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_zThe new image for the negative z-axis.
in_positive_zThe new image for the positive z-axis.
in_negative_xThe new image for the negative x-axis.
in_positive_xThe new image for the positive x-axis.
in_negative_yThe new image for the negative y-axis.
in_positive_yThe new image for the positive y-axis.

◆ ShowOptions()

void HPS::CubeMapDefinition::ShowOptions ( TextureOptionsKit out_options) const

Show the texture options for this CubeMapDefinition.

Parameters
out_optionsThe texture options for this CubeMapDefinition.

◆ ShowSource() [1/2]

void HPS::CubeMapDefinition::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_zThe image for the negative z-axis.
out_positive_zThe image for the positive z-axis.
out_negative_xThe image for the negative x-axis.
out_positive_xThe image for the positive x-axis.
out_negative_yThe image for the negative y-axis.
out_positive_yThe image for the positive y-axis.

◆ ShowSource() [2/2]

void HPS::CubeMapDefinition::ShowSource ( ImageDefinitionArray out_image_sources) const

Show the images for this CubeMapDefinition.

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

The documentation for this class was generated from the following file: