TextureOptionsKit

class HPS::TextureOptionsKit : public HPS::Kit 

The TextureOptionsKit class is a user space object. It is used for setting texture options when defining textures or cube maps. Calling HPS::TextureOptionsKit::GetDefault() will return an options kit with values found in this table.

Public Functions

virtual bool Empty() const

Indicates whether this TextureOptionsKit has any values set on it.

Returns: true if no values are set on this TextureOptionsKit, false otherwise.

bool Equals(TextureOptionsKit const &in_kit) const

Check if the source TextureOptionsKit is equivalent to this TextureOptionsKit.

Parameters: in_kit – The source TextureOptionsKit to compare to this TextureOptionsKit.
Returns: true if the objects are equivalent, false otherwise.

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.

bool operator!=(TextureOptionsKit const &in_kit) const

Check if the source TextureOptionsKit is not equivalent to this TextureOptionsKit.

Parameters: in_kit – The source TextureOptionsKit to compare to this TextureOptionsKit.
Returns: true if the objects are not equivalent, false otherwise.

TextureOptionsKit &operator=(TextureOptionsKit &&in_that)

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

Parameters: in_that – An rvalue reference to a TextureOptionsKit to take the impl from.
Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &operator=(TextureOptionsKit const &in_kit)

Copies the source TextureOptionsKit into this TextureOptionsKit.

Parameters: in_kit – The source TextureOptionsKit to copy.
Returns: A reference to this TextureOptionsKit.

bool operator==(TextureOptionsKit const &in_kit) const

Check if the source TextureOptionsKit is equivalent to this TextureOptionsKit.

Parameters: in_kit – The source TextureOptionsKit to compare to this TextureOptionsKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(TextureOptionsKit const &in_kit)

Copies the source TextureOptionsKit into this TextureOptionsKit.

Parameters: in_kit – The source TextureOptionsKit to copy.

TextureOptionsKit &SetDecal(bool in_state)

Sets whether the texture should act as a decal, i.e., whether diffuse colors will be allowed through transparent portions of a diffuse texture. This only affects a diffuse texture on layer 0.

Parameters: in_state – Whether the texture should act as a decal.
Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &SetDecimationFilter(Material::Texture::Decimation in_filter)

Sets the decimation filter to use for the texture.

Parameters: in_filter – The decimation filter to use for the texture.
Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &SetDownSampling(bool in_state)

Sets whether the texture should be down-sampled.

Parameters: in_state – Whether the texture should be down-sampled.
Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &SetInterpolationFilter(Material::Texture::Interpolation in_filter)

Sets the interpolation filter to use for the texture.

Parameters: in_filter – The interpolation filter to use for the texture.
Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &SetModulation(bool in_state)

Sets whether the texture should be modulated with materials from layers below it. This only applies to diffuse textures.

Parameters: in_state – Whether the texture should be modulated with materials from layers below it.
Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &SetParameterizationSource(Material::Texture::Parameterization in_source)

Sets the parameterization source for the texture.

Parameters: in_source – The parameterization source for the texture.
Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &SetParameterOffset(size_t in_offset)

Sets the parameter offset for the texture, i.e., the offset into the texture parameter list to use at each vertex to locate the parameters for the texture.

Parameters: in_offset – The parameter offset for the texture.
Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &SetTiling(Material::Texture::Tiling in_tiling)

Sets how the texture will be tiled for parameters outside the range [0, 1].

Parameters: in_tiling – How the texture will be tiled for parameters outside the range [0, 1].
Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &SetTransformMatrix(MatrixKit const &in_transform)

Sets the transform matrix to use for the texture.

Parameters: in_transform – The transform matrix to use for the texture.
Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &SetValueScale(float in_min, float in_max)

Sets the value scaling (linear remapping) of texture element values.

Parameters

in_min – The value to which zero will be remapped.
in_max – The value to which one will be remapped.

Returns

A reference to this TextureOptionsKit.

void Show(TextureOptionsKit &out_kit) const

Copies this TextureOptionsKit into the given TextureOptionsKit.

