SoIndexedQuadMesh.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-2019 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Thierry Dufour (Nov 2002)
**=======================================================================*/
 
#ifndef  _SO_INDEXED_QUAD_MESH_
#define  _SO_INDEXED_QUAD_MESH_
 
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/nodes/SoIndexedShape.h>
#include <Inventor/SbPImpl.h>
 
SO_PIMPL_PUBLIC_DECLARATION(SoIndexedQuadMesh)
 
 
//
//  Class: SoIndexedQuadMesh
//
//  Shape node with implicit quadrilateral connectivity. The number of
//  vertices in each row and column of the quadMesh is given by the
//  verticesPerRow and verticesPerColumn fields. The current
//  coordinates are taken in order (starting at startIndex) to form
//  the rows of the quadMesh; i.e., the first verticesPerColumn vertices
//  form the first row of the quadMesh, the next verticesPerColumn
//  vertices form the next row, and so on. It is an error if there are
//  not enough coordinates. If materials or normals are bound to
//  vertices, they will begin at startIndex, as well; otherwise, they
//  will start at index 0.
//
 
class  SoIndexedQuadMesh : public SoIndexedShape
{
  SO_NODE_HEADER(SoIndexedQuadMesh);
  SO_PIMPL_PUBLIC_HEADER(SoIndexedQuadMesh)
 
public:
  // Fields
  SoSFInt32 verticesPerColumn;
  SoSFInt32 verticesPerRow;
 
  SoIndexedQuadMesh();
 
private:
  // Implement 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 );
 
private:
  int getNumRows() const;  // returns the number of Rows
  int getNumCols() const;  // returns the number of Columns
  int getNumQuads() const; // returns the number of Quads
  int getNumMeshVerts() const; // returns the number of vertices of the Quad Mesh
 
   
  // Generic version of  Generate default normals 
  void generateDefaultNormals_QuadMesh( SoState* state, const SbVec3f* vecPQuadCoord[], SbVec3f normals[] );
 
  static void initClass();
  static void exitClass();
 
  // Blow vpCache when vertexProperty field changes:
  virtual void notify( SoNotList* list );
 
  //return number of primitives
  virtual int getNumPrim( SoState* state = NULL );
 
private:
  // This enum is used to indicate the current material or normal binding
  enum Binding {
    OVERALL,
    PER_ROW,     PER_ROW_INDEXED,
    PER_QUAD,    PER_QUAD_INDEXED,
    PER_VERTEX,  PER_VERTEX_INDEXED
  };
  // Generates triangles representing rows
  virtual void generatePrimitives( SoAction* action );
 
  // Overrides standard method to create an SoFaceDetail instance
  virtual SoDetail* createTriangleDetail( SoRayPickAction* action,
                                          const SoPrimitiveVertex* v1,
                                          const SoPrimitiveVertex* v2,
                                          const SoPrimitiveVertex* v3,
                                          SoPickedPoint* pp );
 
  virtual void callSetupIndices( SoState* state, const SoShapeStyleElement* shapeStyle, uint32_t useTexCoordsAnyway );
 
  //Approx number of primitives
  virtual void countPrim( SoState* state = NULL );
 
  // render function
  void doRendering( SoGLRenderAction* action, const SoShapeStyleElement* shapeStyle );
 
  virtual ~SoIndexedQuadMesh();
 
private :
 
  // Returns current normal binding from action's state
  SoIndexedQuadMesh::Binding getNormalBinding( SoAction* action, SoNormalBundle* nb );
};
 
 
#endif /* _SO_INDEXED_QUAD_MESH_ */