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

#include <Inventor/nodes/SoWWWAnchor.h>

Inheritance diagram for SoWWWAnchor:

Public Types
enum	Mapping { NONE , POINT }

Public Types inherited from SoLocateHighlight
enum	Styles { EMISSIVE , EMISSIVE_DIFFUSE }
	Possible values for draw style. More...

enum	Modes { AUTO , ON , OFF }
	Possible values for the mode. More...

Public Types inherited from SoSeparator
enum	CacheEnabled { OFF , ON , AUTO }
	Possible values for caching. More...

Public Types inherited from SoNode
enum	Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE }

Public Member Functions
	SoWWWAnchor ()
	Creates an anchor node with default settings.

Public Member Functions inherited from SoLocateHighlight
	SoLocateHighlight ()
	Creates a LocateHighlight node with default settings.

virtual void	GLRenderBelowPath (SoGLRenderAction *action)
	These methods make render traversal faster by implementing different rendering paths corresponding to different action path codes.

virtual void	GLRenderInPath (SoGLRenderAction *action)

Public Member Functions inherited from SoSeparator
	SoSeparator ()
	Creates a separator node with default settings.

	SoSeparator (int nChildren)
	Constructor that takes approximate number of children.

virtual bool	affectsState () const
	Overrides default method on SoNode.

virtual void	doAction (SoAction *action)
	Implement actions.

virtual void	callback (SoCallbackAction *action)

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)

virtual void	getMatrix (SoGetMatrixAction *action)

virtual void	GLRender (SoGLRenderAction *action)
	These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing.

virtual void	rayPick (SoRayPickAction *action)

virtual void	search (SoSearchAction *action)

virtual void	GLRenderOffPath (SoGLRenderAction *action)

virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance.

Public Member Functions inherited from SoGroup
	SoGroup ()
	Creates an empty group node.

	SoGroup (int nChildren)
	Constructor that takes approximate number of children.

void	addChild (SoNode *child)
	Adds a child as last one in group.

void	insertChild (SoNode *child, int newChildIndex)
	Adds a child so that it becomes the one with the given index.

SoNode *	getChild (int index) const
	Returns pointer to child node with the given index.

int	findChild (const SoNode *child) const
	Finds index of given child within group. Returns -1 if not found.

int	getNumChildren () const
	Returns number of children.

void	removeChild (int index)
	Removes child with given index from group.

void	removeChild (SoNode *child)
	Removes first instance of given child from group.

void	removeAllChildren ()
	Removes all children from group.

void	replaceChild (int index, SoNode *newChild)
	Replaces child with given index with new child.

void	replaceChild (SoNode oldChild, SoNode newChild)
	Replaces first instance of given child with new child.

virtual void	doAction (SoAction *action)
	Implement actions.

virtual void	callback (SoCallbackAction *action)

virtual void	GLRender (SoGLRenderAction *action)
	These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing.

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)

virtual void	getMatrix (SoGetMatrixAction *action)

virtual void	handleEvent (SoHandleEventAction *action)

virtual void	pick (SoPickAction *action)

virtual void	search (SoSearchAction *action)

virtual void	write (SoWriteAction *action)

virtual SoChildList *	getChildren () const
	Returns pointer to children.

Public Member Functions inherited from SoNode
void	setOverride (bool state)
	Turns override flag on or off.

bool	isOverride () const
	Returns the state of the override flag.

SoNode *	copy (bool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.

virtual bool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.

virtual void	doAction (SoAction *action)
	This method performs the "typical" operation of a node for any action.

virtual void	GLRender (SoGLRenderAction *action)
	These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing.

virtual void	callback (SoCallbackAction *action)

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)

virtual void	getMatrix (SoGetMatrixAction *action)

virtual void	handleEvent (SoHandleEventAction *action)

virtual void	pick (SoPickAction *action)

virtual void	rayPick (SoRayPickAction *action)

virtual void	search (SoSearchAction *action)

virtual void	write (SoWriteAction *action)

virtual void	GLRenderBelowPath (SoGLRenderAction *action)
	These methods make render traversal faster by implementing different rendering paths corresponding to different action path codes.

virtual void	GLRenderInPath (SoGLRenderAction *action)

