SoVRMLAnchor Class |
Note: This API is now obsolete.
Group node with URL hyperlink.
Namespace: OIV.Inventor.VRMLnodes
The SoVRMLAnchor type exposes the following members.
Name | Description | |
---|---|---|
![]() | SoVRMLAnchor | Creates a VRMLAnchor node with default settings. |
Name | Description | |
---|---|---|
![]() | AddChild | Adds a child as last one in group. |
![]() | AffectsState | Returns true if a node has an effect on the state during traversal. |
![]() | Callback | (Overrides SoVRMLGroupCallback(SoCallbackAction).) |
![]() | Copy | Calls Copy(false). (Inherited from SoNode.) |
![]() | Copy(Boolean) | Creates and returns an exact copy of the node. |
![]() | CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
![]() | CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
![]() | Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
![]() | Distribute | (Inherited from SoVRMLGroup.) |
![]() | DoAction | (Overrides SoVRMLGroupDoAction(SoAction).) |
![]() ![]() | EnableEvents | |
![]() | EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
![]() | Equals | (Inherited from Object.) |
![]() | FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
![]() | FindChild | Finds index of given child within group. |
![]() | Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
![]() | GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
![]() | GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
![]() | GetBoundingBox | (Overrides SoVRMLGroupGetBoundingBox(SoGetBoundingBoxAction).) |
![]() | GetChild | Returns the nth child node. |
![]() | GetEventIn | Returns a the eventIn with the given name. |
![]() | GetEventOut | Returns the eventOut with the given name. |
![]() | GetField | Returns a the field of this object whose name is fieldName. |
![]() | GetFieldName | Returns the name of the given field in the fieldName argument. |
![]() | GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
![]() | GetFullURLName | Returns the full URL set by setFullURLName(), or if not set, returns the contents of the url field. |
![]() | GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
![]() | GetMatrix | (Inherited from SoVRMLGroup.) |
![]() | GetName | Returns the name of an instance. |
![]() | GetNumChildren | Returns number of children. |
![]() | GetPrimitiveCount | (Overrides SoVRMLGroupGetPrimitiveCount(SoGetPrimitiveCountAction).) |
![]() | GetRenderUnitID | (Inherited from SoNode.) |
![]() | GetStringName | (Inherited from SoBase.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GLRender | (Inherited from SoVRMLGroup.) |
![]() | GLRenderBelowPath | (Overrides SoVRMLGroupGLRenderBelowPath(SoGLRenderAction).) |
![]() | GLRenderInPath | (Overrides SoVRMLGroupGLRenderInPath(SoGLRenderAction).) |
![]() | GLRenderOffPath | (Inherited from SoVRMLGroup.) |
![]() | GrabEventsCleanup | (Inherited from SoNode.) |
![]() | GrabEventsSetup | (Inherited from SoNode.) |
![]() | HandleEvent | (Overrides SoGroupHandleEvent(SoHandleEventAction).) |
![]() | HasDefaultValues | Returns true if all of the object's fields have their default values. |
![]() | InsertChild | Adds a child so that it becomes the one with the given index. |
![]() | IsBoundingBoxIgnoring | Used by BoundingBoxAction to known if bounding box computation should be ignored or not. |
![]() | IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
![]() | IsOverride | Returns the state of the override flag. |
![]() | IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
![]() | Pick | (Inherited from SoGroup.) |
![]() | RayPick | (Overrides SoVRMLGroupRayPick(SoRayPickAction).) |
![]() | RemoveAllChildren | Removes all children from group. |
![]() | RemoveChild(Int32) | Removes child with given index from group. |
![]() | RemoveChild(SoNode) | Removes first instance of given child from group. |
![]() | ReplaceChild(Int32, SoNode) | Replaces child with given index with new child. |
![]() | ReplaceChild(SoNode, SoNode) | Replaces first instance of given child with new child. |
![]() | Search | (Inherited from SoVRMLGroup.) |
![]() | Set | 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. |
![]() ![]() | SetFetchURLCallback(SoVRMLAnchorFetchURLCallback) | Obsolete.
Use FetchURLFunction instead.
Application delegate invoked when the mouse is clicked on an
anchor so that the application can fetch the URL
|
![]() ![]() | SetFetchURLCallback(SoVRMLAnchorFetchURLUserDataCallback, Object) | Obsolete.
Use FetchURLFunction instead.
|
![]() | SetFullURLName | 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. |
![]() | SetName | (Inherited from SoBase.) |
![]() | SetOverride | Turns the override flag on or off. |
![]() | SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
![]() | SetToDefaults | Sets all fields in this object to their default values. |
![]() | ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
![]() | Touch | Marks an instance as modified, simulating a change to it. |
![]() | Write | (Overrides SoVRMLGroupWrite(SoWriteAction).) |
Name | Description | |
---|---|---|
![]() | bboxCenter | The bboxCenter and bboxSize fields specify a bounding box that encloses the SoVRMLParent's children. |
![]() | bboxSize | The bboxCenter and bboxSize fields specify a bounding box that encloses the SoVRMLParents's children. |
![]() | boundingBoxCaching | Whether to cache during bounding box traversal. |
![]() | boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. |
![]() | children | Field that contains a list of children nodes. |
![]() | description | A description of the URL which may make more sense to users than the URL itself (e.g. |
![]() | directVizCaching | Whether to cache during DirectViz rendering traversal. |
![]() ![]() | FetchURLFunction | 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. |
![]() | IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
![]() | metadata | Specifies the metadata node. |
![]() | parameter | Used to supply any additional information to be interpreted by the application. |
![]() | pickCulling | Whether to cull during pick traversal. |
![]() | renderCaching | Whether to cache during rendering traversal. |
![]() | renderCulling | Whether to cull during rendering traversal. |
![]() | renderUnitId | Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator. |
![]() | url | URL which the application will be called back to fetch when this node is activated by a left mouse click (e.g. |
![]() | UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
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.
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.
VRMLAnchor {
children | [] |
description | "" |
parameter | [] |
url | [] |
metadata | NULL |
bboxCenter | 0 0 0 |
bboxSize | -1 -1 -1 |
SoMFNode | addChildren |
SoMFNode | removeChildren |
SoMFNode | set_children |
SoSFString | set_description |
SoMFString | set_parameter |
SoMFString | set_url |
SoSFNode | set_metadata |
SoMFNode | children_changed |
SoSFString | description_changed |
SoMFString | parameter_changed |
SoMFString | url_changed |
SoSFNode | metadata_changed |