Inventor/nodes/SoIndexedQuadMesh.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      : Thierry Dufour (Nov 2002)
**=======================================================================*/

#ifndef  _SO_INDEXED_QUAD_MESH_
#define  _SO_INDEXED_QUAD_MESH_

#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/nodes/SoIndexedShape.h>

//
//  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);

 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 getPrimitiveCount(SoGetPrimitiveCountAction *action);

 private:
  int getNumRows(void) const;  // returns the number of Rows
  int getNumCols(void) const;  // returns the number of Columns
  int getNumQuads(void) const; // returns the number of Quads
  int getNumMeshVerts(void) const; // returns the number of vertices of the Quad Mesh 

  // returns the number of PARTS
  inline int getNumParts(void) const { return getNumRows(); }// PARTS are ROWS   

  // returns the number of FACES
  inline int getNumFaces(void) const { return getNumQuads(); } // FACES are Quads 

  // returns the number of vertices needed
  int getNumVerticesNeeded(void) { return getNumMeshVerts(); }  

  // Checks if enough vertices, normals, textureCoord, colors...etc...
  bool check_RenderVectors( SoState *state, bool bUseTexCoordsAnyway );

  // Generic version of  Generate default normals 
  void generateDefaultNormals_QuadMesh(SoState *state, const SbVec3f *vecPQuadCoord[], SbVec3f normals[] );

  virtual void callDEBUGGLRender(SoGLRenderAction *action,uint32_t useTexCoordsAnyway);

  static void initClass();
  static void exitClass();
 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(const SoShapeStyleElement* shapeStyle,uint32_t useTexCoordsAnyway);

  //max auto caching test
  virtual int getMaxTestValueForAutoCache(){return totalNumVertices;}
  
  //min auto caching test
  virtual int getMinTestValueForAutoCache(){return verticesPerColumn.getValue();}

  //Approx number of primitives
  virtual void countPrim(){
    totalNumVertices = verticesPerColumn.getValue()* verticesPerRow.getValue();}

  //return number of primitives
  virtual int getNumPrim(){return totalNumVertices;}

  //invalid test
  virtual SbBool numPrimInvalid(){return totalNumVertices < 0 ;}

  // render function
  void doRendering(SoGLRenderAction *action, const SoShapeStyleElement* shapeStyle);

  virtual ~SoIndexedQuadMesh();

 private:

  // Returns current material or normal binding from action's state
  static Binding      getMaterialBinding(SoAction *action);
  Binding      getNormalBinding(SoAction *action, SoNormalBundle* nb);

  // Saves normal binding when generating primitives for picking
  Binding             savedNormalBinding;

  // Returns index (of material or normal) based on given binding
  static int getBindIndex(Binding binding, int vert, int row, int quad, const int32_t *indices);

  virtual int getNumNeededNormals(SoState *state);

  // Blow vpCache when vertexProperty field changes:
  virtual void        notify(SoNotList *list);

  // This stores the total number of vertices; we use this
  // information to influence Separator's auto-caching algorithm
  // (shapes with very few triangles should be cached because
  // traversing them can be expensive, shapes with lots of triangles
  // shouldn't be cached because they'll take up too much memory).
  int totalNumVertices;
};

inline int SoIndexedQuadMesh::getNumNeededNormals(SoState *)
{
  return verticesPerColumn.getValue() *   verticesPerRow.getValue();
}


#endif /* _SO_INDEXED_QUAD_MESH_ */

---

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