virtual void	GLRenderOffPath (SoGLRenderAction *action)

virtual void	grabEventsSetup ()
	These virtual functions are called when a node gains or loses status as "grabber" of events (see HandleEventAction::setGrabber()).

virtual void	grabEventsCleanup ()

virtual void	startNotify ()
	Initiates notification from an instance.

virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance.

SbNodeIdType	getNodeId () const
	Returns the unique id for a node.

virtual SoChildList *	getChildren () const
	Returns pointer to children, or NULL if none.

virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used for either stage of writing.)

virtual SoNode *	addToCopyDict () const
	Recursively adds this node and all nodes under it to the copy dictionary.

virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given node into this instance.

virtual SoFieldContainer *	copyThroughConnection () const
	Copies an instance that is encountered through a field connection.

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

bool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

bool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to `fc's` fields.

void	copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE)
	Copies the contents of `fc's` fields into this object's fields.

bool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends pointers to all of this object's fields to resultList, and returns the number of fields appended.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a pointer to the field with the given name.

bool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the `fieldName` argument.

bool	enableNotify (bool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

bool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

bool	set (const char fieldDataString, SoInput dictIn)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format.

void	get (SbString &fieldDataString, SoOutput *dictOut)
	Returns the values of the fields of this object in the Inventor ASCII file format in the given string.

virtual void	notify (SoNotList *)
	Propagates modification notification through an instance.

virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing.

virtual void	writeInstance (SoOutput *out)
	Writes instance to SoOutput. (Used only for last stage of writing)

bool	getIsBuiltIn () const
	Returns whether or not instance is considered 'built-in' to the library.

virtual const SoFieldData *	getFieldData () const
	Returns an SoFieldData structure for the node.

virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given node into this instance.

virtual SoFieldContainer *	copyThroughConnection () const
	During a copy operation, this copies an instance that is encountered through a field connection.

void	addManagedSensor (SoSensor *sensor)
	Adds a sensor which is managed by the field container.

Public Member Functions inherited from SoBase
void	ref () const
	Adds and removes a reference to an instance.

void	unref () const

void	unrefNoDelete () const

void	touch ()
	Marks an instance as modified, simulating a change to it.

virtual SoType	getTypeId () const =0
	Returns the type identifier for a specific instance.

bool	isOfType (SoType type) const
	Returns TRUE if this object is of the type specified in `type` or is derived from that type.

virtual SbName	getName () const
	Returns the name of an instance.

virtual void	setName (const SbName &name)
	Sets the name of an instance.

virtual void	startNotify ()
	Initiates notification from an instance.

virtual void	notify (SoNotList *list)
	Propagates modification notification through an instance.

void	addAuditor (void *auditor, SoNotRec::Type type)
	Adds/removes an auditor to/from list.

void	removeAuditor (void *auditor, SoNotRec::Type type)

const SoAuditorList &	getAuditors ()
	Returns auditor list– used by SoField and SoEngineOutput to trace forward connections.

int	getRefCount () const
	Returns current reference count.

virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Adds a reference to the instance when writing.

bool	shouldWrite ()
	Returns TRUE if the instance should be written, based on the write-reference info already accumulated.

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.

SoSFString	description
	A description of the URL which may make more sense to users than the URL itself (e.g.

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

static SoWWWAnchorCB *	fetchURLcb

static void *	fetchURLdata

static SoWWWAnchorCB *	highlightURLcb

static void *	highlightURLdata

static SbString	emptyString

void	setFullURLName (const SbString &url)

const SbString &	getFullURLName ()
	If the name field contains a relative URL (e.g.

virtual void	handleEvent (SoHandleEventAction *action)
	Override handleEvent to look for left-mouse clicks, to do a pick:

static void	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.

static void	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.

static void	initClass ()

virtual	~SoWWWAnchor ()

virtual void	redrawHighlighted (SoAction *act, bool isNowHighlighting)
	redefine this to also invoke the app callbacks... This is called when the locate highlight status of this node changes.

Additional Inherited Members
Static Public Member Functions inherited from SoLocateHighlight
static void	initClass ()
	initialize the class

static void	turnOffCurrentHighlight (SoGLRenderAction *action)
	This will de-highlight the currently highlighted node if any.

Static Public Member Functions inherited from SoSeparator
static void	setNumRenderCaches (int howMany)
	By default, each separator node maintains 2 render caches.

static int	getNumRenderCaches ()
	Returns the current number of render caches.

static void	initClass ()

Static Public Member Functions inherited from SoGroup
static void	initClass ()

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns type identifier for the SoNode class.

static SoNode *	getByName (const SbName &name)
	Returns the last node given the specified name.

static int	getByName (const SbName &name, SoNodeList &list)
	Returns the number of nodes with the given name, and adds to `list` pointers to those nodes.

static void	initClass ()
	Initializes base node class.

static void	initClasses ()
	Initialize ALL Inventor node classes.

static SbNodeIdType	getNextNodeId ()
	Returns the next available unique id.

static int	getActionMethodIndex (SoType t)
	Returns the index of this node in the action/method table, given its type.

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

static void	initClass ()
	Setup type information.

static void	initCopyDict ()
	During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used.

static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)
	Adds an instance to the dictionary.

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)
	If a copy of the given instance is in the dictionary, this returns it.

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, bool copyConnections)
	If a copy of the given instance is not in the dictionary, this returns NULL.

