#include <hps.h>

Inheritance diagram for HPS::TextureOptionsKit:

Collaboration diagram for HPS::TextureOptionsKit:

Public Member Functions
	TextureOptionsKit ()
	The default constructor creates an empty TextureOptionsKit object. More...

	TextureOptionsKit (TextureOptionsKit const &in_kit)
	The copy constructor creates a new TextureOptionsKit object that contains the same settings as the source TextureOptionsKit. More...

	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. More...

TextureOptionsKit &	operator= (TextureOptionsKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this TextureOptionsKit thereby avoiding a copy. More...

virtual	~TextureOptionsKit ()

HPS::Type	ObjectType () const

void	Set (TextureOptionsKit const &in_kit)
	Copies the source TextureOptionsKit into this TextureOptionsKit. More...

void	Show (TextureOptionsKit &out_kit) const
	Copies this TextureOptionsKit into the given TextureOptionsKit. More...

TextureOptionsKit &	operator= (TextureOptionsKit const &in_kit)
	Copies the source TextureOptionsKit into this TextureOptionsKit. More...

bool	Empty () const
	Indicates whether this TextureOptionsKit has any values set on it. More...

bool	Equals (TextureOptionsKit const &in_kit) const
	Check if the source TextureOptionsKit is equivalent to this TextureOptionsKit. More...

bool	operator== (TextureOptionsKit const &in_kit) const
	Check if the source TextureOptionsKit is equivalent to this TextureOptionsKit. More...

bool	operator!= (TextureOptionsKit const &in_kit) const
	Check if the source TextureOptionsKit is not equivalent to this TextureOptionsKit. More...

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. More...

TextureOptionsKit &	SetDownSampling (bool in_state)
	Sets whether the texture should be down-sampled. More...

TextureOptionsKit &	SetModulation (bool in_state)
	Sets whether the texture should be modulated with materials from layers below it. More...

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. More...

TextureOptionsKit &	SetParameterizationSource (Material::Texture::Parameterization in_source)
	Sets the parameterization source for the texture. More...

TextureOptionsKit &	SetTiling (Material::Texture::Tiling in_tiling)
	Sets how the texture will be tiled for parameters outside the range [0, 1]. More...

TextureOptionsKit &	SetInterpolationFilter (Material::Texture::Interpolation in_filter)
	Sets the interpolation filter to use for the texture. More...

TextureOptionsKit &	SetDecimationFilter (Material::Texture::Decimation in_filter)
	Sets the decimation filter to use for the texture. More...

TextureOptionsKit &	SetTransformMatrix (MatrixKit const &in_transform)
	Sets the transform matrix to use for the texture. More...

TextureOptionsKit &	UnsetDecal ()
	Removes whether the texture should act as a decal. More...

TextureOptionsKit &	UnsetDownSampling ()
	Removes whether to down-sample the texture. More...

TextureOptionsKit &	UnsetModulation ()
	Removes whether the texture should modulate with materials from layers below it. More...

TextureOptionsKit &	UnsetParameterOffset ()
	Removes the parameter offset for the texture. More...

TextureOptionsKit &	UnsetParameterizationSource ()
	Removes the parameter source for the texture. More...

TextureOptionsKit &	UnsetTiling ()
	Removes how the texture will be tiled for parameters outside the range [0, 1]. More...

TextureOptionsKit &	UnsetInterpolationFilter ()
	Removes the interpolation filter for the texture. More...

TextureOptionsKit &	UnsetDecimationFilter ()
	Removes the decimation filter for the texture. More...

TextureOptionsKit &	UnsetTransformMatrix ()
	Removes the transform matrix for the texture. More...

TextureOptionsKit &	UnsetEverything ()
	Removes all settings from this TextureOptionsKit. More...

bool	ShowDecal (bool &out_state) const
	Shows whether the texture should act as a decal. More...

bool	ShowDownSampling (bool &out_state) const
	Shows whether the texture should be down-sampled. More...

bool	ShowModulation (bool &out_state) const
	Shows whether the texture should be modulated with materials from layers below it. More...

bool	ShowParameterOffset (size_t &out_offset) const
	Shows the parameter offset for the texture. More...

bool	ShowParameterizationSource (Material::Texture::Parameterization &out_source) const
	Shows the parameterization source for the texture. More...

bool	ShowTiling (Material::Texture::Tiling &out_tiling) const
	Shows how the texture will be tiled for parameters outside the range [0, 1]. More...

bool	ShowInterpolationFilter (Material::Texture::Interpolation &out_filter) const
	Shows the interpolation filter for the texture. More...

bool	ShowDecimationFilter (Material::Texture::Decimation &out_filter) const
	Shows the decimation filter for the texture. More...

bool	ShowTransformMatrix (MatrixKit &out_transform) const
	Shows the transform matrix for the texture. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static TextureOptionsKit	GetDefault ()
	Creates a TextureOptionsKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::TextureOptionsKit

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.

◆ ~TextureOptionsKit()

virtual HPS::TextureOptionsKit::~TextureOptionsKit ( )

virtual

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ 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.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ 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.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::TextureOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ 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.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ 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.

◆ 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.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

◆ 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.

Member Data Documentation

◆ staticType

const HPS::Type HPS::TextureOptionsKit::staticType = HPS::Type::TextureOptionsKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TextureOptionsKit() [1/3]

◆ TextureOptionsKit() [2/3]

◆ TextureOptionsKit() [3/3]

◆ ~TextureOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetDecal()

◆ SetDecimationFilter()

◆ SetDownSampling()

◆ SetInterpolationFilter()

◆ SetModulation()

◆ SetParameterizationSource()

◆ SetParameterOffset()

◆ SetTiling()

◆ SetTransformMatrix()

◆ Show()

◆ ShowDecal()

◆ ShowDecimationFilter()

◆ ShowDownSampling()

◆ ShowInterpolationFilter()

◆ ShowModulation()

◆ ShowParameterizationSource()

◆ ShowParameterOffset()

◆ ShowTiling()

◆ ShowTransformMatrix()

◆ Type()

◆ UnsetDecal()

◆ UnsetDecimationFilter()

◆ UnsetDownSampling()

◆ UnsetEverything()

◆ UnsetInterpolationFilter()

◆ UnsetModulation()

◆ UnsetParameterizationSource()

◆ UnsetParameterOffset()

◆ UnsetTiling()

◆ UnsetTransformMatrix()

Member Data Documentation

◆ staticType