LayerSetObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteNode
  - - org.web3d.x3d.jsail.Layering.LayerSetObject

All Implemented Interfaces:

X3DNode, LayerSet
```
public class LayerSetObject
extends X3DConcreteNode
implements LayerSet
```
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 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: LayerSet, X3D Tooltips: LayerSet, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACTIVELAYER_DEFAULT_VALUE` SFInt32 field named activeLayer has default value 0 (Java syntax) or 0 (XML syntax).
`static java.lang.String`	`COMPONENT` String constant COMPONENT defines X3D component for the LayerSet element: Layering
`static java.lang.String`	`containerField_DEFAULT_VALUE` containerField describes typical field relationship of a node to its parent.
`static java.lang.String`	`fromField_ACTIVELAYER` fromField ROUTE name for SFInt32 field named activeLayer.
`static java.lang.String`	`fromField_LAYERS` fromField ROUTE name for MFNode field named layers.
`static java.lang.String`	`fromField_METADATA` fromField ROUTE name for SFNode field named metadata.
`static int`	`LEVEL` Integer constant LEVEL provides default X3D Layering component level for this element: 1
`static java.lang.String`	`NAME` String constant NAME provides name of this element: LayerSet.
`static java.util.ArrayList<java.lang.Integer>`	`ORDER_DEFAULT_VALUE` MFInt32 field named order has default value {0} (Java syntax) or 0 (XML syntax).
`static java.lang.String`	`toField_ACTIVELAYER` toField ROUTE name for SFInt32 field named activeLayer.
`static java.lang.String`	`toField_LAYERS` toField ROUTE name for MFNode field named layers.
`static java.lang.String`	`toField_METADATA` toField ROUTE name for SFNode field named metadata.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
validationResult

Constructor Summary

Constructors
Constructor and Description
`LayerSetObject()` Constructor for LayerSetObject to initialize member variables with default values.
`LayerSetObject(java.lang.String DEFlabel)` Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LayerSetObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`LayerSetObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`LayerSetObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`LayerSetObject`	`addLayers(X3DNode newValue)` Add single child node to existing array of layers nodes (if any).
`void`	`addLayers(X3DNode[] newValue)` Add array of child layers nodes to array of existing nodes (if any).
`LayerSetObject`	`addOrder(int newValue)` Add singleton int value to MFInt32 order field.
`LayerSetObject`	`addOrder(SFInt32Object newValue)` Add singleton SFInt32Object value to MFInt32 order field.
`LayerSetObject`	`clearLayers()` Utility method to clear MFNode value of layers field.
`LayerSetObject`	`clearMetadata()` Utility method to clear SFNode value of metadata field.
`LayerSetObject`	`clearOrder()` Utility method to clear MFInt32 value of order field.
`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.
`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.
`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.
`java.lang.String`	`getAccessType(java.lang.String fieldName)` Indicate accessType corresponding to given fieldName.
`int`	`getActiveLayer()` Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named activeLayer.
`java.lang.String`	`getComponent()` Defines X3D component for the LayerSet element: Layering
`int`	`getComponentLevel()` Provides default X3D component level for this element: 1
`java.lang.String`	`getContainerFieldDefault()` containerField describes typical field relationship of a node to its parent.
`java.lang.String`	`getElementName()` Provides name of this element: LayerSet
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`ISObject`	`getIS()` Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`X3DNode[]`	`getLayers()` Provide array of X3DLayerNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field layers.
`java.util.ArrayList<X3DNode>`	`getLayersList()` Utility method to get ArrayList value of MFNode layers field, similar to `getLayers()`.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`int[]`	`getOrder()` Provide array of Integer results within allowed range of [0,infinity) from initializeOnly MFInt32 field named order.
`java.util.ArrayList<java.lang.Integer>`	`getOrderList()` Utility method to get ArrayList value of MFInt32 order field, similar to `getOrder()`.
`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.
`boolean`	`hasLayers()` Indicate whether an object is available for inputOutput MFNode field layers.
`boolean`	`hasMetadata()` Indicate whether an object is available for inputOutput SFNode field metadata.
`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.
`void`	`initialize()` Initialize all member variables to default values.
`LayerSetObject`	`setActiveLayer(int newValue)` Assign int value within allowed range of [0,infinity) to inputOutput SFInt32 field named activeLayer.
`LayerSetObject`	`setActiveLayer(SFInt32Object newValue)` Assign typed object value to SFInt32 activeLayer field, similar to `setActiveLayer(int)`.
`LayerSetObject`	`setCssClass(SFStringObject newValue)` Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`LayerSetObject`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`LayerSetObject`	`setDEF(SFStringObject newValue)` Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`LayerSetObject`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`LayerSetObject`	`setIS(ISObject newValue)` Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`LayerSetObject`	`setLayers(java.util.ArrayList<X3DLayerNode> newValue)` Assign ArrayList value of MFNode layers field, similar to `setLayers(X3DNode[])`.
`LayerSetObject`	`setLayers(X3DConcreteNode newValue)` Utility method to set single SFNode as LayerSetObject layers.
`void`	`setLayers(X3DNode newValue)` Set single child layers node, replacing prior array of existing nodes (if any).
`LayerSetObject`	`setLayers(X3DNode[] newValue)` Assign X3DLayerNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field layers.
`LayerSetObject`	`setMetadata(ProtoInstanceObject newValue)` Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
`LayerSetObject`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`LayerSetObject`	`setOrder(java.util.ArrayList<java.lang.Integer> newValue)` Assign ArrayList value of MFInt32 order field, similar to `setOrder(int[])`.
`LayerSetObject`	`setOrder(int[] newValue)` Assign Integer array within allowed range of [0,infinity) to initializeOnly MFInt32 field named order.
`LayerSetObject`	`setOrder(MFInt32Object newValue)` Assign typed object value to MFInt32 order field, similar to `setOrder(int[])`.
`LayerSetObject`	`setUSE(LayerSetObject DEFnode)` Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`LayerSetObject`	`setUSE(SFStringObject newValue)` Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`LayerSetObject`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`java.lang.String`	`toStringClassicVRML(int indentLevel)` Recursive method to provide ClassicVRML string serialization.
`java.lang.String`	`toStringVRML97(int indentLevel)` Recursive method to provide VRML97 string serialization.
`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.
`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.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: LayerSet.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT defines X3D component for the LayerSet element: Layering
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D Layering component level for this element: 1
    
    See Also:
    
    Constant Field Values
  - ACTIVELAYER_DEFAULT_VALUE
