SoGetBoundingBoxAction.h

Go to the documentation of this file.

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Paul S. Strauss (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef _SO_GET_BOUNDING_BOX_ACTION_
#define _SO_GET_BOUNDING_BOX_ACTION_
 
#include <Inventor/SbBox.h>
#include <Inventor/SbViewportRegion.h>
#include <Inventor/actions/SoSubAction.h>
 
//
//    Class: SoGetBoundingBoxAction
//
//    For computing a bounding box enclosing objects defined by a scene
//    graph. The box is a rectangular prism whose sides are aligned with
//    the coordinate axes, and is represented as an SbBox3f. It also
//    computes the center point, which is defined differently for
//    different objects.
//
 
class  SoGetBoundingBoxAction : public SoAction
{
  SO_ACTION_HEADER(SoGetBoundingBoxAction);
 
 public:
  SoGetBoundingBoxAction(const SbViewportRegion &viewportRegion);
 
  // Destructor
#ifndef HIDDEN_FROM_DOC
  virtual ~SoGetBoundingBoxAction();
#endif // HIDDEN_FROM_DOC
 
  void setViewportRegion(const SbViewportRegion &newRegion);
 
  const SbViewportRegion &getViewportRegion() const;
 
  SbBox3f getBoundingBox() const;
 
  SbXfBox3f &getXfBoundingBox();
 
  const SbVec3f &getCenter() const;
 
  void setInCameraSpace(SbBool flag);
 
  SbBool isInCameraSpace() const;
 
  enum ResetType {    // Which things get reset:
    TRANSFORM = 0x01,
    BBOX = 0x02,
    ALL = 0x03
  };
 
  void setResetPath(const SoPath *path,
                    SbBool resetBefore = TRUE,
                    ResetType what = ALL);
  const SoPath *getResetPath() const;
  SbBool isResetPath() const;
  SbBool isResetBefore() const;
  SoGetBoundingBoxAction::ResetType getWhatReset() const;
 
 private:
 
  // Call these methods at beginning and end (respectively) of
  // the getBoundingBox action for each node. (SoNode calls these in
  // its static method for this action.)
  void checkResetBefore();
  void checkResetAfter();
 
  // Extends the current bounding box by the given bounding box,
  // after transforming it by the current value of the
  // SoLocalBBoxMatrixElement
  void extendBy(const SbBox3f &box);
  void extendBy(const SbXfBox3f &box);
 
  void extendBy(const SbBox3d &box);
  void extendBy(const SbXfBox3d &box);
 
  // Sets the center of the bounding box to the given point, which,
  // if transformCenter is TRUE, is first transformed by the current
  // value of the SoLocalBBoxMatrixElement. After this is called,
  // isCenterSet will return TRUE, unless resetCenter is called.
  // Shapes should setCenter() to whatever is appropriate (e.g.
  // left-justified text might set the center to be the start of the
  // string) with transformCenter set to TRUE.    Groups are
  // responsible for averaging the centers if more than one shape
  // sets the center; when setting the center to the average of
  // transformed centers, pass FALSE for transformCenter.
  void setCenter(const SbVec3f &center, SbBool transformCenter);
  void setCenter(const SbVec3d &center, SbBool transformCenter);
 
  SbBool isCenterSet() const;
  void resetCenter();
 
 private:
  static void initClass();
  static void exitClass();
 
  void setIgnoreScreenSpaceBoundingBoxes(bool flag);
 
  bool ignoreScreenSpaceBoundingBoxes() const;
 
 private:
  // Initiates action on graph
  virtual void beginTraversal(SoNode *node);
 
 private:
  SbXfBox3f box;             // Bounding box
  SbVec3f center;            // Center point
  SbBool cameraSpace;        // Bounding box in camera space?
  const SoPath *resetPath;   // path to reset transform
  SbBool resetBefore;        // reset before or after?
  ResetType resetWhat;       // which things get reset?
  SbViewportRegion vpRegion; // Current viewport region
  SbBool centerSet;          // setCenter() called?
 
  bool m_ignoreScreenSpaceBoundingBoxes;
 
  // check to see if the reset parameters are met, if so, do the
  // reset transform and reset bbox
  void checkReset(SbBool resetBefore);
 
};
 
#endif /* _SO_GET_BOUNDING_BOX_ACTION_ */