TransparencyControl

class HPS::TransparencyControl : public HPS::Control

The HPS::TransparencyControl class is a smart pointer that is tied to a database object. This object allows you to set and unset the algorithms used for calculating transparency. Some algorithms, such as depth peeling, have additional attributes, and those are also controlled using this class.

Default values for the various fields of HPS::TransparencyControl can be found here.

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.

TransparencyControl &operator=(TransparencyControl &&in_that)

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

Parameters

in_that – An rvalue reference to a TransparencyControl to take the impl from.

Returns

A reference to this TransparencyControl.

TransparencyControl &operator=(TransparencyControl const &in_that)

Share the underlying smart-pointer of the TransparencyControl source.

Parameters

in_that – The TransparencyControl source of the assignment.

Returns

A reference to this TransparencyControl.

TransparencyControl &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.

TransparencyControl &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.

TransparencyControl &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.

TransparencyControl &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.

TransparencyControl &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.

TransparencyControl &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.

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

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

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.

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.

bool ShowDepthPeelingPreference(Transparency::Preference &out_preference) const

Shows the depth peeling preference.

Parameters

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

Returns

true if the setting is valid, false otherwise.

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

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

explicit TransparencyControl(SegmentKey &in_seg)

Initializes a control tied to the segment in_seg.

TransparencyControl(TransparencyControl &&in_that)

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

Parameters

in_that – An rvalue reference to a TransparencyControl to take the impl from.

TransparencyControl(TransparencyControl const &in_that)

Initializes a control tied to the same object as in_that.

TransparencyControl &UnsetAlgorithm()

Removes the transparency algorithm setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransparencyKit::GetDefault().

Returns

A reference to this object.

TransparencyControl &UnsetDepthPeelingLayers()

Removes the depth peeling layers setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransparencyKit::GetDefault().

Returns

A reference to this object.

TransparencyControl &UnsetDepthPeelingMinimumArea()

Removes the depth peeling minimum area setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransparencyKit::GetDefault().

Returns

A reference to this object.

TransparencyControl &UnsetDepthPeelingPreference()

Removes the depth peeling preference setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransparencyKit::GetDefault().

Returns

A reference to this object.

TransparencyControl &UnsetDepthWriting()

Removes the depth writing setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransparencyKit::GetDefault().

Returns

A reference to this object.

TransparencyControl &UnsetEverything()

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by TransparencyKit::GetDefault().

Returns

A reference to this object.

TransparencyControl &UnsetMethod()

Removes the transparency method setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransparencyKit::GetDefault().

Returns

A reference to this object.

~TransparencyControl()

Releases a reference to the database object this control is tied to.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::TransparencyControl