SoWWWAnchor(3IV)
SoWWWAnchor (SoWWWAnchor) - separator group node with a URL hyperlink
As shipped in IRIX 6.5.30. Added in IRIX 6.5.22.
NAME SoWWWAnchor (SoWWWAnchor) - separator group node with a URL hyperlink INHERITS FROM SoBase > SoFieldContainer > SoNode > SoGroup > SoSeparator > SoLocateHighlight > SoWWWAnchor SYNOPSIS #include <Inventor_c/nodes/SoWWWAnchor.h> typedef void SoWWWAnchorCB(const SbString &url, void *userData, SoWWWAnchor *node) enum SoWWWAnchorMapping { NONE Do not add information to the URL POINT Add object-space coordinates to URL } Fields from class SoWWWAnchor: SoSFString name SoSFString description SoSFEnum map Fields from class SoLocateHighlight: SoSFColor color SoSFEnum style SoSFEnum mode Fields from class SoSeparator: SoSFEnum renderCaching SoSFEnum boundingBoxCaching SoSFEnum renderCulling SoSFEnum pickCulling Functions from class SoWWWAnchor: SoWWWAnchor * SoWWWAnchorCreate() SoType SoWWWAnchorGetClassTypeId() void SoWWWAnchorSetFullURLName(SoWWWAnchor *this, const SbString *url) const SbString * SoWWWAnchorGetFullURLName(SoWWWAnchor *this) void SoWWWAnchorSetFetchCB(SoWWWAnchorCB *f, void *userData) void SoWWWAnchorSetHLCB(SoWWWAnchorCB *f, void *userData) Functions from class SoSeparator: void SoWWWAnchorSetNumRenderCaches(int howMany) int SoWWWAnchorGetNumRenderCaches() Functions from class SoGroup: void SoWWWAnchorAddChild(SoWWWAnchor *this, SoNode *child) void SoWWWAnchorInsertChild(SoWWWAnchor *this, SoNode *child, int newChildIndex) SoNode * SoWWWAnchorGetChild(const SoWWWAnchor *this, int index) int SoWWWAnchorFindChild(const SoWWWAnchor *this, const SoNode *child) int SoWWWAnchorGetNumChildren(const SoWWWAnchor *this) void SoWWWAnchorRemoveChild(SoWWWAnchor *this, int index) void SoWWWAnchorRemoveChildNode(SoWWWAnchor *this, SoNode *child) void SoWWWAnchorRemoveAllChildren(SoWWWAnchor *this) void SoWWWAnchorReplaceChild(SoWWWAnchor *this, int index, SoNode *newChild) void SoWWWAnchorReplaceChildNode(SoWWWAnchor *this, SoNode *oldChild, SoNode *newChild) Functions from class SoNode: void SoWWWAnchorSetOverride(SoWWWAnchor *this, SbBool state) SbBool SoWWWAnchorIsOverride(const SoWWWAnchor *this) SoNode * SoWWWAnchorCopy(const SoWWWAnchor *this, SbBool copyConnections = FALSE) SbBool SoWWWAnchorAffectsState(const SoWWWAnchor *this) SoNode * SoWWWAnchorGetByName(const char *name) int SoWWWAnchorGetByNameList(const char *name, SoNodeList *list) Functions from class SoFieldContainer: void SoWWWAnchorSetToDflts(SoWWWAnchor *this) SbBool SoWWWAnchorHasDfltVals(const SoWWWAnchor *this) SbBool SoWWWAnchorFldsAreEq(const SoWWWAnchor *this, const SoFieldContainer *fc) void SoWWWAnchorCopyFieldVals(SoWWWAnchor *this, const SoFieldContainer *fc, SbBool copyConnections = FALSE) SbBool SoWWWAnchorSet(SoWWWAnchor *this, const char *fieldDataString) void SoWWWAnchorGet(SoWWWAnchor *this, SbString *fieldDataString) int SoWWWAnchorGetFields(const SoWWWAnchor *this, SoFieldList *resultList) SoField * SoWWWAnchorGetField(const SoWWWAnchor *this, const char *fieldName) SbBool SoWWWAnchorGetFieldName(const SoWWWAnchor *this, const SoField *field, SbName *fieldName) SbBool SoWWWAnchorIsNotifyEnabled(const SoWWWAnchor *this) SbBool SoWWWAnchorEnableNotify(SoWWWAnchor *this, SbBool flag) Functions from class SoBase: void SoWWWAnchorRef(SoWWWAnchor *this) void SoWWWAnchorUnref(const SoWWWAnchor *this) void SoWWWAnchorUnrefNoDelete(const SoWWWAnchor *this) void SoWWWAnchorTouch(SoWWWAnchor *this) SoType SoWWWAnchorGetTypeId(const SoWWWAnchor *this) SbBool SoWWWAnchorIsOfType(const SoWWWAnchor *this, SoType type) void SoWWWAnchorSetName(SoWWWAnchor *this, const char *name) SbName SoWWWAnchorGetName(const SoWWWAnchor *this) 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 SoSFString 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"). SoSFString description A description of the URL which may make more sense to users than the URL itself (e.g. "The Open Inventor Home Page"). SoSFEnum 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"). FUNCTIONS SoWWWAnchor * SoWWWAnchorCreate() Creates an anchor node with default settings. SoType SoWWWAnchorGetClassTypeId() Returns type identifier for this class. void SoWWWAnchorSetFullURLName(SoWWWAnchor *this, const SbString *url) const SbString * SoWWWAnchorGetFullURLName(SoWWWAnchor *this) 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. void SoWWWAnchorSetFetchCB(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. void SoWWWAnchorSetHLCB(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