SoGetPrimitiveCountAction.h

/*=======================================================================
 *** 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-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_GET_PRIMITIVE_COUNT_ACTION_
#define  _SO_GET_PRIMITIVE_COUNT_ACTION_
 
#include <Inventor/actions/SoSubAction.h>
#include <Inventor/elements/SoDecimationTypeElement.h>
 
//
//  Class: SoGetPrimitiveCountAction
//
//  For computing the amount of primitives (triangles, lines, points,
//  text, images) in a scene.  This could be used as an estimate
//  for a scene's complexity, or rendering time.  The triangles,
//  lines, and points are counted; however, the text and images
//  count only the number of text or image nodes.
//  SoText3 can be counted as either triangles or text, depending
//  on the setting in this action.
//  The counts can be approximated depending on the setting in this
//  action.  This allows IndexedShapes to take a guess based on
//  the number of vertices, instead of searching through 
//  the actual values of their fields.
//
 
class  SoGetPrimitiveCountAction : public SoAction {
 
  SO_ACTION_HEADER(SoGetPrimitiveCountAction);
 
 public:
  SoGetPrimitiveCountAction();
 
  virtual ~SoGetPrimitiveCountAction();
 
  int32_t             getTriangleCount() const   { return numTriangles; }
  int32_t             getLineCount() const    { return numLines; }
  int32_t             getPointCount() const   { return numPoints; }
  int32_t             getTextCount() const    { return numText; }
  int32_t             getImageCount() const   { return numImage; }
 
  SbBool      containsNoPrimitives();
  SbBool      containsNonTriangleShapes(); 
 
  void setDecimationValue(SoDecimationTypeElement::Type type,
                          float percentage = 1.0);
  SoDecimationTypeElement::Type getDecimationType() { return decType; };
  float               getDecimationPercentage() { return decPercent; };
 
  void        setCount3DTextAsTriangles(SbBool treatAsTris) 
    { treatText3AsTris = treatAsTris; };
  SbBool      is3DTextCountedAsTriangles() { return treatText3AsTris; };
 
  void        setCanApproximate(SbBool onOff)
    {  canApproximate = onOff; };
  SbBool      canApproximateCount() { return canApproximate; };
 
 private:
  // These functions are called by nodes to add a number of
  // a type of primitive to the number of primitives found.
  void        addNumTriangles(int32_t num)    { numTriangles += num; };
  void        addNumLines(int32_t num)        { numLines += num; };
  void        addNumPoints(int32_t num)       { numPoints += num; };
  void        addNumText(int32_t num)         { numText += num; };
  void        addNumImage(int32_t num)        { numImage += num; };
  void        incNumTriangles()       { numTriangles++; };
  void        incNumLines()           { numLines++; };
  void        incNumPoints()          { numPoints++; };
  void        incNumText()            { numText++; };
  void        incNumImage()           { numImage++; };
 
 private:
  static void         initClass();
  static void         exitClass();
 
 private:
  // Initiates action on graph
  virtual void        beginTraversal(SoNode *node);
 
 private:
  int32_t     numTriangles;
  int32_t     numLines;
  int32_t     numPoints;
  int32_t     numText;
  int32_t     numImage;
    
  SbBool      treatText3AsTris;
  SbBool      canApproximate;
    
  SoDecimationTypeElement::Type decType;
  float       decPercent;
 
};
 
#endif /* _SO_GET_PRIMITIVE_COUNT_ACTION_ */