SoIndexedFaceSet.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)
** Modified by : Gavin Bell (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-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : AJO (May 2011)
**=======================================================================*/
 
 
#ifndef  _SO_INDEXED_FACE_SET_
#define  _SO_INDEXED_FACE_SET_
 
#include <Inventor/nodes/SoIndexedShape.h>
#include <Inventor/sys/SoGLType.h>
 
//
//  Class: SoIndexedFaceSet
//
//  Indexed set of faces. Each face consists of 3 or more vertices,
//  each of which is denoted by an integer index (from the coordIndex
//  field) into the current coordinates. Depending on the current
//  material and normal binding values, the materials and normals for
//  the faces or vertices may be accessed in order or indexed. If they
//  are indexed, the materialIndex and normalIndex fields are used.
//
 
 
// This coordinate index indicates that the current face ends and the
// next face begins.  Use this for simple (1 contour) polygons.
#define SO_END_FACE_INDEX       (-1)
 
// If SoShapeHints is used with a windingType other than NO_WINDING_TYPE,
// this coordinate index indicates that the current contour ends
// and the next contour begins.
#define SO_END_CONTOUR_INDEX    (-1)
 
// This coordinate index indicates that the current complex face (block
// of contours) ends.
#define SO_END_POLYGON_INDEX    (-2)
 
class SoNormalBundle;
class SoShapeStyleElement;
class SoVolumeIndexedFaceSet;
 
SO_PIMPL_PUBLIC_DECLARATION(SoIndexedFaceSet)
 
 
class  SoIndexedFaceSet : public SoIndexedShape
{
  SO_NODE_HEADER(SoIndexedFaceSet);
  SO_PIMPL_PUBLIC_HEADER(SoIndexedFaceSet)
 
public:
 
  SoIndexedFaceSet();
 
private:
  // Implements actions
  virtual void GLRender( SoGLRenderAction* action );
 
 // Generates default normals using the given normal bundle. 
  // Returns TRUE.
  virtual void generateDefaultNormals( SoState* state,
                                       const SbVec3f* coords,
                                       int numCoords,
                                       SoNormalBundle* nb,
                                       SbBool storeRef = FALSE);
 
  virtual void shouldGenerateTangents( SoGLRenderAction* /*action*/, const SoShapeStyleElement* /*shapeStyle*/ ) {}
 
  virtual void getPrimitiveCount( SoGetPrimitiveCountAction* action );
  virtual void rayPick(SoRayPickAction *action);
                                                  
private:
 
  static void initClass();
  static void exitClass();
  
  // set numTris/Quads/Faces to -1 when notified
  virtual void notify( SoNotList* list );
 
  // Compute the number of vertices. This is just an approximation,
  //so using 5 verts per unknown polygon is close enough. 
  virtual int getNumPrim( SoState* state = NULL );
 
 private:
  // This enum is used to indicate the current material or normal binding
  enum Binding {
    OVERALL,
    PER_FACE,
    PER_FACE_INDEXED,
    PER_VERTEX,
    PER_VERTEX_INDEXED
  };
 
  //Whether to check or not shapeHints
  virtual SbBool shouldCheckShapeHints(){ return TRUE;}
 
  virtual SbBool shouldGenerateTexture3DCoordinates(){return TRUE;}
 
  virtual void callSetupIndices( SoState* state, const SoShapeStyleElement* shapeStyle, uint32_t useTexCoordsAnyway );
 
  //Whether to check or not 3d tex coords
  virtual SbBool checkTex3Coords(){return TRUE;}
 
  virtual SbBool shapeHintsTest( SoState* state = NULL );
 
  int getNumPrim( int& _numTris, int& _numQuads, int& _numFaces );
 
  virtual void countPrim( SoState* state = NULL );
 
  // Generates triangles representing faces
  virtual void generatePrimitives( SoAction* action );
 
  // render function
  virtual void doRendering( SoGLRenderAction* action, const SoShapeStyleElement* shapeStyle );
 
  // Overrides standard method to create an SoFaceDetail instance
  virtual SoDetail* createTriangleDetail( SoRayPickAction* action,
                                          const SoPrimitiveVertex* v1,
                                          const SoPrimitiveVertex* v2,
                                          const SoPrimitiveVertex* v3,
                                          SoPickedPoint* pp );
 
  //When tesselating complex polygons, keep the result cached
  virtual bool hasGeneratePrimitiveCache()
  {
    return true;
  }
 
  // destructor
  virtual ~SoIndexedFaceSet();
};
 
#endif /* _SO_INDEXED_FACE_SET_ */