Package org.web3d.x3d.jsail.Navigation

Class ViewpointGroupObject

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Navigation.ViewpointGroupObject
All Implemented Interfaces:
X3DChildNode, X3DNode, ViewpointGroup
public class ViewpointGroupObject
extends X3DConcreteNode
implements ViewpointGroup
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 org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:
X3D Abstract Specification: ViewpointGroup, X3D Tooltips: ViewpointGroup, X3D Scene Authoring Hints: Viewpoints

  • Field Details

  • Constructor Details

    • ViewpointGroupObject

      public ViewpointGroupObject()
      Constructor for ViewpointGroupObject to initialize member variables with default values.

    • ViewpointGroupObject

      public ViewpointGroupObject​(java.lang.String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node

  • Method Details

    • getElementName

      public final java.lang.String getElementName()
      Provides name of this element: ViewpointGroup
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element

    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the ViewpointGroup element: Navigation
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element

    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 3
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element

    • getFieldType

      public java.lang.String getFieldType​(java.lang.String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

    • getAccessType

      public java.lang.String getAccessType​(java.lang.String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

    • getContainerFieldDefault

      public final java.lang.String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)

    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode

    • getCenter

      public 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. *
      Specified by:
      getCenter in interface ViewpointGroup
      Returns:
      value of center field

    • setCenter

      public ViewpointGroupObject 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. *
      Specified by:
      setCenter in interface ViewpointGroup
      Parameters:
      newValue - is new value for the center field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCenter

      public ViewpointGroupObject setCenter​(SFVec3fObject newValue)
      Assign typed object value to SFVec3f center field, similar to setCenter(float[]).
      Parameters:
      newValue - is new value for the center field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCenter

      public ViewpointGroupObject setCenter​(float x, float y, float z)
      Assign values to SFVec3f center field, similar to setCenter(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCenter

      public ViewpointGroupObject setCenter​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setCenter(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCenter

      public ViewpointGroupObject setCenter​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setCenter(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getChildren

      public 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.
      Specified by:
      getChildren in interface ViewpointGroup
      Returns:
      value of children field
      See Also:
      X3DViewpointNode, ViewpointGroupObject

    • getChildrenList

      public java.util.ArrayList<X3DNode> getChildrenList()
      Utility method to get ArrayList value of MFNode children field, similar to getChildren().
      Returns:
      value of children field

    • setChildren

      public ViewpointGroupObject 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.
      Specified by:
      setChildren in interface ViewpointGroup
      Parameters:
      newValue - is new value for the children field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setChildren

      public ViewpointGroupObject setChildren​(java.util.ArrayList<X3DNode> newValue)
      Assign ArrayList value of MFNode children field, similar to setChildren(X3DNode[]).
      Parameters:
      newValue - is new value for the children field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addChildren

      public void addChildren​(X3DNode newValue)
      Add single node to existing array of children nodes (if any).

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

    • addChildren

      public ViewpointGroupObject addChildren​(ProtoInstanceObject newValue)
      Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for children field.

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.
      Parameters:
      newValue - is new value to be appended the parts field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addChild

      public ViewpointGroupObject addChild​(X3DNode newValue)
      Utility method to add single child element to contained list of existing children nodes (if any).
      Parameters:
      newValue - is new node value to be appended the children field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addChildren

      public 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.
      Specified by:
      addChildren in interface ViewpointGroup
      Parameters:
      newValue - is new value array to be appended the children field.

    • setChildren

      public void setChildren​(X3DNode newValue)
      Set single children node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DViewpointNode|ViewpointGroup.
      Specified by:
      setChildren in interface ViewpointGroup
      Parameters:
      newValue - is new node for the children field (restricted to X3DViewpointNode|ViewpointGroup)

    • clearChildren

      public ViewpointGroupObject clearChildren()
      Utility method to clear MFNode value of children field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasChildren

      public boolean hasChildren()
      Indicate whether an object is available for inputOutput MFNode field children.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:
      getChildren()

    • addComments

      public ViewpointGroupObject addComments​(java.lang.String newComment)
      Add comment as CommentsBlock to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addComments

      public ViewpointGroupObject addComments​(java.lang.String[] newComments)
      Add comments as String[] array to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addComments

      public ViewpointGroupObject addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDescription

      public 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 &#38; for & ampersand character, or &#34; for " quotation-mark character).
      Specified by:
      getDescription in interface ViewpointGroup
      Returns:
      value of description field

    • setDescription

      public ViewpointGroupObject 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 &#38; for & ampersand character, or &#34; for " quotation-mark character).
      Specified by:
      setDescription in interface ViewpointGroup
      Parameters:
      newValue - is new value for the description field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDescription

      public ViewpointGroupObject setDescription​(SFStringObject newValue)
      Assign typed object value to SFString description field, similar to setDescription(String).
      Parameters:
      newValue - is new value for the description field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDisplayed

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

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

    • setDisplayed

      public ViewpointGroupObject 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. *
      Specified by:
      setDisplayed in interface ViewpointGroup
      Parameters:
      newValue - is new value for the displayed field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDisplayed

      public ViewpointGroupObject setDisplayed​(SFBoolObject newValue)
      Assign typed object value to SFBool displayed field, similar to setDisplayed(boolean).
      Parameters:
      newValue - is new value for the displayed field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getIS

      public ISObject getIS()
      Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect

    • setIS

      public ViewpointGroupObject setIS​(ISObject newValue)
      Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect

    • clearIS

      public ViewpointGroupObject clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:
      getIS()

    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface ViewpointGroup
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      public ViewpointGroupObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface ViewpointGroup
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes

    • clearMetadata

      public ViewpointGroupObject clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setMetadata

      public ViewpointGroupObject setMetadata​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(X3DMetadataObject)

    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

    • getRetainUserOffsets

      public 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. *
      Specified by:
      getRetainUserOffsets in interface ViewpointGroup
      Returns:
      value of retainUserOffsets field

    • setRetainUserOffsets

      public ViewpointGroupObject 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. *
      Specified by:
      setRetainUserOffsets in interface ViewpointGroup
      Parameters:
      newValue - is new value for the retainUserOffsets field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setRetainUserOffsets

      public ViewpointGroupObject setRetainUserOffsets​(SFBoolObject newValue)
      Assign typed object value to SFBool retainUserOffsets field, similar to setRetainUserOffsets(boolean).
      Parameters:
      newValue - is new value for the retainUserOffsets field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getSize

      public 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.
      Specified by:
      getSize in interface ViewpointGroup
      Returns:
      value of size field

    • setSize

      public ViewpointGroupObject 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.
      Specified by:
      setSize in interface ViewpointGroup
      Parameters:
      newValue - is new value for the size field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setSize

      public ViewpointGroupObject setSize​(SFVec3fObject newValue)
      Assign typed object value to SFVec3f size field, similar to setSize(float[]).
      Parameters:
      newValue - is new value for the size field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setSize

      public ViewpointGroupObject setSize​(float x, float y, float z)
      Assign values to SFVec3f size field, similar to setSize(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setSize

      public ViewpointGroupObject setSize​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setSize(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setSize

      public ViewpointGroupObject setSize​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSize(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDEF

      public java.lang.String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions

    • setDEF

      public final ViewpointGroupObject setDEF​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDEF

      public ViewpointGroupObject setDEF​(SFStringObject newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getUSE

      public java.lang.String getUSE()
      Provide String value from inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions

    • setUSE

      public final ViewpointGroupObject setUSE​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.


      Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

      Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Specified by:
      setUSE in class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public ViewpointGroupObject setUSE​(SFStringObject newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCssClass

      public java.lang.String getCssClass()
      Provide String value from inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets

    • setCssClass

      public final ViewpointGroupObject setCssClass​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      W3C Cascading Style Sheets

    • setCssClass

      public ViewpointGroupObject setCssClass​(SFStringObject newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public ViewpointGroupObject setUSE​(ViewpointGroupObject DEFnode)
      Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

      Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Parameters:
      DEFnode - must have a DEF value defined
      Returns:
      ViewpointGroupObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • toStringX3D

      public java.lang.String toStringX3D​(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool

    • toStringClassicVRML

      public java.lang.String toStringClassicVRML​(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
      X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

    • toStringVRML97

      public java.lang.String toStringVRML97​(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
      X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

    • hasElementByNameValue

      public boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:
      findElementByNameValue(String, String)

    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

    • hasNodeByDEF

      public boolean hasNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:
      findNodeByDEF(String)

    • validate

      public java.lang.String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)