HPS.TransparencyControl Class Reference

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

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

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
HPS.TransparencyControl SetAlgorithm (HPS.Transparency.Algorithm in_algorithm)
 Sets the algorithm to use when calculating transparency. More...
 
HPS.TransparencyControl SetDepthPeelingLayers (uint in_layers)
 Sets the number of layers to use when performing depth peeling. Ignored in other transparency methods. More...
 
HPS.TransparencyControl 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. More...
 
HPS.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. More...
 
HPS.TransparencyControl SetMethod (HPS.Transparency.Method in_style)
 Sets the method to use when blending transparent geometry. More...
 
bool ShowAlgorithm (out HPS.Transparency.Algorithm out_algorithm)
 Shows the algorithm to use when calculating transparency. More...
 
bool ShowDepthPeelingLayers (out uint out_layers)
 Shows the number of layers to use when performing depth peeling. More...
 
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. More...
 
bool ShowDepthWriting (out bool out_state)
 Shows whether transparent geometry should write into the Z-buffer. More...
 
bool ShowMethod (out HPS.Transparency.Method out_style)
 Shows the method to use when blending transparent geometry. More...
 
 TransparencyControl (HPS.SegmentKey in_seg)
 Initializes a control tied to the segment in_seg. More...
 
 TransparencyControl (HPS.TransparencyControl in_that)
 Initializes a control tied to the same object as in_that. More...
 
HPS.TransparencyControl UnsetAlgorithm ()
 Removes the transparency algorithm setting. More...
 
HPS.TransparencyControl UnsetDepthPeelingLayers ()
 Removes the depth peeling layers setting. More...
 
HPS.TransparencyControl UnsetDepthPeelingMinimumArea ()
 Removes the depth peeling minimum area setting. More...
 
HPS.TransparencyControl UnsetDepthWriting ()
 Removes the depth writing setting. More...
 
HPS.TransparencyControl UnsetEverything ()
 Removes all settings from this object. More...
 
HPS.TransparencyControl UnsetMethod ()
 Removes the transparency method setting. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 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. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 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. More...
 

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

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

Initializes a control tied to the segment in_seg.

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

Initializes a control tied to the same object as in_that.

Member Function Documentation

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

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

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

Parameters
in_layersThe number of layers to use when performing depth peeling.
Returns
a reference to this object.
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.
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.
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.
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.
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.
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.
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.
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.
HPS.TransparencyControl HPS.TransparencyControl.UnsetAlgorithm ( )
inline

Removes the transparency algorithm setting.

Returns
A reference to this object.
HPS.TransparencyControl HPS.TransparencyControl.UnsetDepthPeelingLayers ( )
inline

Removes the depth peeling layers setting.

Returns
A reference to this object.
HPS.TransparencyControl HPS.TransparencyControl.UnsetDepthPeelingMinimumArea ( )
inline

Removes the depth peeling minimum area setting.

Returns
A reference to this object.
HPS.TransparencyControl HPS.TransparencyControl.UnsetDepthWriting ( )
inline

Removes the depth writing setting.

Returns
A reference to this object.
HPS.TransparencyControl HPS.TransparencyControl.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.
HPS.TransparencyControl HPS.TransparencyControl.UnsetMethod ( )
inline

Removes the transparency method setting.

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