All Superinterfaces:: X3DLayerNode, X3DNode, X3DPickableObject

All Known Implementing Classes:: LayoutLayer

public interface LayoutLayer extends X3DLayerNode

LayoutLayer is a Grouping node that can contain most nodes.

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. LayoutLayer node tooltip: (X3D version 3.2 or later) [X3DLayerNode] LayoutLayer is a Grouping node that can contain most nodes. LayoutLayer content is clipped by the specified viewport node.

Hint: insert a Shape node before adding geometry or Appearance.
Warning: better functional description needed in X3D specification.

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

addChildren(X3DNode[] newValue)

Add array of children nodes to array of existing nodes (if any).

X3DNode[]

getChildren()

Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.

X3DLayoutNode

getLayout()

Provide org.web3d.x3d.sai.Layout.X3DLayoutNode instance (using a properly typed node) from inputOutput SFNode field layout.

X3DMetadataObject

getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

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.

void

setChildren(X3DNode newValue)

Set single children node, replacing prior array of existing nodes (if any).

LayoutLayer

setChildren(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 children.

LayoutLayer

setLayout(X3DLayoutNode newValue)

Accessor method to assign org.web3d.x3d.sai.Layout.X3DLayoutNode instance (using a properly typed node) to inputOutput SFNode field layout.

LayoutLayer

setMetadata(X3DMetadataObject newValue)

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

LayoutLayer

setObjectType(String[] newValue)

Accessor method to assign String enumeration array (""ALL"" | ""NONE"" | ""TERRAIN"") to inputOutput MFString field named objectType.

LayoutLayer

setPickable(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named pickable.

LayoutLayer

setViewport(X3DViewportNode newValue)

Accessor method to assign org.web3d.x3d.sai.Layering.X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.

LayoutLayer

setVisible(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named visible.

Method Details
- getChildren
  X3DNode[] getChildren()
  
  Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.
  
  Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.
  
  Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.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
  LayoutLayer setChildren(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 children.
  
  Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.
  
  Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.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:
  
  LayoutLayer - 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
- getLayout
  
  X3DLayoutNode getLayout()
  
  Provide org.web3d.x3d.sai.Layout.X3DLayoutNode instance (using a properly typed node) from inputOutput SFNode field layout.
  
  Tooltip: [X3DLayoutNode] The layout field contains an X3DLayoutNode node that provides the information required to locate and size the layout region of the LayoutGroup node relative to its parentâ€™s layout region, and also to scale the contents of the LayoutGroup. *
  
  Returns:
  
  value of layout field
- setLayout
  
  LayoutLayer setLayout(X3DLayoutNode newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Layout.X3DLayoutNode instance (using a properly typed node) to inputOutput SFNode field layout.
  
  Tooltip: [X3DLayoutNode] The layout field contains an X3DLayoutNode node that provides the information required to locate and size the layout region of the LayoutGroup node relative to its parentâ€™s layout region, and also to scale the contents of the LayoutGroup. *
  
  Parameters:
  
  newValue - is new value for the layout field.
  
  Returns:
  
  LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- 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 X3DLayerNode
  
  Specified by:
  
  getMetadata in interface X3DNode
  
  Returns:
  
  value of metadata field
  
  See Also:
  
  X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  LayoutLayer 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 X3DLayerNode
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  LayoutLayer - 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
  String[] getObjectType()
  
  Provide array of String enumeration results with quoted value(s) ["ALL","NONE","TERRAIN",...] from inputOutput MFString field named objectType.
  
  Tooltip: The objectType field specifies a set of labels used in the picking process. Each string specified is treated as an independent label that needs to be matched against the same type in one of the pick sensor instances. Example: labeling a PickableGroup with the objectType value "WATER" and then attempting to intersect a pick sensor with objectType value "GROUND" fails since the objectType values do not match. Example: the special value "ALL" means that each node is available for picking regardless of the type specified by the pick sensor. Example: the special value "NONE" effectively disables all picking for this node and is the equivalent of setting the pickable field to false.
  
  Hint: authors may define any value for objectType.
  
  Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
  
  Specified by:
  
  getObjectType in interface X3DLayerNode
  
  Returns:
  
  value of objectType field
- setObjectType
  LayoutLayer setObjectType(String[] newValue)
  
  Accessor method to assign String enumeration array (""ALL"" | ""NONE"" | ""TERRAIN"") to inputOutput MFString field named objectType.
  
  Tooltip: The objectType field specifies a set of labels used in the picking process. Each string specified is treated as an independent label that needs to be matched against the same type in one of the pick sensor instances. Example: labeling a PickableGroup with the objectType value "WATER" and then attempting to intersect a pick sensor with objectType value "GROUND" fails since the objectType values do not match. Example: the special value "ALL" means that each node is available for picking regardless of the type specified by the pick sensor. Example: the special value "NONE" effectively disables all picking for this node and is the equivalent of setting the pickable field to false.
  
  Hint: authors may define any value for objectType.
  
  Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
  
  Specified by:
  
  setObjectType in interface X3DLayerNode
  
  Parameters:
  
  newValue - is new value for the objectType field.
  
  Returns:
  
  LayoutLayer - 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
  
  LayoutLayer 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:
  
  LayoutLayer - 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.
  
  Tooltip: [X3DViewportNode] The content of the LayoutGroup is clipped by the specified viewport. *
  
  Specified by:
  
  getViewport in interface X3DLayerNode
  
  Returns:
  
  value of viewport field
- setViewport
  
  LayoutLayer setViewport(X3DViewportNode newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Layering.X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.
  
  Tooltip: [X3DViewportNode] The content of the LayoutGroup is clipped by the specified viewport. *
  
  Specified by:
  
  setViewport in interface X3DLayerNode
  
  Parameters:
  
  newValue - is new value for the viewport field.
  
  Returns:
  
  LayoutLayer - 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.
  
  Tooltip: Whether or not renderable content within this node is visually displayed.
  
  Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
  
  Hint: content must be visible to be collidable and to be pickable.
  
  Specified by:
  
  getVisible in interface X3DLayerNode
  
  Returns:
  
  value of visible field
- setVisible
  LayoutLayer setVisible(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named visible.
  
  Tooltip: Whether or not renderable content within this node is visually displayed.
  
  Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
  
  Hint: content must be visible to be collidable and to be pickable.
  
  Specified by:
  
  setVisible in interface X3DLayerNode
  
  Parameters:
  
  newValue - is new value for the visible field.
  
  Returns:
  
  LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface LayoutLayer

Method Summary

Method Details

getChildren

setChildren

addChildren

setChildren

getLayout

setLayout

getMetadata

setMetadata

getObjectType

setObjectType

getPickable

setPickable

getViewport

setViewport

getVisible

setVisible