SoGLRenderAction

java.lang.Object
- com.openinventor.inventor.Inventor
- - com.openinventor.inventor.actions.SoAction
  - - com.openinventor.inventor.actions.SoGLRenderAction

Direct Known Subclasses:

SoBoxHighlightRenderAction, SoLineHighlightRenderAction
```
public class SoGLRenderAction
extends SoAction
```
Renders a scene graph using OpenGL. This class traverses a scene graph and renders it using the OpenGL graphics library. It assumes that a valid window has been created and initialized for proper OpenGL rendering. The SoWinRenderArea class or any of its subclasses may be used to create such a window.
This class has many options for rendering, but the most commonly used methods are exposed by the viewer classes (SoWin, SoXt, SoQt) for convenience. The viewer classes automatically create a render action for you.
Traversal order
In most cases objects are rendered during the SoGLRenderAction traversal of the scene graph, in the order they are encountered during the traversal. However rendering of some objects may be delayed until after the scene graph traversal, particularly transparent objects.
A transparent object is an object:
- With a material that has a transparency value set either by a material node or a vertex property node.
  or
- With a texture that has an alpha value < 1.
Open Inventor automatically detects these cases.
The rendering order for transparent objects depends on the transparency "type" (transparency rendering method) assigned to each object. A transparency type may be set for the entire scene graph using the SoGLRenderAction or SoWinRenderArea method. The transparency type may also be modified during traversal using the SoTransparencyType node.
There are several special cases including:
- Transparency type SORTED_PIXELS_BLEND.
  The environment variable OIV_NO_SHADER_LAYERS_BLEND allows you to disable the use of a fragment shader for this technique.
- SoRenderList nodes, e.g. SoOctreeOrdering.
  Objects that are delayed are generally rendered in the sequence below, but other objects are rendered in various specific orders, not in scene graph order. See the specific node for details.
The general rendering order is:
1. Scene graph traversal
  All objects not in one of the following categories, specifically including transparent objects using the SCREEN_DOOR, ADD, or BLEND transparency types.
2. FastEdit KEEP_ZBUFFER objects
  Objects under an SoSeparator node with fastEditing field set to KEEP_ZBUFFER.
3. Opaque delayed objects
4. Transparent delayed objects
  Objects using transparency types DELAYED_BLEND or DELAYED_ADD. Note that by default the OpenGL depth buffer is not updated while rendering these objects.
5. Transparent sorted objects
  Objects using transparency types SORTED_OBJECT_BLEND or SORTED_OBJECT_ADD. These objects are sorted by the distance of their bounding box from the camera, then rendered in back-to-front order. Note that by default the OpenGL depth buffer is not updated while rendering these objects.
6. Transparent sorted triangles by object
  Objects using transparency types SORTED_OBJECT_TRIANGLES_ADD or SORTED_OBJECT_TRIANGLES_BLEND. First, objects are sorted according to their projected position on the current sorting axis. Then the triangles are sorted within each object and rendered object by object.
7. Transparent sorted triangles
  Objects using transparency types SORTED_TRIANGLES_ADD or SORTED_TRIANGLES_BLEND. All of the triangles for all of the objects in the scene are sorted according to their projected position on the current sorting axis. The triangles are rendered in order, triangle by triangle, regardless of the object they belong to.
8. Annotation delayed objects
  Objects under an SoAnnotation node.
9. FastEdit CLEAR_ZBUFFER objects
  Objects under an SoSeparator node with fastEditing field set to CLEAR_ZBUFFER.
10. Front buffer objects
  Objects under an SoFrontBufferGroup (after the buffer swap).
