SoSeparator.h

/*=======================================================================
 * 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)
** Modified by : Nick Thompson (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-2024 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_SEPARATOR_
#define  _SO_SEPARATOR_
 
#include <Inventor/nodes/SoGroup.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/fields/SoMFInt32.h>
#include <Inventor/SbPImpl.h>
 
class SoBoundingBoxCache;
class SoPrimitiveCountCache;
 
#ifdef _MSC_VER
#pragma warning( push )
#pragma warning(disable:4251)
#endif

//
//  Class: SoSeparator
//
//  Separator group node: state is saved before traversing children
//  and restored afterwards.
//
 
#include <Inventor/fields/SoSFBitMask.h>
#include <Inventor/SbRenderUnitID.h>
 
SO_PIMPL_PUBLIC_DECLARATION(SoSeparator)
 

class  SoSeparator : public SoGroup
{
  SO_NODE_HEADER(SoSeparator);
  SO_PIMPL_PUBLIC_HEADER(SoSeparator)
 
 public:

  enum CacheEnabled {
    OFF,
    ON,
    AUTO
  };
 
#if 1             SoDEPRECATED
  SoSFEnum renderCaching;
#endif 

  SoSFEnum boundingBoxCaching;

  SoSFEnum renderCulling;

  SoSFEnum pickCulling;

  enum FastEditing {
    DISABLE = 0x01,

    KEEP_ZBUFFER = 0x02,

    CLEAR_ZBUFFER = 0x03
  };

  SoSFEnum fastEditing;

  SoSFInt32 renderUnitId;

  SoSeparator();

  SoSeparator(int nChildren);
 
 private:
  // Overrides default method on SoNode
  virtual SbBool      affectsState() const;
 
  // Implement actions
  virtual void        doAction(SoAction *action);
  virtual void        callback(SoCallbackAction *action);
  virtual void        getBoundingBox(SoGetBoundingBoxAction *action);
  virtual void        getMatrix(SoGetMatrixAction *action);
  virtual void        GLRender(SoGLRenderAction *action);
  virtual void        handleEvent(SoHandleEventAction *action);
  virtual void        rayPick(SoRayPickAction *action);
  virtual void        search(SoSearchAction *action);
  virtual void        getPrimitiveCount(SoGetPrimitiveCountAction *action);
  virtual void        clearCacheList();
 
  // These methods make render traversal faster by implementing
  // different rendering paths corresponding to different action
  // path codes.
  virtual void        GLRenderBelowPath(SoGLRenderAction *action);
  virtual void        GLRenderInPath(SoGLRenderAction *action);
  virtual void        GLRenderOffPath(SoGLRenderAction *action);
 
 private:
  static void         initClass();
  static void         exitClass();
 
  SB_THREAD_TLS_HEADER();
 
  virtual void        notify(SoNotList *list);

  SoBoundingBoxCache* getBoundingBoxCache() const
  { return bboxCache; }
 
#ifdef ADD_MFIELD_DEPLIST
  SoMFInt32 renderUnitDependencies;
#endif

  void invalidateAllParentCaches();

  void invalidateAllChildrenCaches();
 
private:
  // Returns TRUE if this separator can be culled because it is
  // outside the cull volume.  The cullResults flags come from the
  // GLRenderAction->getCullTestResults() method, and track the
  // results of previous cull tests to save work when we know we're
  // completely inside the view volume.
  virtual SbBool cullTest(SoGLRenderAction *action, int &cullResults);
 
  virtual SbBool readInstance(SoInput *in, unsigned short flags);
 
  virtual ~SoSeparator();
 
private:
 
  SoBoundingBoxCache* bboxCache; // Cache for bounding boxes
 
  SoPrimitiveCountCache *primCountCache;      // Cache for primitive count
        
  SbBool bboxCacheIsOpen;
 
  // bba is in thread local storage now. 
  struct MTstruct {
    SoGetBoundingBoxAction *bba;
  };
 
  void commonConstructor();
 
  float m_depthOffsetCachedValue;
 
#if 1             SoDEPRECATED
  SoSFEnum directVizCaching;
#endif 
};
 
#ifdef _MSC_VER
#pragma warning( pop )
#endif
 
#endif /* _SO_SEPARATOR_ */