```
public static final int ACTIVELAYER_DEFAULT_VALUE
```
    SFInt32 field named activeLayer has default value 0 (Java syntax) or 0 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - ORDER_DEFAULT_VALUE
```
public static final java.util.ArrayList<java.lang.Integer> ORDER_DEFAULT_VALUE
```
    MFInt32 field named order has default value {0} (Java syntax) or 0 (XML syntax).
  - containerField_DEFAULT_VALUE
```
public static final java.lang.String containerField_DEFAULT_VALUE
```
    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.
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
  - fromField_ACTIVELAYER
```
public static final java.lang.String fromField_ACTIVELAYER
```
    fromField ROUTE name for SFInt32 field named activeLayer.
    
    See Also:
    
    Constant Field Values
  - toField_ACTIVELAYER
```
public static final java.lang.String toField_ACTIVELAYER
```
    toField ROUTE name for SFInt32 field named activeLayer.
    
    See Also:
    
    Constant Field Values
  - fromField_LAYERS
```
public static final java.lang.String fromField_LAYERS
```
    fromField ROUTE name for MFNode field named layers.
    
    See Also:
    
    Constant Field Values
  - toField_LAYERS
```
public static final java.lang.String toField_LAYERS
```
    toField ROUTE name for MFNode field named layers.
    
    See Also:
    
    Constant Field Values
  - fromField_METADATA
