REFERENCE MANUAL
The TransparencyControl class is a smart pointer that is tied to a database object. More...
Public Member Functions | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. 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. 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. More... | |
HPS.TransparencyControl | SetDepthWriting (bool in_state) |
Controls whether transparent geometry should write into the Z-buffer. 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... | |
![]() | |
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. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
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. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The 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 TransparencyControl can be found here.
HPS.TransparencyControl.TransparencyControl | ( | HPS.SegmentKey | in_seg | ) |
Initializes a control tied to the segment in_seg.
HPS.TransparencyControl.TransparencyControl | ( | HPS.TransparencyControl | in_that | ) |
Initializes a control tied to the same object as in_that.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
HPS.TransparencyControl HPS.TransparencyControl.SetAlgorithm | ( | HPS.Transparency.Algorithm | in_algorithm | ) |
Sets the algorithm to use when calculating transparency.
in_algorithm | The algorithm to use. |
HPS.TransparencyControl HPS.TransparencyControl.SetDepthPeelingLayers | ( | uint | in_layers | ) |
Sets the number of layers to use when performing depth peeling.
Ignored in other transparency methods.
in_layers | The number of layers to use when performing depth peeling. |
HPS.TransparencyControl 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.
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. |
HPS.TransparencyControl 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.
in_state | Whether transparent geometry should write into the Z-buffer. |
HPS.TransparencyControl HPS.TransparencyControl.SetMethod | ( | HPS.Transparency.Method | in_style | ) |
Sets the method to use when blending transparent geometry.
in_style | The method to use when blending transparent geometry. |
bool HPS.TransparencyControl.ShowAlgorithm | ( | out HPS.Transparency.Algorithm | out_algorithm | ) |
Shows the algorithm to use when calculating transparency.
out_algorithm | The algorithm to use. |
bool HPS.TransparencyControl.ShowDepthPeelingLayers | ( | out uint | out_layers | ) |
Shows the number of layers to use when performing depth peeling.
out_layers | The number of layers to use when performing depth peeling. |
bool HPS.TransparencyControl.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.
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. |
bool HPS.TransparencyControl.ShowDepthWriting | ( | out bool | out_state | ) |
Shows whether transparent geometry should write into the Z-buffer.
out_state | Whether transparent geometry should write into the Z-buffer. |
bool HPS.TransparencyControl.ShowMethod | ( | out HPS.Transparency.Method | out_style | ) |
Shows the method to use when blending transparent geometry.
out_style | The method to use when blending transparent geometry. |
HPS.TransparencyControl HPS.TransparencyControl.UnsetAlgorithm | ( | ) |
Removes the transparency algorithm setting.
HPS.TransparencyControl HPS.TransparencyControl.UnsetDepthPeelingLayers | ( | ) |
Removes the depth peeling layers setting.
HPS.TransparencyControl HPS.TransparencyControl.UnsetDepthPeelingMinimumArea | ( | ) |
Removes the depth peeling minimum area setting.
HPS.TransparencyControl HPS.TransparencyControl.UnsetDepthWriting | ( | ) |
Removes the depth writing setting.
HPS.TransparencyControl HPS.TransparencyControl.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.TransparencyControl HPS.TransparencyControl.UnsetMethod | ( | ) |
Removes the transparency method setting.