Interface Layer

  • All Superinterfaces:
    X3DLayerNode, X3DNode
    All Known Implementing Classes:
    LayerObject

    public interface Layer
    extends X3DLayerNode
    Abstract node interface, defined by X3D Java Scene Access Interface (SAI) Specification to support X3D Java interoperability.

    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.
      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.
      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 setIsPickable​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named isPickable.
      Layer setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Layer setViewport​(X3DViewportNode newValue)
      Accessor method to 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] 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.
        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, 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:
        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
      • 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, instead only use it a source for ROUTE events.
        Specified by:
        getIsPickable in interface X3DLayerNode
        Returns:
        value of isPickable field
      • setIsPickable

        Layer setIsPickable​(boolean newValue)
        Accessor method to 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, instead only use it a source for ROUTE events.
        Specified by:
        setIsPickable in interface X3DLayerNode
        Parameters:
        newValue - is new value for the isPickable 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).