Node that refers to children through a URL. More...

#include <Inventor/nodes/SoWWWInline.h>

Inheritance diagram for SoWWWInline:

Public Types
enum	BboxVisibility { NEVER , UNTIL_LOADED , ALWAYS }

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

Public Member Functions
	SoWWWInline ()
	Creates an inline node with default settings. More...

void	setFullURLName (const SbString &url)

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

SoGroup *	copyChildren () const
	Return (hidden) children as Group. More...

void	requestURLData ()
	Request that URL data be fetched. More...

bool	isURLDataRequested () const
	Return whether URL data has been requested and whether that data is here (i.e. More...

bool	isURLDataHere () const
	Return whether URL data has been requested and whether that data is here (i.e. More...

void	cancelURLDataRequest ()
	Cancel the active URL data fetch request. More...

void	setChildData (SoNode *urlData)
	Set/get the child data the inline should display. More...

SoNode *	getChildData () const
	Set/get the child data the inline should display. More...

virtual void	doAction (SoAction *action)
	Traversal methods for all the actions: More...

virtual void	doActionOnKidsOrBox (SoAction *action)

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

virtual void	getBoundingBox (SoGetBoundingBoxAction *action)

virtual void	getMatrix (SoGetMatrixAction *action)

virtual void	handleEvent (SoHandleEventAction *action)

virtual void	search (SoSearchAction *action)

virtual void	pick (SoPickAction *action)

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

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

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

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

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

virtual void	rayPick (SoRayPickAction *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. More...

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

virtual void	grabEventsCleanup ()

virtual void	startNotify ()
	Initiates notification from an instance. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	unref () const

void	unrefNoDelete () const

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

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

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

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

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

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

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

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

int	getRefCount () const
	Returns current reference count. More...

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

Static Public Member Functions
static void	setFetchURLCallBack (SoWWWInlineFetchURLCB f, void userData)
	Application callbacks invoked when the inline needs its URL data fetched. More...

static void	setBoundingBoxVisibility (BboxVisibility b)
	This allows the application to specify when bounding boxes are displayed. More...

static BboxVisibility	getBoundingBoxVisibility ()
	Get the bounding boxes visibility. More...

static void	setBoundingBoxColor (SbColor &c)
	This allows the application to specify the color of bounding boxes displayed. More...

static const SbColor &	getBoundingBoxColor ()
	This allows the application to specify the color of bounding boxes displayed. More...

static void	initClass ()

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

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

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

static void	initClass ()
	Initializes base node class. More...

static void	initClasses ()
	Initialize ALL Inventor node classes. More...

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

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

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

static void	initClass ()
	Setup type information. More...

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

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

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

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

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

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

static void	initClass ()
	Setup type information. More...

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

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

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

static void	removeName (SoBase , const char )

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

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

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

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

Public Attributes
SoSFVec3f	bboxCenter
	Bounding box center. More...

SoSFVec3f	bboxSize
	Bounding box size. More...

SoSFString	name
	URL specifying children (might be relative) More...

SoSFNode	alternateRep
	Child data if app cannot fetch URL. More...

Protected Member Functions
virtual	~SoWWWInline ()

virtual void	addBoundingBoxChild (SbVec3f center, SbVec3f size)

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

virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the child data as well as the rest of the node (if the child data has been set) More...

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

virtual	~SoNode ()

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer ()

	~SoFieldContainer ()

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

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

virtual void	destroy ()
	Actually deletes an instance. More...

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

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

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

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

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

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

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

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

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

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

static int	nextActionMethodIndex
	Next index into the action method table. More...

Detailed Description

This node refers to children through a URL (Universal Resource Locator). The application is responsible for actually fetching data from the URL for an SoWWWInline node to display.

Action Behavior

: SoGLRenderAction
This renders the child data if it has been set by the application. It will render a wireframe bounding box as specified by the bboxCenter and bboxSize fields, and the setting passed to setBoundingBoxVisibility(). If no fetch URL callback is set and the alternateRep is not NULL, the alternateRep will be rendered until child data has been set.

See Also

: SoWWWAnchor, SoFile

Definition at line 96 of file SoWWWInline.h.

Member Enumeration Documentation

◆ BboxVisibility

enum SoWWWInline::BboxVisibility

Enumerator
NEVER	Do not show bounding box.
UNTIL_LOADED	Show bounding box (if specified) until data is loaded.
ALWAYS	Show bounding box along with data.

Definition at line 105 of file SoWWWInline.h.

Constructor & Destructor Documentation

◆ SoWWWInline()

SoWWWInline::SoWWWInline ( )

◆ ~SoWWWInline()

virtual SoWWWInline::~SoWWWInline ( )

protectedvirtual

Member Function Documentation

◆ addBoundingBoxChild()

virtual void SoWWWInline::addBoundingBoxChild	(	SbVec3f	center,
		SbVec3f	size
	)

protectedvirtual

◆ callback()

virtual void SoWWWInline::callback ( SoCallbackAction * action )

virtual

Reimplemented from SoNode.

◆ cancelURLDataRequest()

void SoWWWInline::cancelURLDataRequest ( )

inline

Definition at line 141 of file SoWWWInline.h.

References FALSE.

◆ copyChildren()

SoGroup* SoWWWInline::copyChildren ( ) const

◆ copyContents()

virtual void SoWWWInline::copyContents	(	const SoFieldContainer *	fromFC,
		bool	copyConnections
	)

protectedvirtual

Reimplemented from SoNode.

◆ doAction()

virtual void SoWWWInline::doAction ( SoAction * action )

virtual

Reimplemented from SoNode.

◆ doActionOnKidsOrBox()

virtual void SoWWWInline::doActionOnKidsOrBox ( SoAction * action )

virtual

◆ getBoundingBox()

virtual void SoWWWInline::getBoundingBox ( SoGetBoundingBoxAction * action )

virtual

Reimplemented from SoNode.

◆ getBoundingBoxColor()

static const SbColor& SoWWWInline::getBoundingBoxColor ( )

inlinestatic

Definition at line 167 of file SoWWWInline.h.

◆ getBoundingBoxVisibility()

static BboxVisibility SoWWWInline::getBoundingBoxVisibility ( )

inlinestatic

Definition at line 162 of file SoWWWInline.h.

◆ getChildData()

SoNode* SoWWWInline::getChildData ( ) const

The application should set child data after it has fetched data for an inline node.

◆ getChildren()

virtual SoChildList* SoWWWInline::getChildren ( ) const

virtual

Reimplemented from SoNode.

◆ getFullURLName()

const SbString& SoWWWInline::getFullURLName ( )

"foo.wrl" instead of "http://bogus.com/foo.wrl"), the inline 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.

◆ getMatrix()

virtual void SoWWWInline::getMatrix ( SoGetMatrixAction * action )

virtual

Reimplemented from SoNode.

◆ GLRender()

virtual void SoWWWInline::GLRender ( SoGLRenderAction * action )

virtual

Reimplemented from SoNode.

◆ handleEvent()

virtual void SoWWWInline::handleEvent ( SoHandleEventAction * action )

virtual

Reimplemented from SoNode.

◆ initClass()

static void SoWWWInline::initClass ( )

static

◆ isURLDataHere()

bool SoWWWInline::isURLDataHere ( ) const

inline

whether setChildData() has been called.)

Definition at line 139 of file SoWWWInline.h.

◆ isURLDataRequested()

bool SoWWWInline::isURLDataRequested ( ) const

inline

whether setChildData() has been called.)

