The HPS::TransparencyKit class is a user space object, useful for carrying a group of attribute settings related to transparency. More...

#include <hps.h>

Inheritance diagram for HPS::TransparencyKit:

[legend]

Collaboration diagram for HPS::TransparencyKit:

[legend]

Public Member Functions
	TransparencyKit ()
	Initializes an empty kit. More...

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

	TransparencyKit (TransparencyKit &&in_that)
	The move constructor creates a TransparencyKit by transferring the underlying impl of the rvalue reference to this TransparencyKit thereby avoiding a copy and allocation. More...

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

virtual	~TransparencyKit ()
	Destroy this kit. More...

HPS::Type	ObjectType () const

void	Set (TransparencyKit const &in_kit)
	Copies all settings from the source TransparencyKit into this object. More...

void	Show (TransparencyKit &out_kit) const
	Copies all settings from this TransparencyKit into the given TransparencyKit. More...

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

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

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

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

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

TransparencyKit &	SetMethod (Transparency::Method in_style)
	Sets the method to use when blending transparent geometry. More...

TransparencyKit &	SetAlgorithm (Transparency::Algorithm in_algorithm)
	Sets the algorithm to use when calculating transparency. More...

TransparencyKit &	SetDepthPeelingLayers (unsigned int in_layers)
	Sets the number of layers to use when performing depth peeling. More...

TransparencyKit &	SetDepthPeelingPreference (Transparency::Preference in_preference)
	Specifies whether quality or performance should be favored when performing depth peeling. More...

TransparencyKit &	SetDepthPeelingMinimumArea (float in_area, Transparency::AreaUnits in_units)
	Sets the amount of the screen a layer needs to occupy in order to process another layer when performing depth peeling. More...

TransparencyKit &	SetDepthWriting (bool in_state)
	Controls whether transparent geometry should write into the Z-buffer. More...

TransparencyKit &	UnsetMethod ()
	Removes the transparency method setting. More...

TransparencyKit &	UnsetAlgorithm ()
	Removes the transparency algorithm setting. More...

TransparencyKit &	UnsetDepthPeelingLayers ()
	Removes the depth peeling layers setting. More...

TransparencyKit &	UnsetDepthPeelingMinimumArea ()
	Removes the depth peeling minimum area setting. More...

TransparencyKit &	UnsetDepthWriting ()
	Removes the depth writing setting. More...

TransparencyKit &	UnsetDepthPeelingPreference ()
	Removes the depth peeling preference setting. More...

TransparencyKit &	UnsetEverything ()
	Removes all settings from this object. More...

bool	ShowMethod (Transparency::Method &out_style) const
	Shows the method to use when blending transparent geometry. More...

bool	ShowAlgorithm (Transparency::Algorithm &out_algorithm) const
	Shows the algorithm to use when calculating transparency. More...

bool	ShowDepthPeelingLayers (unsigned int &out_layers) const
	Shows the number of layers to use when performing depth peeling. More...

bool	ShowDepthPeelingMinimumArea (float &out_area, Transparency::AreaUnits &out_units) const
	Shows the amount of the screen a layer needs to occupy in order to process another layer when performing depth peeling. More...

bool	ShowDepthWriting (bool &out_state) const
	Shows whether transparent geometry should write into the Z-buffer. More...

bool	ShowDepthPeelingPreference (Transparency::Preference &out_preference) const
	Shows the depth peeling performance setting. 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 TransparencyKit	GetDefault ()
	Creates a TransparencyKit 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::TransparencyKit

Detailed Description

The HPS::TransparencyKit class is a user space object, useful for carrying a group of attribute settings related to transparency.

Calling HPS::TransparencyKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ TransparencyKit() [1/3]

HPS::TransparencyKit::TransparencyKit ( )

Initializes an empty kit.

◆ TransparencyKit() [2/3]

HPS::TransparencyKit::TransparencyKit ( TransparencyKit const & in_kit )

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

Parameters

in_kit The source object to copy.

◆ TransparencyKit() [3/3]

HPS::TransparencyKit::TransparencyKit ( TransparencyKit && in_that )

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

Parameters

in_that An rvalue reference to a TransparencyKit to take the impl from.

◆ ~TransparencyKit()

