SoWWWInline.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/
 *
 */
 
 
/*
 *
 _______________________________________________________________________
 ______________  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 SoWWWInline class
 |
 |   Author(s): Gavin Bell, David Mott, Jim Kent
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_WWWINLINE_
#define  _SO_WWWINLINE_
 
#include <Inventor/misc/SoChildList.h>
#include <Inventor/nodes/SoSubNode.h>
#include <Inventor/fields/SoSFNode.h>
#include <Inventor/fields/SoSFString.h>
#include <Inventor/fields/SoSFVec3f.h>
 
#include <Inventor/actions/SoCallbackAction.h>
 
class SoWWWInline;
class SoGroup;
class SoWriteAction;
 
typedef void INVENTOR_API SoWWWInlineFetchURLCB(
    const SbString &url, void *userData, SoWWWInline *node);
                
 
 
 
 
class INVENTOR_API SoWWWInline : public SoNode {
 
    SO_NODE_HEADER(SoWWWInline);
 
  public:
 
    SoWWWInline();
 
    enum BboxVisibility {
        NEVER,             
        UNTIL_LOADED,      
        ALWAYS            
    };
 
    SoSFVec3f   bboxCenter;     
    SoSFVec3f   bboxSize;       
    SoSFString  name;           
    SoSFNode    alternateRep;   
 
    void                setFullURLName(const SbString &url) { fullURL = url; }
    const SbString &    getFullURLName();
 
    SoGroup             *copyChildren() const;
 
    void                requestURLData() 
                            { if (! kidsRequested) requestChildrenFromURL(); }
    bool                isURLDataRequested() const { return kidsRequested; }
    bool                isURLDataHere() const { return kidsAreHere; }
    void                cancelURLDataRequest() 
                            { if (!kidsAreHere) kidsRequested = FALSE; }
 
    void                setChildData(SoNode *urlData);
    SoNode *            getChildData() const;
 
    static void setFetchURLCallBack(SoWWWInlineFetchURLCB *f, void *userData);
 
    static void setBoundingBoxVisibility(BboxVisibility b) { bboxVisibility = b; } 
    static BboxVisibility getBoundingBoxVisibility() { return bboxVisibility; }
 
    static void setBoundingBoxColor(SbColor &c) { bboxColor = c; }
    static const SbColor &getBoundingBoxColor() { return bboxColor; }
 
 
  SoEXTENDER public:
    virtual void        doAction(SoAction *action);
    virtual void        doActionOnKidsOrBox(SoAction *action);
    virtual void        callback(SoCallbackAction *action);
    virtual void        GLRender(SoGLRenderAction *action);
    virtual void        getBoundingBox(SoGetBoundingBoxAction *action);
    virtual void        getMatrix(SoGetMatrixAction *action);
    virtual void        handleEvent(SoHandleEventAction *action);
    virtual void        search(SoSearchAction *action);
    virtual void        pick(SoPickAction *action);
 
  SoINTERNAL public:
    static void         initClass();
 
    virtual SoChildList *getChildren() const;
 
  protected:
    virtual ~SoWWWInline();
 
    virtual void        addBoundingBoxChild(SbVec3f center, SbVec3f size);
 
    virtual bool        readInstance(SoInput *in, unsigned short flags);
 
    virtual void        copyContents(const SoFieldContainer *fromFC,
                                     bool copyConnections);
 
  private:
    void                requestChildrenFromURL();
 
    SoChildList         *children;
    bool                kidsRequested;
    bool                kidsAreHere;
    SbString            fullURL;
 
    static SbColor            bboxColor;
    static BboxVisibility     bboxVisibility;
 
    static SoWWWInlineFetchURLCB        *fetchURLcb;
    static void                         *fetchURLdata;
};
 
#endif /* _SO_WWWINLINE_ */