SoBufferedShape.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-2025 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
#if !defined SOBUFFEREDSHAPE_H
#define SOBUFFEREDSHAPE_H
 
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoMFEnum.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/fields/SoMFInt32.h>
#include <Inventor/fields/SoSFShort.h>
#include <Inventor/fields/SoSFBox3f.h>
#include <Inventor/fields/SoSFBufferObject.h>
#include <Inventor/fields/SoMFBufferObject.h>
 
#include <Inventor/devices/SoCpuBufferObject.h>
#include <Inventor/devices/SoGLBufferObject.h>
 
#include <Inventor/nodes/SoShape.h>
 
#include <Inventor/elements/SoDrawStyleElement.h>
 
#include <Inventor/SbPImpl.h>
 
 
class SoGLBufferObject;
class SoAction;
 
SO_PIMPL_PUBLIC_DECLARATION(SoBufferedShape)
 

class  SoBufferedShape : public SoShape 
{
  SO_NODE_HEADER( SoBufferedShape );
  SO_PIMPL_PUBLIC_HEADER(SoBufferedShape)
 
  // ----------------------- Public usage --------------------------------------
 
public:

  enum Type
  {
    POINTS,

    LINE_STRIP,

    LINE_LOOP,

    LINES,

    TRIANGLE_STRIP,

    TRIANGLE_FAN,

    TRIANGLES,

    QUAD_STRIP,

    QUADS,

    POLYGON
  };

  enum Usage
  {
    STATIC,
    DYNAMIC
  };

  SoBufferedShape();

  SoSFEnum shapeUsage;

  SoSFBool primitiveRestartEnabled;

  SoSFInt32 primitiveRestartValue;

  SoSFBool useNormalsGenerator;

  SoSFEnum shapeType;

  SoMFInt32 numVertices;

  SoSFBufferObject vertexBuffer;

  SoSFShort vertexComponentsCount;
 
  SoSFEnum vertexComponentsType;

  SoSFShort vertexStride;

  SoSFInt32 vertexOffset;

  SoSFBufferObject normalBuffer;

  SoSFEnum normalComponentsType;

  SoSFShort normalStride;

  SoSFInt32 normalOffset;

  SoSFBufferObject indexBuffer;

  SoSFEnum indexType;

  SoSFInt32 indexOffset;

  SoSFBufferObject colorBuffer;

  SoSFEnum colorComponentsType;

  SoSFInt32 colorStride;

  SoSFInt32 colorOffset;

  SoSFInt32 colorComponentsCount;

  SoMFBufferObject texCoordsBuffer;

  SoMFEnum texCoordsComponentsType;

  SoMFInt32 texCoordsStride;

  SoMFInt32 texCoordsOffset;

  SoMFInt32 texCoordsComponentsCount;
 
private:
  virtual void GLRender(SoGLRenderAction *action );
  
  virtual void getBoundingBox( SoGetBoundingBoxAction *action );

  virtual void computeBBox( SoAction *action, SbBox3f &box, SbVec3f &center );

  virtual void computeBBox(SoAction *action, SbXfBox3d &box, SbVec3d &center);

  virtual void rayPick(SoRayPickAction *action );

  virtual void getPrimitiveCount(SoGetPrimitiveCountAction *action );
 
// ----------------------- Private usage -------------------------------------
// INTERNAL 
private:

  static void initClass();

  static void exitClass();
 
  void notify( SoNotList* list );
 
  int getNumPrim( SoState* state = NULL );
 
  // ----------------------- Protected usage -------------------------------------
 
private:

  virtual ~SoBufferedShape();
 
  virtual SbBool shouldCheckShapeHints();
 
  virtual SbBool shouldGLRender( SoGLRenderAction *action, SbBool isPointsOrLines = FALSE );

  virtual SbBool isLightingUsable( const void* normalBufferPtr );

  virtual SbBool isTransparent(SoState* state) const;
 
  virtual void generatePrimitives( SoAction *action );
 
  
  virtual void GLRenderBoundingBox( SoGLRenderAction *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 SoDetail* createLineSegmentDetail( SoRayPickAction *action,
                                             const SoPrimitiveVertex *v1,
                                             const SoPrimitiveVertex *v2,
                                             SoPickedPoint *pp );
 
  virtual SoDetail* createPointDetail( SoRayPickAction *action,
                                       const SoPrimitiveVertex *v,
                                       SoPickedPoint *pp );
 
  //Transforms the polygons into lines before rendering them.
  //It can be used if :
  //- shapeStyle = TRIANGLE, TRIANGLE_STRIP, TRIANGLE_FAN, TRIANGLES, QUAD_STRIP, QUADS or POLYGON
  //- SoDrawStyle::style = LINES
  // ----------------------- Private usage -------------------------------------
private:
  void commonConstructor();

  unsigned int computeSmallestBatchSize(const SoNodeList* vertexAttribsList, unsigned int numInstances);
 
  //In some cases primitives need to be transformed to POINTS to have a correct rendering
  //with POINTS as drawStyle.
  bool arePointsNeededAsPrimitives( SoDrawStyleElement::Style drawStyle ) const;
 
  template< class T > void computeBBoxTemplate_POINTS( SoAction *action, SbBox3f &box, SbVec3f &center );
 
  template< class T > void computeBBoxTemplate( SoAction *action, SbBox3f &box, SbVec3f &center, const SbVec2d &psize );
 
  template< class T > void computeBBoxTemplateSP( SoAction *action, SbBox3f &box, SbVec3f &center, const SbVec2d &psize );
 
  template< class T, int MODE > void computeBBoxTemplate_( SoAction *, SbBox3f &box, SbVec3f &center, const SbVec2d &pSize );
  
  //A GL context must exist to use this method.
  bool isRenderExtraDataNeededInCurrentContext() const;
 
  //A GL context must exist to use this method.
  bool isRenderExtraDataNeededByGraphicCardInCurrentContext() const;
 
  //For some shapeType values, the render extra data process must be launched ( without considering
  //OIV_SHAPES_PRIMITIVES_OPTIM ) in order to have a correct rendering with LINES as drawStyle.
  bool isRenderExtraDataNeededByShapeType() const;
 
  //Some graphic cards has bad performance when glPolygonMode is used to render the
  //shape with LINES as draw style.
  //
  //Returns true if the polygons must be transformed in lines before rendering them.
  static bool isRenderExtraDataNeededByGraphicCard( const SbString& graphicCardName );
};
 
//------------------------------------------------------------------------------
 
#endif // SOBUFFEREDSHAPE_H