Open Inventor Reference
SoComputeBoundingBox Class Reference

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

#include <Inventor/engines/SoComputeBoundingBox.h>

Inheritance diagram for SoComputeBoundingBox:
SoEngine SoFieldContainer SoBase

Public Member Functions

 SoComputeBoundingBox ()
 Constructor. More...
 
void setViewportRegion (const SbViewportRegion &vpReg)
 Sets the viewport region to use for the bounding box computation. More...
 
const SbViewportRegiongetViewportRegion () const
 
- Public Member Functions inherited from SoEngine
virtual int getOutputs (SoEngineOutputList &list) const
 Returns a list of outputs in this engine. More...
 
SoEngineOutputgetOutput (const SbName &outputName) const
 Returns a pointer to the engine output with the given name. More...
 
bool getOutputName (const SoEngineOutput *output, SbName &outputName) const
 Returns (in outputName) the name of the engine output (output). More...
 
SoEnginecopy () const
 Creates and returns an exact copy of the engine. More...
 
void evaluateWrapper ()
 wrapper for the user's evaluate() engine More...
 
virtual void notify (SoNotList *list)
 Propagates modification notification through an instance. More...
 
virtual const SoEngineOutputDatagetOutputData () const =0
 Info on outputs: More...
 
virtual void writeInstance (SoOutput *out)
 Writes instance to SoOutput. (Used only for last stage of writing) More...
 
virtual SoFieldContainercopyThroughConnection () const
 Copies an instance that is encountered through a field connection. More...
 
bool shouldCopy () const
 Recursive procedure that determines if this engine should be copied during a copy operation, or just referenced as is. More...
 
bool isNotifying () const
 A very annoying double notification occurs with engines that enable their outputs during inputChanged; this flag prevents that: More...
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values. More...
 
bool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values. More...
 
bool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields. More...
 
void copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields. More...
 
bool 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 Inventor file format. More...
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Inventor ASCII file format in the given string. More...
 
virtual int getFields (SoFieldList &list) const
 Appends pointers to all of this object's fields to resultList, and returns the number of fields appended. More...
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a pointer to the field with the given name. More...
 
bool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument. More...
 
bool enableNotify (bool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE). More...
 
bool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed. More...
 
bool set (const char *fieldDataString, SoInput *dictIn)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format. More...
 
void get (SbString &fieldDataString, SoOutput *dictOut)
 Returns the values of the fields of this object in the Inventor ASCII file format in the given string. More...
 
virtual void addWriteReference (SoOutput *out, bool isFromField=FALSE)
 Adds a reference to the instance when writing. More...
 
bool getIsBuiltIn () const
 Returns whether or not instance is considered 'built-in' to the library. More...
 
virtual const SoFieldDatagetFieldData () const
 Returns an SoFieldData structure for the node. More...
 
virtual void copyContents (const SoFieldContainer *fromFC, bool copyConnections)
 Copies the contents of the given node into this instance. More...
 
void addManagedSensor (SoSensor *sensor)
 Adds a sensor which is managed by the field container. More...
 
- Public Member Functions inherited from SoBase
void ref () const
 Adds and removes a reference to an instance. More...
 
void unref () const
 
void unrefNoDelete () const
 
void touch ()
 Marks an instance as modified, simulating a change to it. More...
 
virtual SoType getTypeId () const =0
 Returns the type identifier for a specific instance. More...
 
