All Superinterfaces:: X3DNode

All Known Implementing Classes:: LayerSet

public interface LayerSet extends X3DNode

LayerSet defines a list of layers and a rendering order.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. LayerSet 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.

Hint: the layer first specified in the order field is the first layer rendered and appears below any other layers. The layer last specified in the order field is the last layer rendered and correspondingly appears on top of all other layers.
Warning: only one LayerSet node is allowed in a scene, and it shall be a root node at the top of the scene graph.
Hint: X3D Architecture 35.2.1 Overview of layering https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/layering.html#OverviewOfLayering

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

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 org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field layers.

X3DMetadataObject

getMetadata()

Provide org.web3d.x3d.sai.Core.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 inputOutput 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 org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field layers.

LayerSet

setMetadata(X3DMetadataObject newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

LayerSet

setOrder(int[] newValue)

Accessor method to assign int array to inputOutput 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 org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) 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 org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) 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 org.web3d.x3d.sai.Core.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.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#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 org.web3d.x3d.sai.Core.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.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#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 inputOutput 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 inputOutput 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).

Interface LayerSet

Method Summary

Method Details

getActiveLayer

setActiveLayer

getLayers

setLayers

addLayers

setLayers

getMetadata

setMetadata

getOrder

setOrder