Interface LayoutGroup

All Superinterfaces:
X3DBoundedObject, X3DChildNode, X3DGroupingNode, X3DNode
All Known Implementing Classes:
LayoutGroup
public interface LayoutGroup extends X3DNode, X3DGroupingNode
LayoutGroup is a Grouping node that can contain most nodes, whose children are related by a common layout within a parent layout.

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. LayoutGroup node tooltip: (X3D version 3.2 or later) [X3DGroupingNode,X3DVisibleObject] LayoutGroup is a Grouping node that can contain most nodes, whose children are related by a common layout within a parent layout. 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. LayoutGroup content is clipped by the specified viewport node.
  • Hint: The origin of the node is always in the center of its layout region. Thus, children (with the exception of LayoutGroup) are specified in a coordinate system whose origin is located at the center of the rectangle and can be transformed from that location.
  • Warning: a LayoutGroup can only be a child of a LayoutLayer node or another LayoutGroup node.
  • Hint: insert a Shape node before adding geometry or Appearance.
  • Hint: LayoutGroup does not directly have any pixel-dependent concepts. However, it can contain a Layout node that does have pixel-specific options.

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).
    float[]
    getBboxCenter()
    Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
    boolean
    getBboxDisplay()
    Provide boolean value from inputOutput SFBool field named bboxDisplay.
    float[]
    getBboxSize()
    Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
    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.
    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.
    LayoutGroup
    setBboxCenter(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
    LayoutGroup
    setBboxDisplay(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
    LayoutGroup
    setBboxSize(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
    void
    setChildren(X3DNode newValue)
    Set single children node, replacing prior array of existing nodes (if any).
    LayoutGroup
    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.
    LayoutGroup
    setLayout(X3DLayoutNode newValue)
    Accessor method to assign org.web3d.x3d.sai.Layout.X3DLayoutNode instance (using a properly typed node) to inputOutput SFNode field layout.
    LayoutGroup
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    LayoutGroup
    setViewport(X3DViewportNode newValue)
    Accessor method to assign org.web3d.x3d.sai.Layering.X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.
    LayoutGroup
    setVisible(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named visible.

  • Method Details

    • getBboxCenter

      float[] getBboxCenter()
      Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.

      Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.
      Specified by:
      getBboxCenter in interface X3DBoundedObject
      Specified by:
      getBboxCenter in interface X3DGroupingNode
      Returns:
      value of bboxCenter field

    • setBboxCenter

      LayoutGroup setBboxCenter(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

      Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.
      Specified by:
      setBboxCenter in interface X3DBoundedObject
      Specified by:
      setBboxCenter in interface X3DGroupingNode
      Parameters:
      newValue - is new value for the bboxCenter field.
      Returns:
      LayoutGroup - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getBboxDisplay

      boolean getBboxDisplay()
      Provide boolean value from inputOutput SFBool field named bboxDisplay.

      Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.
      • Hint: the bounding box is displayed regardless of whether contained content is visible.
      Specified by:
      getBboxDisplay in interface X3DBoundedObject
      Specified by:
      getBboxDisplay in interface X3DGroupingNode
      Returns:
      value of bboxDisplay field

    • setBboxDisplay

      LayoutGroup setBboxDisplay(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.

      Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.
      • Hint: the bounding box is displayed regardless of whether contained content is visible.
      Specified by:
      setBboxDisplay in interface X3DBoundedObject
      Specified by:
      setBboxDisplay in interface X3DGroupingNode
      Parameters:
      newValue - is new value for the bboxDisplay field.
      Returns:
      LayoutGroup - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getBboxSize

      float[] getBboxSize()
      Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.

      Tooltip: or [0,+infinity) Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
      Specified by:
      getBboxSize in interface X3DBoundedObject
      Specified by:
      getBboxSize in interface X3DGroupingNode
      Returns:
      value of bboxSize field

    • setBboxSize

      LayoutGroup setBboxSize(float[] newValue)
      Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.

      Tooltip: or [0,+infinity) Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
      Specified by:
      setBboxSize in interface X3DBoundedObject
      Specified by:
      setBboxSize in interface X3DGroupingNode
      Parameters:
      newValue - is new value for the bboxSize field.
      Returns:
      LayoutGroup - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • 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.
      Specified by:
      getChildren in interface X3DGroupingNode
      Returns:
      value of children field
      See Also:

    • setChildren

      LayoutGroup 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.
      Specified by:
      setChildren in interface X3DGroupingNode
      Parameters:
      newValue - is new value for the children field.
      Returns:
      LayoutGroup - 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.
      Specified by:
      addChildren in interface X3DGroupingNode
      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).
      Specified by:
      setChildren in interface X3DGroupingNode
      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

      LayoutGroup 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:
      LayoutGroup - 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.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DGroupingNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      LayoutGroup 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.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DGroupingNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      LayoutGroup - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • 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. *
      Returns:
      value of viewport field

    • setViewport

      LayoutGroup 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. *
      Parameters:
      newValue - is new value for the viewport field.
      Returns:
      LayoutGroup - 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 X3DBoundedObject
      Specified by:
      getVisible in interface X3DGroupingNode
      Returns:
      value of visible field

    • setVisible

      LayoutGroup 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 X3DBoundedObject
      Specified by:
      setVisible in interface X3DGroupingNode
      Parameters:
      newValue - is new value for the visible field.
      Returns:
      LayoutGroup - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).