com.openinventor.inventor.nodes

Class SoBBox

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

All Implemented Interfaces:

SafeDisposable

public class SoBBox
extends SoNode

Bounding box node. This class specifies a bounding box during scene graph traversal. This allows the application to use an application defined bounding box or to stop a getBoundingBox action for the current scene graph branch. Note: if a projection is defined in the scene graph, the SoBBox is ignored.

This can be useful, for example:

• To specify the bounding box of some very large geometry.
  For example to avoid the CPU time to calculate the bounding box. (Use mode = USER_DEFINED)
• To "hide" some geometry from the bounding box calculation.
  For example to avoid having annotation geometry, like legends and titles, affect the viewer's viewAll operation. (Use mode = NO_BOUNDING_BOX)

File format/default:

BBox {

mode	DISABLE
boundingBox	0 0 0 0 0 0

}

Action behavior:

SoGLRenderAction
If enabled, draws the specified bbox when complexity type = BOUNDING_BOX.

SoGetBoundingBoxAction
If enabled, stops traversal of this portion of the scene graph and, if mode = USER_DEFINED, adds the specified bbox to the accumulated bbox.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoBBox.Modes This enum specifies how the node interacts with OpenInventor during a traversal.

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

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFBox3f	boundingBox Application-defined bounding box.
static int	DISABLE Deprecated. Use SoBBox.Modes.DISABLE instead.
SoSFEnum<SoBBox.Modes>	mode Specifies the behavior of the SoBBox node.
static int	NO_BOUNDING_BOX Deprecated. Use SoBBox.Modes.NO_BOUNDING_BOX instead.
static int	USER_DEFINED Deprecated. Use SoBBox.Modes.USER_DEFINED instead.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoBBox() 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

DISABLE

@Deprecated
public static final int DISABLE

Deprecated. Use SoBBox.Modes.DISABLE instead.

NO_BOUNDING_BOX

@Deprecated
public static final int NO_BOUNDING_BOX

Deprecated. Use SoBBox.Modes.NO_BOUNDING_BOX instead.

USER_DEFINED

@Deprecated
public static final int USER_DEFINED

Deprecated. Use SoBBox.Modes.USER_DEFINED instead.

mode

public final SoSFEnum<SoBBox.Modes> mode

Specifies the behavior of the SoBBox node. . Default is DISABLE.

boundingBox

public final SoSFBox3f boundingBox

Application-defined bounding box.

Constructor Detail

SoBBox

public SoBBox()

Constructor.