LayerObject (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.LayerObject

All Implemented Interfaces:

X3DNode, Layer, X3DLayerNode
```
public class LayerObject
extends X3DConcreteNode
implements Layer
```
X3D node tooltip: (X3D version 3.2 or later) [X3DLayerNode] Layer contains a list of children nodes that define the contents of the layer.
- Hint: no transformations are possible above each Layerset/Layer combination in the scene graph hierarchy.
- Hint: each Layer node contains its own binding stacks and thus has its own viewpoints and navigation.
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: Layer, X3D Tooltips: Layer, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENT` String constant COMPONENT defines X3D component for the Layer 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_CHILDREN` fromField ROUTE name for MFNode field named children.
`static java.lang.String`	`fromField_ISPICKABLE` fromField ROUTE name for SFBool field named isPickable.
`static java.lang.String`	`fromField_METADATA` fromField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`fromField_VIEWPORT` fromField ROUTE name for SFNode field named viewport.
`static boolean`	`ISPICKABLE_DEFAULT_VALUE` SFBool field named isPickable has default value true (Java syntax) or true (XML syntax).
`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: Layer.
`static java.lang.String`	`toField_ADDCHILDREN` toField ROUTE name for MFNode field named addChildren.
`static java.lang.String`	`toField_CHILDREN` toField ROUTE name for MFNode field named children.
`static java.lang.String`	`toField_ISPICKABLE` toField ROUTE name for SFBool field named isPickable.
`static java.lang.String`	`toField_METADATA` toField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`toField_REMOVECHILDREN` toField ROUTE name for MFNode field named removeChildren.
`static java.lang.String`	`toField_VIEWPORT` toField ROUTE name for SFNode field named viewport.

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
`LayerObject()` Constructor for LayerObject to initialize member variables with default values.
`LayerObject(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
`LayerObject`	`addChild(X3DChildNode newValue)` Utility method to add single child element to contained list of existing children nodes (if any).
`void`	`addChildren(X3DNode newValue)` Add single node to existing array of children nodes (if any).
`void`	`addChildren(X3DNode[] newValue)` Add array of children nodes to array of existing nodes (if any).
`LayerObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to children field
`LayerObject`	`addComments(java.lang.String newComment)` Add comment as CommentsBlock to children field
`LayerObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to children field
`LayerObject`	`clearChildren()` Utility method to clear MFNode value of children field.
`LayerObject`	`clearMetadata()` Utility method to clear SFNode value of metadata field.
`LayerObject`	`clearViewport()` Utility method to clear SFNode value of viewport 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.
`X3DNode[]`	`getChildren()` Provide array of X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.
`java.util.ArrayList<X3DNode>`	`getChildrenList()` Utility method to get ArrayList value of MFNode children field, similar to `getChildren()`.
`java.lang.String`	`getComponent()` Defines X3D component for the Layer 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: Layer
`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.
`boolean`	`getIsPickable()` Provide boolean value from inputOutput SFBool field named isPickable.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`X3DViewportNode`	`getViewport()` Provide X3DViewportNode instance (using a properly typed node) from inputOutput SFNode field viewport.
`boolean`	`hasChildren()` Indicate whether an object is available for inputOutput MFNode field children.
`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`	`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.
`boolean`	`hasViewport()` Indicate whether an object is available for inputOutput SFNode field viewport.
`void`	`initialize()` Initialize all member variables to default values.
`LayerObject`	`setChildren(java.util.ArrayList<X3DChildNode> newValue)` Assign ArrayList value of MFNode children field, similar to `setChildren(X3DNode[])`.
`void`	`setChildren(X3DNode newValue)` Set single children node, replacing prior array of existing nodes (if any).
`LayerObject`	`setChildren(X3DNode[] newValue)` Assign X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
`LayerObject`	`setCssClass(SFStringObject newValue)` Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`LayerObject`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`LayerObject`	`setDEF(SFStringObject newValue)` Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`LayerObject`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`LayerObject`	`setIS(ISObject newValue)` Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`LayerObject`	`setIsPickable(boolean newValue)` Assign boolean value to inputOutput SFBool field named isPickable.
`LayerObject`	`setIsPickable(SFBoolObject newValue)` Assign typed object value to SFBool isPickable field, similar to `setIsPickable(boolean)`.
`LayerObject`	`setMetadata(ProtoInstanceObject newValue)` Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
`LayerObject`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`LayerObject`	`setUSE(LayerObject DEFnode)` Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`LayerObject`	`setUSE(SFStringObject newValue)` Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`LayerObject`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`LayerObject`	`setViewport(ProtoInstanceObject newValue)` Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field viewport.
`LayerObject`	`setViewport(X3DViewportNode newValue)` Assign X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.
`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: Layer.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT defines X3D component for the Layer 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
  - ISPICKABLE_DEFAULT_VALUE
```
public static final boolean ISPICKABLE_DEFAULT_VALUE
```
    SFBool field named isPickable has default value true (Java syntax) or true (XML syntax).
    
    See Also:
    
    Constant Field Values
  - 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
  - toField_ADDCHILDREN
```
public static final java.lang.String toField_ADDCHILDREN
```
    toField ROUTE name for MFNode field named addChildren.
    
    See Also:
    
    Constant Field Values
  - fromField_CHILDREN
```
public static final java.lang.String fromField_CHILDREN
```
    fromField ROUTE name for MFNode field named children.
    
    See Also:
    
    Constant Field Values
  - toField_CHILDREN
```
public static final java.lang.String toField_CHILDREN
```
    toField ROUTE name for MFNode field named children.
    
    See Also:
    
    Constant Field Values
  - fromField_ISPICKABLE
```
public static final java.lang.String fromField_ISPICKABLE
```
    fromField ROUTE name for SFBool field named isPickable.
    
    See Also:
    
    Constant Field Values
  - toField_ISPICKABLE
```
public static final java.lang.String toField_ISPICKABLE
```
    toField ROUTE name for SFBool field named isPickable.
    
    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
  - toField_REMOVECHILDREN
```
public static final java.lang.String toField_REMOVECHILDREN
```
    toField ROUTE name for MFNode field named removeChildren.
    
    See Also:
    
    Constant Field Values
  - fromField_VIEWPORT
```
public static final java.lang.String fromField_VIEWPORT
```
    fromField ROUTE name for SFNode field named viewport.
    
    See Also:
    
    Constant Field Values
  - toField_VIEWPORT
```
public static final java.lang.String toField_VIEWPORT
```
    toField ROUTE name for SFNode field named viewport.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LayerObject
```
public LayerObject()
```
    Constructor for LayerObject to initialize member variables with default values.
  - LayerObject
```
public LayerObject(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: Layer
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Defines X3D component for the Layer 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
  - getChildren
```
public X3DNode[] getChildren()
```
    Provide array of X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.
    
    Tooltip: [X3DChildNode] Nodes making up this layer.
    - Hint: no transformations are possible above each Layerset/Layer combination in the scene graph hierarchy.
    - 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 X3DChildNode.
    Specified by:
    
    getChildren in interface Layer
    
    Returns:
    
    value of children field
    
    See Also:
    
    X3DChildNode
  - 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 LayerObject setChildren(X3DNode[] newValue)
```
    Assign X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
    
    Tooltip: [X3DChildNode] Nodes making up this layer. Hint: no transformations are possible above each Layerset/Layer combination in the scene graph hierarchy. 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 X3DChildNode.
    
    Specified by:
    
    setChildren in interface Layer
    
    Parameters:
    
    newValue - is new value for the children field.
    
    Returns:
    
    LayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setChildren
```
public LayerObject setChildren(java.util.ArrayList<X3DChildNode> newValue)
```
    Assign ArrayList value of MFNode children field, similar to setChildren(X3DNode[]).
    
    Parameters:
    
    newValue - is new value for the children field.
    
    Returns:
    
    LayerObject - 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 X3DChildNode and ProtoInstance.
    
    Parameters:
    
    newValue - is new value to be appended the children field.
  - addChild
```
public LayerObject addChild(X3DChildNode 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:
    
    LayerObject - 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 X3DChildNode.
    
    Specified by:
    
    addChildren in interface Layer
    
    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 X3DChildNode.
    
    Specified by:
    
    setChildren in interface Layer
    
    Parameters:
    
    newValue - is new node for the children field (restricted to X3DChildNode)
  - clearChildren
```
public LayerObject clearChildren()
```
    Utility method to clear MFNode value of children field.
    
    Returns:
    
    LayerObject - 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 LayerObject addComments(java.lang.String newComment)
```
    Add comment as CommentsBlock to children field
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    LayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public LayerObject 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:
    
    LayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public LayerObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to children field
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    LayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getIsPickable
```
public boolean getIsPickable()
```
    Provide boolean value from inputOutput SFBool field named isPickable.
    
    Tooltip: isPickable determines whether pick traversal is performed for this layer.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Specified by:
    
    getIsPickable in interface Layer
    
    Specified by:
    
    getIsPickable in interface X3DLayerNode
    
    Returns:
    
    value of isPickable field
  - setIsPickable
```
public LayerObject setIsPickable(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named isPickable.
    
    Tooltip: isPickable determines whether pick traversal is performed for this layer. Warning: it is an error to define this transient outputOnly field in an X3D file.
    
    Specified by:
    
    setIsPickable in interface Layer
    
    Specified by:
    
    setIsPickable in interface X3DLayerNode
    
    Parameters:
    
    newValue - is new value for the isPickable field.
    
    Returns:
    
    LayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setIsPickable
```
public LayerObject setIsPickable(SFBoolObject newValue)
```
    Assign typed object value to SFBool isPickable field, similar to setIsPickable(boolean).
    
    Parameters:
    
    newValue - is new value for the isPickable field.
    
    Returns:
    
    LayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - 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 Layer
    
    Specified by:
    
    getMetadata in interface X3DLayerNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
public LayerObject 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 Layer
    
    Specified by:
    
    setMetadata in interface X3DLayerNode
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    LayerObject - 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 LayerObject clearMetadata()
```
    Utility method to clear SFNode value of metadata field.
    
    Returns:
    
    LayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setMetadata
```
public LayerObject 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:
    
    LayerObject - 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
  - getViewport
```
public X3DViewportNode getViewport()
```
    Provide X3DViewportNode instance (using a properly typed node) from inputOutput SFNode field viewport.
    
    Specified by:
    
    getViewport in interface Layer
    
    Specified by:
    
    getViewport in interface X3DLayerNode
    
    Returns:
    
    value of viewport field
    
    See Also:
    
    Tooltip: [X3DViewportNode] The viewport field is a single Viewport node that constrains layer output to a sub-region of the render surface. *
  - setViewport
```
public LayerObject setViewport(X3DViewportNode newValue)
```
    Assign X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.
    
    Specified by:
    
    setViewport in interface Layer
    
    Specified by:
    
    setViewport in interface X3DLayerNode
    
    Parameters:
    
    newValue - is new value for the viewport field.
    
    Returns:
    
    LayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    Tooltip: [X3DViewportNode] The viewport field is a single Viewport node that constrains layer output to a sub-region of the render surface.
  - clearViewport
```
public LayerObject clearViewport()
```
    Utility method to clear SFNode value of viewport field.
    
    Returns:
    
    LayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setViewport
```
public LayerObject setViewport(ProtoInstanceObject newValue)
```
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field viewport.
    
    Parameters:
    
    newValue - is new value for the viewport field.
    
    Returns:
    
    LayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setViewport(X3DViewportNode)
  - hasViewport
```
public boolean hasViewport()
```
    Indicate whether an object is available for inputOutput SFNode field viewport.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getViewport(), getViewportProtoInstance()
  - setDEF
```
public final LayerObject 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 Layer
    
    Specified by:
    
    setDEF in interface X3DLayerNode
    
    Specified by:
    
    setDEF in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    LayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public LayerObject 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:
    
    LayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public final LayerObject 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 Layer
    
    Specified by:
    
    setUSE in interface X3DLayerNode
    
    Specified by:
    
    setUSE in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    LayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public LayerObject 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:
    
    LayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
public final LayerObject 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 Layer
    
    Specified by:
    
    setCssClass in interface X3DLayerNode
    
    Specified by:
    
    setCssClass in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    LayerObject - 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 LayerObject 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:
    
    LayerObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setIS
```
public LayerObject 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:
    
    LayerObject - 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 LayerObject setUSE(LayerObject 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:
    
    LayerObject - 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
  - 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 LayerObject

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

ISPICKABLE_DEFAULT_VALUE

containerField_DEFAULT_VALUE

toField_ADDCHILDREN

fromField_CHILDREN

toField_CHILDREN

fromField_ISPICKABLE

toField_ISPICKABLE

fromField_METADATA

toField_METADATA

toField_REMOVECHILDREN

fromField_VIEWPORT

toField_VIEWPORT

Constructor Detail

LayerObject

LayerObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

getContainerFieldDefault

initialize

getChildren

getChildrenList

setChildren

setChildren

addChildren

addChild

addChildren

setChildren

clearChildren

hasChildren

addComments

addComments

addComments

getIsPickable

setIsPickable

setIsPickable

getMetadata

setMetadata

clearMetadata

setMetadata

hasMetadata

getViewport

setViewport

clearViewport

setViewport

hasViewport

setDEF

setDEF

setUSE

setUSE

setCssClass

setCssClass

setIS

getIS

setUSE

toStringX3D

toStringClassicVRML

toStringVRML97

findElementByNameValue

findElementByNameValue

hasElementByNameValue

findNodeByDEF

hasNodeByDEF

validate