HPS::TextureOptionsKit Class Reference

#include <hps.h>

Inheritance diagram for HPS::TextureOptionsKit:

Public Member Functions
bool	Empty () const
bool	Equals (TextureOptionsKit const &in_kit) const
HPS::Type	ObjectType () const
bool	operator!= (TextureOptionsKit const &in_kit) const
TextureOptionsKit &	operator= (TextureOptionsKit &&in_that)
TextureOptionsKit &	operator= (TextureOptionsKit const &in_kit)
bool	operator== (TextureOptionsKit const &in_kit) const
void	Set (TextureOptionsKit const &in_kit)
TextureOptionsKit &	SetDecal (bool in_state)
TextureOptionsKit &	SetDecimationFilter (Material::Texture::Decimation in_filter)
TextureOptionsKit &	SetDownSampling (bool in_state)
TextureOptionsKit &	SetInterpolationFilter (Material::Texture::Interpolation in_filter)
TextureOptionsKit &	SetModulation (bool in_state)
TextureOptionsKit &	SetParameterizationSource (Material::Texture::Parameterization in_source)
TextureOptionsKit &	SetParameterOffset (size_t in_offset)
TextureOptionsKit &	SetTiling (Material::Texture::Tiling in_tiling)
TextureOptionsKit &	SetTransformMatrix (MatrixKit const &in_transform)
TextureOptionsKit &	SetValueScale (float in_min, float in_max)
void	Show (TextureOptionsKit &out_kit) const
bool	ShowDecal (bool &out_state) const
bool	ShowDecimationFilter (Material::Texture::Decimation &out_filter) const
bool	ShowDownSampling (bool &out_state) const
bool	ShowInterpolationFilter (Material::Texture::Interpolation &out_filter) const
bool	ShowModulation (bool &out_state) const
bool	ShowParameterizationSource (Material::Texture::Parameterization &out_source) const
bool	ShowParameterOffset (size_t &out_offset) const
bool	ShowTiling (Material::Texture::Tiling &out_tiling) const
bool	ShowTransformMatrix (MatrixKit &out_transform) const
bool	ShowValueScale (float &out_min, float &out_max) const
	TextureOptionsKit ()
	TextureOptionsKit (TextureOptionsKit const &in_kit)
	TextureOptionsKit (TextureOptionsKit &&in_that)
TextureOptionsKit &	UnsetDecal ()
TextureOptionsKit &	UnsetDecimationFilter ()
TextureOptionsKit &	UnsetDownSampling ()
TextureOptionsKit &	UnsetEverything ()
TextureOptionsKit &	UnsetInterpolationFilter ()
TextureOptionsKit &	UnsetModulation ()
TextureOptionsKit &	UnsetParameterizationSource ()
TextureOptionsKit &	UnsetParameterOffset ()
TextureOptionsKit &	UnsetTiling ()
TextureOptionsKit &	UnsetTransformMatrix ()
TextureOptionsKit &	UnsetValueScale ()
Public Member Functions inherited from HPS::Kit
virtual HPS::Type	Type () const
Public Member Functions inherited from HPS::Object
intptr_t	GetClassID () const
intptr_t	GetInstanceID () const
bool	HasType (HPS::Type in_mask) const
	Object (Object const &that)
	Object (Object &&in_that)
Object &	operator= (Object const &other_object)
Object &	operator= (Object &&in_that)
virtual void	Reset ()

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

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::TextureOptionsKit
Static Public Attributes inherited from HPS::Kit
static const HPS::Type	staticType = HPS::Type::Kit
Static Public Attributes inherited from HPS::Object
static const HPS::Type	staticType = HPS::Type::None

Additional Inherited Members
Protected Member Functions inherited from HPS::Kit
	Kit (Kit &&in_that)
Kit &	operator= (Kit &&in_that)

Detailed Description

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.

Constructor & Destructor Documentation

TextureOptionsKit() [1/3]

HPS::TextureOptionsKit::TextureOptionsKit

(

)

The default constructor creates an empty TextureOptionsKit object.

TextureOptionsKit() [2/3]

HPS::TextureOptionsKit::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() [3/3]

HPS::TextureOptionsKit::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.

Member Function Documentation

Empty()

bool HPS::TextureOptionsKit::Empty ( ) const

virtual

Indicates whether this TextureOptionsKit has any values set on it.

Returns

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

Reimplemented from HPS::Object.

Equals()

bool HPS::TextureOptionsKit::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.

