SoTransparencyType Class Reference
[Properties]
Node that specifies the transparency algorithm to use for shapes.
More...
#include <Inventor/nodes/SoTransparencyType.h>
Public Types | |
| enum | TransparencyType { SCREEN_DOOR = SoTransparencyTypeElement::SCREEN_DOOR, ADD = SoTransparencyTypeElement::ADD, BLEND = SoTransparencyTypeElement::BLEND, DELAYED_ADD = SoTransparencyTypeElement::DELAYED_ADD, DELAYED_BLEND = SoTransparencyTypeElement::DELAYED_BLEND, SORTED_OBJECT_ADD = SoTransparencyTypeElement::SORTED_OBJECT_ADD, SORTED_OBJECT_BLEND = SoTransparencyTypeElement::SORTED_OBJECT_BLEND, SORTED_TRIANGLES_ADD = SoTransparencyTypeElement::SORTED_TRIANGLES_ADD, SORTED_TRIANGLES_BLEND = SoTransparencyTypeElement::SORTED_TRIANGLES_BLEND, SORTED_OBJECT_TRIANGLES_ADD = SoTransparencyTypeElement::SORTED_OBJECT_TRIANGLES_ADD, SORTED_OBJECT_TRIANGLES_BLEND = SoTransparencyTypeElement::SORTED_OBJECT_TRIANGLES_BLEND, SORTED_PIXELS_BLEND = SoTransparencyTypeElement::SORTED_PIXELS_BLEND, SORTED_LAYERS_BLEND = SORTED_PIXELS_BLEND, DELAYED_SORTED_PIXELS_BLEND = SoTransparencyTypeElement::DELAYED_SORTED_PIXELS_BLEND, DELAYED_SORTED_LAYERS_BLEND = DELAYED_SORTED_PIXELS_BLEND, NO_TRANSPARENCY = SoTransparencyTypeElement::NO_TRANSPARENCY } |
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoTransparencyType () | |
| virtual void | setOverride (const SbBool state) |
| virtual SbBool | isOverride () const |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Public Attributes | |
| SoSFEnum | type |
Detailed Description
Node that specifies the transparency algorithm to use for shapes.
The class allows you to specify the transparency algorithm to use for all subsequent shapes. Transparency handling can be completely disabled by setting NO_TRANSPARENCY.
You can also specify the transparency algorithm globally using SoGLRenderAction or the viewer clases (e.g. SoWinRenderArea).
However, there are some differences in behavior depending on which class you use to set the transparency type.
- Setting transparency type SORTED_PIXELS_BLEND in an SoTransparencyType node is equivalent to setting transparency type SCREEN_DOOR. This transparency type is only effective when set in the SoGLRenderAction or viewer.
- When transparency type SORTED_PIXELS_BLEND or DELAYED_SORTED_PIXELS_BLEND is set in the SoGLRenderAction or viewer, you must be careful using SoTransparencyType nodes in the scene graph. Objects that are assigned to a DELAYED_ or SORTED_ transparency type by an SoTransparencyType node will not be taken into account in the SORTED_PIXELS_BLEND or DELAYED_SORTED_PIXELS_BLEND processing (they will be rendered after this processing).
See SoGLRenderAction for a detailed description of when different shapes, including transparent shapes, are rendered during scene graph traversal.
NOTES:
- Depth buffer.
When using a delayed transparency mode, e.g. DELAYED_SORTED_PIXELS_BLEND, the depth buffer is not updated (depth buffer writes are disabled) while rendering transparent objects. As a result complex 3D shapes may not be rendered correctly.
- Traversal order.
Delayed transparency modes implicitly modify the order of the scene graph traversal by rendering transparent objects after all opaque ones. As a result, using a specific node to achieve an effect that relies on the order of rendering (for example SoDepthBuffer) may lead to incorrect results.
- Compact paths optimization.
When using a delayed transparency mode, paths to transparent objects are saved in a list. After all opaque objects have been rendered, this list is rendered. In order to avoid unnecessary rendering, the common part of each path is rendered only once. This can increase performance on very complex scene graphs. However, in some cases, it can lead to incorrect rendering. In the figure below, node B is a transparent object and node A has a side effect on node B (clipping, shader...). When the compact path optimization is on (the default), node A will not be traversed during the transparency pass, which will lead to incorrect rendering. When a case like this occurs in your scene graph, set the environment variable OIV_USE_COMPACT_PATHS to false to disable this optimization.
- Warning:
- This class is not available in Open Inventor version 10 and later.
Starting with Open version 10, transparency type can only be specified as a property of the whole scene.
See the setTransparencyType() method in SoGLRenderAction or the viewer class.
FILE FORMAT/DEFAULT
- TransparencyType {
| type | SCREEN_DOOR |
ACTION BEHAVIOR
SEE ALSO
- Deprecated:
-
Deprecated since Open Inventor 9630
Will be removed in OIV 10. Please refer to class documentation for details.
Member Enumeration Documentation
Various levels of transparency rendering quality.
- Enumerator:
SCREEN_DOOR Uses stipple patterns to simulate transparency.
Note: This algorithm is very fast because it does not require blending, shaders or sorting. However most applications should use one of the other algorithms. Screen door rendering is low quality and only works for polygons with a single transparency (alpha) value for the entire face. Screen door does not correctly handle the case of transparency per vertex or transparent textures.ADD Uses additive alpha blending.
BLEND Uses multiplicative alpha blending.
DELAYED_ADD Uses additive blending, rendering all transparent objects after opaque ones.
Note: When using this algorithm the OpenGL depth buffer is not updated (depth buffer writes are disabled) while rendering transparent objects. As a result complex 3D shapes may not be rendered correctly.DELAYED_BLEND Uses multiplicative alpha blending, rendering all transparent objects after opaque ones.
Note: When using this algorithm the OpenGL depth buffer is not updated (depth buffer writes are disabled) while rendering transparent objects. As a result complex 3D shapes may not be rendered correctly.SORTED_OBJECT_ADD Same as DELAYED_ADD, but sorts transparent objects by distances of bounding boxes from camera.
SORTED_OBJECT_BLEND Same as DELAYED_BLEND, but sorts transparent objects by distances of bounding boxes from camera.
SORTED_TRIANGLES_ADD Renders all the transparent triangles of the scene using additive blending. All of the transparent triangles of all objects of the scene are collected, and then sorted by triangle position.
SORTED_TRIANGLES_BLEND Same as SORTED_TRIANGLES_ADD, but uses multiplicative alpha blending.
SORTED_OBJECT_TRIANGLES_ADD Renders all the transparent triangles of the scene using additive blending. All of the triangles of all transparent objects of the scene are collected and then sorted by object.
SORTED_OBJECT_TRIANGLES_BLEND Same as SORTED_OBJECT_TRIANGLES_ADD, but uses multiplicative alpha blending.
SORTED_PIXELS_BLEND Uses a fragment-level depth sorting technique. This mode generally gives the best results for complex transparent objects.Since Open Inventor 9.4, if the hardware supports the necessary OpenGL features, this transparency mode (and DELAYED_SORTED_PIXELS_BLEND) is implemented using a single-pass, order-independent fragment sorting (K-buffer or A-buffer) algorithm. The required OpenGL hardware features are: shader_image_load_store, shader_atomic_counters and shading_language_420pack. These features are standard in core OpenGL 4.2. Use SoGLExtension, if necessary, to check if they are supported.If the hardware does not support single-pass transparency, then a multi-pass "depth peeling" algorithm is used. The required OpenGL hardware features are: Multi-Texture, Texture Environment Combine, Depth texture, and Shadow . These features are standard starting with OpenGL 1.4. The method setSortedLayersNumPasses() allows you to set the number of rendering passes for more correct transparency. Usually, four passes gives good results.Please note that since some transparency algorithms rely on multi-pass techniques based on the depth of the polygon, there can be issues if several polygons are rendered at the same depth, resulting in incorrect blending. However, rendering polygons at the same depth is highly discouraged even without using advanced transparency since it can result in Z-fighting. Consider using an SoPolygonOffset or SoDepthOffset node to alleviate this issue.If the graphics board does not support multi-pass transparency, SORTED_OBJECT_BLEND is used.Note: If the application uses fragment sorting transparency and specifies a custom fragment shader, the application shader must call an Open Inventor GLSL method instead of setting gl_FragData[0] directly. In the SDK installation, see shaders/include/Inventor/oivDepthPeeling_frag.h Limitations:
- Antialiasing.
This transparency type is not compatible with FSAA mode. Use SUPERSAMPLING, FXAA or SMAA instead.
- Stereo.
This transparency type is not compatible with interlaced stereo.
- Texturing.
Texturing on transparent objects is limited to one texture.
- GPU memory.
Using the single-pass algorithm, it is possible to run out of GPU memory for storing fragment transparency values. This should only happen for scenes with both high depth complexity and a large number of transparent objects. In this case fragments from the objects traversed last in the scene graph may not be sorted correctly, resulting in small artifacts.
SORTED_LAYERS_BLEND Deprecated name of SORTED_PIXELS_BLEND.
- Deprecated:
-
Deprecated since Open Inventor 9400
It corresponds to the SORTED_PIXELS_BLEND transparency type.
DELAYED_SORTED_PIXELS_BLEND Same as SORTED_PIXELS_BLEND but rendering all transparent objects after opaque ones. See limitations section for SORTED_PIXELS_BLEND!
DELAYED_SORTED_LAYERS_BLEND Deprecated name of DELAYED_SORTED_PIXELS_BLEND.
- Deprecated:
-
Deprecated since Open Inventor 9400
It corresponds to the DELAYED_SORTED_PIXELS_BLEND transparency type.
NO_TRANSPARENCY Draw all objects as opaque ignoring their transparency.
- Antialiasing.
Constructor & Destructor Documentation
| SoTransparencyType::SoTransparencyType | ( | ) |
Constructor.
Member Function Documentation
| static SoType SoTransparencyType::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoNode.
| virtual SoType SoTransparencyType::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoNode.
| virtual SbBool SoTransparencyType::isOverride | ( | ) | const [inline, virtual] |
Returns the state of the override field.
Reimplemented from SoNode.
| virtual void SoTransparencyType::setOverride | ( | const SbBool | state | ) | [inline, virtual] |
Member Data Documentation
Transparency type.
Use enum TransparencyType. Default is SCREEN_DOOR.
The documentation for this class was generated from the following file:
- Inventor/nodes/SoTransparencyType.h