SoComputeBoundingBox(3IV)

NAME
     SoComputeBoundingBox (SoComputeBBox) - computes the bounding box and
     center of a scene graph

INHERITS FROM
     SoBase > SoFieldContainer > SoEngine > SoComputeBoundingBox

SYNOPSIS
     #include <Inventor_c/engines/SoComputeBoundingBox.h>

     typedef SoComputeBoundingBox
                         SoComputeBBox

          Inputs from class SoComputeBoundingBox:

     SoSFNode            node
     SoSFPath            path

          Outputs from class SoComputeBoundingBox:

     (SoSFVec3f)         min
     (SoSFVec3f)         max
     (SoSFVec3f)         boxCenter
     (SoSFVec3f)         objectCenter

          Functions from class SoComputeBoundingBox:

     SoComputeBoundingBox *    SoComputeBBoxCreate()
     void                      SoComputeBBoxSetVPReg(SoComputeBBox *this,
                                    const SbViewportRegion *vpReg);
     const SbViewportRegion *  SoComputeBBoxGetVPReg(SoComputeBBox *this);

          Functions from class SoEngine:

     SoType              SoComputeBBoxGetTypeId()
     int                 SoComputeBBoxGetOuts(const SoComputeBBox *this,
                              SoEngineOutputList *list)
     SoEngineOutput *    SoComputeBBoxGetOut(const SoComputeBBox *this, const
                              char *outputName)
     SbBool              SoComputeBBoxGetOutName(const SoComputeBBox *this,
                              const SoEngineOutput *output, SbName
                              *outputName)
     SoEngine *          SoComputeBBoxCopy(const SoComputeBBox *this)
     SoEngine *          SoComputeBBoxGetByName(const char *name)
     int                 SoComputeBBoxGetByNameList(const char *name,
                              SoEngineList *list)

          Functions from class SoFieldContainer:

     SoType              SoComputeBBoxGetClassTypeId()
     void                SoComputeBBoxSetToDflts(SoComputeBBox *this)
     SbBool              SoComputeBBoxHasDfltVals(const SoComputeBBox *this)
     SbBool              SoComputeBBoxFldsAreEq(const SoComputeBBox *this,
                              const SoFieldContainer *fc)
     void                SoComputeBBoxCopyFieldVals(SoComputeBBox *this, const
                              SoFieldContainer *fc, SbBool copyConnections =
                              FALSE)
     SbBool              SoComputeBBoxSet(SoComputeBBox *this, const char
                              *fieldDataString)
     void                SoComputeBBoxGet(SoComputeBBox *this, SbString
                              *fieldDataString)
     int                 SoComputeBBoxGetFields(const SoComputeBBox *this,
                              SoFieldList *resultList)
     SoField *           SoComputeBBoxGetField(const SoComputeBBox *this,
                              const char *fieldName)
     SbBool              SoComputeBBoxGetFieldName(const SoComputeBBox *this,
                              const SoField *field, SbName *fieldName)
     SbBool              SoComputeBBoxIsNotifyEnabled(const SoComputeBBox
                              *this)
     SbBool              SoComputeBBoxEnableNotify(SoComputeBBox *this, SbBool
                              flag)

          Functions from class SoBase:

     void                SoComputeBBoxRef(SoComputeBBox *this)
     void                SoComputeBBoxUnref(const SoComputeBBox *this)
     void                SoComputeBBoxUnrefNoDelete(const SoComputeBBox *this)
     void                SoComputeBBoxTouch(SoComputeBBox *this)
     SbBool              SoComputeBBoxIsOfType(const SoComputeBBox *this,
                              SoType type)
     void                SoComputeBBoxSetName(SoComputeBBox *this, const char
                              *name)
     SbName              SoComputeBBoxGetName(const SoComputeBBox *this)


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  SoComputeBBoxSetVPReg() on
     the engine instance to set up the correct viewport region to use.

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


OUTPUTS
     (SoSFVec3f)         min
          Minimum point of the computed bounding box.

     (SoSFVec3f)         max
          Maximum point of the computed bounding box.

     (SoSFVec3f)         boxCenter
          Center of the computed bounding box.

     (SoSFVec3f)         objectCenter
          Center of the objects in the graph.


FUNCTIONS
     SoComputeBoundingBox *    SoComputeBBoxCreate()
          Constructor

     void                      SoComputeBBoxSetVPReg(SoComputeBBox *this,
                                    const SbViewportRegion *vpReg);
          Sets the viewport region to use for the bounding box computation.

     const SbViewportRegion *  SoComputeBBoxGetVPReg(SoComputeBBox *this);
          Returns the viewport region to use for the bounding box computation.


FILE FORMAT/DEFAULTS
     ComputeBoundingBox {
          node  NULL
          path  NULL
     }

SEE ALSO
     SoEngineOutput, SoGetBoundingBoxAction, SbBox3f