virtual HPS::TransparencyKit::~TransparencyKit ( )

virtual

Destroy this kit.

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::TransparencyKit::Empty ( ) const

virtual

Indicates whether this object has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::TransparencyKit::Equals ( TransparencyKit const & in_kit ) const

Check if the source TransparencyKit is equivalent to this object.

Parameters

in_kit The source TransparencyKit to compare to this object.

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 TransparencyKit HPS::TransparencyKit::GetDefault ( )

static

Creates a TransparencyKit 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 TransparencyKit 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::TransparencyKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::TransparencyKit::operator!= ( TransparencyKit const & in_kit ) const

Check if the source TransparencyKit is not equivalent to this object.

Parameters

in_kit The source TransparencyKit to compare to this object.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

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

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

Parameters

in_that An rvalue reference to an TransparencyKit to take the impl from.

Returns: A reference to this TransparencyKit.

◆ operator=() [2/2]

TransparencyKit& HPS::TransparencyKit::operator= ( TransparencyKit const & in_kit )

Copies the source TransparencyKit into this object.

Parameters

in_kit The source TransparencyKit to copy.

Returns: A reference to this object.

◆ operator==()

bool HPS::TransparencyKit::operator== ( TransparencyKit const & in_kit ) const

Check if the source TransparencyKit is equivalent to this object.

Parameters

in_kit The source TransparencyKit to compare to this object.

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::TransparencyKit::Set ( TransparencyKit const & in_kit )

Copies all settings from the source TransparencyKit into this object.

Parameters

in_kit The source TransparencyKit to copy.

◆ SetAlgorithm()

TransparencyKit& HPS::TransparencyKit::SetAlgorithm ( Transparency::Algorithm in_algorithm )

Sets the algorithm to use when calculating transparency.

Parameters

in_algorithm The algorithm to use.

Returns: a reference to this object.

◆ SetDepthPeelingLayers()

TransparencyKit& HPS::TransparencyKit::SetDepthPeelingLayers ( unsigned int in_layers )

Sets the number of layers to use when performing depth peeling.

Ignored in other transparency methods.

Warning: This setting will be limited by the depth peeling layer count set at the containing window / subwindow. If the count is lower than the containing window's count, excess render passes will be omitted.

Parameters

in_layers The number of layers to use when performing depth peeling.

Returns: a reference to this object.

◆ SetDepthPeelingMinimumArea()

TransparencyKit& HPS::TransparencyKit::SetDepthPeelingMinimumArea	(	float	in_area,
		Transparency::AreaUnits	in_units
	)

Sets the amount of the screen a layer needs to occupy in order to process another layer when performing depth peeling.

Ignored in other transparency methods.

Parameters

in_area	The amount of the screen a layer needs to occupy in order to process another layer.
in_units	The units of the minimum area.

Returns: a reference to this object.

◆ SetDepthPeelingPreference()

TransparencyKit& HPS::TransparencyKit::SetDepthPeelingPreference ( Transparency::Preference in_preference )

Specifies whether quality or performance should be favored when performing depth peeling.

Ignored in other transparency methods.

Parameters

in_perference The desired preference setting.

Returns: a reference to this object.

◆ SetDepthWriting()

TransparencyKit& HPS::TransparencyKit::SetDepthWriting ( bool in_state )

Controls whether transparent geometry should write into the Z-buffer.

Applies only when the transparency algorithm is NoSorting, ZSortNicest, or ZSortFastest.

Parameters

in_state Whether transparent geometry should write into the Z-buffer.

Returns: a reference to this object.

◆ SetMethod()

TransparencyKit& HPS::TransparencyKit::SetMethod ( Transparency::Method in_style )

Sets the method to use when blending transparent geometry.

Parameters

in_style The method to use when blending transparent geometry.

Returns: a reference to this object.

◆ Show()

void HPS::TransparencyKit::Show ( TransparencyKit & out_kit ) const

Copies all settings from this TransparencyKit into the given TransparencyKit.

Parameters

out_kit The TransparencyKit to populate with the contents of this object.

◆ ShowAlgorithm()

bool HPS::TransparencyKit::ShowAlgorithm ( Transparency::Algorithm & out_algorithm ) const

Shows the algorithm to use when calculating transparency.

