SoShapeHintsElement.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-2025 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_SHAPE_HINTS_ELEMENT
#define  _SO_SHAPE_HINTS_ELEMENT
 
#include <Inventor/elements/SoReplacedElement.h>

 
SoEXTENDER_Documented class  SoShapeHintsElement : public SoElement {
 
  SO_ELEMENT_HEADER(SoShapeHintsElement);
 
 public:
 enum VertexOrdering {
 UNKNOWN_ORDERING,
 CLOCKWISE,
 COUNTERCLOCKWISE,
 ORDERING_AS_IS
  };

 enum ShapeType {
 UNKNOWN_SHAPE_TYPE,
 SOLID,
  INNER_SOLID,
 SHAPE_TYPE_AS_IS
 };

 enum FaceType {
 UNKNOWN_FACE_TYPE,
 CONVEX,
 FACE_TYPE_AS_IS
  };

 enum WindingType {
    NO_WINDING_TYPE,
    ODD_TYPE,
    NON_ZERO_TYPE,
    POSITIVE_TYPE,
    NEGATIVE_TYPE,
    ABS_GEQ_TWO_TYPE
  };

  static void         set(SoState *state, VertexOrdering vertexOrdering,
                          ShapeType shapeType, FaceType faceType);

  static void         set(SoState *state, WindingType windingType);

  static void         set(SoState *state, SbBool useVBO) ;

  static void set(SoState *state, VertexOrdering vertexOrdering, ShapeType shapeType, FaceType faceType,
                  WindingType windingType, SbBool useVBO);

  static void         set(SoState *state, SoNode *,
                          VertexOrdering vertexOrdering,
                          ShapeType shapeType, FaceType faceType)
    { set(state, vertexOrdering, shapeType, faceType); }

  static void         set(SoState *state, SoNode *,WindingType windingType)
    { set(state,windingType); }

  static void         set(SoState *state, SoNode *, SbBool useVBO)
    { set(state,useVBO); }

  static void         get(SoState *state,
                          VertexOrdering &vertexOrdering,
                          ShapeType &shapeType, FaceType &faceType);

  static void         get(SoState *state, WindingType &windingType );

  static SbBool       isVBOUsed(SoState *state) ;

  static VertexOrdering getDefaultVertexOrdering()
  {
    return s_vertexOrderingDefault;
  }

  static ShapeType      getDefaultShapeType()
  {
    return s_shapeTypeDefault;
  }

  static FaceType       getDefaultFaceType()
  {
    return s_faceTypeDefault;
  }

  static WindingType    getDefaultWindingType()
  {
    return s_windingTypeDefault;
  }

  static SbBool         getDefaultVBOUsage()
  {
    return true;
  }

  virtual void        push(SoState *state);

  virtual void        print(FILE *fp) const;
 
private:

  virtual void init(SoState *state);

  virtual SbBool matches(const SoElement* elt) const;

  virtual SoElement* copyMatchInfo() const;
 
 private:
  // Initializes the SoShapeHintsElement class
  static void         initClass();
  static void         exitClass();
 
  static bool isTwoSidedLighting(SoState *state);
  static void setForceTwoSidedLighting( SoState* state, bool forceTwoSidedLighting );

  static bool isFrontCulling( SoState* state );
  static bool isBackCulling( SoState* state );

  bool isFrontCulling() const;
  bool isBackCulling() const;

  static bool isFrontCulling( VertexOrdering vertexOrdering, ShapeType shapeType );
  static bool isBackCulling( VertexOrdering vertexOrdering, ShapeType shapeType );

  static bool isCounterClockwise(SoState *state);

  bool isCounterClockwise() const;
 
private:
  virtual void commonInit();
 
  // Virtual set methods that subclasses can override.
  virtual void setElt(VertexOrdering vertexOrdering, ShapeType shapeType, FaceType faceType);
 
  virtual void setElt(WindingType windingType);
 
  // Set shape hints by defining all options.
  virtual void setElt(VertexOrdering vertexOrdering, ShapeType shapeType, FaceType faceType,
                      WindingType windingType, SbBool useVBO);
 
  VertexOrdering      vertexOrdering;
  ShapeType           shapeType;
  FaceType            faceType;
  WindingType         windingType;
  SbBool              useVBO ;
 
  virtual ~SoShapeHintsElement();
 
private:
  bool isTwoSidedLighting() const;
 
  bool m_forceTwoSidedLighting;
 
  static void initVertexOrdering();
  static void initShapeType();
  static void initFaceType();
  static void initWindingType();
 
  static VertexOrdering      s_vertexOrderingDefault;
  static ShapeType           s_shapeTypeDefault;
  static FaceType            s_faceTypeDefault;
  static WindingType         s_windingTypeDefault;
};
 
#endif /* _SO_SHAPE_HINTS_ELEMENT */