com.openinventor.inventor.vrmlnodes

Class SoVRMLInline

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.vrmlnodes.SoVRMLNode

com.openinventor.inventor.vrmlnodes.SoVRMLInline

All Implemented Interfaces:

SafeDisposable

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoVRMLInline
extends SoVRMLNode

Grouping 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 SoVRMLInline node to display.

<font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later.

See also the VRML97 Specification, below.

VRML97 SPECIFICATION

This section describes the expected behavior of the node in a conforming VRML97 browser application. In some cases, the application is responsible for implementing portions of the expected behavior. Open Inventor viewer classes and IVF classes implement some of the application behaviors.

This section may reference portions of the VRML97 specification that are not present in this help file. The complete VRML97 spec is available at http://www.web3d.org.

The SoVRMLInline 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; reading the children may be delayed until the SoVRMLInline is actually visible to the viewer. The url field specifies the URL containing the children. An SoVRMLInline with an empty URL does nothing.

An Inline's URLs must refer to a valid VRML file that contains a list of children nodes at the top level. See "Concepts - Grouping and Children Nodes". The results are undefined if the URL refers to a file that is not VRML or if the file contains non-children nodes at the top level.

If multiple URLs are specified, the browser may display a URL of a lower preference file while it is obtaining, or if it is unable to obtain the higher preference file. See "Concepts - URLS and URNs" for details on the url field and preference order.

The bboxCenter and bboxSize fields specify a bounding box that encloses the SoVRMLInlines's children. This is a hint that may be used for optimization purposes. If the specified bounding box is smaller than the actual bounding box of the children at any time, then the results are undefined. A default bboxSize value, (-1 -1 -1), implies that the bounding box is not specified and if needed must be calculated by the browser. See "Concepts - Bounding Boxes" for a description of the bboxCenter and bboxSize fields.

File format/default:

VRMLInline {

load	true
url	[]
bboxCenter	0 0 0
bboxSize	-1 -1 -1
metadata	NULL

}

Action behavior:

SoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction, SoHandleEventAction, SoPickAction, SoGetMatrixAction, SoSearchAction

EVENTS

eventIn

SoSFBool	set_load (Note: Not implemented)
SoMFFilePathString	set_url
SoSFNode	set_metadata

eventOut

SoSFBool	load_changed (Note: Not implemented)
SoMFFilePathString	url_changed
SoSFNode	metadata_changed

