SoGLRenderAction.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 SoGLRenderAction class
 |
 |   Author(s)          : Paul S. Strauss
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_GL_RENDER_ACTION_
#define  _SO_GL_RENDER_ACTION_
 
#include <Inventor/system/SbSystem.h>
#include <Inventor/SbViewportRegion.h>
#include <Inventor/actions/SoSubAction.h>
#include <Inventor/elements/SoShapeStyleElement.h>
 
class   SbBox3f;
class   SoGetBoundingBoxAction;
 
typedef void    SoGLRenderPassCB(void *userData);
 
 
 
 
class INVENTOR_API SoGLRenderAction : public SoAction {
 
    SO_ACTION_HEADER(SoGLRenderAction);
 
  public:
 
    enum TransparencyType {
        SCREEN_DOOR,            
        ADD,                    
        DELAYED_ADD,            
        SORTED_OBJECT_ADD,      
        BLEND,                  
        DELAYED_BLEND,          
        SORTED_OBJECT_BLEND     
    };
 
    enum AbortCode {
        CONTINUE,               
        ABORT,                  
        PRUNE,                  
        DELAY                   
    };
 
    typedef AbortCode SoGLRenderAbortCB(void *userData);
 
    SoGLRenderAction(const SbViewportRegion &viewportRegion);
                
 
    virtual ~SoGLRenderAction();
 
    void                setViewportRegion(const SbViewportRegion &newRegion);
 
    const SbViewportRegion &getViewportRegion() const   { return vpRegion; }
 
    void                setUpdateArea(const SbVec2f &origin,
                                      const SbVec2f &size);
    void                getUpdateArea(SbVec2f &origin, SbVec2f &size) const;
 
    void                setAbortCallback(SoGLRenderAbortCB *funcArg,
                                         void *userData)
        { abortCB = funcArg; abortData = userData; }
 
    void                setTransparencyType(TransparencyType type);
    TransparencyType    getTransparencyType() const     { return transpType; }
 
    void                setSmoothing(bool smooth);
    bool                isSmoothing() const             { return doSmooth; }
 
    void                setNumPasses(int num)           { numPasses = num;  }
    int                 getNumPasses() const            { return numPasses; }
 
    void                setPassUpdate(bool flag)      { passUpdate = flag; }
    bool                isPassUpdate() const            { return passUpdate; }
 
    void                setPassCallback(SoGLRenderPassCB *funcArg, void *userData)
        { passCB = funcArg; passData = userData; }
 
    void                setCacheContext(uint32_t context);
    uint32_t            getCacheContext() const;
 
    virtual void        invalidateState();
    
  SoEXTENDER public:
    int                 getCurPass() const              { return curPass; }
 
    bool                abortNow()
        { return (hasTerminated() || (abortCB != NULL && checkAbort())); }
 
    bool                handleTransparency(bool isTransparent = FALSE);
 
 
  SoINTERNAL public:
    static void         initClass();
 
    bool                isDelaying() const  { return sortObjs || delayObjs; }
 
    void                addDelayedPath(SoPath *path);
 
    bool                isRenderingDelayedPaths() const
        { return renderingDelPaths; }
 
    int                 getCullTestResults() { return cullBits; }
    void                setCullTestResults(int b) { cullBits = b; }
 
    bool setAllowDelayedPath(bool flag);
 
    bool getAllowDelayedPaths() { return allowDelayedPaths; }
 
  protected:
    virtual void        beginTraversal(SoNode *node);
 
  private:
    SbViewportRegion    vpRegion;       
    SbVec2f             updateOrigin;   
    SbVec2f             updateSize;     
 
 
    SoGLRenderAbortCB   *abortCB;       
    void                *abortData;     
 
    TransparencyType    transpType;     
    bool                doSmooth;       
    int                 numPasses;      
    int                 curPass;        
    bool                passUpdate;     
    SoGLRenderPassCB    *passCB;        
    void                *passData;      
 
    bool                renderingTranspObjs; 
    bool                delayObjs;      
    bool                sortObjs;       
    SoPathList          transpPaths;    
    SoGetBoundingBoxAction *ba;         
    SbBox3f             *bboxes;        
    int                 numBBoxes;      
 
    uint32_t            cacheContext;   
 
    SoPathList          delayedPaths;   
    bool                renderingDelPaths; 
    bool                allowDelayedPaths; 
 
    enum flags {
        TRANSPARENCY_TYPE       = 0x01,
        SMOOTHING               = 0x02,
        ALL                     = 0x03  
    };
    uint32_t            whatChanged;
 
    void                renderAllPasses(SoNode *node);
 
    void                renderPass(SoNode *node, int pass);
 
    void                renderTransparentObjs();
 
    void                enableBlending(bool enable);
 
    bool                checkAbort();
 
    int                 cullBits;
 
};
 
#endif /* _SO_GL_RENDER_ACTION_ */