Elements
Sets: SoDecimationTypeElement, SoDecimationPercentageElement, SoUpdateAreaElement, SoRenderPassElement, SoViewportRegionElement, SoLogicalViewportElement
See also:
SoSeparator, SoWinRenderArea

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SoGLRenderAction.AbortCodes` Possible return codes from a render abort callback.
`static class`	`SoGLRenderAction.AutoCacheModes` Two bits are stored.
`static class`	`SoGLRenderAction.FastEditSavePolicies` Fast edit traversal types.
`static class`	`SoGLRenderAction.InvalidateCacheModes` Invalidate cache mode.
`static class`	`SoGLRenderAction.TransparencyTypes` Transparency rendering algorithm.

Nested classes/interfaces inherited from class com.openinventor.inventor.actions.SoAction
SoAction.AppliedCodes, SoAction.DistribModes, SoAction.PathCodes, SoAction.PathIndices

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABORT` Deprecated. Use `SoGLRenderAction.AbortCodes.ABORT` instead.
`static int`	`ADD` Deprecated. Use `SoGLRenderAction.TransparencyTypes.ADD` instead.
`static int`	`ALWAYS` Deprecated. Use `SoGLRenderAction.InvalidateCacheModes.ALWAYS` instead.
`static int`	`BLEND` Deprecated. Use `SoGLRenderAction.TransparencyTypes.BLEND` instead.
`static int`	`CONTINUE` Deprecated. Use `SoGLRenderAction.AbortCodes.CONTINUE` instead.
`static int`	`DELAY` Deprecated. Use `SoGLRenderAction.AbortCodes.DELAY` instead.
`static int`	`DELAYED_ADD` Deprecated. Use `SoGLRenderAction.TransparencyTypes.DELAYED_ADD` instead.
`static int`	`DELAYED_BLEND` Deprecated. Use `SoGLRenderAction.TransparencyTypes.DELAYED_BLEND` instead.
`static int`	`DELAYED_SORTED_LAYERS_BLEND` Deprecated. Use `SoGLRenderAction.TransparencyTypes.DELAYED_SORTED_LAYERS_BLEND` instead.
`static int`	`DELAYED_SORTED_PIXELS_BLEND` Deprecated. Use `SoGLRenderAction.TransparencyTypes.DELAYED_SORTED_PIXELS_BLEND` instead.
`static int`	`DISABLE` Deprecated. Use `SoGLRenderAction.FastEditSavePolicies.DISABLE` instead.
`static int`	`DO_AUTO_CACHE` Deprecated. Use `SoGLRenderAction.AutoCacheModes.DO_AUTO_CACHE` instead.
`static int`	`DONT_AUTO_CACHE` Deprecated. Use `SoGLRenderAction.AutoCacheModes.DONT_AUTO_CACHE` instead.
`static int`	`EACH_FRAME` Deprecated. Use `SoGLRenderAction.FastEditSavePolicies.EACH_FRAME` instead.
`static int`	`NO_TRANSPARENCY` Deprecated. Use `SoGLRenderAction.TransparencyTypes.NO_TRANSPARENCY` instead.
`static int`	`OFF` Deprecated. Use `SoGLRenderAction.InvalidateCacheModes.OFF` instead.
`static int`	`ONCE` Deprecated. Use `SoGLRenderAction.InvalidateCacheModes.ONCE` instead.
`static int`	`PRUNE` Deprecated. Use `SoGLRenderAction.AbortCodes.PRUNE` instead.
`static int`	`SCREEN_DOOR` Deprecated. Use `SoGLRenderAction.TransparencyTypes.SCREEN_DOOR` instead.
`static int`	`SORTED_LAYERS_BLEND` Deprecated. Use `SoGLRenderAction.TransparencyTypes.SORTED_LAYERS_BLEND` instead.
`static int`	`SORTED_OBJECT_ADD` Deprecated. Use `SoGLRenderAction.TransparencyTypes.SORTED_OBJECT_ADD` instead.
`static int`	`SORTED_OBJECT_BLEND` Deprecated. Use `SoGLRenderAction.TransparencyTypes.SORTED_OBJECT_BLEND` instead.
`static int`	`SORTED_OBJECT_TRIANGLES_ADD` Deprecated. Use `SoGLRenderAction.TransparencyTypes.SORTED_OBJECT_TRIANGLES_ADD` instead.
`static int`	`SORTED_OBJECT_TRIANGLES_BLEND` Deprecated. Use `SoGLRenderAction.TransparencyTypes.SORTED_OBJECT_TRIANGLES_BLEND` instead.
`static int`	`SORTED_PIXELS_BLEND` Deprecated. Use `SoGLRenderAction.TransparencyTypes.SORTED_PIXELS_BLEND` instead.
`static int`	`SORTED_TRIANGLES_ADD` Deprecated. Use `SoGLRenderAction.TransparencyTypes.SORTED_TRIANGLES_ADD` instead.
`static int`	`SORTED_TRIANGLES_BLEND` Deprecated. Use `SoGLRenderAction.TransparencyTypes.SORTED_TRIANGLES_BLEND` instead.
`static int`	`WHEN_NEEDED` Deprecated. Use `SoGLRenderAction.FastEditSavePolicies.WHEN_NEEDED` instead.

Fields inherited from class com.openinventor.inventor.actions.SoAction
ALL, BELOW_PATH, CLUSTER_ONLY, IN_PATH, LOCAL_ONLY, NO_PATH, NODE, OFF_PATH, PATH, PATH_LIST

Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors
Constructor and Description

SoGLRenderAction(SbViewportRegion viewportRegion)
Constructor.

