Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
SoComputeBoundingBox Class Reference

Computes the bounding box and center of a scene graph. More...

#include <Inventor/engines/SoComputeBoundingBox.h>

+ Inheritance diagram for SoComputeBoundingBox:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoComputeBoundingBox ()
 Constructor.
 
void setViewportRegion (const SbViewportRegion &vpReg)
 Sets the viewport region to use for the bounding box computation.
 
const SbViewportRegiongetViewportRegion () const
 Returns the viewport region to use for the bounding box computation.
 
- Public Member Functions inherited from SoEngine
virtual int getOutputs (SoEngineOutputList &list) const
 Returns a list of outputs in this engine.
 
SoEngineOutputgetOutput (const SbName &outputName) const
 Returns a reference to the engine output with the given name.
 
SbBool getOutputName (const SoEngineOutput *output, SbName &outputName) const
 Returns (in outputName) the name of the engine output (output).
 
SoEnginecopy () const
 Creates and returns an exact copy of the engine.
 
- 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 SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (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 void touch ()
 Marks an instance as modified, simulating a change to it.
 
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 SoEngine
static SoType getClassTypeId ()
 Returns the type identifier for the SoEngine class.
 
static SoEnginegetByName (const SbName &name)
 Looks up engine(s) by name.
 
static int getByName (const SbName &name, SoEngineList &list)
 Looks up engine(s) by name.
 
- 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

SoSFNode node
 Defines the graph for which the bounding box is computed.
 
SoSFPath path
 Alternatively, defines the graph for which the bounding box is computed.
 
SoEngineOutput min
 ( SoSFVec3f ) Minimum point of the computed bounding box.
 
SoEngineOutput max
 ( SoSFVec3f ) Maximum point of the computed bounding box.
 
SoEngineOutput boxCenter
 ( SoSFVec3f ) Center of the computed bounding box.
 
SoEngineOutput objectCenter
 ( SoSFVec3f ) Center of the objects in the graph.
 

Detailed Description

Computes the bounding box and center of a scene graph.

This engine computes the bounding box and center of a scene graph. The scene graph can be defined by a path or by a root node.

If the path input is not NULL, the bounding box of the graph defined by the path will be computed. If path is NULL, but the node input is not NULL, the bounding box is computed on the graph rooted by the node. By default, the two inputs are NULL. If both the inputs are NULL, the outputs are disabled.

The engine uses a default viewport region. If the graph includes screen-based objects (such as SoText2) you can call setViewportRegion() on the engine instance to set up the correct viewport region to use.

FILE FORMAT/DEFAULT

    ComputeBoundingBox {
    node NULL
    path NULL
    }

SEE ALSO

SoEngineOutput, SoGetBoundingBoxAction, SbBox3f

Definition at line 121 of file SoComputeBoundingBox.h.

Constructor & Destructor Documentation

◆ SoComputeBoundingBox()

SoComputeBoundingBox::SoComputeBoundingBox ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoComputeBoundingBox::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoComputeBoundingBox::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

◆ getViewportRegion()

const SbViewportRegion & SoComputeBoundingBox::getViewportRegion ( ) const

Returns the viewport region to use for the bounding box computation.

◆ setViewportRegion()

void SoComputeBoundingBox::setViewportRegion ( const SbViewportRegion vpReg)

Sets the viewport region to use for the bounding box computation.

Member Data Documentation

◆ boxCenter

SoEngineOutput SoComputeBoundingBox::boxCenter

( SoSFVec3f ) Center of the computed bounding box.

Definition at line 146 of file SoComputeBoundingBox.h.

◆ max

SoEngineOutput SoComputeBoundingBox::max

( SoSFVec3f ) Maximum point of the computed bounding box.

Definition at line 142 of file SoComputeBoundingBox.h.

◆ min

SoEngineOutput SoComputeBoundingBox::min

( SoSFVec3f ) Minimum point of the computed bounding box.

Definition at line 138 of file SoComputeBoundingBox.h.

◆ node

SoSFNode SoComputeBoundingBox::node

Defines the graph for which the bounding box is computed.

Definition at line 129 of file SoComputeBoundingBox.h.

◆ objectCenter

SoEngineOutput SoComputeBoundingBox::objectCenter

( SoSFVec3f ) Center of the objects in the graph.

Definition at line 150 of file SoComputeBoundingBox.h.

◆ path

SoSFPath SoComputeBoundingBox::path

Alternatively, defines the graph for which the bounding box is computed.

Definition at line 133 of file SoComputeBoundingBox.h.


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