SoVertexShape.h

/*=======================================================================
 * 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)
**=======================================================================*/
/*=======================================================================
 *** 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-2024 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_VERTEX_SHAPE_
#define  _SO_VERTEX_SHAPE_
 
#include <Inventor/nodes/SoShape.h>
#include <Inventor/nodes/SoVertexProperty.h>
#include <Inventor/fields/SoSFNode.h>
#include <Inventor/threads/SbThreadSpinlock.h>
#include <Inventor/elements/SoNormalBindingElement.h>
#include <Inventor/elements/SoTangentBindingElement.h>
#include <Inventor/STL/map>
#include <Inventor/SbPImpl.h>
#include <Inventor/nodes/SoVertexShader.h>

//
//  Class: SoVertexShape
//
//  Abstract vertex-based shape node class. All nodes derived from
//  this class are shapes that are constructed from vertices at some
//  or all of the current coordinates.  They all have vertexProperty nodes,
//  and vpCaches.
//
 
class SoGLRenderAction;
class SoNormalBundle;
class SoNormalCache;
class SoTangentBundle;
class SoTangentCache;
class SoShapeStyleElement;
class SoState;
class SoTextureCoordinateBundle;
class SoTextureCoordinate3Bundle;
class SiCoordinateGetter;
 
SO_PIMPL_PUBLIC_DECLARATION( SoVertexShape )
 
class SoVertexAttribData;
 
#ifdef _MSC_VER
#pragma warning( push )
#pragma warning(disable:4251)
#endif

class  SoVertexShape : public SoShape {
 
  SO_NODE_ABSTRACT_HEADER(SoVertexShape);
  SO_PIMPL_PUBLIC_HEADER(SoVertexShape)
 
 public:
  SoSFNode vertexProperty;

  SoNormalCache *getNormalCache() const;

  SoTangentCache* getTangentCache() const;
 
 private:
 
  // Subclasses may define this method to generate normals to use
  // when the normal binding is DEFAULT and there aren't enough
  // normals in the state. This should use the given SoNormalBundle
  // to generate the normals. Returns TRUE if normals were generated.
  virtual void      generateDefaultNormals(SoState *state, 
                                   const SbVec3f *coords, 
                                   int numCoords, 
                                   SoNormalBundle *nb,
                                   SbBool storeRef = FALSE);
 
  //Common function for normal generation
  void commonGenerateDefaultNormals(SoState *state, SoNormalBundle *nb);
 
  virtual SbBool figureNormals(SoState *state, SoNormalBundle *nb);

  virtual void generateDefaultTangents( SoState* state,
                                        const SbVec3f* coords,
                                        int numCoords,
                                        SoTangentBundle* tb,
                                        SbBool storeRef = FALSE );
 
  // Common function for tangent generation
  void commonGenerateDefaultTangents( SoState* state, SoTangentBundle* tb );
 
  virtual SbBool figureTangents( SoState* state, SoTangentBundle* tb );

  uint32_t m_vpVertexTimeStamp;
 
  virtual void        write(SoWriteAction *writeAction);
 
  // Implements actions
  virtual void        GLRender(SoGLRenderAction *action);
 
 private:
  static void         initClass();
  static void         exitClass();
 
  // Redefines this to invalidate normal cache
  virtual void        notify(SoNotList *list);
 
  const SiCoordinateGetter* getCoordinateGetter(const SoState* state, bool ignoreProjectionElementDepth = false);
 
 private:
  // Constructor - makes this abstract
  SoVertexShape();
 
  virtual ~SoVertexShape();
    
  // Returns TRUE if the shape should be rendered. 
  // Checks for transparency in vertexProperty node before invoking
  // render action.
  virtual SbBool      shouldGLRender(SoGLRenderAction *action,
                                     SbBool isPointsOrLines = FALSE);
    
  
 
  //Free memory
  virtual void exitRender(SoState *state,int stateFlag,
                  SoTextureCoordinateBundle *tcb,
                  SoTextureCoordinate3Bundle *tc3b);
 
  //------------------ Following result of glRender() factorization GT (Sep 2007) 
  
  // sometimes used in shapes
  virtual void setupRenderFunctions(SoState *state,int &stateFlag);
 
  virtual void callSetupIndices(SoState* state, const SoShapeStyleElement* shapeStyle,uint32_t useTexCoordsAnyway);
 
  // check texture coordinates generation
  virtual void shouldGenerateTextureCoordinates(SoGLRenderAction *action,
                                                int &stateFlag,
                                                SoShapeStyleElement *&shapeStyle,
                                                uint32_t &useTexCoordsAnyway,
                                                SoTextureCoordinateBundle *&tcb,
                                                SoTextureCoordinate3Bundle *&tc3b);
 
  // check texture 3D coordinates generation
  virtual SbBool shouldGenerateTexture3DCoordinates(){return FALSE;}
 
  // check auto caching
  virtual void checkAutoCaching(SoGLRenderAction* action, const SoShapeStyleElement* shapeStyle, SbBool settingVPCache);
 
  // check 3D tex coords
  virtual SbBool checkTex3Coords(){return FALSE;}
 
  // actual rendering
  virtual void doRendering(SoGLRenderAction *action, const SoShapeStyleElement* shapeStyle);
 
  // rendering
  virtual void render(SoGLRenderAction *action,SbBool isPointsOrLines);
 
  // check normal generation
  virtual void shouldGenerateNormals(SoGLRenderAction *action,const SoShapeStyleElement *shapeStyle);
 
  // check tangent generation
  virtual void shouldGenerateTangents( SoGLRenderAction* action, const SoShapeStyleElement* shapeStyle );
 
  //Whether to check or not shapeHints
  virtual SbBool shouldCheckShapeHints(){ return FALSE;}
 
  virtual SbBool shapeHintsTest( SoState *state = NULL );
  
  // check shape hints
  virtual SbBool checkShapeHints(SoGLRenderAction *action);
 
  // setup lazy element
  virtual void setupLazyElement(SoGLRenderAction *action,const SoShapeStyleElement *shapeStyle);
 
  // check shape style
  virtual void checkShapeStyle(SoState *state,const SoShapeStyleElement *shapeStyle);
 
  // Internal routines used to allocate sequential indices so the
  // same rendering loops can be used for indexed or non-indexed
  // cases:
  static int32_t* allocateSequential(const int howMany);
  static int32_t* getConsecutiveIndices();
 
  virtual bool hasGeneratePrimitiveCache()
  {
    return false;
  }
 
private:
  void commonConstructor();
 
    void setupColorMaterial(SoState* state, SbBool enableOrDisable);
};
 
inline void 
SoVertexShape::generateDefaultNormals(SoState *, const SbVec3f *, int , SoNormalBundle *, SbBool )
{}
 
inline void
SoVertexShape::generateDefaultTangents( SoState*, const SbVec3f*, int, SoTangentBundle*, SbBool )
{}
 
inline void 
SoVertexShape::setupRenderFunctions(SoState *,int &)
{}
 
inline void 
SoVertexShape::callSetupIndices(SoState*, const SoShapeStyleElement* ,uint32_t )
{}
 
inline void 
SoVertexShape::doRendering(SoGLRenderAction *, const SoShapeStyleElement* )
{}
 
 
#ifdef _MSC_VER
#pragma warning( pop )
#endif
 
#endif /* _SO_VERTEX_SHAPE_ */