Constructors
Constructor and Description
`SoGLRenderAction(SbViewportRegion viewportRegion)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`abortNow()`
`void`	`enableDepthPeeling3D(boolean flag)` Use 3D texturing instead of 2D for the fixed functionality emulation in depth peeling.
`static void`	`enableElement(java.lang.Class<? extends Inventor> t, int stkIndex)`
`static int`	`generateCacheContext()` Generates and returns a new cache context id.
`int`	`getCacheContext()` Returns the OpenGL cache context id for this action.
`int`	`getCurPass()`
`float`	`getDecimationPercentage()` Gets decimation percentage, the value should be a number between 0.0 and 1.0.
`SoDecimationTypeElement.Types`	`getDecimationType()` Gets decimation type.
`boolean`	`getDelayedObjDepthWrite()` Returns whether delayed transparent objects update the depth buffer.
`int`	`getDepthPeelingPass()` Get the current pass of depth peeling, -1 if not doing depth peeling.
`SoGLRenderAction.FastEditSavePolicies`	`getFastEditSavePolicy()` Returns fast editing save policy used when rendering.
`int`	`getFrameCounter()` Returns the current frame counter.
`SoGLRenderAction.InvalidateCacheModes`	`getInvalidateCacheMode()` Returns the current cache invalidation mode.
`SbViewportRegion`	`getLogicalViewportRegion()` Returns current logical viewport region.
`int`	`getNumPasses()` Gets number of rendering passes for multipass rendering.
`boolean`	`getRenderingIsRemote()` Returns true if remote rendering is being done.
`int`	`getSortedLayersNumPasses()` Returns the number of rendering passes used when transparency type is `SORTED_PIXELS_BLEND`.
`int`	`getSortedTrianglesNumCaches()` Returns the maximum number of caches allowed for the sorted triangles transparency types.
`int`	`getSortedTrianglesSortFrequency()` Returns the sort frequency used for the SORTED_TRIANGLES_XXX and SORTED_OBJECT_TRIANGLES_XXX transparency types.
`long`	`getSynchronizer()` Deprecated. As of Open Inventor 9.1.
`SoGLRenderAction.TransparencyTypes`	`getTransparencyType()` Returns transparency quality level to use when rendering.
`SbVec2f[]`	`getUpdateArea()` Returns the current update area.
`SbViewportRegion`	`getViewportRegion()` Returns viewport region to use for rendering.
`boolean`	`handleTransparency()` Calls handleTransparency(false, false).
`boolean`	`handleTransparency(boolean isTransparent)` Calls handleTransparency(isTransparent, false).
`boolean`	`handleTransparency(boolean isTransparent, boolean isLinesOrPoints)`
`void`	`howToRenderScene(SoSensor sensor, boolean newRender)` Deprecated. As of Open Inventor 9.1.
`boolean`	`isAlphaTest()` Returns whether the OpenGL alpha test is enabled for rendering.
`boolean`	`isDoingDepthPeeling()` Return true if depth peeling is active.
`boolean`	`isPassUpdate()` Returns a flag indicating whether intermediate results are displayed after each antialiasing pass for progressive improvement.
`boolean`	`isSmoothing()` Returns smoothing flag.
`static boolean`	`isSortedLayersSupported()` Calls isSortedLayersSupported((com.openinventor.inventor.misc.SoState)null).
`static boolean`	`isSortedLayersSupported(SoState state)` Indicates if `SORTED_PIXELS_BLEND` transparency is supported by your graphics board on the current context.
`static boolean`	`isUsedCacheContext(int context)` Returns true if the specified cache context id is currently used by any `SoGLRenderAction`.
`void`	`postDelayedTraversal()` Method called by SoMultiPassManager after delayed pass traversals.
`boolean`	`preDelayedTraversal()` Method called by SoMultiPassManager before delayed pass traversals.
`void`	`resetFrameCounter()` Calls resetFrameCounter((int)0).
`void`	`resetFrameCounter(int count)` Reset the frame counter.
`void`	`setAlphaTest(boolean flag)` Enable or disable the OpenGL alpha test for rendering.
`void`	`setCacheContext(int context)` Sets the OpenGL cache context.
`void`	`setDecimationValue(SoDecimationTypeElement.Types type)` Calls setDecimationValue(type, (float)1.0).
`void`	`setDecimationValue(SoDecimationTypeElement.Types type, float percentage)` Sets decimation percentage, the value should be a number between 0.0 and 1.0 Useful for reducing the number of triangles rendered in the scene.
`void`	`setDelayedObjDepthWrite(boolean flag)` Control whether delayed transparent objects update the depth buffer.
`void`	`setFastEditSavePolicy(SoGLRenderAction.FastEditSavePolicies policy)` Calls setFastEditSavePolicy(policy, false).
`void`	`setFastEditSavePolicy(SoGLRenderAction.FastEditSavePolicies policy, boolean fastEditDelayedObjects)` Sets fast editing save policy to use when rendering.
`void`	`setInvalidateCacheMode(SoGLRenderAction.InvalidateCacheModes icm)` Enables or disables the invalidation of render caches.
`void`	`setLogicalViewportRegion(SbViewportRegion newLogicalRegion)` Sets current logical viewport region to use for rendering.
`void`	`setNumPasses(int num)` Sets number of rendering passes for multipass antialiasing.
`void`	`setPassCallback(SoGLRenderPassCB func)`
`void`	`setPassCallback(SoGLRenderPassCB func, java.lang.Object userData)`
`void`	`setPassUpdate(boolean flag)` Sets a flag indicating whether intermediate results are displayed after each antialiasing pass for progressive improvement (default is false).
`void`	`setRenderingIsRemote(boolean flag)` Sets whether or not "remote" rendering is done.
`void`	`setSmoothing(boolean smooth)` Sets smoothing flag.
`void`	`setSortedLayersNumPasses(int num)` Sets the number of rendering passes used when transparency type is `SORTED_PIXELS_BLEND` or `DELAYED_SORTED_PIXELS_BLEND`.
`void`	`setSortedTrianglesNumCaches(int numCaches)` Sets the number of caches to use when the transparency type is SORTED_TRIANGLES_XXX or SORTED_OBJECT_TRIANGLES_XXX.
`void`	`setSortedTrianglesSortFrequency(int angle)` This method specifies the angle between each sorting axis when using the transparency type SORTED_TRIANGLES_XXX or SORTED_OBJECT_TRIANGLES_XXX.
`void`	`setTransparencyType(SoGLRenderAction.TransparencyTypes type)` Sets global transparency algorithm to use when rendering.
`void`	`setUpdateArea(SbVec2f origin, SbVec2f size)` Sets the current update area, which is the rectangular area of the viewport region that will actually be rendered into.
`void`	`setUpState()` initialize the action state.
`void`	`setViewportRegion(SbViewportRegion newRegion)` Changes viewport region to use for rendering.
`void`	`shouldAutoCache(SoGLRenderAction.AutoCacheModes mode)` Called by nodes to say that they should/shouldn't be auto-cached (pass true if should, false if shouldn't, don't call this method at all if the node doesn't care):
`void`	`updateTranspList(SoSensor sensor)` Deprecated. As of Open Inventor 9.1.

Methods inherited from class com.openinventor.inventor.actions.SoAction
apply, apply, clearApplyResult, forwardTraversal, getContinueActionInBranchFlag, getCurPath, getNodeAppliedTo, getOriginalPathListAppliedTo, getPathAppliedTo, getPathCode, getPathListAppliedTo, getPipeId, getSceneManager, getState, getWhatAppliedTo, hasTerminated, invalidateState, isBeingApplied, isLastPathListAppliedTo, isUsingAlternateRep, nullAction, resetContinueActionInBranchFlag, setPipeId, setSceneManager, stopActionInBranch, traverse, useAlternateRep

Methods inherited from class com.openinventor.inventor.Inventor
dispose, 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 SoGLRenderAction.TransparencyTypes.SCREEN_DOOR instead.
  - ADD
```
@Deprecated
public static final int ADD
```
    Deprecated. Use SoGLRenderAction.TransparencyTypes.ADD instead.
  - DELAYED_ADD
```
@Deprecated
public static final int DELAYED_ADD
```
    Deprecated. Use SoGLRenderAction.TransparencyTypes.DELAYED_ADD instead.
  - BLEND
```
@Deprecated
public static final int BLEND
```
    Deprecated. Use SoGLRenderAction.TransparencyTypes.BLEND instead.
  - DELAYED_BLEND
```
@Deprecated
public static final int DELAYED_BLEND
```
    Deprecated. Use SoGLRenderAction.TransparencyTypes.DELAYED_BLEND instead.
  - SORTED_OBJECT_ADD
```
@Deprecated
public static final int SORTED_OBJECT_ADD
```
    Deprecated. Use SoGLRenderAction.TransparencyTypes.SORTED_OBJECT_ADD instead.
  - SORTED_OBJECT_BLEND
```
@Deprecated
public static final int SORTED_OBJECT_BLEND
```
    Deprecated. Use SoGLRenderAction.TransparencyTypes.SORTED_OBJECT_BLEND instead.
  - SORTED_LAYERS_BLEND
```
@Deprecated
public static final int SORTED_LAYERS_BLEND
```
    Deprecated. Use SoGLRenderAction.TransparencyTypes.SORTED_LAYERS_BLEND instead.
  - SORTED_PIXELS_BLEND
```
@Deprecated
public static final int SORTED_PIXELS_BLEND
```
    Deprecated. Use SoGLRenderAction.TransparencyTypes.SORTED_PIXELS_BLEND instead.
  - DELAYED_SORTED_LAYERS_BLEND
```
@Deprecated
public static final int DELAYED_SORTED_LAYERS_BLEND
```
    Deprecated. Use SoGLRenderAction.TransparencyTypes.DELAYED_SORTED_LAYERS_BLEND instead.
  - DELAYED_SORTED_PIXELS_BLEND
```
@Deprecated
public static final int DELAYED_SORTED_PIXELS_BLEND
```
    Deprecated. Use SoGLRenderAction.TransparencyTypes.DELAYED_SORTED_PIXELS_BLEND instead.
  - SORTED_TRIANGLES_ADD
```
@Deprecated
public static final int SORTED_TRIANGLES_ADD
```
    Deprecated. Use SoGLRenderAction.TransparencyTypes.SORTED_TRIANGLES_ADD instead.
  - SORTED_TRIANGLES_BLEND
```
@Deprecated
public static final int SORTED_TRIANGLES_BLEND
```
    Deprecated. Use SoGLRenderAction.TransparencyTypes.SORTED_TRIANGLES_BLEND instead.
  - SORTED_OBJECT_TRIANGLES_ADD
```
@Deprecated
public static final int SORTED_OBJECT_TRIANGLES_ADD
```
    Deprecated. Use SoGLRenderAction.TransparencyTypes.SORTED_OBJECT_TRIANGLES_ADD instead.
  - SORTED_OBJECT_TRIANGLES_BLEND
```
@Deprecated
public static final int SORTED_OBJECT_TRIANGLES_BLEND
```
    Deprecated. Use SoGLRenderAction.TransparencyTypes.SORTED_OBJECT_TRIANGLES_BLEND instead.
  - NO_TRANSPARENCY
```
@Deprecated
public static final int NO_TRANSPARENCY
```
    Deprecated. Use SoGLRenderAction.TransparencyTypes.NO_TRANSPARENCY instead.
  - DISABLE
```
@Deprecated
public static final int DISABLE
```
    Deprecated. Use SoGLRenderAction.FastEditSavePolicies.DISABLE instead.
  - EACH_FRAME
```
@Deprecated
public static final int EACH_FRAME
```
    Deprecated. Use SoGLRenderAction.FastEditSavePolicies.EACH_FRAME instead.
  - WHEN_NEEDED
```
@Deprecated
public static final int WHEN_NEEDED
```
    Deprecated. Use SoGLRenderAction.FastEditSavePolicies.WHEN_NEEDED instead.
  - CONTINUE
```
@Deprecated
public static final int CONTINUE
```
    Deprecated. Use SoGLRenderAction.AbortCodes.CONTINUE instead.
  - ABORT
```
@Deprecated
public static final int ABORT
```
    Deprecated. Use SoGLRenderAction.AbortCodes.ABORT instead.
  - PRUNE
```
@Deprecated
public static final int PRUNE
```
    Deprecated. Use SoGLRenderAction.AbortCodes.PRUNE instead.
  - DELAY
```
@Deprecated
public static final int DELAY
```
    Deprecated. Use SoGLRenderAction.AbortCodes.DELAY instead.
  - OFF
```
@Deprecated
public static final int OFF
```
    Deprecated. Use SoGLRenderAction.InvalidateCacheModes.OFF instead.
  - ONCE
```
@Deprecated
public static final int ONCE
```
    Deprecated. Use SoGLRenderAction.InvalidateCacheModes.ONCE instead.
  - ALWAYS
```
@Deprecated
public static final int ALWAYS
```
    Deprecated. Use SoGLRenderAction.InvalidateCacheModes.ALWAYS instead.
  - DO_AUTO_CACHE
```
@Deprecated
public static final int DO_AUTO_CACHE
```
    Deprecated. Use SoGLRenderAction.AutoCacheModes.DO_AUTO_CACHE instead.
  - DONT_AUTO_CACHE
```
@Deprecated
public static final int DONT_AUTO_CACHE
```
    Deprecated. Use SoGLRenderAction.AutoCacheModes.DONT_AUTO_CACHE instead.
- Constructor Detail
  - SoGLRenderAction
```
public SoGLRenderAction(SbViewportRegion viewportRegion)
```
    Constructor. The parameter defines the viewport region into which rendering will take place.
- Method Detail
  - getSynchronizer
```
@Deprecated
public long getSynchronizer()
```
    Deprecated. As of Open Inventor 9.1.
    
    Internal use only.
  - setPassCallback
```
public void setPassCallback(SoGLRenderPassCB func)
```
  - setPassCallback
```
public void setPassCallback(SoGLRenderPassCB func,
                            java.lang.Object userData)
