SoWWWAnchor Class Reference
[GroupsVRML 1.0 nodes]

VSG extension Separator group node with a URL hyperlink. More...

#include <Inventor/nodes/SoWWWAnchor.h>

Inheritance diagram for SoWWWAnchor:
SoLocateHighlight SoSeparator SoGroup SoNode SoFieldContainer SoBase SoRefCounter SoTypedObject

List of all members.

Public Types

enum  Mapping {
  NONE,
  POINT
}

Public Member Functions

virtual SoType getTypeId () const
 SoWWWAnchor ()
void setFullURLName (const SbString &url)
const SbStringgetFullURLName ()

Static Public Member Functions

static SoType getClassTypeId ()
static void setFetchURLCallBack (SoWWWAnchorCB *f, void *userData)
static void setHighlightURLCallBack (SoWWWAnchorCB *f, void *userData)
static void enableEvents (SbBool OnOffFlag)

Public Attributes

SoSFFilePathString name
SoSFString description
SoSFEnum map

Detailed Description

VSG extension Separator group node with a URL hyperlink.

This node defines a separator group which has a URL (Universal Resource Locator) hyperlink. When clicked on, this node invokes an application callback to fetch the URL. The application may fetch the data itself, or call a World Wide Web browser like the HTML based Netscape Navigator or the VRML based WebSpace Navigator to load the URL.

FILE FORMAT/DEFAULT

ACTION BEHAVIOR

SEE ALSO

SoWWWInline


Member Enumeration Documentation

Mapping.

Enumerator:
NONE 

Do no add information to the URL.

POINT 

Add object-space coordinates to URL.


Constructor & Destructor Documentation

SoWWWAnchor::SoWWWAnchor (  ) 

Creates an anchor node with default settings.


Member Function Documentation

static void SoWWWAnchor::enableEvents ( SbBool  OnOffFlag  )  [static]
static SoType SoWWWAnchor::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoLocateHighlight.

const SbString& SoWWWAnchor::getFullURLName (  ) 

Returns the full URL set by setFullURLName(), or if not set, returns the contents of the name field.

virtual SoType SoWWWAnchor::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoLocateHighlight.

static void SoWWWAnchor::setFetchURLCallBack ( SoWWWAnchorCB f,
void *  userData 
) [static]

Application callback invoked when the mouse is clicked on an anchor so that the application can fetch the URL.

void SoWWWAnchor::setFullURLName ( const SbString url  )  [inline]

If the name field contains a relative URL (e.g., "foo.wrl" instead of "http://bogus.com/foo.wrl"), the anchor cannot resolve the URL reference.

This method allows the application to tell the anchor what its full URL should be. getFullURLName() returns the fullURL set here, or if not set, returns the contents of the name field.

static void SoWWWAnchor::setHighlightURLCallBack ( SoWWWAnchorCB f,
void *  userData 
) [static]

Application callbacks invoked when the mouse is moved over an anchor so that the app can provide feedback such as changing the cursor, or displaying the anchor description and name.


Member Data Documentation

A description of the URL which may make more sense to users than the URL itself (e.g., "The VSG Home Page").

Specifies what additional information should be added to the end of the URL when passed back to the application for fetching.

If set to POINT, then the x,y,z location of the object space intersection point when the mouse was clicked will be suffixed to the URL. Since the comma character does not transmit through some web browsers, it is written in hex form (e.g., if the intersection point is 17,4.5,1 the URL passed to the application callback would be "http://www.vsg3d.com/?17\%2c4.5\%2c1"). Use enum Mapping. Default is NONE.

URL which the application will be called back to fetch when this node is activated by a left mouse click (e.g., "http://www.vsg3d.com/").


The documentation for this class was generated from the following file:

Open Inventor Toolkit reference manual, generated on 8 Apr 2021
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/