.TH "SoVRMLInline" 3 "Sat Oct 12 2013" "Version 4.0.0a" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoVRMLInline \- 
.PP
The \fBSoVRMLInline\fP class is used to insert VRML files into a scene\&.
.PP
\fBThe detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997)\&. It is copyright The Web3D Consortium, and is used by permission of the Consortium:\fP  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/VRMLnodes/SoVRMLInline\&.h>\fP
.PP
Inherits \fBSoNode\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBBboxVisibility\fP { \fBNEVER\fP, \fBUNTIL_LOADED\fP, \fBALWAYS\fP }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const "
.br
.RI "\fIReturns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for run-time type checking and 'downward' casting\&. \fP"
.ti -1c
.RI "\fBSoVRMLInline\fP (void)"
.br
.ti -1c
.RI "void \fBsetFullURLName\fP (const \fBSbString\fP &url)"
.br
.ti -1c
.RI "const \fBSbString\fP & \fBgetFullURLName\fP (void)"
.br
.ti -1c
.RI "\fBSoGroup\fP * \fBcopyChildren\fP (void) const "
.br
.ti -1c
.RI "void \fBrequestURLData\fP (void)"
.br
.ti -1c
.RI "SbBool \fBisURLDataRequested\fP (void) const "
.br
.ti -1c
.RI "SbBool \fBisURLDataHere\fP (void) const "
.br
.ti -1c
.RI "void \fBcancelURLDataRequest\fP (void)"
.br
.ti -1c
.RI "void \fBsetChildData\fP (\fBSoNode\fP *urlData)"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetChildData\fP (void) const "
.br
.ti -1c
.RI "virtual void \fBdoAction\fP (\fBSoAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBcallback\fP (\fBSoCallbackAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBGLRender\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBgetBoundingBox\fP (\fBSoGetBoundingBoxAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBgetMatrix\fP (\fBSoGetMatrixAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBhandleEvent\fP (\fBSoHandleEventAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBsearch\fP (\fBSoSearchAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBpick\fP (\fBSoPickAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBgetPrimitiveCount\fP (\fBSoGetPrimitiveCountAction\fP *action)"
.br
.ti -1c
.RI "virtual \fBSoChildList\fP * \fBgetChildren\fP (void) const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.RI "\fIThis static method returns the \fBSoType\fP object associated with objects of this class\&. \fP"
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "\fISets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. \fP"
.ti -1c
.RI "static void \fBsetFetchURLCallBack\fP (SoVRMLInlineFetchURLCB *f, void *closure)"
.br
.ti -1c
.RI "static void \fBsetBoundingBoxVisibility\fP (\fBBboxVisibility\fP b)"
.br
.ti -1c
.RI "static \fBBboxVisibility\fP \fBgetBoundingBoxVisibility\fP (void)"
.br
.ti -1c
.RI "static void \fBsetBoundingBoxColor\fP (\fBSbColor\fP &color)"
.br
.ti -1c
.RI "static \fBSbColor\fP & \fBgetBoundingBoxColor\fP (void)"
.br
.ti -1c
.RI "static void \fBsetReadAsSoFile\fP (SbBool enable)"
.br
.ti -1c
.RI "static SbBool \fBgetReadAsSoFile\fP (void)"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBSoSFVec3f\fP \fBbboxCenter\fP"
.br
.ti -1c
.RI "\fBSoSFVec3f\fP \fBbboxSize\fP"
.br
.ti -1c
.RI "\fBSoMFString\fP \fBurl\fP"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual const \fBSoFieldData\fP * \fBgetFieldData\fP (void) const "
.br
.ti -1c
.RI "virtual \fB~SoVRMLInline\fP ()"
.br
.in -1c
.SS "Static Protected Member Functions"

.in +1c
.ti -1c
.RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
The \fBSoVRMLInline\fP class is used to insert VRML files into a scene\&.
.PP
\fBThe detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997)\&. It is copyright The Web3D Consortium, and is used by permission of the Consortium:\fP 