```
  - updateTranspList
```
@Deprecated
public void updateTranspList(SoSensor sensor)
```
    Deprecated. As of Open Inventor 9.1.
    
    This is an internal method. It should not be called by user.
  - howToRenderScene
```
@Deprecated
public void howToRenderScene(SoSensor sensor,
                                          boolean newRender)
```
    Deprecated. As of Open Inventor 9.1.
    
    This is an internal method. It should not be called by user.
  - isSortedLayersSupported
```
public static boolean isSortedLayersSupported()
```
    Calls isSortedLayersSupported((com.openinventor.inventor.misc.SoState)null).
  - handleTransparency
```
public boolean handleTransparency()
```
    Calls handleTransparency(false, false).
  - setFastEditSavePolicy
```
public void setFastEditSavePolicy(SoGLRenderAction.FastEditSavePolicies policy)
```
    Calls setFastEditSavePolicy(policy, false).
  - resetFrameCounter
```
public void resetFrameCounter()
```
    Calls resetFrameCounter((int)0).
  - setDecimationValue
```
public void setDecimationValue(SoDecimationTypeElement.Types type)
```
    Calls setDecimationValue(type, (float)1.0).
  - handleTransparency
```
public boolean handleTransparency(boolean isTransparent)
```
    Calls handleTransparency(isTransparent, false).
  - setDecimationValue
```
public void setDecimationValue(SoDecimationTypeElement.Types type,
                               float percentage)
