Interface Layout

All Superinterfaces:
X3DChildNode, X3DLayoutNode, X3DNode
All Known Implementing Classes:
LayoutObject

public interface Layout
extends X3DLayoutNode
Layout node is used as layout field of LayoutLayer and LayoutGroup nodes.

X3D node tooltip: (X3D version 3.2 or later) [X3DLayoutNode] Layout node is used as layout field of LayoutLayer and LayoutGroup nodes. Layout provides all parameters required to define the size, location and scale of a 2D rectangular region.
  • Hint: the align, offset, and offsetUnits fields are used to determine the location of the layout region.

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: Layout, X3D Tooltips: Layout, X3D Scene Authoring Hints
  • Method Summary

    Modifier and Type Method Description
    java.lang.String[] getAlign()
    Provide array of String enumeration results ( baseType layoutAlignChoices) [""LEFT" "BOTTOM"" | ""LEFT" "CENTER"" | ""LEFT" "TOP"" | ""CENTER" "BOTTOM"" | ""CENTER" "CENTER"" | ""CENTER" "TOP"" | ""RIGHT" "BOTTOM"" | ""RIGHT" "CENTER"" | ""RIGHT" "TOP""] from inputOutput MFString field named align.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float[] getOffset()
    Provide array of float results from inputOutput MFFloat field named offset.
    java.lang.String[] getOffsetUnits()
    Provide array of String enumeration results ( baseType layoutUnitsChoices) [""WORLD" "WORLD"" | ""WORLD" "FRACTION"" | ""WORLD" "PIXEL"" | ""FRACTION" "WORLD"" | ""FRACTION" "FRACTION"" | ""FRACTION" "PIXEL"" | ""PIXEL" "WORLD"" | ""PIXEL" "FRACTION"" | ""PIXEL" "PIXEL""] from inputOutput MFString field named offsetUnits.
    java.lang.String[] getScaleMode()
    Provide array of String enumeration results ( baseType layoutScaleModeChoices) [""NONE" "NONE"" | ""NONE" "FRACTION"" | ""NONE" "STRETCH"" | ""NONE" "PIXEL"" | ""FRACTION" "NONE"" | ""FRACTION" "FRACTION"" | ""FRACTION" "STRETCH"" | ""FRACTION" "PIXEL"" | ""STRETCH" "NONE"" | ""STRETCH" "FRACTION"" | ""STRETCH" "STRETCH"" | ""STRETCH" "PIXEL"" | ""PIXEL" "NONE"" | ""PIXEL" "FRACTION"" | ""PIXEL" "STRETCH"" | ""PIXEL" "PIXEL""] from inputOutput MFString field named scaleMode.
    float[] getSize()
    Provide array of float results from initializeOnly MFFloat field named size.
    java.lang.String[] getSizeUnits()
    Provide array of String enumeration results ( baseType layoutUnitsChoices) [""WORLD" "WORLD"" | ""WORLD" "FRACTION"" | ""WORLD" "PIXEL"" | ""FRACTION" "WORLD"" | ""FRACTION" "FRACTION"" | ""FRACTION" "PIXEL"" | ""PIXEL" "WORLD"" | ""PIXEL" "FRACTION"" | ""PIXEL" "PIXEL""] from inputOutput MFString field named sizeUnits.
    Layout setAlign​(java.lang.String[] newValue)
    Accessor method to assign String enumeration array (""LEFT" "BOTTOM"" | ""LEFT" "CENTER"" | ""LEFT" "TOP"" | ""CENTER" "BOTTOM"" | ""CENTER" "CENTER"" | ""CENTER" "TOP"" | ""RIGHT" "BOTTOM"" | ""RIGHT" "CENTER"" | ""RIGHT" "TOP"") to inputOutput MFString field named align.
    Layout setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    Layout setOffset​(float[] newValue)
    Accessor method to assign float array to inputOutput MFFloat field named offset.
    Layout setOffsetUnits​(java.lang.String[] newValue)
    Accessor method to assign String enumeration array (""WORLD" "WORLD"" | ""WORLD" "FRACTION"" | ""WORLD" "PIXEL"" | ""FRACTION" "WORLD"" | ""FRACTION" "FRACTION"" | ""FRACTION" "PIXEL"" | ""PIXEL" "WORLD"" | ""PIXEL" "FRACTION"" | ""PIXEL" "PIXEL"") to inputOutput MFString field named offsetUnits.
    Layout setScaleMode​(java.lang.String[] newValue)
    Accessor method to assign String enumeration array (""NONE" "NONE"" | ""NONE" "FRACTION"" | ""NONE" "STRETCH"" | ""NONE" "PIXEL"" | ""FRACTION" "NONE"" | ""FRACTION" "FRACTION"" | ""FRACTION" "STRETCH"" | ""FRACTION" "PIXEL"" | ""STRETCH" "NONE"" | ""STRETCH" "FRACTION"" | ""STRETCH" "STRETCH"" | ""STRETCH" "PIXEL"" | ""PIXEL" "NONE"" | ""PIXEL" "FRACTION"" | ""PIXEL" "STRETCH"" | ""PIXEL" "PIXEL"") to inputOutput MFString field named scaleMode.
    Layout setSize​(float[] newValue)
    Accessor method to assign float array to initializeOnly MFFloat field named size.
    Layout setSizeUnits​(java.lang.String[] newValue)
    Accessor method to assign String enumeration array (""WORLD" "WORLD"" | ""WORLD" "FRACTION"" | ""WORLD" "PIXEL"" | ""FRACTION" "WORLD"" | ""FRACTION" "FRACTION"" | ""FRACTION" "PIXEL"" | ""PIXEL" "WORLD"" | ""PIXEL" "FRACTION"" | ""PIXEL" "PIXEL"") to inputOutput MFString field named sizeUnits.
  • Method Details

    • getAlign

      java.lang.String[] getAlign()
      Provide array of String enumeration results ( baseType layoutAlignChoices) [""LEFT" "BOTTOM"" | ""LEFT" "CENTER"" | ""LEFT" "TOP"" | ""CENTER" "BOTTOM"" | ""CENTER" "CENTER"" | ""CENTER" "TOP"" | ""RIGHT" "BOTTOM"" | ""RIGHT" "CENTER"" | ""RIGHT" "TOP""] from inputOutput MFString field named align.

      Tooltip: The align field values align the sized rectangle to an edge or center of the parent rectangle. Two quoted string values are provided. The first value is for horizontal direction (LEFT | CENTER | RIGHT) and the second value is for vertical direction (BOTTOM | CENTER | TOP). Examples: "CENTER" "CENTER" (default value), "LEFT" "TOP" or "RIGHT" "BOTTOM".
      • Warning: two values (or possibly one value) only.
      • Warning: if the align field has only one value, that value shall be "CENTER" and apply both horizontally and vertically.
      • Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
      Returns:
      value of align field
    • setAlign

      Layout setAlign​(java.lang.String[] newValue)
      Accessor method to assign String enumeration array (""LEFT" "BOTTOM"" | ""LEFT" "CENTER"" | ""LEFT" "TOP"" | ""CENTER" "BOTTOM"" | ""CENTER" "CENTER"" | ""CENTER" "TOP"" | ""RIGHT" "BOTTOM"" | ""RIGHT" "CENTER"" | ""RIGHT" "TOP"") to inputOutput MFString field named align.

      Tooltip: The align field values align the sized rectangle to an edge or center of the parent rectangle. Two quoted string values are provided. The first value is for horizontal direction (LEFT | CENTER | RIGHT) and the second value is for vertical direction (BOTTOM | CENTER | TOP). Examples: "CENTER" "CENTER" (default value), "LEFT" "TOP" or "RIGHT" "BOTTOM".
      • Warning: two values (or possibly one value) only.
      • Warning: if the align field has only one value, that value shall be "CENTER" and apply both horizontally and vertically.
      • Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
      Parameters:
      newValue - is new value for the align field.
      Returns:
      Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMetadata

      X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DLayoutNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      Layout setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DLayoutNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      Layout - 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
    • getOffset

      float[] getOffset()
      Provide array of float results from inputOutput MFFloat field named offset.

      Tooltip: (-infinity,+infinity) The values of the offset field are used to translate the location of this rectangle after the initial alignment. The offsetUnits field specifies how to interpret the offset field.
      • Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
      Returns:
      value of offset field
    • setOffset

      Layout setOffset​(float[] newValue)
      Accessor method to assign float array to inputOutput MFFloat field named offset.

      Tooltip: (-infinity,+infinity) The values of the offset field are used to translate the location of this rectangle after the initial alignment. The offsetUnits field specifies how to interpret the offset field.
      • Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
      Parameters:
      newValue - is new value for the offset field.
      Returns:
      Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getOffsetUnits

      java.lang.String[] getOffsetUnits()
      Provide array of String enumeration results ( baseType layoutUnitsChoices) [""WORLD" "WORLD"" | ""WORLD" "FRACTION"" | ""WORLD" "PIXEL"" | ""FRACTION" "WORLD"" | ""FRACTION" "FRACTION"" | ""FRACTION" "PIXEL"" | ""PIXEL" "WORLD"" | ""PIXEL" "FRACTION"" | ""PIXEL" "PIXEL""] from inputOutput MFString field named offsetUnits.

      Tooltip: The offsetUnits field values are used to interprete the offset values. Two quoted string values are provided. The first value is for horizontal offset, and the second value is for vertical offset. Examples: "WORLD" "WORLD" (default value), "FRACTION" "FRACTION" or "PIXEL" "PIXEL".
      • Hint: If the value of the offsetUnits field is FRACTION, the size of the corresponding dimension is interpreted as a fraction of the corresponding parent’s dimension.
      • Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
      • Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
      Returns:
      value of offsetUnits field
    • setOffsetUnits

      Layout setOffsetUnits​(java.lang.String[] newValue)
      Accessor method to assign String enumeration array (""WORLD" "WORLD"" | ""WORLD" "FRACTION"" | ""WORLD" "PIXEL"" | ""FRACTION" "WORLD"" | ""FRACTION" "FRACTION"" | ""FRACTION" "PIXEL"" | ""PIXEL" "WORLD"" | ""PIXEL" "FRACTION"" | ""PIXEL" "PIXEL"") to inputOutput MFString field named offsetUnits.

      Tooltip: The offsetUnits field values are used to interprete the offset values. Two quoted string values are provided. The first value is for horizontal offset, and the second value is for vertical offset. Examples: "WORLD" "WORLD" (default value), "FRACTION" "FRACTION" or "PIXEL" "PIXEL".
      • Hint: If the value of the offsetUnits field is FRACTION, the size of the corresponding dimension is interpreted as a fraction of the corresponding parent’s dimension.
      • Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
      • Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
      Parameters:
      newValue - is new value for the offsetUnits field.
      Returns:
      Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getScaleMode

      java.lang.String[] getScaleMode()
      Provide array of String enumeration results ( baseType layoutScaleModeChoices) [""NONE" "NONE"" | ""NONE" "FRACTION"" | ""NONE" "STRETCH"" | ""NONE" "PIXEL"" | ""FRACTION" "NONE"" | ""FRACTION" "FRACTION"" | ""FRACTION" "STRETCH"" | ""FRACTION" "PIXEL"" | ""STRETCH" "NONE"" | ""STRETCH" "FRACTION"" | ""STRETCH" "STRETCH"" | ""STRETCH" "PIXEL"" | ""PIXEL" "NONE"" | ""PIXEL" "FRACTION"" | ""PIXEL" "STRETCH"" | ""PIXEL" "PIXEL""] from inputOutput MFString field named scaleMode.

      Tooltip: The scaleMode field specifies how the scale of the parent is modified. Two quoted string values are provided. The first value is for horizontal scale and the second value is for vertical scale. Examples: "NONE" "NONE" (default value), "FRACTION" "FRACTION", "STRETCH" "STRETCH" or "PIXEL" "PIXEL".
      • Hint: A scaleMode field value of NONE specifies that the corresponding scale value is not modified. Instead, the scale is inherited from its parent. Since a LayoutLayer node does not have a parent, the value of NONE reverts to FRACTION.
      • Hint: A scaleMode value of FRACTION specifies a scale in the corresponding direction so that one unit is equal to the dimension (width or height) of this rectangle.
      • Hint: a scaleMode value of STRETCH specifies a scale in the corresponding direction such that the resulting scale in the horizontal direction is equal to the scale in the vertical direction, thus producing a uniform scale.
      • Hint: a value of PIXEL specifies a scale in the corresponding direction such that one unit is equal to one pixel.
      • Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
      • Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
      Returns:
      value of scaleMode field
    • setScaleMode

      Layout setScaleMode​(java.lang.String[] newValue)
      Accessor method to assign String enumeration array (""NONE" "NONE"" | ""NONE" "FRACTION"" | ""NONE" "STRETCH"" | ""NONE" "PIXEL"" | ""FRACTION" "NONE"" | ""FRACTION" "FRACTION"" | ""FRACTION" "STRETCH"" | ""FRACTION" "PIXEL"" | ""STRETCH" "NONE"" | ""STRETCH" "FRACTION"" | ""STRETCH" "STRETCH"" | ""STRETCH" "PIXEL"" | ""PIXEL" "NONE"" | ""PIXEL" "FRACTION"" | ""PIXEL" "STRETCH"" | ""PIXEL" "PIXEL"") to inputOutput MFString field named scaleMode.

      Tooltip: The scaleMode field specifies how the scale of the parent is modified. Two quoted string values are provided. The first value is for horizontal scale and the second value is for vertical scale. Examples: "NONE" "NONE" (default value), "FRACTION" "FRACTION", "STRETCH" "STRETCH" or "PIXEL" "PIXEL".
      • Hint: A scaleMode field value of NONE specifies that the corresponding scale value is not modified. Instead, the scale is inherited from its parent. Since a LayoutLayer node does not have a parent, the value of NONE reverts to FRACTION.
      • Hint: A scaleMode value of FRACTION specifies a scale in the corresponding direction so that one unit is equal to the dimension (width or height) of this rectangle.
      • Hint: a scaleMode value of STRETCH specifies a scale in the corresponding direction such that the resulting scale in the horizontal direction is equal to the scale in the vertical direction, thus producing a uniform scale.
      • Hint: a value of PIXEL specifies a scale in the corresponding direction such that one unit is equal to one pixel.
      • Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
      • Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
      Parameters:
      newValue - is new value for the scaleMode field.
      Returns:
      Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSize

      float[] getSize()
      Provide array of float results from initializeOnly MFFloat field named size.

      Tooltip: (0,+infinity) The two values in the size field define the width and height of the layout rectangle. The sizeUnits field specifies how to interpret the size values.
      • Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
      Returns:
      value of size field
    • setSize

      Layout setSize​(float[] newValue)
      Accessor method to assign float array to initializeOnly MFFloat field named size.

      Tooltip: (0,+infinity) The two values in the size field define the width and height of the layout rectangle. The sizeUnits field specifies how to interpret the size values.
      • Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
      Parameters:
      newValue - is new value for the size field.
      Returns:
      Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSizeUnits

      java.lang.String[] getSizeUnits()
      Provide array of String enumeration results ( baseType layoutUnitsChoices) [""WORLD" "WORLD"" | ""WORLD" "FRACTION"" | ""WORLD" "PIXEL"" | ""FRACTION" "WORLD"" | ""FRACTION" "FRACTION"" | ""FRACTION" "PIXEL"" | ""PIXEL" "WORLD"" | ""PIXEL" "FRACTION"" | ""PIXEL" "PIXEL""] from inputOutput MFString field named sizeUnits.

      Tooltip: The sizeUnits field values are used to interprete the offset values. Two quoted string values are provided. The first value is for horizontal size, and the second value is for vertical size. Examples: "WORLD" "WORLD" (default value), "FRACTION" "FRACTION" or "PIXEL" "PIXEL".
      • Hint: If the value of the sizeUnits field is FRACTION, the size of the corresponding dimension is interpreted as a fraction of the corresponding parent’s dimension.
      • Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
      • Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
      Returns:
      value of sizeUnits field
    • setSizeUnits

      Layout setSizeUnits​(java.lang.String[] newValue)
      Accessor method to assign String enumeration array (""WORLD" "WORLD"" | ""WORLD" "FRACTION"" | ""WORLD" "PIXEL"" | ""FRACTION" "WORLD"" | ""FRACTION" "FRACTION"" | ""FRACTION" "PIXEL"" | ""PIXEL" "WORLD"" | ""PIXEL" "FRACTION"" | ""PIXEL" "PIXEL"") to inputOutput MFString field named sizeUnits.

      Tooltip: The sizeUnits field values are used to interprete the offset values. Two quoted string values are provided. The first value is for horizontal size, and the second value is for vertical size. Examples: "WORLD" "WORLD" (default value), "FRACTION" "FRACTION" or "PIXEL" "PIXEL".
      • Hint: If the value of the sizeUnits field is FRACTION, the size of the corresponding dimension is interpreted as a fraction of the corresponding parent’s dimension.
      • Warning: if only one value is provided, it applies equally to horizontal and vertical directions (width and height). More than two values are not allowed.
      • Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
      Parameters:
      newValue - is new value for the sizeUnits field.
      Returns:
      Layout - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).