SoLevelOfSimplification.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_LEVEL_OF_SIMPLIFICATION_
#define  _SO_LEVEL_OF_SIMPLIFICATION_
 
#include <Inventor/fields/SoMFFloat.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/nodes/SoLOD.h>
 
//
//  Class: SoLevelOfSimplification
//
//  Level-of-simplfication group node. The children of this node typically
//  represent the same object or objects at varying levels of detail,
//  from highest detail to lowest.  
//
//  The group node is derived from SoLOD, and adds a new field
//  "percentages", which can be used to specify how complex
//  a representation each child is.  The first child is assumed
//  to be the 1.0 representation, and then each value in the
//  "percentages" field specifies what percentage reduction
//  this representation is.
//
//  If a full model has 1000 triangles, and there are two lower
//  levels of detail: one with 500 triangles and the other with 250,
//  then the percentages field should be [0.5, 0.25]
//
//  This node will react to the Decimation element, forcing this
//  node to choose the representation with a certain percentage
//  detail. 
//  If DecimationType is LOWEST or HIGHEST, this node will choose
//  the lowest or highest child.
//
//  If DecimationType is PERCENTAGE, and DecimationValue "D",
//  this node will choose Child "i" such that:
//        percentages[i-1] <= D < percentages[i]
//
//  If DeciamtionType is AUTOMATIC, then the child is chosen 
//  based on the range value in the usual SoLOD manner, but
//  no child greater than the value of the DecimationPercentage
//  element will be chosen.  
//
//  You should specify N percentages for N+1 children. 
//
 
class  SoLevelOfSimplification : public SoLOD {
 
  SO_NODE_HEADER(SoLevelOfSimplification);
 
 public:
  // Fields
  SoMFFloat           percentages;
  SoSFInt32           numTriangles;
 
  SoLevelOfSimplification();
 
  SoLevelOfSimplification(int nChildren);
 
 
 private:
  static void         initClass();
  static void         exitClass();
 
 private:
  // Implement actions:
  virtual void        getPrimitiveCount(SoGetPrimitiveCountAction *action);
 
   
 private:
  virtual ~SoLevelOfSimplification();
 
  virtual int         whichToTraverse(SoAction *);
};
 
#endif /* _SO_LEVEL_OF_SIMPLIFICATION_ */