```
    Sets decimation percentage, the value should be a number between 0.0 and 1.0 Useful for reducing the number of triangles rendered in the scene.
  - setTransparencyType
```
public void setTransparencyType(SoGLRenderAction.TransparencyTypes type)
```
    Sets global transparency algorithm to use when rendering. . The default is SCREEN_DOOR, but SORTED_PIXELS_BLEND is recommended for most cases. See also getTransparencyType(). Transparency handling can be completely disabled by setting NO_TRANSPARENCY.
    The global transparency algorithm can also be set using a method in the viewer class (e.g. SoWinRenderArea.setTransparencyType()). The transparency type can also be set for a portion of the scene graph using the SoTransparencyType node (for all types except SORTED_PIXELS_BLEND and DELAYED_SORTED_PIXELS_BLEND).
    The default value for this field can be set using the environment variable OIV_TRANSPARENCY_TYPE.
    See SoTransparencyType for more discussion about transparency.
    Notes:
    - SCREEN_DOOR 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.
    - When using transparency types with DELAYED in the name, 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.
    - 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.
  - getTransparencyType
```
public SoGLRenderAction.TransparencyTypes getTransparencyType()
```
    Returns transparency quality level to use when rendering. See setTransparencyType().
  - setUpdateArea
```
public void setUpdateArea(SbVec2f origin,
                          SbVec2f size)