```
public static final java.lang.String fromField_METADATA
```
    fromField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - toField_METADATA
```
public static final java.lang.String toField_METADATA
```
    toField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LayerSetObject
```
public LayerSetObject()
```
    Constructor for LayerSetObject to initialize member variables with default values.
  - LayerSetObject
```
public LayerSetObject(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 Detail
  - getElementName
```
public final java.lang.String getElementName()
```
    Provides name of this element: LayerSet
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Defines X3D component for the LayerSet element: Layering
    
    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: 1
    
    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
  - getActiveLayer
```
public 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.
    Specified by:
    
    getActiveLayer in interface LayerSet
    
    Returns:
    
    value of activeLayer field
  - setActiveLayer
```
public LayerSetObject 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.
    
    Specified by:
    
    setActiveLayer in interface LayerSet
    
    Parameters:
    
    newValue - is new value for the activeLayer field.
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setActiveLayer
```
public LayerSetObject setActiveLayer(SFInt32Object newValue)
```
    Assign typed object value to SFInt32 activeLayer field, similar to setActiveLayer(int).
    
    Parameters:
    
    newValue - is new value for the activeLayer field.
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getLayers
```
public X3DNode[] getLayers()
```
    Provide array of X3DLayerNode 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.
    Specified by:
    
    getLayers in interface LayerSet
    
    Returns:
    
    value of layers field
    
    See Also:
    
    X3DLayerNode
  - getLayersList
```
public java.util.ArrayList<X3DNode> getLayersList()
```
    Utility method to get ArrayList value of MFNode layers field, similar to getLayers().
    
    Returns:
    
    value of layers field
  - setLayers
```
public LayerSetObject setLayers(X3DNode[] newValue)
```
    Assign X3DLayerNode 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.
    
    Specified by:
    
    setLayers in interface LayerSet
    
    Parameters:
    
    newValue - is new value for the layers field.
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setLayers
```
public LayerSetObject setLayers(java.util.ArrayList<X3DLayerNode> newValue)
```
    Assign ArrayList value of MFNode layers field, similar to setLayers(X3DNode[]).
    
    Parameters:
    
    newValue - is new value for the layers field.
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addLayers
```
public LayerSetObject addLayers(X3DNode newValue)
```
    Add single child node to existing array of layers nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DLayerNode and ProtoInstance.
    
    Parameters:
    
    newValue - is new value to be appended the layers field.
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addLayers
```
public 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.
    
    Specified by:
    
    addLayers in interface LayerSet
    
    Parameters:
    
    newValue - is new value array to be appended the layers field.
  - setLayers
```
public void setLayers(X3DNode newValue)
```
    Set single child layers node, replacing prior array of existing nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DLayerNode.
    
    Specified by:
    
    setLayers in interface LayerSet
    
    Parameters:
    
    newValue - is new node for the layers field (restricted to X3DLayerNode)
  - setLayers
```
public LayerSetObject setLayers(X3DConcreteNode newValue)
```
    Utility method to set single SFNode as LayerSetObject layers.
    
    Parameters:
    
    newValue - LayerSetObject node to set
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - clearLayers
```
public LayerSetObject clearLayers()
```
    Utility method to clear MFNode value of layers field.
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - hasLayers
```
public boolean hasLayers()
```
    Indicate whether an object is available for inputOutput MFNode field layers.
    
    Returns:
    
    whether a properly typed node or ProtoInstance array or CommentsBlock is available.
    
    See Also:
    
    getLayers()
  - getMetadata
```
public X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface LayerSet
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
public LayerSetObject setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface LayerSet
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
  - clearMetadata
```
public LayerSetObject clearMetadata()
```
    Utility method to clear SFNode value of metadata field.
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setMetadata
```
public LayerSetObject 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:
    
    LayerSetObject - 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
  - getOrder
```
public int[] getOrder()
```
    Provide array of Integer 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.
    Specified by:
    
    getOrder in interface LayerSet
    
    Returns:
    
    value of order field
  - getOrderList
