Package org.web3d.x3d.sai.Layering

Interface X3DLayerNode

All Superinterfaces:
X3DNode, X3DPickableObject
All Known Subinterfaces:
Layer, LayoutLayer
All Known Implementing Classes:
Layer, LayoutLayer
public interface X3DLayerNode
extends X3DNode, X3DPickableObject
The X3DLayerNode abstract node type is the base node type for layer nodes.


Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification, X3D Abstract Specification, X3D Tooltips, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    X3DMetadataObject getMetadata()
    Provide org.web3d.x3d.sai.Core.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 org.web3d.x3d.sai.Layering.X3DViewportNode instance (using a properly typed node) from inputOutput SFNode field viewport.
    boolean getVisible()
    Provide boolean value from inputOutput SFBool field named visible.
    X3DLayerNode setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    X3DLayerNode setObjectType​(java.lang.String[] newValue)
    Accessor method to assign String enumeration array (""ALL"" | ""NONE"" | ""TERRAIN"") to inputOutput MFString field named objectType.
    X3DLayerNode setPickable​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named pickable.
    X3DLayerNode setViewport​(X3DViewportNode newValue)
    Accessor method to assign org.web3d.x3d.sai.Layering.X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.
    X3DLayerNode setVisible​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named visible.

  • Method Details

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.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

      X3DLayerNode setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.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:
      X3DLayerNode - 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.
      Returns:
      value of objectType field

    • setObjectType

      X3DLayerNode setObjectType​(java.lang.String[] newValue)
      Accessor method to assign String enumeration array (""ALL"" | ""NONE"" | ""TERRAIN"") to inputOutput MFString field named objectType.
      Parameters:
      newValue - is new value for the objectType field.
      Returns:
      X3DLayerNode - 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.
      Specified by:
      getPickable in interface X3DPickableObject
      Returns:
      value of pickable field

    • setPickable

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

    • getViewport

      X3DViewportNode getViewport()
      Provide org.web3d.x3d.sai.Layering.X3DViewportNode instance (using a properly typed node) from inputOutput SFNode field viewport.
      Returns:
      value of viewport field

    • setViewport

      X3DLayerNode setViewport​(X3DViewportNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Layering.X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.
      Parameters:
      newValue - is new value for the viewport field.
      Returns:
      X3DLayerNode - 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.
      Returns:
      value of visible field

    • setVisible

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