Inventor/nodes/SoOctreeOrdering.h

Go to the documentation of this file.

/*=======================================================================
 *** 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-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/

/*---------------------------------------------------------------------
 *  Header file for "SoOctreeOrdering", 
 *   SoRenderList-derived group node.
 *
 *  Created: bga 31-March-97
 *  Modified: Jerome Hummel - Jun 2001 -
 *  -for multithreading. 
 *  -drawing of the octree for debug purpose, permanently (environment variable OIV_DRAWOCTREE)
 *  or controlled by the user (seeOctreeDrawing(), eraseOctreeDrawing())
 *  -add a CB for the user to get the statistics of the octree
 *  (how many objects are rendered by thread,number of objects to render,...)                
 *------------------------------------------------------------*/


#ifndef _SO_OCTREE_ORDERING_HH
#define _SO_OCTREE_ORDERING_HH 1

#include <Inventor/fields/SoSFBool.h>
#include <Inventor/nodes/SoRenderList.h>
#include <Inventor/threads/SbThread.h>
#include <Inventor/actions/SoGetBoundingBoxAction.h>

#ifndef HIDDEN_FROM_DOC
class _SoOctreeRenderObjectTree;

// Extend the SoRenderObject to contain the data we want to store
class SoDEPRECATED SoOctreeRenderObject : public SoRenderObject
{

 public:
  
  SoOctreeRenderObject(const SoPath *p) : SoRenderObject(p) 
    { 
    
      flags.rendered = FALSE; flags.inOctree = FALSE; 
      flags.inMoving = FALSE; flags.moving = FALSE; 
    
      name = p->getTail()->getName();
    };
  
  virtual ~SoOctreeRenderObject()  { };
  
  struct 
  {
    unsigned int rendered : 1; 
    unsigned int inOctree : 1; 
    unsigned int inMoving : 1; 
    unsigned int moving   : 1; 
  } flags;
  
  // to get an easyest way to identify the object
  SbName getName(void) { return name; };

  private :
    
    SbName name;
    
};
#endif // HIDDEN_FROM_DOC

//used to allow the user to get the statistics of the render.
class SoOctreeOrdering;
typedef     SoDEPRECATED void SoReportCB(SoOctreeOrdering *node,
                        int numObj,
                        int objRendered,
                        void *userData);

class SoDEPRECATED SoOctreeOrdering : public SoRenderList
{
  
  SO_NODE_HEADER(SoOctreeOrdering);
  
 public:

     SoOctreeOrdering();
  
     SoOctreeOrdering(int numChildren);
  
  // Fields
  SoSFBool dropCulling;
  
  SoSFUInt32 dropScreenArea;

  SoSFBool boundingBoxSubstitutes;

  SoSFBool useMovingQueue;

  SoSFBool adjustDecimation;

  static void setReportCB(SoReportCB *func, void *userData);

  void setOctreeDrawing(SbBool enable);

  SbBool isOctreeDrawing(void);

  SbBool isChainingOn(void) 
    { return (coworker != NULL); };

     void setHandleTransparency(SbBool handle);
     SbBool getHandleTransparency();

     void reset();

 private:
  // These implement supported actions
  virtual void getBoundingBox(SoGetBoundingBoxAction *action);
  virtual void GLRenderBelowPath(SoGLRenderAction *action);
  virtual void rayPick(SoRayPickAction *action);
  virtual void getPrimitiveCount(SoGetPrimitiveCountAction *action);
  
 private:

  static void initClass();
  static void exitClass();
 
  // Set whether the bounding box is called from inside the octree code
  static SbBool m_internalGetBBox;

 private:
    SbBool m_handleTransparency;
    SbBool m_reset;

  // Generic traversal of children, handles scene graph as if
  // this was just a SoSeparator node
  virtual void doStandardTraversal(SoAction *action);
  
  // Spatial traversal of children
  virtual void doSpatialTraversal(SoAction *action);
  
  // Virtual callbacks for when changes are made to the RenderObject list.
  virtual SoRenderObject *createRenderObject(const SoPath *path);
  virtual void removingRenderObject(SoRenderObject *);
  virtual void renderObjectChanged(SoRenderObject *);
  virtual void ourFieldChanged(SoField *);
  
  // Destructor
  virtual ~SoOctreeOrdering();
  
 private:
  
  static SoReportCB *m_reportCB;
  static void *m_reportUserData;
  
  // Common code for the two constructors:
  void commonConstructor();
  
  SoGetBoundingBoxAction *bbAction;
  SoGetPrimitiveCountAction *countAction;
  
  SbPList movingQueue;
  SbPList changeQueue;
  
  void insertInChangedQueue(void *);
  void updateChangedQueue();
  void updateRenderObject(SoOctreeRenderObject *);
  
  _SoOctreeRenderObjectTree *octreeTree;   
  
  SbThreadMutex *octreeMutex; 
  
  // number of objects to render
  int numObjects;  
  
  SbBool seeOctree; //used to draw the octree or not,
  
  // help function for spatial traversal
  float calculateDecimation(float,float);
  
  void renderTransparentObjs(SoAction *action, 
                             SoRenderObjectList *visibleTransparentObject);
  
  void handleMovingQueue(SoAction *action,SbBool);

  // Whether the environment variable is set
  SbBool isEnvOn;
};

#endif

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/