Interface LayerSet

All Superinterfaces:
X3DNode
All Known Implementing Classes:
LayerSetObject

public interface LayerSet
extends X3DNode
LayerSet defines a list of layers and a rendering order.

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.
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: LayerSet, X3D Tooltips: LayerSet, X3D Scene Authoring Hints
  • Method Summary

    Modifier and Type Method Description
    void addLayers​(X3DNode[] newValue)
    Add array of child layers nodes to array of existing nodes (if any).
    int getActiveLayer()
    Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named activeLayer.
    X3DNode[] getLayers()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field layers.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    int[] getOrder()
    Provide array of int results within allowed range of [0,infinity) from initializeOnly MFInt32 field named order.
    LayerSet setActiveLayer​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named activeLayer.
    void setLayers​(X3DNode newValue)
    Set single child layers node, replacing prior array of existing nodes (if any).
    LayerSet setLayers​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field layers.
    LayerSet setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    LayerSet setOrder​(int[] newValue)
    Accessor method to assign int array to initializeOnly MFInt32 field named order.
  • Method Details

    • getActiveLayer

      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.
      Returns:
      value of activeLayer field
    • setActiveLayer

      LayerSet setActiveLayer​(int newValue)
      Accessor method to assign int value 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.
      Parameters:
      newValue - is new value for the activeLayer field.
      Returns:
      LayerSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getLayers

      X3DNode[] getLayers()
      Provide array of X3DNode 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.
      Returns:
      value of layers field
      See Also:
      X3DLayerNode
    • setLayers

      LayerSet setLayers​(X3DNode[] newValue)
      Accessor method to assign X3DNode 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.
      Parameters:
      newValue - is new value for the layers field.
      Returns:
      LayerSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addLayers

      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.
      Parameters:
      newValue - is new value array to be appended the layers field.
    • setLayers

      void setLayers​(X3DNode newValue)
      Set single child layers node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the layers field
    • getMetadata

      X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      LayerSet setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      LayerSet - 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
    • getOrder

      int[] getOrder()
      Provide array of int 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.
      Returns:
      value of order field
    • setOrder

      LayerSet setOrder​(int[] newValue)
      Accessor method to assign int array 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.
      Parameters:
      newValue - is new value for the order field.
      Returns:
      LayerSet - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).