```
    Sets the current update area, which is the rectangular area of the viewport region that will actually be rendered into. This can be used for partial updates in applications that can manage them. The update area is specified in normalized viewport coordinates, where (0,0) is the lower left corner of the viewport and (1,1) is the upper right corner. The area is specified or returned as an origin and a size.
  - getUpdateArea
```
public SbVec2f[] getUpdateArea()
```
    Returns the current update area. See setUpdateArea() for details.
  - resetFrameCounter
```
public void resetFrameCounter(int count)
```
    Reset the frame counter. Do not call this method during a traversal.
  - setRenderingIsRemote
```
public void setRenderingIsRemote(boolean flag)
```
    Sets whether or not "remote" rendering is done. Inventor's auto-render-caching algorithm will choose to cache more often when rendering is remote (the assumption being that performance will be better with display lists stored on the remote machine). By default, it is assumed rendering is NOT remote.
  - isUsedCacheContext
```
public static boolean isUsedCacheContext(int context)
```
    Returns true if the specified cache context id is currently used by any SoGLRenderAction.
  - generateCacheContext
```
public static int generateCacheContext()
```
    Generates and returns a new cache context id. The returned cache context id can then be used to pass to the setCacheContext() method call.
  - shouldAutoCache
```
public void shouldAutoCache(SoGLRenderAction.AutoCacheModes mode)
```
    Called by nodes to say that they should/shouldn't be auto-cached (pass true if should, false if shouldn't, don't call this method at all if the node doesn't care):
  - getRenderingIsRemote
```
public boolean getRenderingIsRemote()
```
    Returns true if remote rendering is being done.
  - getLogicalViewportRegion
```
public SbViewportRegion getLogicalViewportRegion()
```
    Returns current logical viewport region.
  - setSortedTrianglesSortFrequency
```
public void setSortedTrianglesSortFrequency(int angle)
```
    This method specifies the angle between each sorting axis when using the transparency type SORTED_TRIANGLES_XXX or SORTED_OBJECT_TRIANGLES_XXX.
    Transparent triangles are sorted based on the nearest axis. (in terms of the dot (inner) product). If the triangles have already been sorted on this axis (or the opposite), and the sort result is cached, the triangles are rendered using the cached information.
    The default value for sort frequency is 90, meaning that a sorting is made every 90 degrees. If the value is 0, sorting is always done and the camera orientation vector is the axis used for sorting. In this case, no cache is made.
    The allowable angular increments for the sort angle are the integer divisors of 90: { 1, 2, 3, 5, 6, 9, 10, 15, 18, 30, 45, 90 }. If the input value is not an integer divisor of 90, Open Inventor will use the next highest integer divisor of 90.
    Examples:
    - angle=67 => sort axes every 90 degrees
    - angle=45 => sort axes every 45 degrees
    - angle=37 => sort axes every 45 degrees
    Input values will be clamped to the range 0 to 90.
    The following figures show the sort axes used for sort frequencies of 90 degrees and 45 degrees.
  - setInvalidateCacheMode
```
public void setInvalidateCacheMode(SoGLRenderAction.InvalidateCacheModes icm)
```
    Enables or disables the invalidation of render caches.
    - When set to ALWAYS, the caches are invalidated for each SoSeparator node before its children are traversed. No new caches will be built. This value forces all nodes to be visited during each render traversal.
    - When set to ONCE, the caches are invalidated for each SoSeparator node before its children are traversed. The invalidate cache mode is automatically changed to OFF at the end of the traversal.
    - When set to OFF (default), caches are managed by their respective render caching nodes in the usual way.
    This method is useful to force all nodes to be visited during render traversal.
  - getDecimationPercentage
```
public float getDecimationPercentage()
```
    Gets decimation percentage, the value should be a number between 0.0 and 1.0.
  - setSortedTrianglesNumCaches
```
public void setSortedTrianglesNumCaches(int numCaches)
```
    Sets the number of caches to use when the transparency type is SORTED_TRIANGLES_XXX or SORTED_OBJECT_TRIANGLES_XXX. This specifies the number of lists of sorted triangles to keep in memory in order to render transparent triangles more quickly.
    When computing a new list of sorted triangles, if an empty cache is available, it is used. Else, the farthest axis from the camera orientation axis is replaced in the cache. The default number of caches is 3.
  - getSortedTrianglesSortFrequency
```
public int getSortedTrianglesSortFrequency()
```
    Returns the sort frequency used for the SORTED_TRIANGLES_XXX and SORTED_OBJECT_TRIANGLES_XXX transparency types.
  - getSortedTrianglesNumCaches
```
public int getSortedTrianglesNumCaches()
```
    Returns the maximum number of caches allowed for the sorted triangles transparency types.
  - getInvalidateCacheMode
```
public SoGLRenderAction.InvalidateCacheModes getInvalidateCacheMode()
```
    Returns the current cache invalidation mode.
  - setViewportRegion
```
public void setViewportRegion(SbViewportRegion newRegion)
```
    Changes viewport region to use for rendering.
  - getViewportRegion
```
public SbViewportRegion getViewportRegion()
```
    Returns viewport region to use for rendering.
  - setLogicalViewportRegion
```
public void setLogicalViewportRegion(SbViewportRegion newLogicalRegion)
```
    Sets current logical viewport region to use for rendering. Setting an empty viewport region (0,0) unsets the logical viewport.
  - getDecimationType
```
public SoDecimationTypeElement.Types getDecimationType()
```
    Gets decimation type.
  - getFrameCounter
```
public int getFrameCounter()
```
    Returns the current frame counter. The frame counter starts at zero and is automatically incremented each time the action is applied. The frame counter will have the same value throughout a single apply, even if there are multiple render passes, delayed rendering, etc.
  - setUpState
```
public void setUpState()
```
    initialize the action state.
    
    Overrides:
    
    setUpState in class SoAction
  - setNumPasses
```
public void setNumPasses(int num)
```
    Sets number of rendering passes for multipass antialiasing. The default is 1. Specifying more than one pass will result in antialiasing of the rendered scene, using OpenGL's accumulation buffer. (Camera nodes typically move their viewpoints a little bit for each pass to achieve the antialiasing.) Each additional pass provides better antialiasing, but requires more rendering time.
    The default value can be set using the environment variable OIV_NUM_RENDER_PASSES.
    NOTE: Multipass antialiasing can have very poor performance for large scenes. Full-scene antialiasing (multi-sample) is strongly recommended when the hardware supports it. See SoSceneManager and SoFullSceneAntialiasing.
  - setDelayedObjDepthWrite
```
public void setDelayedObjDepthWrite(boolean flag)
```
    Control whether delayed transparent objects update the depth buffer. By default they do not (historical behavior)
  - setPassUpdate
```
public void setPassUpdate(boolean flag)
```
    Sets a flag indicating whether intermediate results are displayed after each antialiasing pass for progressive improvement (default is false).
  - handleTransparency
```
public boolean handleTransparency(boolean isTransparent,
                                  boolean isLinesOrPoints)
