SoWWWInline Class Reference
[Groups]
Node that refers to children through a URL.
More...
#include <Inventor/nodes/SoWWWInline.h>
Public Types | |
| enum | BboxVisibility { NEVER, UNTIL_LOADED, ALWAYS } |
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoWWWInline () | |
| void | setFullURLName (const SbString &url) |
| const SbString & | getFullURLName () |
| SoGroup * | copyChildren () const |
| void | requestURLData () |
| SbBool | isURLDataRequested () const |
| SbBool | isURLDataHere () const |
| void | cancelURLDataRequest () |
| void | setChildData (SoNode *urlData) |
| SoNode * | getChildData () const |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| static void | setFetchURLCallBack (SoWWWInlineFetchURLCB *f, void *userData) |
| static void | setBoundingBoxVisibility (BboxVisibility b) |
| static BboxVisibility | getBoundingBoxVisibility () |
| static void | setBoundingBoxColor (SbColor &c) |
| static const SbColor & | getBoundingBoxColor () |
| static void | setReadAsSoFile (SbBool onOff) |
| static SbBool | getReadAsSoFile () |
Public Attributes | |
| SoSFVec3f | bboxCenter |
| SoSFVec3f | bboxSize |
| SoSFFilePathString | name |
| SoSFNode | alternateRep |
Detailed Description
Node that refers to children through a URL.
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.
FILE FORMAT/DEFAULT
- WWWInline {
| name | "<Undefined file>" |
| bboxCenter | 0 0 0 |
| bboxSize | 0 0 0 |
| alternateRep | NULL |
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
- See related examples:
Member Enumeration Documentation
Constructor & Destructor Documentation
| SoWWWInline::SoWWWInline | ( | ) |
Creates an inline node with default settings.
Member Function Documentation
| void SoWWWInline::cancelURLDataRequest | ( | ) | [inline] |
Cancels the active URL data fetch request.
| SoGroup* SoWWWInline::copyChildren | ( | ) | const |
Return a copy of the hidden children as a Group.
The children are set by the application through setChildData().
| static const SbColor& SoWWWInline::getBoundingBoxColor | ( | ) | [static] |
Queries the color of bounding boxes displayed.
| static BboxVisibility SoWWWInline::getBoundingBoxVisibility | ( | ) | [static] |
Queries when bounding boxes are displayed.
| SoNode* SoWWWInline::getChildData | ( | ) | const |
Gets the child data the inline should display.
| static SoType SoWWWInline::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoNode.
| const SbString& SoWWWInline::getFullURLName | ( | ) |
Returns the fullURL set by setFullURLName, or if not set, returns the contents of the name field.
| static SbBool SoWWWInline::getReadAsSoFile | ( | ) | [inline, static] |
Queries the ReadAsSoFile flag.
| virtual SoType SoWWWInline::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoNode.
| SbBool SoWWWInline::isURLDataHere | ( | ) | const [inline] |
Returns whether URL data is here (i.e. whether setChildData() has been called.
)
| SbBool SoWWWInline::isURLDataRequested | ( | ) | const [inline] |
Returns whether URL data has been requested.
| void SoWWWInline::requestURLData | ( | ) | [inline] |
Requests 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()).
| static void SoWWWInline::setBoundingBoxColor | ( | SbColor & | c | ) | [static] |
Specifies the color of bounding boxes displayed.
| static void SoWWWInline::setBoundingBoxVisibility | ( | BboxVisibility | b | ) | [static] |
Specifies 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.
| void SoWWWInline::setChildData | ( | SoNode * | urlData | ) |
Sets the child data the inline should display.
The application should set child data after it has fetched data for an inline node.
| static void SoWWWInline::setFetchURLCallBack | ( | SoWWWInlineFetchURLCB * | f, | |
| void * | userData | |||
| ) | [static] |
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.
| void SoWWWInline::setFullURLName | ( | const SbString & | url | ) | [inline] |
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 its full URL should be. getFullURLName() returns the fullURL set here, or if not set, returns the contents of the name field.
| static void SoWWWInline::setReadAsSoFile | ( | SbBool | onOff | ) | [inline, static] |
Sets the ReadAsSoFile flag.
If TRUE, assume that "url" points to other Open Inventor files on local filesystem, and load them directly as if this were an SoFile node instead of using SoWWWInlineFetchURLCB.
Member Data Documentation
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()).
Defines the center of the bounding box surrounding the URL child data.
Defines the size of the bounding box surrounding the URL child data.
Specifies the URL which the application should fetch as child data to this node (e.g. "http://bogus.com/homeWorld.wrl.gz").
The documentation for this class was generated from the following file:
- Inventor/nodes/SoWWWInline.h