SoWWWInline - node that refers to children through a URL

SoBase > SoFieldContainer > SoNode > SoWWWInline

#include <Inventor/nodes/SoWWWInline.h> c } c } SoWWWInlineFetchURLCB(const SbString &url, void *userData, SoWWWInline *node) enum BboxVisibility { c } c } Do not show bounding box

c } c } Show bounding box (if specified) until data is loaded

c } c } Show bounding box along with data

} Fields from class SoWWWInline: c } c } name

c } c } bboxCenter

c } c } bboxSize

c } c } alternateRep Methods from class SoWWWInline: c } c } SoWWWInline()

c } c } getClassTypeId()

c } c } setFullURLName(const SbString &url)

c } c } getFullURLName()

c } c } copyChildren() const

c } c } requestURLData()

c } c } isURLDataRequested() const

c } c } isURLDataHere() const

c } c } cancelURLDataRequest()

c } c } setChildData(SoNode *urlData)

c } c } getChildData() const

c } c } setFetchURLCallBack(SoWWWInlineFetchURLCB *f, void *userData)

c } c } setBoundingBoxVisibility(BboxVisibility b)

c } c } getBoundingBoxVisibility()

c } c } setBoundingBoxColor(SbColor &c)

c } c } getBoundingBoxColor() 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

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.

c } c } name

Specifies the URL which the application should fetch as child data to this node (e.g. "http://bogus.com/homeWorld.wrl.gz"). c } c } bboxCenter

Defines the center of the bounding box surrounding the URL child data. c } c } bboxSize

Defines the size of the bounding box surrounding the URL child data. c } c } alternateRep

Specifies child data that can be used instead of fetching data from the URL. On read, if this field is set and there is no fetch URL callback registered, the alternateRep will be used as the child data. Otherwise, it is the applications responsibility to set the child data (see setChildData()).

c } c } SoWWWInline()

Creates an inline 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 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. c } c } copyChildren() const

Return a copy of the hidden children as a Group. The children are set by the application through setChildData(). c } c } requestURLData()

Request that URL data be fetched. This will invoke the application callback to actually fetch the data and can be called before the inline does this for itself (see setFetchURLCallBack()). c } c } isURLDataRequested() const

c } c } isURLDataHere() const

Return whether URL data has been requested and whether that data is here (i.e. whether setChildData() has been called.) c } c } cancelURLDataRequest()

Cancel the active URL data fetch request. c } c } setChildData(SoNode *urlData)

c } c } getChildData() const

Set/get the child data the inline should display. The application should set child data after it has fetched data for an inline node. c } c } setFetchURLCallBack(SoWWWInlineFetchURLCB *f, void *userData)

Application callbacks invoked when the inline needs its URL data fetched. 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. c } c } setBoundingBoxVisibility(BboxVisibility b)

c } c } getBoundingBoxVisibility()

This allows the application to specify when bounding boxes are displayed. 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 c } c } setBoundingBoxColor(SbColor &c)

c } c } getBoundingBoxColor()

This allows the application to specify the color of bounding boxes displayed.

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.

WWWInline {
name	"<Undefined file>"
bboxCenter	0 0 0
bboxSize	0 0 0
alternateRep	NULL
}

SoWWWAnchor, SoFile