GetDefault()

static TextureOptionsKit HPS::TextureOptionsKit::GetDefault ( )

static

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.

ObjectType()

HPS::Type HPS::TextureOptionsKit::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::Kit.

operator!=()

bool HPS::TextureOptionsKit::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.

operator=() [1/2]

TextureOptionsKit& HPS::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.

operator=() [2/2]

TextureOptionsKit& HPS::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.

operator==()

bool HPS::TextureOptionsKit::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.

Set()

void HPS::TextureOptionsKit::Set

(

TextureOptionsKit const &

in_kit

)

Copies the source TextureOptionsKit into this TextureOptionsKit.

Parameters

in_kit

The source TextureOptionsKit to copy.

SetDecal()

TextureOptionsKit& HPS::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.

SetDecimationFilter()

TextureOptionsKit& HPS::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.

SetDownSampling()

TextureOptionsKit& HPS::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.

SetInterpolationFilter()

TextureOptionsKit& HPS::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.

SetModulation()

TextureOptionsKit& HPS::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.

SetParameterizationSource()

TextureOptionsKit& HPS::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.

SetParameterOffset()

TextureOptionsKit& HPS::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.

SetTiling()

TextureOptionsKit& HPS::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.

SetTransformMatrix()

TextureOptionsKit& HPS::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.

SetValueScale()

TextureOptionsKit& HPS::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.

Show()

void HPS::TextureOptionsKit::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.

ShowDecal()

bool HPS::TextureOptionsKit::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.

ShowDecimationFilter()

bool HPS::TextureOptionsKit::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.

ShowDownSampling()

bool HPS::TextureOptionsKit::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.

ShowInterpolationFilter()

bool HPS::TextureOptionsKit::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.

ShowModulation()

bool HPS::TextureOptionsKit::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.

ShowParameterizationSource()

bool HPS::TextureOptionsKit::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.

ShowParameterOffset()

bool HPS::TextureOptionsKit::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.

ShowTiling()

bool HPS::TextureOptionsKit::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.

ShowTransformMatrix()

bool HPS::TextureOptionsKit::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.

ShowValueScale()

bool HPS::TextureOptionsKit::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.

UnsetDecal()

TextureOptionsKit& HPS::TextureOptionsKit::UnsetDecal

(

)

Removes whether the texture should act as a decal.

Returns

A reference to this TextureOptionsKit.

UnsetDecimationFilter()

TextureOptionsKit& HPS::TextureOptionsKit::UnsetDecimationFilter

(

)

Removes the decimation filter for the texture.

Returns

A reference to this TextureOptionsKit.

UnsetDownSampling()

TextureOptionsKit& HPS::TextureOptionsKit::UnsetDownSampling

(

)

Removes whether to down-sample the texture.

Returns

A reference to this TextureOptionsKit.

UnsetEverything()

TextureOptionsKit& HPS::TextureOptionsKit::UnsetEverything

(

)

Removes all settings from this TextureOptionsKit.

Returns

A reference to this TextureOptionsKit.

UnsetInterpolationFilter()

TextureOptionsKit& HPS::TextureOptionsKit::UnsetInterpolationFilter

(

)

Removes the interpolation filter for the texture.

Returns

A reference to this TextureOptionsKit.

UnsetModulation()

TextureOptionsKit& HPS::TextureOptionsKit::UnsetModulation

(

)

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

Returns

A reference to this TextureOptionsKit.

UnsetParameterizationSource()

TextureOptionsKit& HPS::TextureOptionsKit::UnsetParameterizationSource

(

)

Removes the parameter source for the texture.

Returns

A reference to this TextureOptionsKit.

UnsetParameterOffset()

TextureOptionsKit& HPS::TextureOptionsKit::UnsetParameterOffset

(

)

Removes the parameter offset for the texture.

Returns

A reference to this TextureOptionsKit.

UnsetTiling()

TextureOptionsKit& HPS::TextureOptionsKit::UnsetTiling

(

)

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

Returns

A reference to this TextureOptionsKit.

UnsetTransformMatrix()

TextureOptionsKit& HPS::TextureOptionsKit::UnsetTransformMatrix

(

)

Removes the transform matrix for the texture.

Returns

A reference to this TextureOptionsKit.

UnsetValueScale()

TextureOptionsKit& HPS::TextureOptionsKit::UnsetValueScale

(

)

Removes the value scale for the texture.

Returns

A reference to this TextureOptionsKit.

---

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

• include/hps.h