com.openinventor.inventor.nodes

Class SoTransparencyType

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.nodes.SoTransparencyType

All Implemented Interfaces:

SafeDisposable

Deprecated.

As of Open Inventor 9630 See documentation for more details

public class SoTransparencyType
extends SoNode

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:

Sets: SoTransparencyTypeElement

See also:

SoGLRenderAction.Deprecated since Open Inventor 9630
Will be removed in OIV 10. Please refer to class documentation for details.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoTransparencyType.TransparencyTypes Deprecated. Various levels of transparency rendering quality.

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADD Deprecated. Use SoTransparencyType.TransparencyTypes.ADD instead.
static int	BLEND Deprecated. Use SoTransparencyType.TransparencyTypes.BLEND instead.
static int	DELAYED_ADD Deprecated. Use SoTransparencyType.TransparencyTypes.DELAYED_ADD instead.
static int	DELAYED_BLEND Deprecated. Use SoTransparencyType.TransparencyTypes.DELAYED_BLEND instead.
static int	DELAYED_SORTED_LAYERS_BLEND Deprecated. Use SoTransparencyType.TransparencyTypes.DELAYED_SORTED_LAYERS_BLEND instead.
static int	DELAYED_SORTED_PIXELS_BLEND Deprecated. Use SoTransparencyType.TransparencyTypes.DELAYED_SORTED_PIXELS_BLEND instead.
static int	NO_TRANSPARENCY Deprecated. Use SoTransparencyType.TransparencyTypes.NO_TRANSPARENCY instead.
static int	SCREEN_DOOR Deprecated. Use SoTransparencyType.TransparencyTypes.SCREEN_DOOR instead.
static int	SORTED_LAYERS_BLEND Deprecated. Use SoTransparencyType.TransparencyTypes.SORTED_LAYERS_BLEND instead.
static int	SORTED_OBJECT_ADD Deprecated. Use SoTransparencyType.TransparencyTypes.SORTED_OBJECT_ADD instead.
static int	SORTED_OBJECT_BLEND Deprecated. Use SoTransparencyType.TransparencyTypes.SORTED_OBJECT_BLEND instead.
static int	SORTED_OBJECT_TRIANGLES_ADD Deprecated. Use SoTransparencyType.TransparencyTypes.SORTED_OBJECT_TRIANGLES_ADD instead.
static int	SORTED_OBJECT_TRIANGLES_BLEND Deprecated. Use SoTransparencyType.TransparencyTypes.SORTED_OBJECT_TRIANGLES_BLEND instead.
static int	SORTED_PIXELS_BLEND Deprecated. Use SoTransparencyType.TransparencyTypes.SORTED_PIXELS_BLEND instead.
static int	SORTED_TRIANGLES_ADD Deprecated. Use SoTransparencyType.TransparencyTypes.SORTED_TRIANGLES_ADD instead.
static int	SORTED_TRIANGLES_BLEND Deprecated. Use SoTransparencyType.TransparencyTypes.SORTED_TRIANGLES_BLEND instead.
SoSFEnum<SoTransparencyType.TransparencyTypes>	type Deprecated. Transparency type.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoTransparencyType() Deprecated. Constructor.

Method Summary

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SCREEN_DOOR

@Deprecated
public static final int SCREEN_DOOR

Deprecated. Use SoTransparencyType.TransparencyTypes.SCREEN_DOOR instead.

ADD

@Deprecated
public static final int ADD

Deprecated. Use SoTransparencyType.TransparencyTypes.ADD instead.

BLEND

@Deprecated
public static final int BLEND

Deprecated. Use SoTransparencyType.TransparencyTypes.BLEND instead.

DELAYED_ADD

@Deprecated
public static final int DELAYED_ADD

Deprecated. Use SoTransparencyType.TransparencyTypes.DELAYED_ADD instead.

DELAYED_BLEND

@Deprecated
public static final int DELAYED_BLEND

Deprecated. Use SoTransparencyType.TransparencyTypes.DELAYED_BLEND instead.

SORTED_OBJECT_ADD

@Deprecated
public static final int SORTED_OBJECT_ADD

Deprecated. Use SoTransparencyType.TransparencyTypes.SORTED_OBJECT_ADD instead.

SORTED_OBJECT_BLEND

@Deprecated
public static final int SORTED_OBJECT_BLEND

Deprecated. Use SoTransparencyType.TransparencyTypes.SORTED_OBJECT_BLEND instead.

SORTED_TRIANGLES_ADD

@Deprecated
public static final int SORTED_TRIANGLES_ADD

Deprecated. Use SoTransparencyType.TransparencyTypes.SORTED_TRIANGLES_ADD instead.

SORTED_TRIANGLES_BLEND

@Deprecated
public static final int SORTED_TRIANGLES_BLEND

Deprecated. Use SoTransparencyType.TransparencyTypes.SORTED_TRIANGLES_BLEND instead.

SORTED_OBJECT_TRIANGLES_ADD

@Deprecated
public static final int SORTED_OBJECT_TRIANGLES_ADD

Deprecated. Use SoTransparencyType.TransparencyTypes.SORTED_OBJECT_TRIANGLES_ADD instead.

SORTED_OBJECT_TRIANGLES_BLEND

@Deprecated
public static final int SORTED_OBJECT_TRIANGLES_BLEND

Deprecated. Use SoTransparencyType.TransparencyTypes.SORTED_OBJECT_TRIANGLES_BLEND instead.

SORTED_PIXELS_BLEND

@Deprecated
public static final int SORTED_PIXELS_BLEND

Deprecated. Use SoTransparencyType.TransparencyTypes.SORTED_PIXELS_BLEND instead.

SORTED_LAYERS_BLEND

@Deprecated
public static final int SORTED_LAYERS_BLEND

Deprecated. Use SoTransparencyType.TransparencyTypes.SORTED_LAYERS_BLEND instead.

DELAYED_SORTED_PIXELS_BLEND

@Deprecated
public static final int DELAYED_SORTED_PIXELS_BLEND

Deprecated. Use SoTransparencyType.TransparencyTypes.DELAYED_SORTED_PIXELS_BLEND instead.

DELAYED_SORTED_LAYERS_BLEND

@Deprecated
public static final int DELAYED_SORTED_LAYERS_BLEND

Deprecated. Use SoTransparencyType.TransparencyTypes.DELAYED_SORTED_LAYERS_BLEND instead.

NO_TRANSPARENCY

@Deprecated
public static final int NO_TRANSPARENCY

Deprecated. Use SoTransparencyType.TransparencyTypes.NO_TRANSPARENCY instead.

type

public final SoSFEnum<SoTransparencyType.TransparencyTypes> type

Deprecated.

Transparency type. . Default is SCREEN_DOOR.

Constructor Detail

SoTransparencyType

public SoTransparencyType()

Deprecated.

Constructor.