SoCallbackAction.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      : Dave Immel (MMM yyyy)
** Modified by : Thad Beier (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_CALLBACK_ACTION_
#define  _SO_CALLBACK_ACTION_
 
#include <Inventor/SbBox.h>
#include <Inventor/actions/SoSubAction.h>
#include <Inventor/nodes/SoComplexity.h>
#include <Inventor/nodes/SoDrawStyle.h>
#include <Inventor/nodes/SoFont.h>
#include <Inventor/nodes/SoLightModel.h>
#include <Inventor/nodes/SoMaterialBinding.h>
#include <Inventor/nodes/SoNormalBinding.h>
#include <Inventor/nodes/SoPickStyle.h>
#include <Inventor/nodes/SoShapeHints.h>
#include <Inventor/nodes/SoTexture.h>
#include <Inventor/nodes/SoTextureCoordinateBinding.h>
#include <Inventor/nodes/SoUnits.h>
#include <Inventor/elements/SoDecimationTypeElement.h>
#include <Inventor/actions/SoGLRenderAction.h>
 
class SoPrimitiveVertex;
class SoShape;
class SoTexture2Transform;
 
typedef void SoTriangleCB(void *userData,
                          SoCallbackAction *action,
                          const SoPrimitiveVertex *v1,
                          const SoPrimitiveVertex *v2,
                          const SoPrimitiveVertex *v3);
typedef void SoLineSegmentCB(void *userData, 
                             SoCallbackAction *action,
                             const SoPrimitiveVertex *v1,
                             const SoPrimitiveVertex *v2);
typedef void SoPointCB(void *userData, 
                       SoCallbackAction *action,
                       const SoPrimitiveVertex *v);
 
#ifdef _WIN32
//JSG - Changed SoCallbackActionCB back to how it is done under unix,
//SoCallbackActionCB2 is included for backward compatibility on Windows
typedef int SoCallbackActionCB2(void *userData,
                                SoCallbackAction *action,
                                const SoNode *node);
#endif
//
//  Class: SoCallbackAction
//
//  State accumulation action. This action performs a generic
//  traversal of a scene graph. The caller can register callback
//  functions to be called when specific types of nodes are traversed.
//
 
class  SoCallbackAction : public SoAction {
 
  SO_ACTION_HEADER(SoCallbackAction);
 
 public:
 
  enum Response {
    CONTINUE,
    ABORT,
    PRUNE
  };
 
  typedef Response SoCallbackActionCB(void *userData,
                                      SoCallbackAction *action,
                                      const SoNode *node);
 
  SoCallbackAction();
 
  // Destructor
#ifndef HIDDEN_FROM_DOC
  virtual ~SoCallbackAction();
#endif // HIDDEN_FROM_DOC
 
  //
  // Adding callback functions:
  //
 
  void addPreCallback(SoType type, SoCallbackActionCB *cb, void *data);
 
  void addPostCallback(SoType type, SoCallbackActionCB *cb, void *data);
 
  void addPreTailCallback(SoCallbackActionCB *cb, void *data);
 
  void addPostTailCallback(SoCallbackActionCB *cb, void *data);
 
  void addTriangleCallback(SoType type, SoTriangleCB *cb, void *data);
 
  void addLineSegmentCallback(SoType type, SoLineSegmentCB *cb, void *data);
 
  void addPointCallback(SoType type, SoPointCB *cb, void *data);
 
  //
  // Accessing state information from callbacks. Non-obvious return
  // values are documented.
  //
 
 
  float getComplexity() const;
 
  SoComplexity::Type getComplexityType() const;
 
 
  int32_t getNumCoordinates() const;
 
  const SbVec3f &getCoordinate3(int index) const;
 
  const SbVec4f &getCoordinate4(int index) const;
 
  SoDecimationTypeElement::Type getDecimationType() const;
 
  float getDecimationPercentage() const;
 
  SoDrawStyle::Style getDrawStyle() const;
 
  u_short getLinePattern() const;
 
  int getLinePatternScaleFactor() const;
 
  float getLineWidth() const;
 
  float getPointSize() const;
 
 
  const SbString & getFontName() const;
 
  float getFontSize() const;
 
  SoFont::RenderStyle getFontRenderStyle() const;
 
 
  SoLightModel::Model getLightModel() const;
 
  const SbVec3f &getLightAttenuation() const;
 
 
  void getMaterial(SbColor &ambient,
                   SbColor &diffuse,
                   SbColor &specular,
                   SbColor &emission,
                   float &shininess,
                   float &transparency,
                   int mtlIndex = 0) const;
 
  SoMaterialBinding::Binding getMaterialBinding() const;
 
 
  SoGLRenderAction::TransparencyType getTransparencyType() const;
 
 
  int32_t getNumNormals() const;
 
  const SbVec3f & getNormal(int index) const;
 
  SoNormalBinding::Binding getNormalBinding() const;
 
 
  int32_t getNumProfileCoordinates() const;
 
  const SbVec2f &getProfileCoordinate2(int index) const;
 
  const SbVec3f &getProfileCoordinate3(int index) const;
 
  const SoNodeList & getProfile() const;
 
 
  SoShapeHints::VertexOrdering getVertexOrdering() const;
 
  SoShapeHints::ShapeType getShapeType() const;
 
  SoShapeHints::FaceType getFaceType() const;
 
  float getCreaseAngle() const;
 
 
  int32_t getNumTextureCoordinates() const;
 
  const SbVec2f &getTextureCoordinate2(int index) const;
 
  const SbVec4f &getTextureCoordinate4(int index) const;
 
  SoTextureCoordinateBinding::Binding   getTextureCoordinateBinding() const;
 
#ifdef _WIN32
  const SbColor getTextureBlendColor() const;
#else
  const SbColor &getTextureBlendColor() const;
#endif
 
  const unsigned char *getTextureImage(SbVec2i32 &size, int &numComps) const;
 
  const SbName &getTextureFileName() const;
 
  const SbMatrix &getTextureMatrix() const;
 
  const SoTexture2Transform *getTextureTransformNode() const;
 
  SoTexture::Model getTextureModel() const;
 
  SoTexture::Wrap getTextureWrapS() const;
  SoTexture::Wrap getTextureWrapT() const;
 
 
  const SbMatrix & getModelMatrix() const;
 
  SoUnits::Units getUnits() const;
 
 
  float getFocalDistance() const;
 
  const SbMatrix &getProjectionMatrix() const;
 
  const SbMatrix &getViewingMatrix() const;
 
  const SbViewVolume &getViewVolume() const;
 
 
  SoPickStyle::Style getPickStyle() const;
 
  int32_t getSwitch() const;
 
  void setCallbackAll(SbBool flag) { callbackAll = flag; }
 
  SbBool isCallbackAll() const  { return callbackAll; }
 
#if 1             SoDEPRECATED
  const unsigned char *getTextureImage(SbVec2s &size, int &numComps) const;
 
#endif 
private:
#ifdef _WIN32
  void addPreCallback(SoType type, SoCallbackActionCB2 *cb, void *data);
  void addPostCallback(SoType type, SoCallbackActionCB2 *cb, void *data);
  void addPreTailCallback(SoCallbackActionCB2 *cb, void *data);
  void addPostTailCallback(SoCallbackActionCB2 *cb, void *data);
#endif
 
  // Returns the current response
  Response getCurrentResponse() const { return response; }
 
  // Call the pre-callbacks and post-callbacks
  virtual void invokePreCallbacks(const SoNode *node);
  virtual void invokePostCallbacks(const SoNode *node);
 
  // Call the primitive callbacks
  virtual void invokeTriangleCallbacks(const SoShape *shape,
                               const SoPrimitiveVertex *v1,
                               const SoPrimitiveVertex *v2,
                               const SoPrimitiveVertex *v3);
  virtual void invokeLineSegmentCallbacks(const SoShape *shape,
                                  const SoPrimitiveVertex *v1,
                                  const SoPrimitiveVertex *v2);
  virtual void invokePointCallbacks(const SoShape *shape,
                            const SoPrimitiveVertex *v);
 
  // Should primitives be generated for this shape?
  virtual SbBool shouldGeneratePrimitives(const SoShape *shape) const;    
 
 private:
 
  // This flag is used by the SoSwitch etc. nodes which must return a
  // different result from its 'affectsState' method when called
  // during a CallbackAction that is doing the callback on all children.
  static SbBool duringCallbackAll;
  static void initClass();
  static void exitClass();
  
  // Returns the node that caused the callback:
  virtual SoNode *getCurPathTail();
  
  // Set the current node during traversal:
  void setCurrentNode(SoNode *node)
    { currentNode = node;} 
 
  void setStartTransparencyType(  SoGLRenderAction::TransparencyType type) {
    transpType = type;
  };
 
  bool removeTriangleCallback(SoType type, SoTriangleCB *cb);
 
  bool removeLineSegmentCallback(SoType type, SoLineSegmentCB *cb);
 
  bool removePointCallback(SoType type, SoPointCB *cb);
 
  bool removePostCallback(SoType type, SoCallbackActionCB *cb);
 
  bool removePreCallback(SoType type, SoCallbackActionCB *cb);
 
  enum CBFuncTypes
  {
    NONE=0,
    PRE =1,
    POST=2,
    PRE_TAIL=4,
    POST_TAIL=8,
    ANY=PRE|POST|PRE_TAIL|POST_TAIL,
  };
 
  // get the container for the given type
  // for same type ambiguity is solved using type
  template< class T, int N >
  SbPList& getCallbackList( );
 
 private:
  // Initiates action on graph
  virtual void beginTraversal(SoNode *node);
 
  // transforms vertices with the given matrix.
  // this is used to transform points during a forward traversal for callback actions
  void transformForwardTraversedVertices(const SbMatrix& model, size_t numVertices, SoPrimitiveVertex** vertices);
 
  // Response from last callback
  Response response;
 
 private:
  SbBool callbackAll;   // Callback all children or follow
  // normal traversal rules.
  // Callback lists
  SbPList preCallbackList;
  SbPList postCallbackList;
 
  SbPList preTailCallbackList;
  SbPList postTailCallbackList;
 
  SbPList triangleCallbackList;
  SbPList lineSegmentCallbackList;
  SbPList pointCallbackList;
 
  // Node where the callback occurs:
  SoNode *currentNode;
 
  SoGLRenderAction::TransparencyType transpType;     // Transparency quality type
};
 
#endif /* _SO_CALLBACK_ACTION_ */