com.openinventor.inventor.nodes

Class SoOcclusionCulling

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.SoGroup

com.openinventor.inventor.nodes.SoSeparator

com.openinventor.inventor.nodes.SoRenderList

com.openinventor.inventor.nodes.SoOcclusionCulling

All Implemented Interfaces:

SafeDisposable

Deprecated.

As of Open Inventor 9800 See documentation for more details

public class SoOcclusionCulling
extends SoRenderList

Group node derived from SoRenderList that performs an OpenGL-based occlusion culling test on its list of render objects. The SoOcclusionCulling node uses the functionality from SoRenderList to create a list of paths to the shapes beneath it. It then reorganizes the list of shapes from front to back to perform an OpenGL-based occlusion culling test. The result is that render objects completely hidden by another visible object are not rendered. For instance, if the camera is inside an object, only the object containing the camera will be drawn (because that's the only object that the camera can see).

<font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later.

The SoOcclusionCulling node depends on the graphics board having support for the OpenGL GL_HP_occlusion_test extension. If this OpenGL extension is not supported, the SoOcclusionCulling node will have no effect on the display of the scene graph.

If the occlusionCulling node is below another culling node (for instance, an octree and an occlusion culling node) then it will use the renderObject list computed by the RenderList above it (the octree). In this particular case, the isHead field (from SoRenderList) must be initialized to false. Otherwise the node will create its own renderObject list, which is unnecessary and time consuming at scene graph creation time.

File format/default:

OcclusionCulling {

renderCaching	AUTO
boundingBoxCaching	AUTO
renderCulling	AUTO
pickCulling	AUTO
fastEditing	DISABLE
isHead	true

}

Action behavior:

Actions use standard SoSeparator traversal.

See also:

SoRenderList, SoOctreeOrderingDeprecated since Open Inventor 9800
SoOcclusionCulling has been deprecated and will be removed in next major version. Please use SoSeparator instead.

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.nodes.SoSeparator

SoSeparator.Cachings, SoSeparator.FastEditings, SoSeparator.RenderUnitIds

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

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.nodes.SoRenderList

isHead

Fields inherited from class com.openinventor.inventor.nodes.SoSeparator

AUTO, boundingBoxCaching, CLEAR_ZBUFFER, directVizCaching, DISABLE, fastEditing, KEEP_ZBUFFER, OFF, ON, pickCulling, renderCaching, renderCulling, renderUnitId

Fields inherited from class com.openinventor.inventor.nodes.SoGroup

boundingBoxIgnoring

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoOcclusionCulling() Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
int	getNumFrame() Deprecated. Returns the number of frames between recalculation of the list of occluders when approximate occlusion is On.
int	getThreshold() Deprecated. Returns the pixel threshold.
boolean	getUseHPExtension() Deprecated. Returns true if the GL_HP_occlusion_test test is used instead of GL_NV_occlusion_query test.
boolean	isApproximateOcclusion() Deprecated. Returns true if approximate occlusion is On.
void	setApproximateOcclusion(boolean enable) Deprecated. Enabling this option may speed up rendering.
void	setNumFrame(int num) Deprecated. When approximate occlusion is On, after num frames, the list of occluders will be recalculated.
void	setThreshold(int threshold) Deprecated. Specifies the number of pixels below which the object will be culled.
void	setUseHPExtension(boolean enable) Deprecated. By default, and if the hardware supports it, during the n-1 frames where occluders are not retested, occluded objects are tested with a more efficient test using the GL_NV_occlusion_query extension.

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

addRenderObjectClass, addRenderObjectName, getNumRenderObjectNames, getNumRenderObjectTypes, getRenderObjectClass, getRenderObjectName, removeAllRenderObjectNames, removeRenderObjectClass, removeRenderObjectName

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

getNumRenderCaches, setNumRenderCaches

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

addChild, findChild, getChild, getNumChildren, insertChild, removeAllChildren, removeChild, removeChild, replaceChild, replaceChild

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

Constructor Detail

SoOcclusionCulling

public SoOcclusionCulling()

Deprecated.

Constructor.

Method Detail

setThreshold

public void setThreshold(int threshold)

Deprecated.

Specifies the number of pixels below which the object will be culled. The graphics board must support the GL_NV_occlusion_query OpenGL extension, otherwise this method has no effect.

getUseHPExtension

public boolean getUseHPExtension()

Deprecated.

Returns true if the GL_HP_occlusion_test test is used instead of GL_NV_occlusion_query test. See setUseHPExtension.

setUseHPExtension

public void setUseHPExtension(boolean enable)

Deprecated.

By default, and if the hardware supports it, during the n-1 frames where occluders are not retested, occluded objects are tested with a more efficient test using the GL_NV_occlusion_query extension. If you prefer that the GL_NV_occlusion_query extension not be used, pass true to this function; the GL_HP_occlusion_test extension will be used instead.

setNumFrame

public void setNumFrame(int num)

Deprecated.

When approximate occlusion is On, after num frames, the list of occluders will be recalculated.

getNumFrame

public int getNumFrame()

Deprecated.

Returns the number of frames between recalculation of the list of occluders when approximate occlusion is On.

getThreshold

public int getThreshold()

Deprecated.

Returns the pixel threshold.

setApproximateOcclusion

public void setApproximateOcclusion(boolean enable)

Deprecated.

Enabling this option may speed up rendering. During the first frame, a list of occluders (objects that occlude others) will be computed. Then during the next N frames, only previously occluded objects will be tested against the previous occluders.

isApproximateOcclusion

public boolean isApproximateOcclusion()

Deprecated.

Returns true if approximate occlusion is On.