SoCallbackAction.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */
 
 
/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.1.1.1 $
 |
 |   Description:
 |      Defines the SoCallbackAction class
 |
 |   Author(s)          : Dave Immel, Thad Beier
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_CALLBACK_ACTION_
#define  _SO_CALLBACK_ACTION_
 
#include <Inventor/system/SbSystem.h>
#include <Inventor/SbBox.h>
#include <Inventor/actions/SoSubAction.h>
#include <Inventor/nodes/SoComplexity.h>
#include <Inventor/nodes/SoDrawStyle.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/SoTexture2.h>
#include <Inventor/nodes/SoTextureCoordinateBinding.h>
#include <Inventor/nodes/SoUnits.h>
 
class SoPrimitiveVertex;
class SoShape;

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


 
class INVENTOR_API SoCallbackAction : public SoAction {
 
    SO_ACTION_HEADER(SoCallbackAction);
 
  public:

    enum Response {
        CONTINUE,               
        ABORT,                  
        PRUNE                   
    };

    typedef Response SoCallbackActionCB(void *userData,
                                        SoCallbackAction *action,
                                        const SoNode *node);

    SoCallbackAction();

    virtual ~SoCallbackAction();


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



    float                       getComplexity() const;
    SoComplexity::Type          getComplexityType() const;


    int32_t                     getNumCoordinates() const;
    const SbVec3f &             getCoordinate3(int index) const;
    const SbVec4f &             getCoordinate4(int index) const;

 
    SoDrawStyle::Style          getDrawStyle() const;
    u_short                     getLinePattern() const;
    float                       getLineWidth() const;
    float                       getPointSize() const;


    const SbName &              getFontName() const;
    float                       getFontSize() 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;


    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;
    const SbColor &                     getTextureBlendColor() const;

    const unsigned char *               getTextureImage(SbVec2s &size,
                                                        int &numComps) const;
    const SbMatrix &                    getTextureMatrix() const;
    SoTexture2::Model   getTextureModel() const;
    SoTexture2::Wrap                    getTextureWrapS() const;
    SoTexture2::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;
 
  SoEXTENDER public:
    Response            getCurrentResponse() const { return response; }

    void                invokePreCallbacks(const SoNode *node);
    void                invokePostCallbacks(const SoNode *node);

    void        invokeTriangleCallbacks(const SoShape *shape,
                                        const SoPrimitiveVertex *v1,
                                        const SoPrimitiveVertex *v2,
                                        const SoPrimitiveVertex *v3);
    void        invokeLineSegmentCallbacks(const SoShape *shape,
                                           const SoPrimitiveVertex *v1,
                                           const SoPrimitiveVertex *v2);
    void        invokePointCallbacks(const SoShape *shape,
                                     const SoPrimitiveVertex *v);

    bool        shouldGeneratePrimitives(const SoShape *shape) const;    
 
  SoINTERNAL public:
    static void         initClass();
    
    virtual SoNode *    getCurPathTail();
    
    void                setCurrentNode(SoNode *node)
        { currentNode = node;} 
 
  protected:
    virtual void        beginTraversal(SoNode *node);
 
  private:
    SbPList             preCallbackList;
    SbPList             postCallbackList;
 
    SbPList             preTailCallbackList;
    SbPList             postTailCallbackList;
 
    SbPList             triangleCallbackList;
    SbPList             lineSegmentCallbackList;
    SbPList             pointCallbackList;

    Response            response;
    
    SoNode *            currentNode;
};
 
#endif /* _SO_CALLBACK_ACTION_ */