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

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 | SetDepthPeelingPreference (HPS.Transparency.Preference in_preference) |
Specifies whether quality or performance should be favored 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 | ShowDepthPeelingPreference (out HPS.Transparency.Preference out_preference) |
Shows the depth peeling preference. 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... | |
override 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... | |
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 | UnsetDepthPeelingPreference () |
Removes the depth peeling preference 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... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
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
|
inline |
Initializes a control tied to the segment in_seg.
|
inline |
Initializes a control tied to the same object as in_that.
Member Function Documentation
|
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.Control.
|
inline |
Sets the algorithm to use when calculating transparency.
- Parameters
-
in_algorithm The algorithm to use.
- Returns
- a reference to this object.
|
inline |
Sets the number of layers to use when performing depth peeling. Ignored in other transparency methods.
- Parameters
-
in_layers The number of layers to use when performing depth peeling.
- Returns
- a reference to this object.
|
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_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.
|
inline |
Specifies whether quality or performance should be favored when performing depth peeling. Ignored in other transparency methods.
- Returns
- a reference to this object.
|
inline |
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.
|
inline |
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.
|
inline |
Shows the algorithm to use when calculating transparency.
- Parameters
-
out_algorithm The algorithm to use.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Control.
|
inline |
Removes the transparency algorithm setting.
- Returns
- A reference to this object.
|
inline |
Removes the depth peeling layers setting.
- Returns
- A reference to this object.
|
inline |
Removes the depth peeling minimum area setting.
- Returns
- A reference to this object.
|
inline |
Removes the depth peeling preference setting.
- Returns
- A reference to this object.
|
inline |
Removes the depth writing setting.
- Returns
- A reference to this object.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
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