man SoWWWAnchor () - separator group node with a URL hyperlink
NAME
SoWWWAnchor - separator group node with a URL hyperlink
INHERITS FROM
SoBase > SoFieldContainer > SoNode > SoGroup > SoSeparator > SoLocateHighlight > SoWWWAnchor
SYNOPSIS
#include <Inventor/nodes/SoWWWAnchor.h>
c
}
c
}
SoWWWAnchorCB(const SbString &url, void *userData, SoWWWAnchor *node)
enum Mapping {
c
}
c
}
Do not add information to the URL
c
}
c
}
Add object-space coordinates to URL
}
Fields from class SoWWWAnchor:
c
}
c
}
name
c
}
c
}
description
c
}
c
}
map
Fields from class SoLocateHighlight:
c
}
c
}
color
c
}
c
}
style
c
}
c
}
mode
Fields from class SoSeparator:
c
}
c
}
renderCaching
c
}
c
}
boundingBoxCaching
c
}
c
}
renderCulling
c
}
c
}
pickCulling
Methods from class SoWWWAnchor:
c
}
c
}
SoWWWAnchor()
c
}
c
}
getClassTypeId()
c
}
c
}
setFullURLName(const SbString &url)
c
}
c
}
getFullURLName()
c
}
c
}
setFetchURLCallBack(SoWWWAnchorCB *f, void *userData)
c
}
c
}
setHighlightURLCallBack(SoWWWAnchorCB *f, void *userData)
Methods from class SoSeparator:
c
}
c
}
setNumRenderCaches(int howMany)
c
}
c
}
getNumRenderCaches()
Methods from class SoGroup:
c
}
c
}
addChild(SoNode *child)
c
}
c
}
insertChild(SoNode *child, int newChildIndex)
c
}
c
}
getChild(int index) const
c
}
c
}
findChild(const SoNode *child) const
c
}
c
}
getNumChildren() const
c
}
c
}
removeChild(int index)
c
}
c
}
removeChild(SoNode *child)
c
}
c
}
removeAllChildren()
c
}
c
}
replaceChild(int index, SoNode *newChild)
c
}
c
}
replaceChild(SoNode *oldChild, SoNode *newChild)
Methods from class SoNode:
c
}
c
}
setOverride(SbBool state)
c
}
c
}
isOverride() const
c
}
c
}
copy(SbBool copyConnections = FALSE) const
c
}
c
}
affectsState() const
c
}
c
}
getByName(const SbName &name)
c
}
c
}
getByName(const SbName &name, SoNodeList &list)
Methods from class SoFieldContainer:
c
}
c
}
setToDefaults()
c
}
c
}
hasDefaultValues() const
c
}
c
}
fieldsAreEqual(const SoFieldContainer *fc) const
c
}
c
}
copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)
c
}
c
}
set(const char *fieldDataString)
c
}
c
}
get(SbString &fieldDataString)
c
}
c
}
getFields(SoFieldList &resultList) const
c
}
c
}
getField(const SbName &fieldName) const
c
}
c
}
getFieldName(const SoField *field, SbName &fieldName) const
c
}
c
}
isNotifyEnabled() const
c
}
c
}
enableNotify(SbBool flag)
Methods from class SoBase:
c
}
c
}
ref()
c
}
c
}
unref() const
c
}
c
}
unrefNoDelete() const
c
}
c
}
touch()
c
}
c
}
getTypeId() const
c
}
c
}
isOfType(SoType type) const
c
}
c
}
setName(const SbName &name)
c
}
c
}
getName() const
DESCRIPTION
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.
FIELDS
c
}
c
}
name
URL which the application will be called back to fetch when this node is activated by a left mouse click (e.g. "http://www.sgi.com/Technology/Inventor").
c
}
c
}
description
A description of the URL which may make more sense to users than the URL itself (e.g. "The Open Inventor Home Page").
c
}
c
}
map
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.sgi.com/Technology/Inventor?17%2c4.5%2c1").
METHODS
c
}
c
}
SoWWWAnchor()
Creates an anchor node with default settings.
c
}
c
}
getClassTypeId()
Returns type identifier for this class.
c
}
c
}
setFullURLName(const SbString &url)
c
}
c
}
getFullURLName()
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
it's full URL should be. getFullURLName() returns the fullURL set here, or if not set, returns the contents of the name field.
c
}
c
}
setFetchURLCallBack(SoWWWAnchorCB *f, void *userData)
Application callbacks invoked when the mouse is clicked on an anchor so that the application can fetch the URL or call Netscape or WebSpace to fetch the URL.
c
}
c
}
setHighlightURLCallBack(SoWWWAnchorCB *f, void *userData)
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.
ACTION BEHAVIOR
SoHandleEventAction
When the left mouse is clicked over a child of this anchor node, the application is called back to fetch the URL (see setFetchURLCallBack()).
FILE FORMAT/DEFAULTS
WWWAnchor {
renderCaching AUTO
boundingBoxCaching AUTO
renderCulling AUTO
pickCulling AUTO
mode AUTO
style EMISSIVE
color 0.3 0.3 0.3
name "<Undefined URL>"
description ""
map NONE
}
SEE ALSO
SoWWWInline