HPS.TransparencyControl Class Reference
Inheritance diagram for HPS.TransparencyControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.TransparencyControl SetAlgorithm (HPS.Transparency.Algorithm in_algorithm)
 
HPS.TransparencyControl SetDepthPeelingLayers (uint in_layers)
 
HPS.TransparencyControl SetDepthPeelingMinimumArea (float in_area, HPS.Transparency.AreaUnits in_units)
 
HPS.TransparencyControl SetDepthPeelingPreference (HPS.Transparency.Preference in_preference)
 
HPS.TransparencyControl SetDepthWriting (bool in_state)
 
HPS.TransparencyControl SetMethod (HPS.Transparency.Method in_style)
 
bool ShowAlgorithm (out HPS.Transparency.Algorithm out_algorithm)
 
bool ShowDepthPeelingLayers (out uint out_layers)
 
bool ShowDepthPeelingMinimumArea (out float out_area, out HPS.Transparency.AreaUnits out_units)
 
bool ShowDepthPeelingPreference (out HPS.Transparency.Preference out_preference)
 
bool ShowDepthWriting (out bool out_state)
 
bool ShowMethod (out HPS.Transparency.Method out_style)
 
 TransparencyControl (HPS.SegmentKey in_seg)
 
 TransparencyControl (HPS.TransparencyControl in_that)
 
override HPS.Type Type ()
 
HPS.TransparencyControl UnsetAlgorithm ()
 
HPS.TransparencyControl UnsetDepthPeelingLayers ()
 
HPS.TransparencyControl UnsetDepthPeelingMinimumArea ()
 
HPS.TransparencyControl UnsetDepthPeelingPreference ()
 
HPS.TransparencyControl UnsetDepthWriting ()
 
HPS.TransparencyControl UnsetEverything ()
 
HPS.TransparencyControl UnsetMethod ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ TransparencyControl() [1/2]

HPS.TransparencyControl.TransparencyControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ TransparencyControl() [2/2]

HPS.TransparencyControl.TransparencyControl ( HPS.TransparencyControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.TransparencyControl.ObjectType ( )
inlinevirtual

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.

Reimplemented from HPS.Control.

◆ SetAlgorithm()

HPS.TransparencyControl HPS.TransparencyControl.SetAlgorithm ( HPS.Transparency.Algorithm  in_algorithm)
inline

Sets the algorithm to use when calculating transparency.

Parameters
in_algorithmThe algorithm to use.
Returns
a reference to this object.

◆ SetDepthPeelingLayers()

HPS.TransparencyControl HPS.TransparencyControl.SetDepthPeelingLayers ( uint  in_layers)
inline

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_layersThe number of layers to use when performing depth peeling.
Returns
a reference to this object.

◆ SetDepthPeelingMinimumArea()

HPS.TransparencyControl HPS.TransparencyControl.SetDepthPeelingMinimumArea ( float  in_area,
HPS.Transparency.AreaUnits  in_units 
)
inline

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_areaThe amount of the screen a layer needs to occupy in order to process another layer.
in_unitsThe units of the minimum area.
Returns
a reference to this object.

◆ SetDepthPeelingPreference()

HPS.TransparencyControl HPS.TransparencyControl.SetDepthPeelingPreference ( HPS.Transparency.Preference  in_preference)
inline

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

Returns
a reference to this object.

◆ SetDepthWriting()

HPS.TransparencyControl HPS.TransparencyControl.SetDepthWriting ( bool  in_state)
inline

Controls whether transparent geometry should write into the Z-buffer. Applies only when the transparency algorithm is NoSorting, ZSortNicest, or ZSortFastest.

Parameters
in_stateWhether transparent geometry should write into the Z-buffer.
Returns
a reference to this object.

◆ SetMethod()

HPS.TransparencyControl HPS.TransparencyControl.SetMethod ( HPS.Transparency.Method  in_style)
inline

Sets the method to use when blending transparent geometry.

Parameters
in_styleThe method to use when blending transparent geometry.
Returns
a reference to this object.

◆ ShowAlgorithm()

bool HPS.TransparencyControl.ShowAlgorithm ( out HPS.Transparency.Algorithm  out_algorithm)
inline

Shows the algorithm to use when calculating transparency.

Parameters
out_algorithmThe algorithm to use.
Returns
true if the setting is valid, false otherwise.

◆ ShowDepthPeelingLayers()

bool HPS.TransparencyControl.ShowDepthPeelingLayers ( out uint  out_layers)
inline

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

Parameters
out_layersThe number of layers to use when performing depth peeling.
Returns
true if the setting is valid, false otherwise.

◆ ShowDepthPeelingMinimumArea()

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

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

Parameters
out_areaThe amount of the screen a layer needs to occupy in order to process another layer.
out_unitsThe units of the minimum area.
Returns
true if the setting is valid, false otherwise.

◆ ShowDepthPeelingPreference()

bool HPS.TransparencyControl.ShowDepthPeelingPreference ( out HPS.Transparency.Preference  out_preference)
inline

Shows the depth peeling preference.

Parameters
out_preferenceWhether quality of performance should be favored when performing depth peeling.
Returns
true if the setting is valid, false otherwise.

◆ ShowDepthWriting()

bool HPS.TransparencyControl.ShowDepthWriting ( out bool  out_state)
inline

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

Parameters
out_stateWhether transparent geometry should write into the Z-buffer.
Returns
true if the setting is valid, false otherwise.

◆ ShowMethod()

bool HPS.TransparencyControl.ShowMethod ( out HPS.Transparency.Method  out_style)
inline

Shows the method to use when blending transparent geometry.

Parameters
out_styleThe method to use when blending transparent geometry.
Returns
true if the setting is valid, false otherwise.

◆ Type()

override HPS.Type HPS.TransparencyControl.Type ( )
inlinevirtual

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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS.Control.

◆ UnsetAlgorithm()

HPS.TransparencyControl HPS.TransparencyControl.UnsetAlgorithm ( )
inline

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.

◆ UnsetDepthPeelingLayers()

HPS.TransparencyControl HPS.TransparencyControl.UnsetDepthPeelingLayers ( )
inline

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.

◆ UnsetDepthPeelingMinimumArea()

HPS.TransparencyControl HPS.TransparencyControl.UnsetDepthPeelingMinimumArea ( )
inline

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.

◆ UnsetDepthPeelingPreference()

HPS.TransparencyControl HPS.TransparencyControl.UnsetDepthPeelingPreference ( )
inline

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.

◆ UnsetDepthWriting()

HPS.TransparencyControl HPS.TransparencyControl.UnsetDepthWriting ( )
inline

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.

◆ UnsetEverything()

HPS.TransparencyControl HPS.TransparencyControl.UnsetEverything ( )
inline

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.

◆ UnsetMethod()

HPS.TransparencyControl HPS.TransparencyControl.UnsetMethod ( )
inline

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.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.TransparencyControl.cs