.PP
.nf
Inline {
  exposedField MFString url        []
  field        SFVec3f  bboxCenter 0 0 0     # (-,)
  field        SFVec3f  bboxSize   -1 -1 -1  # (0,) or -1,-1,-1
}
.fi
.PP
.PP
The Inline node is a grouping node that reads its children data from a location in the World Wide Web\&. Exactly when its children are read and displayed is not defined (e\&.g\&. reading the children may be delayed until the Inline node's bounding box is visible to the viewer)\&. The url field specifies the URL containing the children\&. An Inline node with an empty URL does nothing\&.
.PP
Each specified URL shall refer to a valid VRML file that contains a list of children nodes, prototypes, and routes at the top level as described in 4\&.6\&.5, Grouping and children nodes\&.
.PP
The results are undefined if the URL refers to a file that is not VRML or if the VRML file contains non-children nodes at the top level\&.
.PP
If multiple URLs are specified, the browser may display a URL of a lower preference VRML file while it is obtaining, or if it is unable to obtain, the higher preference VRML file\&. Details on the url field and preference order can be found in 4\&.5, VRML and the World Wide Web (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.5)\&.
.PP
The results are undefined if the contents of the URL change after it has been loaded\&.
.PP
The bboxCenter and bboxSize fields specify a bounding box that encloses the Inline node's children\&. This is a hint that may be used for optimization purposes\&. The results are undefined if the specified bounding box is smaller than the actual bounding box of the children at any time\&. A default bboxSize value, (-1, -1, -1), implies that the bounding box is not specified and if needed shall be calculated by the browser\&. A description of the bboxCenter and bboxSize fields is in 4\&.6\&.4, Bounding boxes (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.4)\&. 
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBSoVRMLInline::BboxVisibility\fP"

.PP
\fBEnumerator: \fP
.in +1c
.TP
\fB\fINEVER \fP\fP
\fBSoSFVec3f\fP SoVRMLInline::bboxCenter Center of bounding box\&.
.PP
\fBSoSFVec3f\fP SoVRMLInline::bboxSize Size of bounding box\&.
.PP
\fBSoMFString\fP SoVRMLInline::url The VRML file URL\&.
.PP
enum \fBSoVRMLInline::BboxVisibility\fP Used to enumerate bounding box visibility settings\&.
.PP
Never display bounding box\&. 
.TP
\fB\fIUNTIL_LOADED \fP\fP
Display bounding box until file is loaded\&. 
.TP
\fB\fIALWAYS \fP\fP
Always display bounding box\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoVRMLInline::SoVRMLInline (void)"
Constructor 
.SS "SoVRMLInline::~SoVRMLInline ()\fC [protected]\fP, \fC [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoVRMLInline::getTypeId (void) const\fC [virtual]\fP"

.PP
Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for run-time type checking and 'downward' casting\&. Usage example:
.PP
.PP
.nf
void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}
.fi
.PP
.PP
For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in \fIall\fP subclasses\&. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance \fBInventor/nodes/SoSubNode\&.h\fP (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine\&.h (for engine classes) and so on\&.
.PP
For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups\&. 
.PP
Implements \fBSoBase\fP\&.
.SS "const \fBSoFieldData\fP ** SoVRMLInline::getFieldDataPtr (void)\fC [static]\fP, \fC [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP 
.PP
Reimplemented from \fBSoNode\fP\&.
.SS "const \fBSoFieldData\fP * SoVRMLInline::getFieldData (void) const\fC [protected]\fP, \fC [virtual]\fP"
Returns a pointer to the class-wide field data storage object for this instance\&. If no fields are present, returns \fCNULL\fP\&. 
.PP
Reimplemented from \fBSoFieldContainer\fP\&.
.SS "void SoVRMLInline::setFullURLName (const \fBSbString\fP &urlref)"
Sets the full (non-relative) URL name\&. 
.SS "const \fBSbString\fP & SoVRMLInline::getFullURLName (void)"
Returns the full URL name\&. 
.SS "\fBSoGroup\fP * SoVRMLInline::copyChildren (void) const"
Returns a copy of the children\&. 
.SS "void SoVRMLInline::requestURLData (void)"
Request URL data\&. 
.SS "SbBool SoVRMLInline::isURLDataRequested (void) const"
Returns TRUE if the URL data has been requested\&. 
.SS "SbBool SoVRMLInline::isURLDataHere (void) const"
Returns TRUE if the data has been loaded\&. 
.SS "void SoVRMLInline::cancelURLDataRequest (void)"
Cancel the URL data request\&. 
.SS "void SoVRMLInline::setChildData (\fBSoNode\fP *urldata)"
Sets the child data\&. Can be used by the URL fetch callback\&. 
.SS "\fBSoNode\fP * SoVRMLInline::getChildData (void) const"
Returns the child data (the scene loaded from the url)\&. 
.SS "void SoVRMLInline::setFetchURLCallBack (SoVRMLInlineFetchURLCB *f, void *closure)\fC [static]\fP"
Sets the callback used to handle URL loading\&. 
.SS "void SoVRMLInline::setBoundingBoxVisibility (\fBBboxVisibility\fPb)\fC [static]\fP"
Sets the bounding box visibility strategy\&. 
.SS "\fBSoVRMLInline::BboxVisibility\fP SoVRMLInline::getBoundingBoxVisibility (void)\fC [static]\fP"
Returns the bounding box visibility strategy\&. 
.SS "void SoVRMLInline::setBoundingBoxColor (\fBSbColor\fP &color)\fC [static]\fP"
Sets the color of the bounding box\&. 
.SS "\fBSbColor\fP & SoVRMLInline::getBoundingBoxColor (void)\fC [static]\fP"
Returns the color of the bounding box\&. 
.SS "void SoVRMLInline::setReadAsSoFile (SbBoolenable)\fC [static]\fP"
Sets whether Inline nodes should be treated as a normal Inventor \fBSoFile\fP node\&. 
.SS "SbBool SoVRMLInline::getReadAsSoFile (void)\fC [static]\fP"
Returns whether Inline nodes is read as \fBSoFile\fP nodes\&. 
.SS "void SoVRMLInline::doAction (\fBSoAction\fP *action)\fC [virtual]\fP"
This function performs the typical operation of a node for any action\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.SS "void SoVRMLInline::callback (\fBSoCallbackAction\fP *action)\fC [virtual]\fP"
Action method for \fBSoCallbackAction\fP\&.
.PP
Simply updates the state according to how the node behaves for the render action, so the application programmer can use the \fBSoCallbackAction\fP for extracting information about the scene graph\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.SS "void SoVRMLInline::GLRender (\fBSoGLRenderAction\fP *action)\fC [virtual]\fP"
Action method for the \fBSoGLRenderAction\fP\&.
.PP
This is called during rendering traversals\&. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.SS "void SoVRMLInline::getBoundingBox (\fBSoGetBoundingBoxAction\fP *action)\fC [virtual]\fP"
Action method for the \fBSoGetBoundingBoxAction\fP\&.
.PP
Calculates bounding box and center coordinates for node and modifies the values of the \fIaction\fP to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node\&.
.PP
Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.SS "void SoVRMLInline::getMatrix (\fBSoGetMatrixAction\fP *action)\fC [virtual]\fP"
Action method for \fBSoGetMatrixAction\fP\&.
.PP
Updates \fIaction\fP by accumulating with the transformation matrix of this node (if any)\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.SS "void SoVRMLInline::handleEvent (\fBSoHandleEventAction\fP *action)\fC [virtual]\fP"
Action method for \fBSoHandleEventAction\fP\&.
.PP
Inspects the event data from \fIaction\fP, and processes it if it is something which this node should react to\&.
.PP
Nodes influencing relevant state variables for how event handling is done also overrides this method\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.SS "void SoVRMLInline::search (\fBSoSearchAction\fP *action)\fC [virtual]\fP"
Action method for \fBSoSearchAction\fP\&.
.PP
Compares the search criteria from the \fIaction\fP to see if this node is a match\&. Searching is done by matching up \fIall\fP criteria set up in the \fBSoSearchAction\fP -- if \fIany\fP of the requested criteria is a miss, the search is not deemed successful for the node\&.
.PP
\fBSee Also:\fP
.RS 4
\fBSoSearchAction\fP 
.RE
.PP

.PP
Reimplemented from \fBSoNode\fP\&.
.SS "void SoVRMLInline::pick (\fBSoPickAction\fP *action)\fC [virtual]\fP"
Action method for \fBSoPickAction\fP\&.
.PP
Does common processing for \fBSoPickAction\fP \fIaction\fP instances\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.SS "void SoVRMLInline::getPrimitiveCount (\fBSoGetPrimitiveCountAction\fP *action)\fC [virtual]\fP"
Action method for the \fBSoGetPrimitiveCountAction\fP\&.
.PP
Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the \fIaction\fP\&.
.PP
Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.SS "\fBSoChildList\fP * SoVRMLInline::getChildren (void) const\fC [virtual]\fP"
Returns list of children for this node\&. 
.PP
Reimplemented from \fBSoNode\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.