Definition at line 136 of file SoWWWInline.h.

◆ pick()

virtual void SoWWWInline::pick ( SoPickAction * action )

virtual

Reimplemented from SoNode.

◆ readInstance()

virtual bool SoWWWInline::readInstance	(	SoInput *	in,
		unsigned short	flags
	)

protectedvirtual

Reimplemented from SoFieldContainer.

◆ requestURLData()

void SoWWWInline::requestURLData ( )

inline

This will invoke the application callback to actually fetch the data and can be called before the inline does this for itself (see setFetchURLCallBack()).

Definition at line 132 of file SoWWWInline.h.

◆ search()

virtual void SoWWWInline::search ( SoSearchAction * action )

virtual

Reimplemented from SoNode.

◆ setBoundingBoxColor()

static void SoWWWInline::setBoundingBoxColor ( SbColor & c )

inlinestatic

Definition at line 165 of file SoWWWInline.h.

◆ setBoundingBoxVisibility()

static void SoWWWInline::setBoundingBoxVisibility ( BboxVisibility b )

inlinestatic

The bounding box can be rendered along with the children (ALWAYS), only until the child data is loaded (UNTIL_LOADED), or not at all (NEVER). Default is UNTIL_LOADED

Definition at line 160 of file SoWWWInline.h.

◆ setChildData()

void SoWWWInline::setChildData ( SoNode * urlData )

The application should set child data after it has fetched data for an inline node.

◆ setFetchURLCallBack()

static void SoWWWInline::setFetchURLCallBack	(	SoWWWInlineFetchURLCB *	f,
		void *	userData
	)

static

This happens the first time the inline is rendered, or if it needs to compute a bounding box and the bboxSize field is not set, or when requestURLData() is called.

◆ setFullURLName()

void SoWWWInline::setFullURLName ( const SbString & url )

inline

See also: getFullURLName()

Definition at line 117 of file SoWWWInline.h.

Member Data Documentation

◆ alternateRep

SoSFNode SoWWWInline::alternateRep

Definition at line 114 of file SoWWWInline.h.

◆ bboxCenter

SoSFVec3f SoWWWInline::bboxCenter

Definition at line 111 of file SoWWWInline.h.

◆ bboxSize

SoSFVec3f SoWWWInline::bboxSize

Definition at line 112 of file SoWWWInline.h.

◆ name

SoSFString SoWWWInline::name

Definition at line 113 of file SoWWWInline.h.

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

/home/jenkins/workspaces/mevislab/3.7.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/nodes/SoWWWInline.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ BboxVisibility

Constructor & Destructor Documentation

◆ SoWWWInline()

◆ ~SoWWWInline()

Member Function Documentation

◆ addBoundingBoxChild()

◆ callback()

◆ cancelURLDataRequest()

◆ copyChildren()

◆ copyContents()

◆ doAction()

◆ doActionOnKidsOrBox()

◆ getBoundingBox()

◆ getBoundingBoxColor()

◆ getBoundingBoxVisibility()

◆ getChildData()

◆ getChildren()

◆ getFullURLName()

◆ getMatrix()

◆ GLRender()

◆ handleEvent()

◆ initClass()

◆ isURLDataHere()

◆ isURLDataRequested()

◆ pick()

◆ readInstance()

◆ requestURLData()

◆ search()

◆ setBoundingBoxColor()

◆ setBoundingBoxVisibility()

◆ setChildData()

◆ setFetchURLCallBack()

◆ setFullURLName()

Member Data Documentation

◆ alternateRep

◆ bboxCenter

◆ bboxSize

◆ name