SoWWWAnchor.h

Go to the documentation of this file.

/*=======================================================================
 * 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      : David Mott (MMM yyyy)
** Modified by : Jim Kent (MMM yyyy)
** Modified by : Gavin Bell (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-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_WWWANCHOR_
#define  _SO_WWWANCHOR_
 
#include <Inventor/fields/SoSFString.h>
#include <Inventor/fields/SoSFFilePathString.h>
#include <Inventor/nodes/SoLocateHighlight.h>
 
class SoWWWAnchor;
 
typedef void SoWWWAnchorCB(const SbString &url, void *userData, SoWWWAnchor *node);
 
 
//
//  Class: SoWWWAnchor
//
 
class  SoWWWAnchor : public SoLocateHighlight {
 
  SO_NODE_HEADER(SoWWWAnchor);
 
 public:
  SoWWWAnchor();
 
  enum Mapping { 
    NONE,
    POINT
  };
 
  SoSFFilePathString  name;
  SoSFString  description;
  SoSFEnum map;
    
  void setFullURLName(const SbString &url) { fullURL = url; }
  const SbString & getFullURLName();
 
  static void setFetchURLCallBack( SoWWWAnchorCB *f, void *userData); 
 
  static void setHighlightURLCallBack( SoWWWAnchorCB *f, void *userData);
 
  // Need to enable or disable event handling so the geometry
  // contained therein can be picked, manipulated, etc.
  static void enableEvents(SbBool OnOffFlag);
 
 private:
  // Override handleEvent to look for left-mouse clicks, to do a
  // pick:
  virtual void handleEvent(SoHandleEventAction *action);
 
 private:
  static void initClass();
  static void exitClass();
 
 private:
  virtual ~SoWWWAnchor();
    
  // redefine this to also invoke the app callbacks...
  // This is called when the locate highlight status of this node changes.
  virtual void redrawHighlighted(SoAction *act, SbBool isNowHighlighting);
 
  static SoWWWAnchorCB           *fetchURLcb;
  static void                    *fetchURLdata;
  static SoWWWAnchorCB           *highlightURLcb;
  static void                    *highlightURLdata;
  static SbString                emptyString;
  
 private:  
  SbString fullURL;
  static SbBool enableEventsFlag;
 
};
 
#endif /* _SO_WWWANCHOR_ */