Click or drag to resize
SoVRMLAnchor Class

Note: This API is now obsolete.

Group node with URL hyperlink.

Inheritance Hierarchy

Namespace: OIV.Inventor.VRMLnodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)
Syntax
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
[ObsoleteAttribute("See documentation for more details")]
public class SoVRMLAnchor : SoVRMLGroup

The SoVRMLAnchor type exposes the following members.

Constructors
  NameDescription
Public methodSoVRMLAnchor

Creates a VRMLAnchor node with default settings.

Top
Methods
  NameDescription
Public methodAddChild

Adds a child as last one in group.

(Inherited from SoVRMLParent.)
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoVRMLParent.)
Public methodCallback
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoVRMLGroup.)
Public methodDoAction
Public methodStatic memberEnableEvents
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodFindChild

Finds index of given child within group.

(Inherited from SoVRMLParent.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
Public methodGetChild

Returns the nth child node.

(Inherited from SoVRMLParent.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetFullURLName

Returns the full URL set by setFullURLName(), or if not set, returns the contents of the url field.

Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoVRMLGroup.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNumChildren

Returns number of children.

(Inherited from SoVRMLParent.)
Public methodGetPrimitiveCount
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender
(Inherited from SoVRMLGroup.)
Public methodGLRenderBelowPath
Public methodGLRenderInPath
Public methodGLRenderOffPath
(Inherited from SoVRMLGroup.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodInsertChild

Adds a child so that it becomes the one with the given index.

(Inherited from SoVRMLParent.)
Public methodIsBoundingBoxIgnoring

Used by BoundingBoxAction to known if bounding box computation should be ignored or not.

(Inherited from SoGroup.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoGroup.)
Public methodRayPick
Public methodRemoveAllChildren

Removes all children from group.

(Inherited from SoVRMLParent.)
Public methodRemoveChild(Int32)

Removes child with given index from group.

(Inherited from SoVRMLParent.)
Public methodRemoveChild(SoNode)

Removes first instance of given child from group.

(Inherited from SoVRMLParent.)
Public methodReplaceChild(Int32, SoNode)

Replaces child with given index with new child.

(Inherited from SoVRMLParent.)
Public methodReplaceChild(SoNode, SoNode)

Replaces first instance of given child with new child.

(Inherited from SoVRMLParent.)
Public methodSearch
(Inherited from SoVRMLGroup.)
Public methodSet

Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

(Inherited from SoFieldContainer.)
Public methodStatic memberSetFetchURLCallback(SoVRMLAnchorFetchURLCallback) Obsolete.
Use FetchURLFunction instead. Application delegate invoked when the mouse is clicked on an anchor so that the application can fetch the URL
Public methodStatic memberSetFetchURLCallback(SoVRMLAnchorFetchURLUserDataCallback, Object) Obsolete.
Use FetchURLFunction instead.
Public methodSetFullURLName

If the url field contains a relative URL (for instance "foo.wrl" instead of "http://bogus.com/foo.wrl"), the anchor cannot resolve the URL reference.

Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
Top
Properties
  NameDescription
Public propertybboxCenter

The bboxCenter and bboxSize fields specify a bounding box that encloses the SoVRMLParent's children.

(Inherited from SoVRMLParent.)
Public propertybboxSize

The bboxCenter and bboxSize fields specify a bounding box that encloses the SoVRMLParents's children.

(Inherited from SoVRMLParent.)
Public propertyboundingBoxCaching

Whether to cache during bounding box traversal.

(Inherited from SoVRMLGroup.)
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoGroup.)
Public propertychildren

Field that contains a list of children nodes.

(Inherited from SoVRMLParent.)
Public propertydescription

A description of the URL which may make more sense to users than the URL itself (e.g.

Public propertydirectVizCaching

Whether to cache during DirectViz rendering traversal.

(Inherited from SoVRMLGroup.)
Public propertyStatic memberFetchURLFunction

Application callbacks invoked when the mouse is clicked on an anchor (activate) so that the app can fetch the URL or call Netscape/Mosaic to fetch the URL.

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertymetadata

Specifies the metadata node.

(Inherited from SoVRMLParent.)
Public propertyparameter

Used to supply any additional information to be interpreted by the application.

Public propertypickCulling

Whether to cull during pick traversal.

(Inherited from SoVRMLGroup.)
Public propertyrenderCaching

Whether to cache during rendering traversal.

(Inherited from SoVRMLGroup.)
Public propertyrenderCulling

Whether to cull during rendering traversal.

(Inherited from SoVRMLGroup.)
Public propertyrenderUnitId

Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator.

(Inherited from SoVRMLGroup.)
Public propertyurl

URL which the application will be called back to fetch when this node is activated by a left mouse click (e.g.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

This node defines a separator group which has a URL (Universal Resource Locator) hyperlink. When clicked on, this node invokes an application delegateto fetch the URL.

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

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 SoVRMLAnchor grouping node causes a URL to be fetched over the network when the viewer activates (e.g. clicks) some geometry contained within the SoVRMLAnchor's children. If the URL pointed to is a legal VRML world, then that world replaces the world which the SoVRMLAnchor is a part of. If non-VRML data type is fetched, it is up to the browser to determine how to handle that data; typically, it will be passed to an appropriate general viewer.

Exactly how a user activates a child of the SoVRMLAnchor depends on the pointing device and is determined by the VRML browser. Typically, clicking with the pointing device will result in the new scene replacing the current scene. An SoVRMLAnchor with an empty ("") url does nothing when its children are chosen. See "Concepts - Sensors and Pointing Device Sensors" for a description of how multiple SoVRMLAnchors and pointing device sensors are resolved on activation.

See the "Concepts - Grouping and Children Nodes" section for a description of children , addChildren , and removeChildren fields and eventIns.

The description field in the SoVRMLAnchor allows for a prompt to be displayed as an alternative to the URL in the url field. Ideally, browsers will allow the user to choose the description, the URL, or both to be displayed for a candidate SoVRMLAnchor.

The parameter exposed field may be used to supply any additional information to be interpreted by the VRML or HTML browser. Each string should consist of "keyword=value" pairs. For example, some browsers allow the specification of a 'target' for a link, to display a link in another part of the HTML document; the parameter field is then:

   SoVRMLAnchor {
  parameter [ "target=name_of_frame" ]
  ...
 }
An SoVRMLAnchor may be used to bind the initial Viewpoint in a world by specifying a URL ending with "#ViewpointName", where "ViewpointName" is the name of a viewpoint defined in the file. For example:

   SoVRMLAnchor {
  url "http://www.school.edu/vrml/someScene.wrl#OverView"
  children Shape { geometry Box {} }
 }
specifies an anchor that loads the file "someScene.wrl", and binds the initial user view to the SoVRMLViewpoint named "OverView" (when the Box is activated). If the named Viewpoint is not found in the file, then ignore it and load the file with the default Viewpoint. If no world is specified, then this means that the Viewpoint specified should be bound ( set_bind true). For example:

   SoVRMLAnchor {
  url "#Doorway"
  children Shape { geometry Sphere {} }
 }
binds viewer to the viewpoint defined by the "Doorway" viewpoint in the current world when the sphere is activated. In this case, if the Viewpoint is not found, then do nothing on activation.

See "Concepts - URLS and URNs" for more details on the url field.

The bboxCenter and bboxSize fields specify a bounding box that encloses the SoVRMLAnchor'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 bboxCenter and bboxSize fields.

FILE FORMAT/DEFAULT

VRMLAnchor {
children []
description ""
parameter []
url []
metadata NULL
bboxCenter 0 0 0
bboxSize -1 -1 -1
}

ACTION BEHAVIOR

SoHandleEventAction

EVENTS

eventIn

SoMFNodeaddChildren
SoMFNoderemoveChildren
SoMFNodeset_children
SoSFStringset_description
SoMFStringset_parameter
SoMFStringset_url
SoSFNodeset_metadata

eventOut

SoMFNodechildren_changed
SoSFStringdescription_changed
SoMFStringparameter_changed
SoMFStringurl_changed
SoSFNodemetadata_changed
Obsoletesince 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.

See Also