Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   31559 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

							      SoWWWInline(3IV)

NAME
     SoWWWInline (SoWWWInline) - node that refers to children through a URL

INHERITS FROM
     SoBase > SoFieldContainer > SoNode > SoWWWInline

SYNOPSIS
     #include <Inventor_c/nodes/SoWWWInline.h>

     typedef void	 SoWWWInlineFetchURLCB(const SbString &url, void
			      *userData, SoWWWInline *node)

     enum SoWWWInlineBboxVisibility {
	  NEVER		      Do not show bounding box
	  UNTIL_LOADED	      Show bounding box (if specified) until data is
				   loaded
	  ALWAYS	      Show bounding box along with data
     }

	  Fields from class SoWWWInline:

     SoSFString		 name
     SoSFVec3f		 bboxCenter
     SoSFVec3f		 bboxSize
     SoSFNode		 alternateRep

	  Functions from class SoWWWInline:

     SoWWWInline *	 SoWWWInlineCreate()
     SoType		 SoWWWInlineGetClassTypeId()
     void		 SoWWWInlineSetFullURLName(SoWWWInline *this, const
			      SbString *url)
     const SbString *	 SoWWWInlineGetFullURLName(SoWWWInline *this)
     SoGroup *		 SoWWWInlineCopyChildren(const SoWWWInline *this)
     void		 SoWWWInlineReqURLData(SoWWWInline *this)
     SbBool		 SoWWWInlineIsURLDataReq(const SoWWWInline *this)
     SbBool		 SoWWWInlineIsURLDataHere(const SoWWWInline *this)
     void		 SoWWWInlineCancelURLDataReq(SoWWWInline *this)
     void		 SoWWWInlineSetChildData(SoWWWInline *this, SoNode
			      *urlData)
     SoNode *		 SoWWWInlineGetChildData(const SoWWWInline *this)
     void		 SoWWWInlineSetFetchCB(SoWWWInlineFetchURLCB *f, void
			      *userData)
     void		 SoWWWInlineSetBboxVis(BboxVisibility b)
     BboxVisibility	 SoWWWInlineGetBboxVis()
     void		 SoWWWInlineSetBboxCol(SbColor *c)
     const SbColor *	 SoWWWInlineGetBboxCol()

	  Functions from class SoNode:

     void		 SoWWWInlineSetOverride(SoWWWInline *this, SbBool
			      state)

Page 1

SoWWWInline(3IV)

     SbBool		 SoWWWInlineIsOverride(const SoWWWInline *this)
     SoNode *		 SoWWWInlineCopy(const SoWWWInline *this, SbBool
			      copyConnections = FALSE)
     SbBool		 SoWWWInlineAffectsState(const SoWWWInline *this)
     SoNode *		 SoWWWInlineGetByName(const char *name)
     int		 SoWWWInlineGetByNameList(const char *name, SoNodeList
			      *list)

	  Functions from class SoFieldContainer:

     void		 SoWWWInlineSetToDflts(SoWWWInline *this)
     SbBool		 SoWWWInlineHasDfltVals(const SoWWWInline *this)
     SbBool		 SoWWWInlineFldsAreEq(const SoWWWInline *this, const
			      SoFieldContainer *fc)
     void		 SoWWWInlineCopyFieldVals(SoWWWInline *this, const
			      SoFieldContainer *fc, SbBool copyConnections =
			      FALSE)
     SbBool		 SoWWWInlineSet(SoWWWInline *this, const char
			      *fieldDataString)
     void		 SoWWWInlineGet(SoWWWInline *this, SbString
			      *fieldDataString)
     int		 SoWWWInlineGetFields(const SoWWWInline *this,
			      SoFieldList *resultList)
     SoField *		 SoWWWInlineGetField(const SoWWWInline *this, const
			      char *fieldName)
     SbBool		 SoWWWInlineGetFieldName(const SoWWWInline *this,
			      const SoField *field, SbName *fieldName)
     SbBool		 SoWWWInlineIsNotifyEnabled(const SoWWWInline *this)
     SbBool		 SoWWWInlineEnableNotify(SoWWWInline *this, SbBool
			      flag)

	  Functions from class SoBase:

     void		 SoWWWInlineRef(SoWWWInline *this)
     void		 SoWWWInlineUnref(const SoWWWInline *this)
     void		 SoWWWInlineUnrefNoDelete(const SoWWWInline *this)
     void		 SoWWWInlineTouch(SoWWWInline *this)
     SoType		 SoWWWInlineGetTypeId(const SoWWWInline *this)
     SbBool		 SoWWWInlineIsOfType(const SoWWWInline *this, SoType
			      type)
     void		 SoWWWInlineSetName(SoWWWInline *this, const char
			      *name)
     SbName		 SoWWWInlineGetName(const SoWWWInline *this)

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.

Page 2

							      SoWWWInline(3IV)

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

     SoSFVec3f		 bboxCenter
	  Defines the center of the bounding box surrounding the URL child
	  data.

     SoSFVec3f		 bboxSize
	  Defines the size of the bounding box surrounding the URL child data.

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

FUNCTIONS
     SoWWWInline *	 SoWWWInlineCreate()
	  Creates an inline node with default settings.

     SoType		 SoWWWInlineGetClassTypeId()
	  Returns type identifier for this class.

     void		 SoWWWInlineSetFullURLName(SoWWWInline *this, const
			      SbString *url)
     const SbString *	 SoWWWInlineGetFullURLName(SoWWWInline *this)
	  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 *		 SoWWWInlineCopyChildren(const SoWWWInline *this)
	  Return a copy of the hidden children as a Group. The children are
	  set by the application through setChildData().

     void		 SoWWWInlineReqURLData(SoWWWInline *this)
	  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()).

     SbBool		 SoWWWInlineIsURLDataReq(const SoWWWInline *this)
     SbBool		 SoWWWInlineIsURLDataHere(const SoWWWInline *this)
	  Return whether URL data has been requested and whether that data is
	  here (i.e. whether setChildData() has been called.)

     void		 SoWWWInlineCancelURLDataReq(SoWWWInline *this)
	  Cancel the active URL data fetch request.

Page 3

SoWWWInline(3IV)

     void		 SoWWWInlineSetChildData(SoWWWInline *this, SoNode
			      *urlData)
     SoNode *		 SoWWWInlineGetChildData(const SoWWWInline *this)
	  Set/get the child data the inline should display. The application
	  should set child data after it has fetched data for an inline node.

     void		 SoWWWInlineSetFetchCB(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.

     void		 SoWWWInlineSetBboxVis(BboxVisibility b)
     BboxVisibility	 SoWWWInlineGetBboxVis()
	  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

     void		 SoWWWInlineSetBboxCol(SbColor *c)
     const SbColor *	 SoWWWInlineGetBboxCol()
	  This allows the application to specify the color of bounding boxes
	  displayed.

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.

FILE FORMAT/DEFAULTS
     WWWInline {
	  name		"<Undefined file>"
	  bboxCenter	0 0 0
	  bboxSize	0 0 0
	  alternateRep	NULL
     }

SEE ALSO
     SoWWWAnchor, SoFile

Page 4

Vote for polarhome