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

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

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

bool Equals (HPS.TransparencyKit in_kit)

Check if the source TransparencyKit is equivalent to this object.

Param in_kit: The source TransparencyKit to compare to this object.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

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

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.TransparencyKit in_kit)

Copies all settings from the source TransparencyKit into this object.

Param in_kit: The source TransparencyKit to copy.

HPS.TransparencyKit SetAlgorithm (HPS.Transparency.Algorithm in_algorithm)

Sets the algorithm to use when calculating transparency.

Param in_algorithm: The algorithm to use.
Return: a reference to this object.

HPS.TransparencyKit SetDepthPeelingLayers (uint 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.

Param in_layers: The number of layers to use when performing depth peeling.
Return: a reference to this object.

HPS.TransparencyKit SetDepthPeelingMinimumArea (float in_area, HPS.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.

Param in_area: The amount of the screen a layer needs to occupy in order to process another layer.
Param in_units: The units of the minimum area.
Return: a reference to this object.

HPS.TransparencyKit SetDepthPeelingPreference (HPS.Transparency.Preference in_preference)

Specifies whether quality or performance should be favored when performing depth peeling. Ignored in other transparency methods.

Return: a reference to this object.

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.

Param in_state: Whether transparent geometry should write into the Z-buffer.
Return: a reference to this object.

HPS.TransparencyKit SetMethod (HPS.Transparency.Method in_style)

Sets the method to use when blending transparent geometry.

Param in_style: The method to use when blending transparent geometry.
Return: a reference to this object.

void Show (out HPS.TransparencyKit out_kit)

Copies all settings from this TransparencyKit into the given TransparencyKit.

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

bool ShowAlgorithm (out HPS.Transparency.Algorithm out_algorithm)

Shows the algorithm to use when calculating transparency.

Param out_algorithm: The algorithm to use.
Return: true if the setting is valid, false otherwise.

bool ShowDepthPeelingLayers (out uint out_layers)

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

Param out_layers: The number of layers to use when performing depth peeling.
Return: true if the setting is valid, false otherwise.

bool ShowDepthPeelingMinimumArea (out float out_area, out HPS.Transparency.AreaUnits out_units)

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

Param out_area: The amount of the screen a layer needs to occupy in order to process another layer.
Param out_units: The units of the minimum area.
Return: true if the setting is valid, false otherwise.

bool ShowDepthPeelingPreference (out HPS.Transparency.Preference out_preference)

Shows the depth peeling performance setting.

Param out_preference: Whether quality or performance should be favored when performing depth peeling.
Return: true if the setting is valid, false otherwise.

bool ShowDepthWriting (out bool out_state)

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

Param out_state: Whether transparent geometry should write into the Z-buffer.
Return: true if the setting is valid, false otherwise.

bool ShowMethod (out HPS.Transparency.Method out_style)

Shows the method to use when blending transparent geometry.

Param out_style: The method to use when blending transparent geometry.
Return: true if the setting is valid, false otherwise.

TransparencyKit (): Initializes an empty kit.

TransparencyKit (HPS.TransparencyKit in_kit)

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

Param in_kit: The source object to copy.

HPS.TransparencyKit UnsetAlgorithm ()

Removes the transparency algorithm setting.

Return: A reference to this object.

HPS.TransparencyKit UnsetDepthPeelingLayers ()

Removes the depth peeling layers setting.

Return: A reference to this object.

HPS.TransparencyKit UnsetDepthPeelingMinimumArea ()

Removes the depth peeling minimum area setting.

Return: A reference to this object.

HPS.TransparencyKit UnsetDepthPeelingPreference ()

Removes the depth peeling preference setting.

Return: A reference to this object.

HPS.TransparencyKit UnsetDepthWriting ()

Removes the depth writing setting.

Return: A reference to this object.

HPS.TransparencyKit UnsetEverything ()

Removes all settings from this object.

Return: A reference to this object.

HPS.TransparencyKit UnsetMethod ()

Removes the transparency method setting.

Return: A reference to this object.

Public Static Functions

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

Return: A TransparencyKit with the default settings.

bool operator!= (HPS.TransparencyKit a, HPS.TransparencyKit b)

bool operator== (HPS.TransparencyKit a, HPS.TransparencyKit b)