```
  - getNumPasses
```
public int getNumPasses()
```
    Gets number of rendering passes for multipass rendering.
  - isSmoothing
```
public boolean isSmoothing()
```
    Returns smoothing flag.
  - getFastEditSavePolicy
```
public SoGLRenderAction.FastEditSavePolicies getFastEditSavePolicy()
```
    Returns fast editing save policy used when rendering.
  - postDelayedTraversal
```
public void postDelayedTraversal()
```
    Method called by SoMultiPassManager after delayed pass traversals. Overriding this method can be done action that may want to apply some post processing after all delayed passes traversal.
    
    Overrides:
    
    postDelayedTraversal in class SoAction
    
    Since:
    
    Open Inventor 9.1
  - setFastEditSavePolicy
```
public void setFastEditSavePolicy(SoGLRenderAction.FastEditSavePolicies policy,
                                  boolean fastEditDelayedObjects)
```
    Sets fast editing save policy to use when rendering. The default is WHEN_NEEDED. Valid values are DISABLE, EACH_FRAME, and WHEN_NEEDED. See SoSeparator.
    If fastEditDelayedObjects is set to true, delayed objects won't be redrawn when editing the scene graph. It means that the composition between delayed transparent objects and the fast edit scene graph won't be correct, but rendering will be much faster if there are a lot of transparent objects.
    Limitations: Using fast edit can lead to visual artifacts when overlay support is enabled. In this case, we recommend to set the OIV_BUFFER_REGION_ENABLE environment variable to 0. The rendering performance of fast edit will be somewhat lower, but resulting rendering will be correct.
  - getDelayedObjDepthWrite
```
public boolean getDelayedObjDepthWrite()
```
    Returns whether delayed transparent objects update the depth buffer. By default they do not (historical behavior)
  - setSmoothing
```
public void setSmoothing(boolean smooth)
```
    Sets smoothing flag. When on, smoothing uses OpenGL's line- and point-smoothing features to provide cheap antialiasing of lines and points. Smoothing is required to render points as circles instead of squares. The default is false.
    The default value can be set using the environment variable OIV_GL_SMOOTHING (0 = false, 1 = true).
  - preDelayedTraversal
```
public boolean preDelayedTraversal()
```
    Method called by SoMultiPassManager before delayed pass traversals. Overriding this method can be done action that may want to discard the traversal of all delayed passes. Returning false aborts the delayed passes traversal.
    
    Overrides:
    
    preDelayedTraversal in class SoAction
    
    Since:
    
    Open Inventor 9.1
  - abortNow
```
public boolean abortNow()
```
  - enableElement
```
public static void enableElement(java.lang.Class<? extends Inventor> t,
                                 int stkIndex)
