Package org.web3d.x3d.sai.Navigation

Interface ViewpointGroup

All Superinterfaces:
X3DChildNode, X3DNode
All Known Implementing Classes:
ViewpointGroupObject
public interface ViewpointGroup
extends X3DChildNode
ViewpointGroup can contain Viewpoint, OrthoViewpoint, GeoViewpoint and other ViewpointGroup nodes for better user-navigation support with a shared description on the viewpoint list.

X3D node tooltip: (X3D version 3.2 or later) [X3DChildNode] ViewpointGroup can contain Viewpoint, OrthoViewpoint, GeoViewpoint and other ViewpointGroup nodes for better user-navigation support with a shared description on the viewpoint list.
  • Hint: use ViewpointGroup as parent for Viewpoint, OrthoViewpoint, GeoViewpoint and other ViewpointGroup nodes to constrain location proximity where contained viewpoints are available to user.
  • Hint: ViewpointGroup and OrthoViewpoint require Navigation component level 3, which is higher than CADInterchange profile.
  • Hint: Viewpoint and ViewpointGroup descriptions together build simple menu/submenu lists for simple user navigation. ViewpointGroup is not an X3DGroupingNode, and can only contain a Metadata* node, Viewpoint, OrthoViewpoint, GeoViewpoint and other ViewpointGroup nodes.

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification: TODO, X3D Abstract Specification: ViewpointGroup, X3D Tooltips: ViewpointGroup, X3D Scene Authoring Hints: Viewpoints

  • Method Summary

    Modifier and Type Method Description
    void addChildren​(X3DNode[] newValue)
    Add array of children nodes to array of existing nodes (if any).
    float[] getCenter()
    Provide array of 3-tuple float results from inputOutput SFVec3f field named center.
    X3DNode[] getChildren()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DViewpointNode|ViewpointGroup, from inputOutput MFNode field children.
    java.lang.String getDescription()
    Provide String value from inputOutput SFString field named description.
    boolean getDisplayed()
    Provide boolean value from inputOutput SFBool field named displayed.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    boolean getRetainUserOffsets()
    Provide boolean value from inputOutput SFBool field named retainUserOffsets.
    float[] getSize()
    Provide array of 3-tuple float results from initializeOnly SFVec3f field named size.
    ViewpointGroup setCenter​(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named center.
    void setChildren​(X3DNode newValue)
    Set single children node, replacing prior array of existing nodes (if any).
    ViewpointGroup setChildren​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (newValue instanceof org.web3d.x3d.jsail.Core.CommentsBlock) || (newValue instanceof org.web3d.x3d.jsail.Core.ROUTEObject) || (newValue instanceof org.web3d.x3d.jsail.Networking.IMPORTObject) || (newValue instanceof org.web3d.x3d.jsail.Networking.EXPORTObject) || (newValue instanceof org.web3d.x3d.jsail.Core.ProtoDeclareObject) || (newValue instanceof org.web3d.x3d.jsail.Core.ExternProtoDeclareObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Navigation.X3DViewpointNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Navigation.ViewpointGroupObject); if (!
    ViewpointGroup setDescription​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    ViewpointGroup setDisplayed​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named displayed.
    ViewpointGroup setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    ViewpointGroup setRetainUserOffsets​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named retainUserOffsets.
    ViewpointGroup setSize​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named size.

  • Method Details

    • getCenter

      float[] getCenter()
      Provide array of 3-tuple float results from inputOutput SFVec3f field named center.

      Tooltip: center specifies center point of proximity box within which ViewpointGroup is usable and displayed on viewpoint list. *
      Returns:
      value of center field

    • setCenter

      ViewpointGroup setCenter​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named center.

      Tooltip: center specifies center point of proximity box within which ViewpointGroup is usable and displayed on viewpoint list. *
      Parameters:
      newValue - is new value for the center field.
      Returns:
      ViewpointGroup - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getChildren

      X3DNode[] getChildren()
      Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DViewpointNode|ViewpointGroup, from inputOutput MFNode field children.

      Tooltip: [X3DChildNode] ViewpointGroup contains Viewpoint, OrthoViewpoint, GeoViewpoint and other ViewpointGroup nodes that each have containerField='children' default value.

      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DViewpointNode|ViewpointGroup.
      Returns:
      value of children field
      See Also:
      X3DViewpointNode, ViewpointGroupObject

    • setChildren

      ViewpointGroup setChildren​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (newValue instanceof org.web3d.x3d.jsail.Core.CommentsBlock) || (newValue instanceof org.web3d.x3d.jsail.Core.ROUTEObject) || (newValue instanceof org.web3d.x3d.jsail.Networking.IMPORTObject) || (newValue instanceof org.web3d.x3d.jsail.Networking.EXPORTObject) || (newValue instanceof org.web3d.x3d.jsail.Core.ProtoDeclareObject) || (newValue instanceof org.web3d.x3d.jsail.Core.ExternProtoDeclareObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Navigation.X3DViewpointNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Navigation.ViewpointGroupObject); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes X3DViewpointNode|ViewpointGroup; newValue=" + newValue); }

      Tooltip: [X3DChildNode] ViewpointGroup contains Viewpoint, OrthoViewpoint, GeoViewpoint and other ViewpointGroup nodes that each have containerField='children' default value.

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DViewpointNode|ViewpointGroup.
      Parameters:
      newValue - is new value for the children field.
      Returns:
      ViewpointGroup - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addChildren

      void addChildren​(X3DNode[] newValue)
      Add array of children nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DViewpointNode|ViewpointGroup.
      Parameters:
      newValue - is new value array to be appended the children field.

    • setChildren

      void setChildren​(X3DNode newValue)
      Set single children node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the children field

    • getDescription

      java.lang.String getDescription()
      Provide String value from inputOutput SFString field named description.

      Tooltip: Text description or navigation hint to identify this ViewpointGroup.
      • Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
      • Warning: without description, this ViewpointGroup is unlikely to appear on browser Viewpoint menus.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Returns:
      value of description field

    • setDescription

      ViewpointGroup setDescription​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.

      Tooltip: Text description or navigation hint to identify this ViewpointGroup.
      • Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
      • Warning: without description, this ViewpointGroup is unlikely to appear on browser Viewpoint menus.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Parameters:
      newValue - is new value for the description field.
      Returns:
      ViewpointGroup - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDisplayed

      boolean getDisplayed()
      Provide boolean value from inputOutput SFBool field named displayed.

      Tooltip: displayed determines whether this ViewpointGroup is displayed in the current viewpoint list. *
      Returns:
      value of displayed field

    • setDisplayed

      ViewpointGroup setDisplayed​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named displayed.

      Tooltip: displayed determines whether this ViewpointGroup is displayed in the current viewpoint list. *
      Parameters:
      newValue - is new value for the displayed field.
      Returns:
      ViewpointGroup - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      ViewpointGroup setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ViewpointGroup - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • getRetainUserOffsets

      boolean getRetainUserOffsets()
      Provide boolean value from inputOutput SFBool field named retainUserOffsets.

      Tooltip: Retain (true) or reset to zero (false) any prior user navigation offsets from defined viewpoint position, orientation. *
      Returns:
      value of retainUserOffsets field

    • setRetainUserOffsets

      ViewpointGroup setRetainUserOffsets​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named retainUserOffsets.

      Tooltip: Retain (true) or reset to zero (false) any prior user navigation offsets from defined viewpoint position, orientation. *
      Parameters:
      newValue - is new value for the retainUserOffsets field.
      Returns:
      ViewpointGroup - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getSize

      float[] getSize()
      Provide array of 3-tuple float results from initializeOnly SFVec3f field named size.

      Tooltip: [0,+infinity) Size of proximity box around center location within which ViewpointGroup is usable and displayed on viewpoint list.
      • Hint: size 0 0 0 specifies that ViewpointGroup is always usable and displayable.
      Returns:
      value of size field

    • setSize

      ViewpointGroup setSize​(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named size.

      Tooltip: [0,+infinity) Size of proximity box around center location within which ViewpointGroup is usable and displayed on viewpoint list.
      • Hint: size 0 0 0 specifies that ViewpointGroup is always usable and displayable.
      Parameters:
      newValue - is new value for the size field.
      Returns:
      ViewpointGroup - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).