SoBBox Class Reference

Bounding box node. More...

#include <Inventor/nodes/SoBBox.h>

Inheritance diagram for SoBBox:

Public Types
enum	Mode {   DISABLE ,   NO_BOUNDING_BOX ,   USER_DEFINED }
	This enum specifies how the node interacts with OpenInventor during a traversal. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoBBox ()
	Constructor.
Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.
virtual SbBool	isOverride () const
	Returns the state of the override flag.
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().
static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFEnum	mode
	Specifies the behavior of the SoBBox node.
SoSFBox3f	boundingBox
	Application-defined bounding box.

Detailed Description

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.

Definition at line 72 of file SoBBox.h.

Member Enumeration Documentation

Mode

enum SoBBox::Mode

This enum specifies how the node interacts with OpenInventor during a traversal.

Enumerator
DISABLE	The node doesn't do anything.
NO_BOUNDING_BOX	SoGetBoundingBoxAction will ignore subsequent nodes in this portion of the scene graph (as if the nodes don't exist).
USER_DEFINED	SoGetBoundingBoxAction will ignore subsequent nodes in this portion of the scene graph and use the box specified in the boundingBox field as the bounding box of those nodes. When the complexity type is BOUNDING_BOX (see SoComplexity), SoGLRenderAction will ignore subsequent nodes in this portion of the scene graph and render the box specified in the boundingBox field.

Definition at line 81 of file SoBBox.h.

Constructor & Destructor Documentation

SoBBox()

SoBBox::SoBBox

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType SoBBox::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoBBox::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Member Data Documentation

boundingBox

SoSFBox3f SoBBox::boundingBox

Application-defined bounding box.

Definition at line 114 of file SoBBox.h.

mode

SoSFEnum SoBBox::mode

Specifies the behavior of the SoBBox node.

Use enum Mode. Default is DISABLE.

Definition at line 109 of file SoBBox.h.

---

The documentation for this class was generated from the following file:

• Inventor/nodes/SoBBox.h