```
public java.util.ArrayList<java.lang.Integer> getOrderList()
```
    Utility method to get ArrayList value of MFInt32 order field, similar to getOrder().
    
    Returns:
    
    value of order field
  - setOrder
```
public LayerSetObject setOrder(int[] newValue)
```
    Assign Integer 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.
    
    Specified by:
    
    setOrder in interface LayerSet
    
    Parameters:
    
    newValue - is new value for the order field.
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setOrder
```
public LayerSetObject setOrder(MFInt32Object newValue)
```
    Assign typed object value to MFInt32 order field, similar to setOrder(int[]).
    
    Parameters:
    
    newValue - is new value for the order field.
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setOrder
```
public LayerSetObject setOrder(java.util.ArrayList<java.lang.Integer> newValue)
```
    Assign ArrayList value of MFInt32 order field, similar to setOrder(int[]).
    
    Parameters:
    
    newValue - is new value for the order field.
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - clearOrder
```
public LayerSetObject clearOrder()
```
    Utility method to clear MFInt32 value of order field.
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addOrder
```
public LayerSetObject addOrder(int newValue)
```
    Add singleton int value to MFInt32 order field.
    
    Parameters:
    
    newValue - is new value to add to the order field.
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addOrder
```
public LayerSetObject addOrder(SFInt32Object newValue)
```
    Add singleton SFInt32Object value to MFInt32 order field.
    
    Parameters:
    
    newValue - is new value to add to the order field.
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public final LayerSetObject 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
    
    Specified by:
    
    setDEF in interface LayerSet
    
    Specified by:
    
    setDEF in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public LayerSetObject 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:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public final LayerSetObject 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
    
    Specified by:
    
    setUSE in interface LayerSet
    
    Specified by:
    
    setUSE in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public LayerSetObject 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:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
public final LayerSetObject 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
    
    Specified by:
    
    setCssClass in interface LayerSet
    
    Specified by:
    
    setCssClass in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    LayerSetObject - 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 LayerSetObject 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:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setIS
```
public LayerSetObject setIS(ISObject newValue)
```
    Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    setIS in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    LayerSetObject - 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
  - getIS
```
public ISObject getIS()
```
    Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    getIS in class X3DConcreteNode
    
    Returns:
    
    current ISObject, if any.
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - setUSE
```
public LayerSetObject setUSE(LayerSetObject 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:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addComments
```
public LayerSetObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public LayerSetObject addComments(java.lang.String[] newComments)
```
    Add comments as String[] array to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComments - array of comments
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public LayerSetObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    LayerSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - 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
  - 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)

Class LayerSetObject

Field Summary

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Constructor Summary

Method Summary

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Methods inherited from class java.lang.Object

Field Detail

NAME

COMPONENT

LEVEL

ACTIVELAYER_DEFAULT_VALUE

ORDER_DEFAULT_VALUE

containerField_DEFAULT_VALUE

fromField_ACTIVELAYER

toField_ACTIVELAYER

fromField_LAYERS

toField_LAYERS

fromField_METADATA

toField_METADATA

Constructor Detail

LayerSetObject

LayerSetObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

getContainerFieldDefault

initialize

getActiveLayer

setActiveLayer

setActiveLayer

getLayers

getLayersList

setLayers

setLayers

addLayers

addLayers

setLayers

setLayers

clearLayers

hasLayers

getMetadata

setMetadata

clearMetadata

setMetadata

hasMetadata

getOrder

getOrderList

setOrder

setOrder

setOrder

clearOrder

addOrder

addOrder

setDEF

setDEF

setUSE

setUSE

setCssClass

setCssClass

setIS

getIS

setUSE

addComments

addComments

addComments

toStringX3D

toStringClassicVRML

toStringVRML97

findElementByNameValue

findElementByNameValue

hasElementByNameValue

findNodeByDEF

hasNodeByDEF

validate