MeVis/ThirdParty/Sources/Inventor/inventor/lib/interaction/include/Inventor/SoSceneManager.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/
 *
 */



#ifndef _SO_SCENE_MANAGER_
#define _SO_SCENE_MANAGER_

#include <Inventor/SbColor.h>
#include <Inventor/actions/SoGLRenderAction.h>

class SoNodeSensor;
class SoEvent;
class SoHandleEventAction;
class SoNode;
class SoSceneManager;
class SoSensor;
class SoSFTime;
class SoOneShotSensor;

typedef void SoSceneManagerRenderCB(void *userData, SoSceneManager *mgr);





class INVENTOR_API SoSceneManager {
  public:

    SoSceneManager();

    ~SoSceneManager();

    virtual void        render(SbBool clearWindow = TRUE, SbBool clearZbuffer = TRUE);
    virtual SbBool      processEvent(const SoEvent *event);
    void                reinitialize();

    void                scheduleRedraw();

    virtual void        setSceneGraph(SoNode *newScene);
    virtual SoNode *    getSceneGraph() const;

    void                setWindowSize(const SbVec2s &newSize);
    const SbVec2s &     getWindowSize() const;

    void                setSize(const SbVec2s &newSize);
    const SbVec2s &     getSize() const;
    void                setOrigin(const SbVec2s &newOrigin);    
    const SbVec2s &     getOrigin() const;
    
    void        setViewportRegion(const SbViewportRegion &newRegion);
    const SbViewportRegion &getViewportRegion() const;

    void                setBackgroundColor(const SbColor &c);
    const SbColor &     getBackgroundColor() const  { return bkgColor; }

    void                setBackgroundIndex(int index);
    int                 getBackgroundIndex() const  { return bkgIndex; }

    void                setRGBMode(SbBool onOrOff);
    SbBool              isRGBMode() const           { return rgbMode; }

    virtual void        activate();
    virtual void        deactivate();

    void                setRenderCallback(
                            SoSceneManagerRenderCB *f,
                            void *userData = NULL);
    SbBool              isAutoRedraw() const { return (renderCB != NULL); }

    void                setRedrawPriority(uint32_t priority);
    uint32_t    getRedrawPriority() const;

    static uint32_t getDefaultRedrawPriority() { return 10000; }

    static void         enableRealTimeUpdate(SbBool flag);
    static SbBool       isRealTimeUpdateEnabled()       { return updateRealTime; }

    void            setAntialiasing(SbBool smoothing, int numPasses);
    void            getAntialiasing(SbBool &smoothing, int &numPasses) const;
    
  SoEXTENDER public:
    void                setGLRenderAction(SoGLRenderAction *ra);
    SoGLRenderAction    *getGLRenderAction() const { return renderAction; }

    void                setHandleEventAction(SoHandleEventAction *hea);
    SoHandleEventAction *getHandleEventAction() const { return handleEventAction; }

  protected:
    SoSceneManagerRenderCB  *renderCB;
    void                    *renderCBData;
    SbBool              isActive() const { return active; }
    
    void                redraw();
    
  private:
    SbBool              raCreatedHere;
    SbBool              heaCreatedHere;
    SoGLRenderAction    *renderAction;
    SoHandleEventAction *handleEventAction;
    SoNode              *scene;
    SoNodeSensor        *sceneSensor;   
    uint32_t    redrawPriority; 
    SbBool              active;         
    SbBool              needZbuffer;
    SbBool              needToSendVP; 
    
    SbColor             bkgColor;
    int                 bkgIndex;
    SbBool              graphicsInitNeeded;
    SbBool              rgbMode;
    
    static void         antialiasingCallback(void *);
    static void         sceneSensorCallback(SoSceneManager *, SoSensor *);
    
    static SbBool       updateRealTime;
    static SoSFTime     *realTime;
    static SoOneShotSensor *realTimeSensor; 
    static void         realTimeSensorCB();
};


#endif // _SO_SCENE_MANAGER_