HPS::TextureDefinition Class Reference

#include <hps.h>

Inheritance diagram for HPS::TextureDefinition:
HPS::Definition HPS::Object

Public Member Functions

HPS::Type ObjectType () const
 
TextureDefinitionoperator= (TextureDefinition const &in_that)
 
TextureDefinitionoperator= (TextureDefinition &&in_that)
 
void SetOptions (TextureOptionsKit const &in_options)
 
void SetSource (ImageDefinition const &in_source)
 
void ShowOptions (TextureOptionsKit &out_options) const
 
bool ShowSource (ImageDefinition &out_source) const
 
bool ShowSource (UTF8 &out_source) const
 
 TextureDefinition ()
 
 TextureDefinition (Definition const &in_that)
 
 TextureDefinition (TextureDefinition const &in_that)
 
 TextureDefinition (TextureDefinition &&in_that)
 
- 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::TextureDefinition
 
- 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 TextureDefinition class is a smart pointer to a database object. It is a handler to a texture defined within a portfolio.

Constructor & Destructor Documentation

◆ TextureDefinition() [1/4]

HPS::TextureDefinition::TextureDefinition ( )

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

◆ TextureDefinition() [2/4]

HPS::TextureDefinition::TextureDefinition ( Definition const &  in_that)

This constructor creates a TextureDefinition 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 texture definition. Otherwise the copy will fail and the resulting TextureDefinition will be invalid.

Parameters
in_thatThe source Definition to copy.

◆ TextureDefinition() [3/4]

HPS::TextureDefinition::TextureDefinition ( TextureDefinition const &  in_that)

The copy constructor creates an TextureDefinition object that shares the underlying smart-pointer of the source TextureDefinition.

Parameters
in_thatThe source TextureDefinition to copy.

◆ TextureDefinition() [4/4]

HPS::TextureDefinition::TextureDefinition ( TextureDefinition &&  in_that)

The move constructor creates a TextureDefinition by transferring the underlying impl of the rvalue reference to this TextureDefinition thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a TextureDefinition to take the impl from.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::TextureDefinition::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]

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

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

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

◆ operator=() [2/2]

TextureDefinition& HPS::TextureDefinition::operator= ( TextureDefinition &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this TextureDefinition thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a TextureDefinition to take the impl from.
Returns
A reference to this TextureDefinition.

◆ SetOptions()

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

Redefine the texture options for this TextureDefinition.

Parameters
in_optionsThe new texture options for this TextureDefinition.

◆ SetSource()

void HPS::TextureDefinition::SetSource ( ImageDefinition const &  in_source)

Redefine the image for this TextureDefinition.

Parameters
in_sourceThe new image for this TextureDefinition.

◆ ShowOptions()

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

Show the texture options for this TextureDefinition.

Parameters
out_optionsThe texture options for this TextureDefinition.

◆ ShowSource() [1/2]

bool HPS::TextureDefinition::ShowSource ( ImageDefinition out_source) const

Show the image for this TextureDefinition.

Parameters
out_sourceThe image for this TextureDefinition.
Returns
true if an image definition was found in the same Portfolio as this TextureDefinition, false otherwise.

◆ ShowSource() [2/2]

bool HPS::TextureDefinition::ShowSource ( UTF8 out_source) const

Show the name of the source image for this TextureDefinition. If the source image for this TextureDefinition resides in a separate portfolio, users can use this method to retrieve the name of the source image, and use KeyPath::ShowEffectiveImageDefinition with the image name to retrieve the image definition.

Parameters
out_sourceThe name of the source image for this TextureDefinition.
Returns
true if able to retrieve the name of the source image, false otherwise.

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