```
  - getSortedLayersNumPasses
```
public int getSortedLayersNumPasses()
```
    Returns the number of rendering passes used when transparency type is SORTED_PIXELS_BLEND.
  - isDoingDepthPeeling
```
public boolean isDoingDepthPeeling()
```
    Return true if depth peeling is active.
  - isAlphaTest
```
public boolean isAlphaTest()
```
    Returns whether the OpenGL alpha test is enabled for rendering.
  - isSortedLayersSupported
```
public static boolean isSortedLayersSupported(SoState state)
```
    Indicates if SORTED_PIXELS_BLEND transparency is supported by your graphics board on the current context.
  - setAlphaTest
```
public void setAlphaTest(boolean flag)
```
    Enable or disable the OpenGL alpha test for rendering. Default is false (alpha test disabled) and the default test is "not equal to zero". The alpha test operates on all pixel writes, including those resulting from the scan conversion of points, lines, polygons, and bitmaps, and from pixel draw and copy operations. It does not affect screen clear operations.
    For example, if rendering with textures containing "binary" alpha values (0 or 1), the alpha test may be faster than blended transparency and does not require the use of delayed rendering transparency types.
    The default value can be set using the environment variable OIV_ALPHA_TEST (0 = false, 1 = true).
  - setSortedLayersNumPasses
```
public void setSortedLayersNumPasses(int num)
```
    Sets the number of rendering passes used when transparency type is SORTED_PIXELS_BLEND or DELAYED_SORTED_PIXELS_BLEND. Default is 4.
    Note: Since Open Inventor 9.4, if the hardware supports the necessary OpenGL features, these transparency modes are implemented using a single-pass, order-independent fragment sorting (A-buffer) algorithm. Therefore the value of this field is not used except in two special cases:
    - If hardware support for single pass transparency is not available, then the previous "depth peeling" algorithm is used (which normally requires multiple passes), or
    - If volume rendering (see SoVolumeRender) is combined with geometry rendering, then multiple layers of transparency information are required and this field specifies the number of layers.
    Use more passes for more correct transparency. Usually four passes (which is the default value) gives good results. For example, the number of passes needed for rendering an opaque sphere behind two cubes is the number of planes separating the sphere from the viewer (plus 1 in SORTED_PIXELS_BLEND). So, when backface culling is enabled, 2 faces separate the sphere from the viewer: the front face of the first cube and the front face of the second cube. The number of passes needed in this case is 3 in SORTED_PIXELS_BLEND and 2 in DELAYED_SORTED_PIXELS_BLEND.
    The default value for this field can be set using the environment variable OIV_NUM_SORTED_LAYERS_PASSES.
  - setCacheContext
```
public void setCacheContext(int context)
```
    Sets the OpenGL cache context. A cache context is just an integer identifying when OpenGL display lists (which are used for render caching) can be shared between render actions; for example, see the documentation on GLX contexts for information on when OpenGL display lists can be shared between GLX windows. See generateCacheContext(). Note: The value 0xFFFFFFFF (~0) is reserved to represent an undefined id.
  - getCurPass
```
public int getCurPass()
```
  - isPassUpdate
```
public boolean isPassUpdate()
```
    Returns a flag indicating whether intermediate results are displayed after each antialiasing pass for progressive improvement. The default value can be set using the environment variable OIV_ANTIALIAS_PASS_UPDATE.
  - getDepthPeelingPass
```
public int getDepthPeelingPass()
```
    Get the current pass of depth peeling, -1 if not doing depth peeling.
  - getCacheContext
```
public int getCacheContext()
```
    Returns the OpenGL cache context id for this action.
  - enableDepthPeeling3D
```
public void enableDepthPeeling3D(boolean flag)
```
    Use 3D texturing instead of 2D for the fixed functionality emulation in depth peeling.

Class SoGLRenderAction

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.actions.SoAction

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

Field Summary

Fields inherited from class com.openinventor.inventor.actions.SoAction

Fields inherited from class com.openinventor.inventor.Inventor

Constructor Summary

Method Summary

Methods inherited from class com.openinventor.inventor.actions.SoAction

Methods inherited from class com.openinventor.inventor.Inventor

Methods inherited from class java.lang.Object

Field Detail

SCREEN_DOOR

ADD

DELAYED_ADD

BLEND

DELAYED_BLEND

SORTED_OBJECT_ADD

SORTED_OBJECT_BLEND

SORTED_LAYERS_BLEND

SORTED_PIXELS_BLEND

DELAYED_SORTED_LAYERS_BLEND

DELAYED_SORTED_PIXELS_BLEND

SORTED_TRIANGLES_ADD

SORTED_TRIANGLES_BLEND

SORTED_OBJECT_TRIANGLES_ADD

SORTED_OBJECT_TRIANGLES_BLEND

NO_TRANSPARENCY

DISABLE

EACH_FRAME

WHEN_NEEDED

CONTINUE

ABORT

PRUNE

DELAY

OFF

ONCE

ALWAYS

DO_AUTO_CACHE

DONT_AUTO_CACHE

Constructor Detail

SoGLRenderAction

Method Detail

getSynchronizer

setPassCallback

setPassCallback

updateTranspList

howToRenderScene

isSortedLayersSupported

handleTransparency

setFastEditSavePolicy

resetFrameCounter

setDecimationValue

handleTransparency

setDecimationValue

setTransparencyType

getTransparencyType

setUpdateArea

getUpdateArea

resetFrameCounter

setRenderingIsRemote

isUsedCacheContext

generateCacheContext

shouldAutoCache

getRenderingIsRemote

getLogicalViewportRegion

setSortedTrianglesSortFrequency

setInvalidateCacheMode

getDecimationPercentage

setSortedTrianglesNumCaches

getSortedTrianglesSortFrequency

getSortedTrianglesNumCaches

getInvalidateCacheMode

setViewportRegion

getViewportRegion

setLogicalViewportRegion

getDecimationType

getFrameCounter

setUpState