Open Inventor Reference
SoWWWInline Class Reference

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

#include <Inventor/nodes/SoWWWInline.h>

Inheritance diagram for SoWWWInline:
SoNode SoFieldContainer SoBase

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.
 
void setFullURLName (const SbString &url)
 
const SbStringgetFullURLName ()
 If the name field contains a relative URL (e.g.
 
SoGroupcopyChildren () const
 Return (hidden) children as Group.
 
void requestURLData ()
 Request that URL data be fetched.
 
bool isURLDataRequested () const
 Return whether URL data has been requested and whether that data is here (i.e.
 
bool isURLDataHere () const
 Return whether URL data has been requested and whether that data is here (i.e.
 
void cancelURLDataRequest ()
 Cancel the active URL data fetch request.
 
void setChildData (SoNode *urlData)
 Set/get the child data the inline should display.
 
SoNodegetChildData () const
 Set/get the child data the inline should display.
 
virtual void doAction (SoAction *action)
 Traversal methods for all the actions:
 
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.
 
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 SoChildListgetChildren () const
 Returns pointer to children, or NULL if none.
 
- 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.
 
SoNodecopy (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 SoChildListgetChildren () 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 SoNodeaddToCopyDict () 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 SoFieldContainercopyThroughConnection () 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 SoFieldgetField (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 SoFieldDatagetFieldData () 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 SoFieldContainercopyThroughConnection () 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 SoAuditorListgetAuditors ()
 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.
 

Static Public Member Functions

static void setFetchURLCallBack (SoWWWInlineFetchURLCB *f, void *userData)
 Application callbacks invoked when the inline needs its URL data fetched.
 
static void setBoundingBoxVisibility (BboxVisibility b)
 This allows the application to specify when bounding boxes are displayed.
 
static BboxVisibility getBoundingBoxVisibility ()
 Get the bounding boxes visibility.
 
static void setBoundingBoxColor (SbColor &c)
 This allows the application to specify the color of bounding boxes displayed.
 
static const SbColorgetBoundingBoxColor ()
 This allows the application to specify the color of bounding boxes displayed.
 
static void initClass ()
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns type identifier for the SoNode class.
 
static SoNodegetByName (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 SoFieldContainercheckCopy (const SoFieldContainer *orig)
 If a copy of the given instance is in the dictionary, this returns it.
 
static SoFieldContainerfindCopy (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 SoBasegetNamedBase (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

SoSFVec3f bboxCenter
 Bounding box center.
 
SoSFVec3f bboxSize
 Bounding box size.
 
SoSFString name
 URL specifying children (might be relative)
 
SoSFNode alternateRep
 Child data if app cannot fetch URL.
 

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

Additional Inherited Members

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

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: