Package org.web3d.x3d.sai.Layout

Interface LayoutGroup

All Superinterfaces:
X3DBoundedObject, X3DChildNode, X3DGroupingNode, X3DNode
All Known Implementing Classes:
LayoutGroupObject
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.

X3D node tooltip: (X3D version 3.2 or later) [X3DGroupingNode] 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:
SAI Java Specification: TODO, X3D Abstract Specification: LayoutGroup, X3D Tooltips: LayoutGroup, X3D Scene Authoring Hints

  • 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.
    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 X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.
    boolean getDisplayBBox()
    Provide boolean value from inputOutput SFBool field named displayBBox.
    X3DLayoutNode getLayout()
    Provide X3DLayoutNode instance (using a properly typed node) from inputOutput SFNode field layout.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    X3DViewportNode getViewport()
    Provide 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 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 X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
    LayoutGroup setDisplayBBox​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named displayBBox.
    LayoutGroup setLayout​(X3DLayoutNode newValue)
    Accessor method to assign X3DLayoutNode instance (using a properly typed node) to inputOutput SFNode field layout.
    LayoutGroup setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    LayoutGroup setViewport​(X3DViewportNode newValue)
    Accessor method to assign 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.