Parameters: out_kit – The TextureOptionsKit to populate with the contents of this TextureOptionsKit.

bool ShowDecal(bool &out_state) const

Shows whether the texture should act as a decal.

Parameters: out_state – Whether the texture should act as a decal.
Returns: true if the flag is valid, false otherwise.

bool ShowDecimationFilter(Material::Texture::Decimation &out_filter) const

Shows the decimation filter for the texture.

Parameters: out_filter – The decimation filter for the texture.
Returns: true if the filter is valid, false otherwise.

bool ShowDownSampling(bool &out_state) const

Shows whether the texture should be down-sampled.

Parameters: out_state – Whether the texture should be down-sampled.
Returns: true if the flag is valid, false otherwise.

bool ShowInterpolationFilter(Material::Texture::Interpolation &out_filter) const

Shows the interpolation filter for the texture.

Parameters: out_filter – The interpolation filter for the texture.
Returns: true if the filter is valid, false otherwise.

bool ShowModulation(bool &out_state) const

Shows whether the texture should be modulated with materials from layers below it.

Parameters: out_state – Whether the texture should be be modulated with materials from layers below it.
Returns: true if the flag is valid, false otherwise.

bool ShowParameterizationSource(Material::Texture::Parameterization &out_source) const

Shows the parameterization source for the texture.

Parameters: out_source – The parametererization source for the texture.
Returns: true if the parameterization source is valid, false otherwise.

bool ShowParameterOffset(size_t &out_offset) const

Shows the parameter offset for the texture.

Parameters: out_offset – The parameter offset for the texture.
Returns: true if the offset is valid, false otherwise.

bool ShowTiling(Material::Texture::Tiling &out_tiling) const

Shows how the texture will be tiled for parameters outside the range [0, 1].

Parameters: out_tiling – How the texture will be tiled for parameters outside the range [0, 1].
Returns: true if the tiling is valid, false otherwise.

bool ShowTransformMatrix(MatrixKit &out_transform) const

Shows the transform matrix for the texture.

Parameters: out_transform – The transform matrix for the texture.
Returns: true if the transform matrix is valid, false otherwise.

bool ShowValueScale(float &out_min, float &out_max) const

Shows the value scale for the texture.

Parameters

out_min – The value to which zero will be remapped.
out_max – The value to which one will be remapped.

Returns

true if the filter is valid, false otherwise.

TextureOptionsKit(): The default constructor creates an empty TextureOptionsKit object.

TextureOptionsKit(TextureOptionsKit &&in_that)

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

Parameters: in_that – An rvalue reference to a TextureOptionsKit to take the impl from.

TextureOptionsKit(TextureOptionsKit const &in_kit)

The copy constructor creates a new TextureOptionsKit object that contains the same settings as the source TextureOptionsKit.

Parameters: in_kit – The source TextureOptionsKit to copy.

TextureOptionsKit &UnsetDecal()

Removes whether the texture should act as a decal.

Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &UnsetDecimationFilter()

Removes the decimation filter for the texture.

Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &UnsetDownSampling()

Removes whether to down-sample the texture.

Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &UnsetEverything()

Removes all settings from this TextureOptionsKit.

Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &UnsetInterpolationFilter()

Removes the interpolation filter for the texture.

Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &UnsetModulation()

Removes whether the texture should modulate with materials from layers below it.

Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &UnsetParameterizationSource()

Removes the parameter source for the texture.

Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &UnsetParameterOffset()

Removes the parameter offset for the texture.

Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &UnsetTiling()

Removes how the texture will be tiled for parameters outside the range [0, 1].

Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &UnsetTransformMatrix()

Removes the transform matrix for the texture.

Returns: A reference to this TextureOptionsKit.

TextureOptionsKit &UnsetValueScale()

Removes the value scale for the texture.

Returns: A reference to this TextureOptionsKit.

virtual ~TextureOptionsKit()

Public Static Functions

static TextureOptionsKit GetDefault()

Creates a TextureOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Returns: A TextureOptionsKit with the default settings.

Public Static Attributes

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