SoWWWInline.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      : Gavin Bell (MMM yyyy)
** Modified by : David Mott (MMM yyyy)
** Modified by : Jim Kent (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_WWWINLINE_
#define  _SO_WWWINLINE_
 
#include <Inventor/misc/SoChildList.h>
#include <Inventor/nodes/SoNode.h>
#include <Inventor/fields/SoSFNode.h>
#include <Inventor/fields/SoSFFilePathString.h>
#include <Inventor/fields/SoSFVec3f.h>
 
#include <Inventor/actions/SoCallbackAction.h>
 
class SoWWWInline;
class SoGroup;
class SoWriteAction;
 
typedef void SoWWWInlineFetchURLCB(
                                   const SbString &url, void *userData, SoWWWInline *node);
                
 
//
//  Class: SoWWWInline
//
 
class  SoWWWInline : public SoNode {
 
  SO_NODE_HEADER(SoWWWInline);
 
 public:
  SoWWWInline();
 
  enum BboxVisibility {
    NEVER,
    UNTIL_LOADED,
    ALWAYS
  };
 
  SoSFVec3f   bboxCenter;
  SoSFVec3f   bboxSize;
  SoSFFilePathString  name;
  SoSFNode    alternateRep;
    
  void                setFullURLName(const SbString &url) { fullURL = url; }
  const SbString &    getFullURLName();
 
  SoGroup             *copyChildren() const;
    
  void                requestURLData() 
    { if (! kidsRequested) requestChildrenFromURL(); }
  SbBool              isURLDataRequested() const { return kidsRequested; }
  SbBool              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) ;
  static BboxVisibility getBoundingBoxVisibility() ;
 
  static void setBoundingBoxColor(SbColor &c) ;
  static const SbColor &getBoundingBoxColor() ;
 
  static void setReadAsSoFile(SbBool onOff) { readAsSoFile = onOff; };
  static SbBool getReadAsSoFile() { return readAsSoFile; };
 
 
 private:
  // Traversal methods for all the actions:
  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);
  virtual void        getPrimitiveCount(SoGetPrimitiveCountAction *action);
 
 private:
  static void         initClass();
  static void         exitClass();
  const SbString &    getBasePath() { return basePath; }
  void                setBasePath( const SbString &path ) { basePath = path; }
 
  // Returns pointer to children, or NULL if none
  virtual SoChildList *getChildren() const;
  
  // Copies the child data as well as the rest of the node (if
  // the child data has been set)
  virtual void        copyContents(const SoFieldContainer *fromFC,
                                   SbBool copyConnections);
 
 private:
  virtual ~SoWWWInline();
 
  virtual void        addBoundingBoxChild(SbVec3f center, SbVec3f size);
 
  // Reads into instance of SoWWWInline. Returns FALSE on error.
  virtual SbBool      readInstance(SoInput *in, unsigned short flags);
 
 private:
  SbString            basePath;
  void                requestChildrenFromURL();
 
  SoChildList         *children;
  SbBool              kidsRequested;
  SbBool              kidsAreHere;
  SbString            fullURL;
 
  static SbColor            bboxColor;
  static BboxVisibility     bboxVisibility;
 
  // Static methods
  static SoWWWInlineFetchURLCB       *fetchURLcb;
  static void                                *fetchURLdata;
 
  // static variable for whether to read "name" as if this
  // was an SoFile node
  static SbBool readAsSoFile;
};
 
#endif /* _SO_WWWINLINE_ */