static void	copyDone ()
	Cleans up the dictionary when done.

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.

static void	initClass ()
	Setup type information.

static void	incrementCurrentWriteCounter ()
	Increments the current write counter at the start of a write operation.

static void	decrementCurrentWriteCounter ()
	Decrements the current write counter after a write operation, in some rare cases.

static void	addName (SoBase , const char )
	Internal methods used to maintain the global name dictionary.

static void	removeName (SoBase , const char )

static SoBase *	getNamedBase (const SbName &, SoType)
	Helper routines used to get stuff out of nameDict.

static int	getNamedBases (const SbName &, SoBaseList &, SoType)

static bool	read (SoInput in, SoBase &base, SoType expectedType)
	Reads one instance of some subclass of SoBase.

static void	setInstancePrefix (const SbString &c)
	This defaults to "+" and is used when naming nodes that are DEF's and USE'd.

Public Attributes inherited from SoLocateHighlight
SoSFColor	color
	Highlighting color - default [.3, .3, .3].

SoSFEnum	style
	Highlighting draw style - default EMISSIVE.

SoSFEnum	mode
	Whether to highlight or not - default AUTO.

Public Attributes inherited from SoSeparator
SoSFEnum	renderCaching
	Whether to cache during rendering traversal.

SoSFEnum	boundingBoxCaching
	Whether to cache during bounding box traversal.

SoSFEnum	renderCulling
	Whether to cull during rendering traversal.

SoSFEnum	pickCulling
	Whether to cull during picking traversal.

Static Public Attributes inherited from SoBase
static bool	traceRefs
	Turns on/off reference count tracing (for debugging)

Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
	This set of enums is used when reading and writing the base. More...

Protected Member Functions inherited from SoLocateHighlight
virtual	~SoLocateHighlight ()

Protected Member Functions inherited from SoSeparator
virtual bool	cullTest (SoGLRenderAction *action, int &cullResults)
	Returns TRUE if this separator can be culled because it is outside the cull volume.

virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance of SoGroup. Returns FALSE on error.

virtual	~SoSeparator ()

Protected Member Functions inherited from SoGroup
virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance of SoGroup. Returns FALSE on error.

virtual bool	readChildren (SoInput *in)
	Reads just the children into instance of SoGroup. Returns FALSE on error.

virtual	~SoGroup ()

virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given node into this instance.

Protected Member Functions inherited from SoNode
	SoNode ()
	Constructor, destructor.

virtual	~SoNode ()

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer ()

	~SoFieldContainer ()

virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance. Returns FALSE on error.

Protected Member Functions inherited from SoBase
	SoBase ()
	Constructor is protected - this is an abstract class.

virtual	~SoBase ()
	Virtual destructor so that subclasses are deleted properly.

virtual void	destroy ()
	Actually deletes an instance.

bool	hasMultipleWriteRefs () const
	Returns TRUE if the instance has multiple write references.

bool	writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
	Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput.