Deprecated since Open Inventor 9500
The VRML API is no longer supported. See section http://oivdoc95.vsg3d.com/content/compatibility-notes-4#Deprecation of the Reference Manual.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoVRMLInline.BboxVisibilities Deprecated. BboxVisibility.

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALWAYS Deprecated. Use SoVRMLInline.BboxVisibilities.ALWAYS instead.
SoSFVec3f	bboxCenter Deprecated. Specifies the center of a bounding box that encloses the children.
SoSFVec3f	bboxSize Deprecated. Specifies the size of a bounding box that encloses the children.
SoSFBool	load Deprecated. (Note: Not implemented) Controls when the Inline is read and displayed.
static int	NEVER Deprecated. Use SoVRMLInline.BboxVisibilities.NEVER instead.
static int	UNTIL_LOADED Deprecated. Use SoVRMLInline.BboxVisibilities.UNTIL_LOADED instead.
SoMFFilePathString	url Deprecated. URL which the application will be called back to fetch when this node is activated by a left mouse click (e.g.

Fields inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLNode

metadata

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoVRMLInline() Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
void	cancelURLDataRequest() Deprecated. Cancels URL request.
SoGroup	copyChildren() Deprecated. Returns (hidden) children as Group.
static SbColor	getBoundingBoxColor() Deprecated. Returns the bounding box color.
static SoVRMLInline.BboxVisibilities	getBoundingBoxVisibility() Deprecated. Returns how bounding boxes are displayed.
SoNode	getChildData() Deprecated. Sets the child data the inline should display.
java.lang.String	getFullURLName() Deprecated. Returns the fullURL set here, or if not set, returns the contents of the name field.
static boolean	getReadAsSoFile() Deprecated. Gets the ReadAsSoFile flag.
boolean	isURLDataHere() Deprecated. Returns whether the URL data is here.
boolean	isURLDataRequested() Deprecated. Returns whether URL data has been requested.
void	requestURLData() Deprecated. Requests that URL data be fetched.
static void	setBoundingBoxColor(SbColor c) Deprecated. Sets the bounding box color.
static void	setBoundingBoxVisibility(SoVRMLInline.BboxVisibilities b) Deprecated. Sets how bounding boxes are displayed.
void	setChildData(SoNode urlData) Deprecated. Gets the child data the inline should display.
void	setFullURLName(java.lang.String urlin) Deprecated. If the url field is not a local file and contains a relative URL (e.g.
static void	setReadAsSoFile(boolean onOff) Deprecated. Sets the ReadAsSoFile flag.

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NEVER

@Deprecated
public static final int NEVER

Deprecated. Use SoVRMLInline.BboxVisibilities.NEVER instead.

UNTIL_LOADED

@Deprecated
public static final int UNTIL_LOADED

Deprecated. Use SoVRMLInline.BboxVisibilities.UNTIL_LOADED instead.

ALWAYS

@Deprecated
public static final int ALWAYS

Deprecated. Use SoVRMLInline.BboxVisibilities.ALWAYS instead.

bboxCenter

public final SoSFVec3f bboxCenter

Deprecated.

Specifies the center of a bounding box that encloses the children.

bboxSize

public final SoSFVec3f bboxSize

Deprecated.

Specifies the size of a bounding box that encloses the children. If the specified bounding box is smaller than the actual bounding box of the children at any time, then the results are undefined.

url

public final SoMFFilePathString url

Deprecated.

URL which the application will be called back to fetch when this node is activated by a left mouse click (e.g. "http://www.sgi.com").

load

public final SoSFBool load

Deprecated.

(Note: Not implemented) Controls when the Inline is read and displayed.

Since:

Open Inventor 5.0 NOTE 2: This field is not compatible with VRML97. If you specify a non-default value for this field, when this node is written to a VRML file, the file will contain this incompatible field and standard VRML97 file readers will not be able to read it.

Constructor Detail

SoVRMLInline

public SoVRMLInline()

Deprecated.

Constructor.

Method Detail

copyChildren

public SoGroup copyChildren()

Deprecated.

Returns (hidden) children as Group.

getReadAsSoFile

public static boolean getReadAsSoFile()

Deprecated.

Gets the ReadAsSoFile flag.

getBoundingBoxColor

public static SbColor getBoundingBoxColor()

Deprecated.

Returns the bounding box color.

setReadAsSoFile

public static void setReadAsSoFile(boolean onOff)

Deprecated.

Sets the ReadAsSoFile flag. If true, assumes that "url" points to other Inventor files on local filesystem, and loads them directly as if this were an SoFile node instead of using SoVRMLInlineFetchURLCB.

getFullURLName

public java.lang.String getFullURLName()

Deprecated.

Returns the fullURL set here, or if not set, returns the contents of the name field.

setFullURLName

public void setFullURLName(java.lang.String urlin)

Deprecated.

If the url field is not a local file and 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 inline what its full URL should be.

requestURLData

public void requestURLData()

Deprecated.

Requests that URL data be fetched.

getBoundingBoxVisibility

public static SoVRMLInline.BboxVisibilities getBoundingBoxVisibility()

Deprecated.

Returns how bounding boxes are displayed.

cancelURLDataRequest

public void cancelURLDataRequest()

Deprecated.

Cancels URL request.

setBoundingBoxVisibility

public static void setBoundingBoxVisibility(SoVRMLInline.BboxVisibilities b)

Deprecated.

Sets how bounding boxes are displayed.

setChildData

public void setChildData(SoNode urlData)

Deprecated.

Gets the child data the inline should display. Application should call this after it has fetched data for the inline node.

isURLDataRequested

public boolean isURLDataRequested()

Deprecated.

Returns whether URL data has been requested.

getChildData

public SoNode getChildData()

Deprecated.

Sets the child data the inline should display. Application should call this after it has fetched data for the inline node.

isURLDataHere

public boolean isURLDataHere()

Deprecated.

Returns whether the URL data is here.

setBoundingBoxColor

public static void setBoundingBoxColor(SbColor c)

Deprecated.

Sets the bounding box color.