LayerSet (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DNode

All Known Implementing Classes:

LayerSetObject
```
public interface LayerSet
extends X3DNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: (X3D version 3.2 or later) [X3DNode] LayerSet defines a list of layers and a rendering order. The rendering order is specified by the order field.
- Hint: the layer first specified in the order field is the first layer rendered and appears below any other layers. The layer last specified in the order field is the last layer rendered and correspondingly appears on top of all other layers.
- Warning: only one LayerSet node is allowed in a scene, and it shall be a root node at the top of the scene graph.
- Hint: X3D Architecture 35.2.1 Overview of layering
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/layering.html#OverviewOfLayering
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: LayerSet, X3D Tooltips: LayerSet, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addLayers(X3DNode[] newValue)` Add array of child layers nodes to array of existing nodes (if any).
`int`	`getActiveLayer()` Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named activeLayer.
`X3DNode[]`	`getLayers()` Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field layers.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`int[]`	`getOrder()` Provide array of int results within allowed range of [0,infinity) from initializeOnly MFInt32 field named order.
`LayerSet`	`setActiveLayer(int newValue)` Assign int value within allowed range of [0,infinity) to inputOutput SFInt32 field named activeLayer.
`LayerSet`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`LayerSet`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`void`	`setLayers(X3DNode newValue)` Set single child layers node, replacing prior array of existing nodes (if any).
`LayerSet`	`setLayers(X3DNode[] newValue)` Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field layers.
`LayerSet`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`LayerSet`	`setOrder(int[] newValue)` Assign int array within allowed range of [0,infinity) to initializeOnly MFInt32 field named order.
`LayerSet`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getActiveLayer
```
int getActiveLayer()
```
    Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named activeLayer.
    
    Tooltip: [0,+infinity) activeLayer field specifies the layer in which navigation takes place.
    - Hint: nodes that are not part of a layer are considered to be in layer 0.
    Returns:
    
    value of activeLayer field
  - setActiveLayer
```
LayerSet setActiveLayer(int newValue)
```
    Assign int value within allowed range of [0,infinity) to inputOutput SFInt32 field named activeLayer.
    
    Tooltip: [0,+infinity) activeLayer field specifies the layer in which navigation takes place. Hint: nodes that are not part of a layer are considered to be in layer 0.
    
    Parameters:
    
    newValue - is new value for the activeLayer field.
    
    Returns:
    
    LayerSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getLayers
```
X3DNode[] getLayers()
```
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field layers.
    
    Tooltip: [X3DLayerNode] The layers list defines a list of Layer nodes that contain the constituent parts of the scene. Each layer is assigned an ordinal number depending on its position in this contained list of nodes.
    - Hint: Ordinal values start with the numeral 1 representing the first item in the list.
    - Hint: nodes that are not part of a layer are considered to be in layer 0.
    Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DLayerNode.
    Returns:
    
    value of layers field
    
    See Also:
    
    X3DLayerNode
  - setLayers
```
LayerSet setLayers(X3DNode[] newValue)
```
    Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field layers.
    
    Tooltip: [X3DLayerNode] The layers list defines a list of Layer nodes that contain the constituent parts of the scene. Each layer is assigned an ordinal number depending on its position in this contained list of nodes. Hint: Ordinal values start with the numeral 1 representing the first item in the list. Hint: nodes that are not part of a layer are considered to be in layer 0.
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DLayerNode.
    
    Parameters:
    
    newValue - is new value for the layers field.
    
    Returns:
    
    LayerSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addLayers
```
void addLayers(X3DNode[] newValue)
```
    Add array of child layers nodes to array of existing nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DLayerNode.
    
    Parameters:
    
    newValue - is new value array to be appended the layers field.
  - setLayers
```
void setLayers(X3DNode newValue)
```
    Set single child layers node, replacing prior array of existing nodes (if any).
    
    Parameters:
    
    newValue - is new node for the layers field
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
LayerSet setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    LayerSet - 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
  - getOrder
```
int[] getOrder()
```
    Provide array of int results within allowed range of [0,infinity) from initializeOnly MFInt32 field named order.
    
    Tooltip: [0,+infinity) The order list defines the order in which layers are rendered. Each value corresponds to the ordinals of the layers.
    - Hint: the order list may contain repetitions of ordinal values, in which case the layer is rendered again.
    - Warning: if order contains number values that are not ordinals assigned to layers, such numbers are ignored.
    - Warning: layers that are not included in the order list are not rendered.
    Returns:
    
    value of order field
  - setOrder
```
LayerSet setOrder(int[] newValue)
```
    Assign int array within allowed range of [0,infinity) to initializeOnly MFInt32 field named order.
    
    Tooltip: [0,+infinity) The order list defines the order in which layers are rendered. Each value corresponds to the ordinals of the layers. Hint: the order list may contain repetitions of ordinal values, in which case the layer is rendered again. Warning: if order contains number values that are not ordinals assigned to layers, such numbers are ignored. Warning: layers that are not included in the order list are not rendered.
    
    Parameters:
    
    newValue - is new value for the order field.
    
    Returns:
    
    LayerSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
LayerSet 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 X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    LayerSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
LayerSet 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 X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    LayerSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
LayerSet 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 X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    LayerSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface LayerSet

Method Summary

Method Detail

getActiveLayer

setActiveLayer

getLayers

setLayers

addLayers

setLayers

getMetadata

setMetadata

getOrder

setOrder

setDEF

setUSE

setCssClass