void	writeFooter (SoOutput *out) const

virtual const char *	getFileFormatName () const
	Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned)

virtual bool	readInstance (SoInput *in, unsigned short flags)=0
	Reads stuff into instance of subclass.

Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr ()
	This is used by the field-inheritence mechanism, hidden in the SoSubNode macros.

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter ()
	Returns current write counter.

Protected Attributes inherited from SoGroup
SoChildList *	children

Protected Attributes inherited from SoNode
SbNodeIdType	uniqueId
	Unique id for this node.

Protected Attributes inherited from SoFieldContainer
bool	isBuiltIn
	Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information.

Static Protected Attributes inherited from SoNode
static SbNodeIdType	nextUniqueId
	Next available unique id.

static int	nextActionMethodIndex
	Next index into the action method table.

Detailed 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.

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()).

See Also

: SoWWWInline

Definition at line 93 of file SoWWWAnchor.h.

Member Enumeration Documentation

◆ Mapping

enum SoWWWAnchor::Mapping

Enumerator
NONE	Do no add information to the URL.
POINT	Add object-space coordinates to URL.

Definition at line 102 of file SoWWWAnchor.h.

Constructor & Destructor Documentation

◆ SoWWWAnchor()

SoWWWAnchor::SoWWWAnchor ( )

◆ ~SoWWWAnchor()

virtual SoWWWAnchor::~SoWWWAnchor ( )

protectedvirtual

Member Function Documentation

◆ getFullURLName()

const SbString & SoWWWAnchor::getFullURLName ( )

"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.

◆ handleEvent()

virtual void SoWWWAnchor::handleEvent ( SoHandleEventAction * action )

virtual

Reimplemented from SoLocateHighlight.

◆ initClass()

static void SoWWWAnchor::initClass ( )

static

◆ redrawHighlighted()

virtual void SoWWWAnchor::redrawHighlighted	(	SoAction *	act,
		bool	isNowHighlighting
	)

protectedvirtual

Reimplemented from SoLocateHighlight.

◆ setFetchURLCallBack()

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

static

◆ setFullURLName()

void SoWWWAnchor::setFullURLName ( const SbString & url )

inline

See also: getFullURLName()

Definition at line 132 of file SoWWWAnchor.h.

◆ setHighlightURLCallBack()

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

static

Member Data Documentation

◆ description

SoSFString SoWWWAnchor::description

"The Open Inventor Home Page").

Definition at line 117 of file SoWWWAnchor.h.

◆ emptyString

SbString SoWWWAnchor::emptyString

staticprotected

Definition at line 172 of file SoWWWAnchor.h.

◆ fetchURLcb

SoWWWAnchorCB* SoWWWAnchor::fetchURLcb

staticprotected

Definition at line 168 of file SoWWWAnchor.h.

◆ fetchURLdata

void* SoWWWAnchor::fetchURLdata

staticprotected

Definition at line 169 of file SoWWWAnchor.h.

◆ highlightURLcb

SoWWWAnchorCB* SoWWWAnchor::highlightURLcb

staticprotected

Definition at line 170 of file SoWWWAnchor.h.

◆ highlightURLdata

void* SoWWWAnchor::highlightURLdata

staticprotected

Definition at line 171 of file SoWWWAnchor.h.

◆ map

SoSFEnum SoWWWAnchor::map

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").

Definition at line 127 of file SoWWWAnchor.h.

◆ name

SoSFString SoWWWAnchor::name

"http://www.sgi.com/Technology/Inventor").

Definition at line 113 of file SoWWWAnchor.h.

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

C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/nodes/SoWWWAnchor.h

Public Types

Public Member Functions

Fields

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Mapping

Constructor & Destructor Documentation

◆ SoWWWAnchor()

◆ ~SoWWWAnchor()

Member Function Documentation

◆ getFullURLName()

◆ handleEvent()

◆ initClass()

◆ redrawHighlighted()

◆ setFetchURLCallBack()

◆ setFullURLName()

◆ setHighlightURLCallBack()

Member Data Documentation

◆ description

◆ emptyString

◆ fetchURLcb

◆ fetchURLdata

◆ highlightURLcb

◆ highlightURLdata

◆ map

◆ name