LayoutLayer (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DLayerNode, X3DNode

All Known Implementing Classes:

LayoutLayerObject
```
public interface LayoutLayer
extends X3DLayerNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: (X3D version 3.2 or later) [X3DLayerNode] LayoutLayer is a Grouping node that can contain most nodes. LayoutLayer content is clipped by the specified viewport node.
- Hint: insert a Shape node before adding geometry or Appearance.
- Warning: better functional description needed in X3D specification.
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: LayoutLayer, X3D Tooltips: LayoutLayer, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addChildren(X3DNode[] newValue)` Add array of children nodes to array of existing nodes (if any).
`X3DNode[]`	`getChildren()` Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.
`boolean`	`getIsPickable()` Provide boolean value from inputOutput SFBool field named isPickable.
`X3DLayoutNode`	`getLayout()` Provide X3DLayoutNode instance (using a properly typed node) from inputOutput SFNode field layout.
`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.
`void`	`setChildren(X3DNode newValue)` Set single children node, replacing prior array of existing nodes (if any).
`LayoutLayer`	`setChildren(X3DNode[] newValue)` Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
`LayoutLayer`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`LayoutLayer`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`LayoutLayer`	`setIsPickable(boolean newValue)` Assign boolean value to inputOutput SFBool field named isPickable.
`LayoutLayer`	`setLayout(X3DLayoutNode newValue)` Assign X3DLayoutNode instance (using a properly typed node) to inputOutput SFNode field layout.
`LayoutLayer`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`LayoutLayer`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`LayoutLayer`	`setViewport(X3DViewportNode newValue)` Assign X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.

- Method Detail
  - getChildren
```
X3DNode[] getChildren()
```
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.
    
    Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.
    - Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down 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.
    Returns:
    
    value of children field
    
    See Also:
    
    X3DChildNode
  - setChildren
```
LayoutLayer setChildren(X3DNode[] newValue)
```
    Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
    
    Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes. Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down 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.
    
    Parameters:
    
    newValue - is new value for the children field.
    
    Returns:
    
    LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addChildren
```
void addChildren(X3DNode[] newValue)
```
    Add array of children nodes to array of existing nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.
    
    Parameters:
    
    newValue - is new value array to be appended the children field.
  - setChildren
```
void setChildren(X3DNode newValue)
```
    Set single children node, replacing prior array of existing nodes (if any).
    
    Parameters:
    
    newValue - is new node for the children field
  - getIsPickable
```
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 X3DLayerNode
    
    Returns:
    
    value of isPickable field
  - setIsPickable
```
LayoutLayer 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 X3DLayerNode
    
    Parameters:
    
    newValue - is new value for the isPickable field.
    
    Returns:
    
    LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getLayout
```
X3DLayoutNode getLayout()
```
    Provide X3DLayoutNode instance (using a properly typed node) from inputOutput SFNode field layout.
    
    Tooltip: [X3DLayoutNode] The layout field contains an X3DLayoutNode node that provides the information required to locate and size the layout region of the LayoutGroup node relative to its parent’s layout region, and also to scale the contents of the LayoutGroup. *
    
    Returns:
    
    value of layout field
  - setLayout
```
LayoutLayer setLayout(X3DLayoutNode newValue)
```
    Assign X3DLayoutNode instance (using a properly typed node) to inputOutput SFNode field layout.
    
    Tooltip: [X3DLayoutNode] The layout field contains an X3DLayoutNode node that provides the information required to locate and size the layout region of the LayoutGroup node relative to its parent’s layout region, and also to scale the contents of the LayoutGroup.
    
    Parameters:
    
    newValue - is new value for the layout field.
    
    Returns:
    
    LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DLayerNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
LayoutLayer setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DLayerNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    LayoutLayer - 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
  - getViewport
```
X3DViewportNode getViewport()
```
    Provide X3DViewportNode instance (using a properly typed node) from inputOutput SFNode field viewport.
    
    Tooltip: [X3DViewportNode] The content of the LayoutGroup is clipped by the specified viewport. *
    
    Specified by:
    
    getViewport in interface X3DLayerNode
    
    Returns:
    
    value of viewport field
  - setViewport
```
LayoutLayer setViewport(X3DViewportNode newValue)
```
    Assign X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.
    
    Tooltip: [X3DViewportNode] The content of the LayoutGroup is clipped by the specified viewport.
    
    Specified by:
    
    setViewport in interface X3DLayerNode
    
    Parameters:
    
    newValue - is new value for the viewport field.
    
    Returns:
    
    LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
LayoutLayer 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 X3DLayerNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
LayoutLayer 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 X3DLayerNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
LayoutLayer 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 X3DLayerNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface LayoutLayer

Method Summary

Method Detail

getChildren

setChildren

addChildren

setChildren

getIsPickable

setIsPickable

getLayout

setLayout

getMetadata

setMetadata

getViewport

setViewport

setDEF

setUSE

setCssClass