ViewpointGroup (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DNode

All Known Implementing Classes:

ViewpointGroupObject
```
public interface ViewpointGroup
extends X3DChildNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and 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)` 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)` Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DViewpointNode\|ViewpointGroup, 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`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`ViewpointGroup`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`ViewpointGroup`	`setDescription(java.lang.String newValue)` Assign String value to inputOutput SFString field named description.
`ViewpointGroup`	`setDisplayed(boolean newValue)` Assign boolean value to inputOutput SFBool field named displayed.
`ViewpointGroup`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`ViewpointGroup`	`setRetainUserOffsets(boolean newValue)` Assign boolean value to inputOutput SFBool field named retainUserOffsets.
`ViewpointGroup`	`setSize(float[] newValue)` Assign 3-tuple float array to initializeOnly SFVec3f field named size.
`ViewpointGroup`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - 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)
```
    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.
    - Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
    - Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
    - Hint: X3D Architecture 10.2.1 Grouping and children node types,
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes
    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)
```
    Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DViewpointNode|ViewpointGroup, 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. Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored. Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored. Hint: X3D Architecture 10.2.1 Grouping and children node types, http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes
    
    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)
```
    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)
```
    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.
    
    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)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    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)
```
    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)
```
    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).
  - setDEF
```
ViewpointGroup setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    ViewpointGroup - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
ViewpointGroup setUSE(java.lang.String newValue)
```
    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 interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    ViewpointGroup - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
ViewpointGroup setCssClass(java.lang.String newValue)
```
    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 interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    ViewpointGroup - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface ViewpointGroup

Method Summary

Method Detail

getCenter

setCenter

getChildren

setChildren

addChildren

setChildren

getDescription

setDescription

getDisplayed

setDisplayed

getMetadata

setMetadata

getRetainUserOffsets

setRetainUserOffsets

getSize

setSize

setDEF

setUSE

setCssClass