Package org.web3d.x3d.sai.Layering

Interface Layer

All Superinterfaces:
X3DLayerNode, X3DNode, X3DPickableObject
All Known Implementing Classes:
LayerObject
public interface Layer
extends X3DLayerNode
Layer contains a list of children nodes that define the contents of the 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 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: Layer, X3D Tooltips: Layer, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method 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.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    java.lang.String[] getObjectType()
    Provide array of String enumeration results with quoted value(s) ["ALL","NONE","TERRAIN",...] from inputOutput MFString field named objectType.
    boolean getPickable()
    Provide boolean value from inputOutput SFBool field named pickable.
    X3DViewportNode getViewport()
    Provide X3DViewportNode instance (using a properly typed node) from inputOutput SFNode field viewport.
    boolean getVisible()
    Provide boolean value from inputOutput SFBool field named visible.
    void setChildren​(X3DNode newValue)
    Set single children node, replacing prior array of existing nodes (if any).
    Layer setChildren​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
    Layer setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    Layer setObjectType​(java.lang.String[] newValue)
    Accessor method to assign String enumeration array (""ALL"" | ""NONE"" | ""TERRAIN"") to inputOutput MFString field named objectType.
    Layer setPickable​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named pickable.
    Layer setViewport​(X3DViewportNode newValue)
    Accessor method to assign X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.
    Layer setVisible​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named visible.

  • Method Details

    • 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] 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, https://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

      Layer setChildren​(X3DNode[] newValue)
      Accessor method to assign X3DNode 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, https://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:
      Layer - 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

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      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

      Layer setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DLayerNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      Layer - 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

    • getObjectType

      java.lang.String[] getObjectType()
      Provide array of String enumeration results with quoted value(s) ["ALL","NONE","TERRAIN",...] from inputOutput MFString field named objectType.
      Specified by:
      getObjectType in interface X3DLayerNode
      Returns:
      value of objectType field

    • setObjectType

      Layer setObjectType​(java.lang.String[] newValue)
      Accessor method to assign String enumeration array (""ALL"" | ""NONE"" | ""TERRAIN"") to inputOutput MFString field named objectType.
      Specified by:
      setObjectType in interface X3DLayerNode
      Parameters:
      newValue - is new value for the objectType field.
      Returns:
      Layer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getPickable

      boolean getPickable()
      Provide boolean value from inputOutput SFBool field named pickable.

      Tooltip: pickable determines whether pick traversal is performed for this layer. *
      Specified by:
      getPickable in interface X3DLayerNode
      Specified by:
      getPickable in interface X3DPickableObject
      Returns:
      value of pickable field

    • setPickable

      Layer setPickable​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named pickable.

      Tooltip: pickable determines whether pick traversal is performed for this layer. *
      Specified by:
      setPickable in interface X3DLayerNode
      Specified by:
      setPickable in interface X3DPickableObject
      Parameters:
      newValue - is new value for the pickable field.
      Returns:
      Layer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getViewport

      X3DViewportNode getViewport()
      Provide X3DViewportNode instance (using a properly typed node) from inputOutput SFNode field viewport.

      Tooltip: [X3DViewportNode] The viewport field is a single Viewport node that constrains layer output to a sub-region of the render surface. *
      Specified by:
      getViewport in interface X3DLayerNode
      Returns:
      value of viewport field

    • setViewport

      Layer setViewport​(X3DViewportNode newValue)
      Accessor method to assign X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.

      Tooltip: [X3DViewportNode] The viewport field is a single Viewport node that constrains layer output to a sub-region of the render surface. *
      Specified by:
      setViewport in interface X3DLayerNode
      Parameters:
      newValue - is new value for the viewport field.
      Returns:
      Layer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getVisible

      boolean getVisible()
      Provide boolean value from inputOutput SFBool field named visible.
      Specified by:
      getVisible in interface X3DLayerNode
      Returns:
      value of visible field

    • setVisible

      Layer setVisible​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named visible.
      Specified by:
      setVisible in interface X3DLayerNode
      Parameters:
      newValue - is new value for the visible field.
      Returns:
      Layer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).