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. More...
Public Member Functions | |
override void | Dispose () |
TransparencyKit () | |
Initializes an empty kit. More... | |
TransparencyKit (HPS.TransparencyKit in_kit) | |
The copy constructor creates a new TransparencyKit object that contains the same settings as the source object. More... | |
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... | |
void | Set (HPS.TransparencyKit in_kit) |
Copies all settings from the source TransparencyKit into this object. More... | |
void | Show (out HPS.TransparencyKit out_kit) |
Copies all settings from this TransparencyKit into the given TransparencyKit. More... | |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.TransparencyKit in_kit) |
Check if the source TransparencyKit is equivalent to this object. More... | |
HPS.TransparencyKit | SetMethod (HPS.Transparency.Method in_style) |
Sets the method to use when blending transparent geometry. More... | |
HPS.TransparencyKit | SetAlgorithm (HPS.Transparency.Algorithm in_algorithm) |
Sets the algorithm to use when calculating transparency. More... | |
HPS.TransparencyKit | SetDepthPeelingLayers (uint in_layers) |
Sets the number of layers to use when performing depth peeling. Ignored in other transparency methods. More... | |
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. More... | |
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. More... | |
HPS.TransparencyKit | UnsetMethod () |
Removes the transparency method setting. More... | |
HPS.TransparencyKit | UnsetAlgorithm () |
Removes the transparency algorithm setting. More... | |
HPS.TransparencyKit | UnsetDepthPeelingLayers () |
Removes the depth peeling layers setting. More... | |
HPS.TransparencyKit | UnsetDepthPeelingMinimumArea () |
Removes the depth peeling minimum area setting. More... | |
HPS.TransparencyKit | UnsetDepthWriting () |
Removes the depth writing setting. More... | |
HPS.TransparencyKit | UnsetEverything () |
Removes all settings from this object. More... | |
bool | ShowMethod (out HPS.Transparency.Method out_style) |
Shows 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... | |
![]() | |
IntPtr | GetClassID () |
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... | |
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... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
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... | |
Static Public Member Functions | |
static 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. More... | |
static bool | operator== (HPS.TransparencyKit a, HPS.TransparencyKit b) |
static bool | operator!= (HPS.TransparencyKit a, HPS.TransparencyKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
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.
|
inline |
Initializes an empty kit.
|
inline |
The copy constructor creates a new TransparencyKit object that contains the same settings as the source object.
in_kit | The source object to copy. |
|
inlinevirtual |
Indicates whether this object has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source TransparencyKit is equivalent to this object.
in_kit | The source <ref refid="class_h_p_s_1_1_transparency_kit" kindref="compound">TransparencyKit</ref> to compare to this object. |
|
inlinestatic |
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.
|
inlinevirtual |
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.
|
inline |
Copies all settings from the source TransparencyKit into this object.
in_kit | The source <ref refid="class_h_p_s_1_1_transparency_kit" kindref="compound">TransparencyKit</ref> to copy. |
|
inline |
Sets the algorithm to use when calculating transparency.
in_algorithm | The algorithm to use. |
|
inline |
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. |
|
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.
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. |
|
inline |
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. |
|
inline |
Sets the method to use when blending transparent geometry.
in_style | The method to use when blending transparent geometry. |
|
inline |
Copies all settings from this TransparencyKit into the given TransparencyKit.
out_kit | The <ref refid="class_h_p_s_1_1_transparency_kit" kindref="compound">TransparencyKit</ref> to populate with the contents of this object. |
|
inline |
Shows the algorithm to use when calculating transparency.
out_algorithm | The algorithm to use. |
|
inline |
Shows the number of layers to use when performing depth peeling.
out_layers | The number of layers to use when performing depth peeling. |
|
inline |
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. |
|
inline |
Shows whether transparent geometry should write into the Z-buffer.
out_state | Whether transparent geometry should write into the Z-buffer. |
|
inline |
Shows the method to use when blending transparent geometry.
out_style | The method to use when blending transparent geometry. |
|
inline |
Removes the transparency algorithm setting.
|
inline |
Removes the depth peeling layers setting.
|
inline |
Removes the depth peeling minimum area setting.
|
inline |
Removes the depth writing setting.
|
inline |
Removes all settings from this object.
|
inline |
Removes the transparency method setting.