bool isOfType (SoType type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type. More...
 
virtual SbName getName () const
 Returns the name of an instance. More...
 
virtual void setName (const SbName &name)
 Sets the name of an instance. More...
 
virtual void startNotify ()
 Initiates notification from an instance. More...
 
void addAuditor (void *auditor, SoNotRec::Type type)
 Adds/removes an auditor to/from list. More...
 
void removeAuditor (void *auditor, SoNotRec::Type type)
 
const SoAuditorListgetAuditors ()
 Returns auditor list– used by SoField and SoEngineOutput to trace forward connections. More...
 
int getRefCount () const
 Returns current reference count. More...
 
bool shouldWrite ()
 Returns TRUE if the instance should be written, based on the write-reference info already accumulated. More...
 

Static Public Member Functions

static void initClass ()
 
- Static Public Member Functions inherited from SoEngine
static SoType getClassTypeId ()
 Returns the type identifier for the SoEngine class. More...
 
static SoEnginegetByName (const SbName &name)
 Look up engine(s) by name. More...
 
static int getByName (const SbName &name, SoEngineList &list)
 Look up engine(s) by name. More...
 
static void initClass ()
 Initializes base engine class. More...
 
static void initClasses ()
 Initialize ALL Inventor engine classes. More...
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class. More...
 
static void initClass ()
 Setup type information. More...
 
static void initCopyDict ()
 During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used. More...
 
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
 Adds an instance to the dictionary. More...
 
static SoFieldContainercheckCopy (const SoFieldContainer *orig)
 If a copy of the given instance is in the dictionary, this returns it. More...
 
static SoFieldContainerfindCopy (const SoFieldContainer *orig, bool copyConnections)
 If a copy of the given instance is not in the dictionary, this returns NULL. More...
 
static void copyDone ()
 Cleans up the dictionary when done. More...
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class. More...
 
static void initClass ()
 Setup type information. More...
 
static void incrementCurrentWriteCounter ()
 Increments the current write counter at the start of a write operation. More...
 
static void decrementCurrentWriteCounter ()
 Decrements the current write counter after a write operation, in some rare cases. More...
 
static void addName (SoBase *, const char *)
 Internal methods used to maintain the global name dictionary. More...
 
static void removeName (SoBase *, const char *)
 
static SoBasegetNamedBase (const SbName &, SoType)
 Helper routines used to get stuff out of nameDict. More...
 
static int getNamedBases (const SbName &, SoBaseList &, SoType)
 
static bool read (SoInput *in, SoBase *&base, SoType expectedType)
 Reads one instance of some subclass of SoBase. More...
 
static void setInstancePrefix (const SbString &c)
 This defaults to "+" and is used when naming nodes that are DEF's and USE'd. More...
 

Public Attributes

SoSFNode node
 Inputs: More...
 
SoSFPath path
 Pointer to path defining graph. More...
 
SoEngineOutput min
 Outputs: More...
 
SoEngineOutput max
 (SoSFVec3f) Maximum point of bbox More...
 
SoEngineOutput boxCenter
 (SoSFVec3f) Center point of bbox More...
 
SoEngineOutput objectCenter
 (SoSFVec3f) Center of object(s) More...
 

Protected Member Functions

virtual void inputChanged (SoField *whichInput)
 Indicates that an input has changed - we use this to determine whether to use the node or path, or to disable output entirely. More...
 
- Protected Member Functions inherited from SoEngine
 SoEngine ()
 Constructor, destructor. More...
 
 ~SoEngine ()
 
virtual bool readInstance (SoInput *in, unsigned short flags)
 Reads stuff into instance. Returns FALSE on error. More...
 
void writeOutputTypes (SoOutput *out)
 Write output type information for engines that are not built-in. More...
 
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer ()
 
 ~SoFieldContainer ()
 
- Protected Member Functions inherited from SoBase
 SoBase ()
 Constructor is protected - this is an abstract class. More...
 
virtual ~SoBase ()
 Virtual destructor so that subclasses are deleted properly. More...
 
virtual void destroy ()
 Actually deletes an instance. More...
 
bool hasMultipleWriteRefs () const
 Returns TRUE if the instance has multiple write references. More...
 
bool writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
 Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput. More...
 
void writeFooter (SoOutput *out) const
 
virtual const char * getFileFormatName () const
 Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned) More...
 

Additional Inherited Members

- Static Public Attributes inherited from SoBase
static bool traceRefs
 Turns on/off reference count tracing (for debugging) More...
 
- Protected Types inherited from SoBase
enum  BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
 This set of enums is used when reading and writing the base. More...
 
- Static Protected Member Functions inherited from SoEngine
static const SoFieldData ** getInputDataPtr ()
 This is used by the input&output inheritence mechanism, hidden in the SoSubEngine macros. More...
 
static const SoEngineOutputData ** getOutputDataPtr ()
 
- Static Protected Member Functions inherited from SoBase
static uint32_t getCurrentWriteCounter ()
 Returns current write counter. More...
 
- Protected Attributes inherited from SoFieldContainer
bool isBuiltIn
 Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information. More...
 

Detailed Description

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 {
path NULL
}
SoSFPath path
Pointer to path defining graph.
See Also
SoEngineOutput, SoGetBoundingBoxAction, SbBox3f

Definition at line 107 of file SoComputeBoundingBox.h.

Constructor & Destructor Documentation

◆ SoComputeBoundingBox()

SoComputeBoundingBox::SoComputeBoundingBox ( )

Member Function Documentation

◆ getViewportRegion()

const SbViewportRegion& SoComputeBoundingBox::getViewportRegion ( ) const

◆ initClass()

static void SoComputeBoundingBox::initClass ( )
static

◆ inputChanged()

virtual void SoComputeBoundingBox::inputChanged ( SoField whichInput)
protectedvirtual

Reimplemented from SoEngine.

◆ setViewportRegion()

void SoComputeBoundingBox::setViewportRegion ( const SbViewportRegion vpReg)

Member Data Documentation

◆ boxCenter

SoEngineOutput SoComputeBoundingBox::boxCenter

Definition at line 119 of file SoComputeBoundingBox.h.

◆ max

SoEngineOutput SoComputeBoundingBox::max

Definition at line 118 of file SoComputeBoundingBox.h.

◆ min

SoEngineOutput SoComputeBoundingBox::min

(SoSFVec3f) Minimum point of bbox

Definition at line 117 of file SoComputeBoundingBox.h.

◆ node

SoSFNode SoComputeBoundingBox::node

Pointer to root node of graph

Definition at line 113 of file SoComputeBoundingBox.h.

◆ objectCenter

SoEngineOutput SoComputeBoundingBox::objectCenter

Definition at line 120 of file SoComputeBoundingBox.h.

◆ path

SoSFPath SoComputeBoundingBox::path

Definition at line 114 of file SoComputeBoundingBox.h.


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