logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SoWWWInline — node that refers to children through a URL

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.

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.

Fields

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

     SoSFVec3fbboxCenter
          Defines the center of the bounding box surrounding the URL child data.

     SoSFVec3fbboxSize
          Defines the size of the bounding box surrounding the URL child data.

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

File Format/Defaults

WWWInline{name"<Undefinedfile>"bboxCenter000bboxSize000alternateRepNULL}

Inherits From

       SoBase > SoFieldContainer > SoNode > SoWWWInline

Methods

SoWWWInline()
          Creates an inline node with default settings.

     staticSoTypegetClassTypeId()
          Returns type identifier for this class.

     voidsetFullURLName(constSbString&url)constSbString&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.

     SoGroup*copyChildren()const
          Return  a  copy  of  the  hidden  children as a Group. The children are set by the application through
          setChildData().

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

     SbBoolisURLDataRequested()constSbBoolisURLDataHere()const
          Return whether URL data has been requested and whether that data is here (i.e. whether  setChildData()
          has been called.)

     voidcancelURLDataRequest()
          Cancel the active URL data fetch request.

     voidsetChildData(SoNode*urlData)SoNode*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.

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

     staticvoidsetBoundingBoxVisibility(BboxVisibilityb)staticBboxVisibilitygetBoundingBoxVisibility()
          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_LOADEDstaticvoidsetBoundingBoxColor(SbColor&c)staticconstSbColor&getBoundingBoxColor()
          This allows the application to specify the color of bounding boxes displayed.

Name

       SoWWWInline — node that refers to children through a URL

See Also

SoWWWAnchor,SoFileSoWWWInline(3IV)()

Synopsis

#include<Inventor/nodes/SoWWWInline.h>typedefvoidSoWWWInlineFetchURLCB(constSbString&url,void*userData,SoWWWInline*node)enumBboxVisibility{SoWWWInline::NEVER         Do not show bounding box
          SoWWWInline::UNTIL_LOADED  Show bounding box (if specified) until data is loaded
          SoWWWInline::ALWAYS        Show bounding box along with data
     }

          Fields from class SoWWWInline:

     SoSFStringnameSoSFVec3fbboxCenterSoSFVec3fbboxSizeSoSFNodealternateRep

          Methods from class SoWWWInline:

                             SoWWWInline()staticSoTypegetClassTypeId()voidsetFullURLName(constSbString&url)constSbString&getFullURLName()SoGroup*copyChildren()constvoidrequestURLData()SbBoolisURLDataRequested()constSbBoolisURLDataHere()constvoidcancelURLDataRequest()voidsetChildData(SoNode*urlData)SoNode*getChildData()conststaticvoidsetFetchURLCallBack(SoWWWInlineFetchURLCB*f,void*userData)staticvoidsetBoundingBoxVisibility(BboxVisibilityb)staticBboxVisibilitygetBoundingBoxVisibility()staticvoidsetBoundingBoxColor(SbColor&c)staticconstSbColor&getBoundingBoxColor()

          Methods from class SoNode:

     voidsetOverride(SbBoolstate)SbBoolisOverride()constSoNode*copy(SbBoolcopyConnections=FALSE)constvirtualSbBoolaffectsState()conststaticSoNode*getByName(constSbName&name)staticintgetByName(constSbName&name,SoNodeList&list)

          Methods from class SoFieldContainer:

     voidsetToDefaults()SbBoolhasDefaultValues()constSbBoolfieldsAreEqual(constSoFieldContainer*fc)constvoidcopyFieldValues(constSoFieldContainer*fc,SbBoolcopyConnections=FALSE)SbBoolset(constchar*fieldDataString)voidget(SbString&fieldDataString)virtualintgetFields(SoFieldList&resultList)constvirtualSoField*getField(constSbName&fieldName)constSbBoolgetFieldName(constSoField*field,SbName&fieldName)constSbBoolisNotifyEnabled()constSbBoolenableNotify(SbBoolflag)

          Methods from class SoBase:

     voidref()voidunref()constvoidunrefNoDelete()constvoidtouch()virtualSoTypegetTypeId()constSbBoolisOfType(SoTypetype)constvirtualvoidsetName(constSbName&name)virtualSbNamegetName()const

See Also