Class LayoutLayer

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Layout.LayoutLayer
All Implemented Interfaces:
X3DNode, X3DLayerNode, LayoutLayer, X3DPickableObject
public class LayoutLayer extends X3DConcreteNode implements LayoutLayer
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 org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:

  • Field Details

    • OBJECTTYPE_ALL

      public static final String OBJECTTYPE_ALL
      Tooltip: each node is available for picking. MFString field named objectType with X3DUOM simpleType pickableObjectTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ALL" (Java syntax) or '"ALL"' (XML syntax).
      See Also:

    • OBJECTTYPE_NONE

      public static final String OBJECTTYPE_NONE
      Tooltip: no node is available for picking. MFString field named objectType with X3DUOM simpleType pickableObjectTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "NONE" (Java syntax) or '"NONE"' (XML syntax).
      See Also:

    • OBJECTTYPE_TERRAIN

      public static final String OBJECTTYPE_TERRAIN
      Tooltip: TERRAIN is an example value. MFString field named objectType with X3DUOM simpleType pickableObjectTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "TERRAIN" (Java syntax) or '"TERRAIN"' (XML syntax).
      See Also:

    • NAME

      public static final String NAME
      String constant NAME provides name of this element: LayoutLayer.
      See Also:

    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the LayoutLayer element: Layout
      See Also:

    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D Layout component level for this element: 1
      See Also:

    • IS_DEFAULT_VALUE

      public static final IS IS_DEFAULT_VALUE
      SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

    • LAYOUT_DEFAULT_VALUE

      public static final X3DLayoutNode LAYOUT_DEFAULT_VALUE
      SFNode field named layout has default value null (Java syntax) or NULL (XML syntax).

    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject METADATA_DEFAULT_VALUE
      SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

    • OBJECTTYPE_DEFAULT_VALUE

      public static final ArrayList<String> OBJECTTYPE_DEFAULT_VALUE
      MFString field named objectType has default quoted value new String[] {"ALL"} (Java syntax) or quoted value "ALL" (XML syntax).

    • PICKABLE_DEFAULT_VALUE

      public static final boolean PICKABLE_DEFAULT_VALUE
      SFBool field named pickable has default value true (Java syntax) or true (XML syntax).
      See Also:

    • VIEWPORT_DEFAULT_VALUE

      public static final X3DViewportNode VIEWPORT_DEFAULT_VALUE
      SFNode field named viewport has default value null (Java syntax) or NULL (XML syntax).

    • VISIBLE_DEFAULT_VALUE

      public static final boolean VISIBLE_DEFAULT_VALUE
      SFBool field named visible has default value true (Java syntax) or true (XML syntax).
      See Also:

    • containerField_DEFAULT_VALUE

      public static final String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
      containerField_DEFAULT_VALUE = "layers";
      containerField_ALLOWED_VALUES = {"layers" }; type xs:NMTOKEN
      See Also:

    • toField_ADDCHILDREN

      public static final String toField_ADDCHILDREN
      toField ROUTE name for MFNode field named addChildren.
      See Also:

    • fromField_CHILDREN

      public static final String fromField_CHILDREN
      fromField ROUTE name for MFNode field named children.
      See Also:

    • toField_CHILDREN

      public static final String toField_CHILDREN
      toField ROUTE name for MFNode field named children.
      See Also:

    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:

    • fromField_LAYOUT

      public static final String fromField_LAYOUT
      fromField ROUTE name for SFNode field named layout.
      See Also:

    • toField_LAYOUT

      public static final String toField_LAYOUT
      toField ROUTE name for SFNode field named layout.
      See Also:

    • fromField_METADATA

      public static final String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:

    • toField_METADATA

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:

    • fromField_OBJECTTYPE

      public static final String fromField_OBJECTTYPE
      fromField ROUTE name for MFString field named objectType.
      See Also:

    • toField_OBJECTTYPE

      public static final String toField_OBJECTTYPE
      toField ROUTE name for MFString field named objectType.
      See Also:

    • fromField_PICKABLE

      public static final String fromField_PICKABLE
      fromField ROUTE name for SFBool field named pickable.
      See Also:

    • toField_PICKABLE

      public static final String toField_PICKABLE
      toField ROUTE name for SFBool field named pickable.
      See Also:

    • toField_REMOVECHILDREN

      public static final String toField_REMOVECHILDREN
      toField ROUTE name for MFNode field named removeChildren.
      See Also:

    • fromField_VIEWPORT

      public static final String fromField_VIEWPORT
      fromField ROUTE name for SFNode field named viewport.
      See Also:

    • toField_VIEWPORT

      public static final String toField_VIEWPORT
      toField ROUTE name for SFNode field named viewport.
      See Also:

    • fromField_VISIBLE

      public static final String fromField_VISIBLE
      fromField ROUTE name for SFBool field named visible.
      See Also:

    • toField_VISIBLE

      public static final String toField_VISIBLE
      toField ROUTE name for SFBool field named visible.
      See Also:

  • Constructor Details

    • LayoutLayer

      public LayoutLayer()
      Constructor for LayoutLayer to initialize member variables with default values.

    • LayoutLayer

      public LayoutLayer(String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node

  • Method Details

    • getElementName

      public final String getElementName()
      Provides name of this element: LayoutLayer
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element

    • getComponent

      public final String getComponent()
      Defines X3D component for the LayoutLayer element: Layout
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element

    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 1
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element

    • getFieldType

      public String getFieldType(String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:

    • getAccessType

      public String getAccessType(String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:

    • getContainerFieldDefault

      public final String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:

    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode

    • getChildren

      public X3DNode[] getChildren()
      Provide array of org.web3d.x3d.sai.Core.X3DChildNode 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.
      Specified by:
      getChildren in interface LayoutLayer
      Returns:
      value of children field
      See Also:

    • getChildrenList

      public ArrayList<X3DNode> getChildrenList()
      Utility method to get ArrayList value of MFNode children field, similar to getChildren().
      Returns:
      value of children field

    • setChildren

      public LayoutLayer setChildren(X3DNode[] newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DChildNode 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.
      Specified by:
      setChildren in interface LayoutLayer
      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).

    • setChildren

      public LayoutLayer setChildren(ArrayList<X3DChildNode> newValue)
      Assign ArrayList value of MFNode children field, similar to setChildren(org.web3d.x3d.sai.Core.X3DNode[]).
      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

      public void addChildren(X3DNode newValue)
      Add single node to existing array of children nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode and ProtoInstance.
      Parameters:
      newValue - is new value to be appended the children field.

    • addChildren

      public LayoutLayer addChildren(ProtoInstance newValue)
      Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for children field.

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.
      Parameters:
      newValue - is new value to be appended the parts field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addChild

      public LayoutLayer addChild(X3DChildNode newValue)
      Utility method to add single child element to contained list of existing children nodes (if any).
      Parameters:
      newValue - is new node value to be appended the children field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addChildren

      public 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.
      Specified by:
      addChildren in interface LayoutLayer
      Parameters:
      newValue - is new value array to be appended the children field.

    • setChildren

      public void setChildren(X3DNode newValue)
      Set single children node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DChildNode.
      Specified by:
      setChildren in interface LayoutLayer
      Parameters:
      newValue - is new node for the children field (restricted to X3DChildNode)

    • clearChildren

      public LayoutLayer clearChildren()
      Utility method to clear MFNode value of children field. This method does not initialize withCHILDREN_DEFAULT_VALUE.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasChildren

      public boolean hasChildren()
      Indicate whether an object is available for inputOutput MFNode field children.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:

    • addComments

      public LayoutLayer addComments(String newComment)
      Add comment as CommentsBlock to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addComments

      public LayoutLayer addComments(String[] newComments)
      Add comments as String[] array to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addComments

      public LayoutLayer addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getIS

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:

    • setIS

      public LayoutLayer setIS(IS newValue)
      Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearIS

      public LayoutLayer clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:

    • getLayout

      public X3DLayoutNode getLayout()
      Provide org.web3d.x3d.sai.Layout.X3DLayoutNode instance (using a properly typed node) from inputOutput SFNode field layout.
      Specified by:
      getLayout in interface LayoutLayer
      Returns:
      value of layout field
      See Also:


      • 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. *

    • setLayout

      public 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.
      Specified by:
      setLayout in interface LayoutLayer
      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).
      See Also:

    • clearLayout

      public LayoutLayer clearLayout()
      Utility method to clear SFNode value of layout field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setLayout

      public LayoutLayer setLayout(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field layout.
      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).
      See Also:

    • hasLayout

      public boolean hasLayout()
      Indicate whether an object is available for inputOutput SFNode field layout.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:

    • getMetadata

      public 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 LayoutLayer
      Specified by:
      getMetadata in interface X3DLayerNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      public 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.
      Specified by:
      setMetadata in interface LayoutLayer
      Specified by:
      setMetadata in interface X3DLayerNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      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:

    • clearMetadata

      public LayoutLayer clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setMetadata

      public LayoutLayer setMetadata(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      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:

    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:

    • getObjectType

      public 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".


      Available enumeration values for string comparison: ALL, NONE, TERRAIN.
      Specified by:
      getObjectType in interface LayoutLayer
      Specified by:
      getObjectType in interface X3DLayerNode
      Returns:
      value of objectType field

    • getObjectTypeList

      public ArrayList<String> getObjectTypeList()
      Utility method to get ArrayList value of MFString objectType field, similar to getObjectType().
      Returns:
      value of objectType field

    • getObjectTypeString

      public String getObjectTypeString()
      Utility method to get String value of MFString objectType field, similar to getObjectType().
      Returns:
      value of objectType field

    • setObjectType

      public LayoutLayer setObjectType(String[] newValue)
      Accessor method to assign String enumeration array (""ALL"" | ""NONE"" | ""TERRAIN"") to inputOutput MFString field named objectType.

      Hint: authors have option to choose from an extendible list of predefined enumeration values (ALL, NONE, TERRAIN).

      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 LayoutLayer
      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).

    • setObjectType

      public LayoutLayer setObjectType(MFString newValue)
      Assign typed object value to MFString objectType field, similar to setObjectType(String[]).
      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).

    • setObjectType

      public LayoutLayer setObjectType(SFString newValue)
      Assign single SFString object value to MFString objectType field, similar to setObjectType(String[]).
      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).
      See Also:

    • setObjectType

      public LayoutLayer setObjectType(String newValue)
      Assign singleton String value to MFString objectType field, similar to setObjectType(String[]).
      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).
      See Also:

    • setObjectType

      public LayoutLayer setObjectType(ArrayList<String> newValue)
      Assign ArrayList value of MFString objectType field, similar to setObjectType(String[]).
      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).

    • clearObjectType

      public LayoutLayer clearObjectType()
      Utility method to clear MFString value of objectType field. This method does not initialize withOBJECTTYPE_DEFAULT_VALUE.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addObjectType

      public LayoutLayer addObjectType(String newValue)
      Add singleton String value to MFString objectType field.
      Parameters:
      newValue - is new value to add to the objectType field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addObjectType

      public LayoutLayer addObjectType(SFString newValue)
      Add singleton SFString value to MFString objectType field.
      Parameters:
      newValue - is new value to add to the objectType field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getPickable

      public 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 LayoutLayer
      Specified by:
      getPickable in interface X3DLayerNode
      Specified by:
      getPickable in interface X3DPickableObject
      Returns:
      value of pickable field

    • setPickable

      public 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 LayoutLayer
      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).

    • setPickable

      public LayoutLayer setPickable(SFBool newValue)
      Assign typed object value to SFBool pickable field, similar to setPickable(boolean).
      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

      public X3DViewportNode getViewport()
      Provide org.web3d.x3d.sai.Layering.X3DViewportNode instance (using a properly typed node) from inputOutput SFNode field viewport.
      Specified by:
      getViewport in interface LayoutLayer
      Specified by:
      getViewport in interface X3DLayerNode
      Returns:
      value of viewport field
      See Also:


      • Tooltip: [X3DViewportNode] The content of the LayoutGroup is clipped by the specified viewport. *

    • setViewport

      public 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.
      Specified by:
      setViewport in interface LayoutLayer
      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).
      See Also:

    • clearViewport

      public LayoutLayer clearViewport()
      Utility method to clear SFNode value of viewport field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setViewport

      public LayoutLayer setViewport(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field viewport.
      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).
      See Also:

    • hasViewport

      public boolean hasViewport()
      Indicate whether an object is available for inputOutput SFNode field viewport.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:

    • getVisible

      public 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 LayoutLayer
      Specified by:
      getVisible in interface X3DLayerNode
      Returns:
      value of visible field

    • setVisible

      public 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 LayoutLayer
      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).

    • setVisible

      public LayoutLayer setVisible(SFBool newValue)
      Assign typed object value to SFBool visible field, similar to setVisible(boolean).
      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).

    • getDEF

      public String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:

    • setDEF

      public final LayoutLayer setDEF(String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDEF

      public LayoutLayer setDEF(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getUSE

      public String getUSE()
      Provide String value from inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:

    • setUSE

      public final LayoutLayer setUSE(String newValue)
      Accessor method to assign String value to inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.


      Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

      Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Specified by:
      setUSE in class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public LayoutLayer setUSE(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCssClass

      public String getCssClass()
      Provide String value from inputOutput SFString field named class.
      Overrides:
      getCssClass in class X3DConcreteElement
      Returns:
      value of class field
      See Also:

    • setCssClass

      public final LayoutLayer setCssClass(String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setCssClass

      public LayoutLayer setCssClass(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getHtmlID

      public String getHtmlID()
      Provide String value from inputOutput SFString field named id.
      Overrides:
      getHtmlID in class X3DConcreteElement
      Returns:
      value of id field
      See Also:

    • setHtmlID

      public final LayoutLayer setHtmlID(String newValue)
      Accessor method to assign String value to inputOutput SFString field named id.
      Specified by:
      setHtmlID in class X3DConcreteNode
      Parameters:
      newValue - is new value for the id field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setHtmlID

      public LayoutLayer setHtmlID(SFString newValue)
      Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
      Parameters:
      newValue - is new value for the id field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCssStyle

      public String getCssStyle()
      Provide String value from inputOutput SFString field named style.
      Overrides:
      getCssStyle in class X3DConcreteElement
      Returns:
      value of style field
      See Also:

    • setCssStyle

      public final LayoutLayer setCssStyle(String newValue)
      Accessor method to assign String value to inputOutput SFString field named style.
      Specified by:
      setCssStyle in class X3DConcreteNode
      Parameters:
      newValue - is new value for the style field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setCssStyle

      public LayoutLayer setCssStyle(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
      Parameters:
      newValue - is new value for the style field.
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public LayoutLayer setUSE(LayoutLayer DEFnode)
      Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

      Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Parameters:
      DEFnode - must have a DEF value defined
      Returns:
      LayoutLayer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • toStringX3D

      public String toStringX3D(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:

    • toStringClassicVRML

      public String toStringClassicVRML(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:

    • toStringVRML97

      public String toStringVRML97(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue, String elementName)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:

    • hasElementByNameValue

      public boolean hasElementByNameValue(String nameValue, String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:

    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF(String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:

    • hasNodeByDEF

      public boolean hasNodeByDEF(String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:

    • validate

      public String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)