TextureDefinition

class HPS::TextureDefinition : public HPS::Definition 

The TextureDefinition class is a smart pointer to a database object. It is a handler to a texture defined within a portfolio.

Public Functions

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.

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_that – An rvalue reference to a TextureDefinition to take the impl from.
Returns: A reference to this TextureDefinition.

TextureDefinition &operator=(TextureDefinition const &in_that)

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

Parameters: in_that – The source TextureDefinition for the assignment.
Returns: A reference to this TextureDefinition.

void SetOptions(TextureOptionsKit const &in_options)

Redefine the texture options for this TextureDefinition.

Parameters: in_options – The new texture options for this TextureDefinition.

void SetSource(ImageDefinition const &in_source)

Redefine the image for this TextureDefinition.

Parameters: in_source – The new image for this TextureDefinition.

void ShowOptions(TextureOptionsKit &out_options) const

Show the texture options for this TextureDefinition.

Parameters: out_options – The texture options for this TextureDefinition.

bool ShowSource(ImageDefinition &out_source) const

Show the image for this TextureDefinition.

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

bool 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_source – The name of the source image for this TextureDefinition.
Returns: true if able to retrieve the name of the source image, false otherwise.

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

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_that – The source Definition to copy.

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_that – An rvalue reference to a TextureDefinition to take the impl from.

TextureDefinition(TextureDefinition const &in_that)

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

Parameters: in_that – The source TextureDefinition to copy.

~TextureDefinition()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::TextureDefinition