TransparencyKit

class HPS::TransparencyKit : public HPS::Kit 

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.

Public Functions

virtual bool Empty() const

Indicates whether this object has any values set on it.

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

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

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!=(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.

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.

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.

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

void Set(TransparencyKit const &in_kit)

Copies all settings from the source TransparencyKit into this object.

Parameters: in_kit – The source TransparencyKit to copy.

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.

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.

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.

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.

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.

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.

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

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

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.

TransparencyKit(): Initializes an empty kit.

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(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 &UnsetAlgorithm()

Removes the transparency algorithm setting.

Returns: A reference to this object.

TransparencyKit &UnsetDepthPeelingLayers()

Removes the depth peeling layers setting.

Returns: A reference to this object.

TransparencyKit &UnsetDepthPeelingMinimumArea()

Removes the depth peeling minimum area setting.

Returns: A reference to this object.

TransparencyKit &UnsetDepthPeelingPreference()

Removes the depth peeling preference setting.

Returns: A reference to this object.

TransparencyKit &UnsetDepthWriting()

Removes the depth writing setting.

Returns: A reference to this object.

TransparencyKit &UnsetEverything()

Removes all settings from this object.

Returns: A reference to this object.

TransparencyKit &UnsetMethod()

Removes the transparency method setting.

Returns: A reference to this object.

virtual ~TransparencyKit(): Destroy this kit.

Public Static Functions

static TransparencyKit GetDefault()

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.

Public Static Attributes

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