Parameters

out_algorithm The algorithm to use.

Returns: true if the setting is valid, false otherwise.

◆ ShowDepthPeelingLayers()

bool HPS::TransparencyKit::ShowDepthPeelingLayers ( unsigned int & out_layers ) const

Shows the number of layers to use when performing depth peeling.

Parameters

out_layers The number of layers to use when performing depth peeling.

Returns: true if the setting is valid, false otherwise.

◆ ShowDepthPeelingMinimumArea()

bool HPS::TransparencyKit::ShowDepthPeelingMinimumArea	(	float &	out_area,
		Transparency::AreaUnits &	out_units
	)		const

Shows the amount of the screen a layer needs to occupy in order to process another layer when performing depth peeling.

Parameters

out_area	The amount of the screen a layer needs to occupy in order to process another layer.
out_units	The units of the minimum area.

Returns: true if the setting is valid, false otherwise.

◆ ShowDepthPeelingPreference()

bool HPS::TransparencyKit::ShowDepthPeelingPreference ( Transparency::Preference & out_preference ) const

Shows the depth peeling performance setting.

Parameters

out_preference Whether quality or performance should be favored when performing depth peeling.

Returns: true if the setting is valid, false otherwise.

◆ ShowDepthWriting()

bool HPS::TransparencyKit::ShowDepthWriting ( bool & out_state ) const

Shows whether transparent geometry should write into the Z-buffer.

Parameters

out_state Whether transparent geometry should write into the Z-buffer.

Returns: true if the setting is valid, false otherwise.

◆ ShowMethod()

bool HPS::TransparencyKit::ShowMethod ( Transparency::Method & out_style ) const

Shows the method to use when blending transparent geometry.

Parameters

out_style The method to use when blending transparent geometry.

Returns: true if the setting 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.

◆ UnsetAlgorithm()

TransparencyKit& HPS::TransparencyKit::UnsetAlgorithm ( )

Removes the transparency algorithm setting.

Returns: A reference to this object.

◆ UnsetDepthPeelingLayers()

TransparencyKit& HPS::TransparencyKit::UnsetDepthPeelingLayers ( )

Removes the depth peeling layers setting.

Returns: A reference to this object.

◆ UnsetDepthPeelingMinimumArea()

TransparencyKit& HPS::TransparencyKit::UnsetDepthPeelingMinimumArea ( )

Removes the depth peeling minimum area setting.

Returns: A reference to this object.

◆ UnsetDepthPeelingPreference()

TransparencyKit& HPS::TransparencyKit::UnsetDepthPeelingPreference ( )

Removes the depth peeling preference setting.

Returns: A reference to this object.

◆ UnsetDepthWriting()

TransparencyKit& HPS::TransparencyKit::UnsetDepthWriting ( )

Removes the depth writing setting.

Returns: A reference to this object.

◆ UnsetEverything()

TransparencyKit& HPS::TransparencyKit::UnsetEverything ( )

Removes all settings from this object.

Returns: A reference to this object.

◆ UnsetMethod()

TransparencyKit& HPS::TransparencyKit::UnsetMethod ( )

Removes the transparency method setting.

Returns: A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::TransparencyKit::staticType = HPS::Type::TransparencyKit

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

◆ TransparencyKit() [1/3]

◆ TransparencyKit() [2/3]

◆ TransparencyKit() [3/3]

◆ ~TransparencyKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetAlgorithm()

◆ SetDepthPeelingLayers()

◆ SetDepthPeelingMinimumArea()

◆ SetDepthPeelingPreference()

◆ SetDepthWriting()

◆ SetMethod()

◆ Show()

◆ ShowAlgorithm()

◆ ShowDepthPeelingLayers()

◆ ShowDepthPeelingMinimumArea()

◆ ShowDepthPeelingPreference()

◆ ShowDepthWriting()

◆ ShowMethod()

◆ Type()

◆ UnsetAlgorithm()

◆ UnsetDepthPeelingLayers()

◆ UnsetDepthPeelingMinimumArea()

◆ UnsetDepthPeelingPreference()

◆ UnsetDepthWriting()

◆ UnsetEverything()

◆ UnsetMethod()

Member Data Documentation

◆ staticType