Class LayoutObject

java.lang.Object
All Implemented Interfaces:
X3DChildNode, X3DNode, Layout, X3DLayoutNode

public class LayoutObject
extends X3DConcreteNode
implements Layout
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 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:
X3D Abstract Specification: Layout, X3D Tooltips: Layout, X3D Scene Authoring Hints
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static java.lang.String ALIGN_CENTER_BOTTOM
    MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"CENTER\" \"BOTTOM\"" (Java syntax) or '"CENTER" "BOTTOM"' (XML syntax).
    static java.lang.String ALIGN_CENTER_CENTER
    MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"CENTER\" \"CENTER\"" (Java syntax) or '"CENTER" "CENTER"' (XML syntax).
    static java.lang.String ALIGN_CENTER_TOP
    MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"CENTER\" \"TOP\"" (Java syntax) or '"CENTER" "TOP"' (XML syntax).
    static java.util.ArrayList<java.lang.String> ALIGN_DEFAULT_VALUE
    MFString field named align has default quoted value new String[] {"CENTER","CENTER"} (Java syntax) or quoted value "CENTER" "CENTER" (XML syntax).
    static java.lang.String ALIGN_LEFT_BOTTOM
    MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"LEFT\" \"BOTTOM\"" (Java syntax) or '"LEFT" "BOTTOM"' (XML syntax).
    static java.lang.String ALIGN_LEFT_CENTER
    MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"LEFT\" \"CENTER\"" (Java syntax) or '"LEFT" "CENTER"' (XML syntax).
    static java.lang.String ALIGN_LEFT_TOP
    MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"LEFT\" \"TOP\"" (Java syntax) or '"LEFT" "TOP"' (XML syntax).
    static java.lang.String ALIGN_RIGHT_BOTTOM
    MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"RIGHT\" \"BOTTOM\"" (Java syntax) or '"RIGHT" "BOTTOM"' (XML syntax).
    static java.lang.String ALIGN_RIGHT_CENTER
    MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"RIGHT\" \"CENTER\"" (Java syntax) or '"RIGHT" "CENTER"' (XML syntax).
    static java.lang.String ALIGN_RIGHT_TOP
    MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"RIGHT\" \"TOP\"" (Java syntax) or '"RIGHT" "TOP"' (XML syntax).
    static java.lang.String COMPONENT
    String constant COMPONENT defines X3D component for the Layout element: Layout
    static java.lang.String containerField_DEFAULT_VALUE
    containerField describes typical field relationship of a node to its parent.
    static java.lang.String fromField_ALIGN
    fromField ROUTE name for MFString field named align.
    static java.lang.String fromField_IS
    fromField ROUTE name for SFNode field named IS.
    static java.lang.String fromField_METADATA
    fromField ROUTE name for SFNode field named metadata.
    static java.lang.String fromField_OFFSET
    fromField ROUTE name for MFFloat field named offset.
    static java.lang.String fromField_OFFSETUNITS
    fromField ROUTE name for MFString field named offsetUnits.
    static java.lang.String fromField_SCALEMODE
    fromField ROUTE name for MFString field named scaleMode.
    static java.lang.String fromField_SIZEUNITS
    fromField ROUTE name for MFString field named sizeUnits.
    static ISObject IS_DEFAULT_VALUE
    SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
    static java.util.ArrayList<java.lang.String> layoutAlignChoices
    List of specification-defined enumeration values, with additional author-defined enumeration values not allowed.
    static java.util.ArrayList<java.lang.String> layoutScaleModeChoices
    List of specification-defined enumeration values, with additional author-defined enumeration values not allowed.
    static java.util.ArrayList<java.lang.String> layoutUnitsChoices
    List of specification-defined enumeration values, with additional author-defined enumeration values not allowed.
    static int LEVEL
    Integer constant LEVEL provides default X3D Layout component level for this element: 1
    static X3DMetadataObject METADATA_DEFAULT_VALUE
    SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
    static java.lang.String NAME
    String constant NAME provides name of this element: Layout.
    static java.util.ArrayList<java.lang.Float> OFFSET_DEFAULT_VALUE
    MFFloat field named offset has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).
    static java.util.ArrayList<java.lang.String> OFFSETUNITS_DEFAULT_VALUE
    MFString field named offsetUnits has default quoted value new String[] {"WORLD","WORLD"} (Java syntax) or quoted value "WORLD" "WORLD" (XML syntax).
    static java.lang.String OFFSETUNITS_FRACTION_FRACTION
    MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"FRACTION\"" (Java syntax) or '"FRACTION" "FRACTION"' (XML syntax).
    static java.lang.String OFFSETUNITS_FRACTION_PIXEL
    MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"PIXEL\"" (Java syntax) or '"FRACTION" "PIXEL"' (XML syntax).
    static java.lang.String OFFSETUNITS_FRACTION_WORLD
    MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"WORLD\"" (Java syntax) or '"FRACTION" "WORLD"' (XML syntax).
    static java.lang.String OFFSETUNITS_PIXEL_FRACTION
    MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"FRACTION\"" (Java syntax) or '"PIXEL" "FRACTION"' (XML syntax).
    static java.lang.String OFFSETUNITS_PIXEL_PIXEL
    MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"PIXEL\"" (Java syntax) or '"PIXEL" "PIXEL"' (XML syntax).
    static java.lang.String OFFSETUNITS_PIXEL_WORLD
    MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"WORLD\"" (Java syntax) or '"PIXEL" "WORLD"' (XML syntax).
    static java.lang.String OFFSETUNITS_WORLD_FRACTION
    MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"WORLD\" \"FRACTION\"" (Java syntax) or '"WORLD" "FRACTION"' (XML syntax).
    static java.lang.String OFFSETUNITS_WORLD_PIXEL
    MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"WORLD\" \"PIXEL\"" (Java syntax) or '"WORLD" "PIXEL"' (XML syntax).
    static java.lang.String OFFSETUNITS_WORLD_WORLD
    MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"WORLD\" \"WORLD\"" (Java syntax) or '"WORLD" "WORLD"' (XML syntax).
    static java.util.ArrayList<java.lang.String> SCALEMODE_DEFAULT_VALUE
    MFString field named scaleMode has default quoted value new String[] {"NONE","NONE"} (Java syntax) or quoted value "NONE" "NONE" (XML syntax).
    static java.lang.String SCALEMODE_FRACTION_FRACTION
    MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"FRACTION\"" (Java syntax) or '"FRACTION" "FRACTION"' (XML syntax).
    static java.lang.String SCALEMODE_FRACTION_NONE
    MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"NONE\"" (Java syntax) or '"FRACTION" "NONE"' (XML syntax).
    static java.lang.String SCALEMODE_FRACTION_PIXEL
    MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"PIXEL\"" (Java syntax) or '"FRACTION" "PIXEL"' (XML syntax).
    static java.lang.String SCALEMODE_FRACTION_STRETCH
    MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"STRETCH\"" (Java syntax) or '"FRACTION" "STRETCH"' (XML syntax).
    static java.lang.String SCALEMODE_NONE_FRACTION
    MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"NONE\" \"FRACTION\"" (Java syntax) or '"NONE" "FRACTION"' (XML syntax).
    static java.lang.String SCALEMODE_NONE_NONE
    MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"NONE\" \"NONE\"" (Java syntax) or '"NONE" "NONE"' (XML syntax).
    static java.lang.String SCALEMODE_NONE_PIXEL
    MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"NONE\" \"PIXEL\"" (Java syntax) or '"NONE" "PIXEL"' (XML syntax).
    static java.lang.String SCALEMODE_NONE_STRETCH
    MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"NONE\" \"STRETCH\"" (Java syntax) or '"NONE" "STRETCH"' (XML syntax).
    static java.lang.String SCALEMODE_PIXEL_FRACTION
    MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"FRACTION\"" (Java syntax) or '"PIXEL" "FRACTION"' (XML syntax).
    static java.lang.String SCALEMODE_PIXEL_NONE
    MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"NONE\"" (Java syntax) or '"PIXEL" "NONE"' (XML syntax).
    static java.lang.String SCALEMODE_PIXEL_PIXEL
    MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"PIXEL\"" (Java syntax) or '"PIXEL" "PIXEL"' (XML syntax).
    static java.lang.String SCALEMODE_PIXEL_STRETCH
    MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"STRETCH\"" (Java syntax) or '"PIXEL" "STRETCH"' (XML syntax).
    static java.lang.String SCALEMODE_STRETCH_FRACTION
    MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"STRETCH\" \"FRACTION\"" (Java syntax) or '"STRETCH" "FRACTION"' (XML syntax).
    static java.lang.String SCALEMODE_STRETCH_NONE
    MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"STRETCH\" \"NONE\"" (Java syntax) or '"STRETCH" "NONE"' (XML syntax).
    static java.lang.String SCALEMODE_STRETCH_PIXEL
    MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"STRETCH\" \"PIXEL\"" (Java syntax) or '"STRETCH" "PIXEL"' (XML syntax).
    static java.lang.String SCALEMODE_STRETCH_STRETCH
    MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"STRETCH\" \"STRETCH\"" (Java syntax) or '"STRETCH" "STRETCH"' (XML syntax).
    static java.util.ArrayList<java.lang.Float> SIZE_DEFAULT_VALUE
    MFFloat field named size has default value {1f,1f} (Java syntax) or 1 1 (XML syntax).
    static java.util.ArrayList<java.lang.String> SIZEUNITS_DEFAULT_VALUE
    MFString field named sizeUnits has default quoted value new String[] {"WORLD","WORLD"} (Java syntax) or quoted value "WORLD" "WORLD" (XML syntax).
    static java.lang.String SIZEUNITS_FRACTION_FRACTION
    MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"FRACTION\"" (Java syntax) or '"FRACTION" "FRACTION"' (XML syntax).
    static java.lang.String SIZEUNITS_FRACTION_PIXEL
    MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"PIXEL\"" (Java syntax) or '"FRACTION" "PIXEL"' (XML syntax).
    static java.lang.String SIZEUNITS_FRACTION_WORLD
    MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"WORLD\"" (Java syntax) or '"FRACTION" "WORLD"' (XML syntax).
    static java.lang.String SIZEUNITS_PIXEL_FRACTION
    MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"FRACTION\"" (Java syntax) or '"PIXEL" "FRACTION"' (XML syntax).
    static java.lang.String SIZEUNITS_PIXEL_PIXEL
    MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"PIXEL\"" (Java syntax) or '"PIXEL" "PIXEL"' (XML syntax).
    static java.lang.String SIZEUNITS_PIXEL_WORLD
    MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"WORLD\"" (Java syntax) or '"PIXEL" "WORLD"' (XML syntax).
    static java.lang.String SIZEUNITS_WORLD_FRACTION
    MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"WORLD\" \"FRACTION\"" (Java syntax) or '"WORLD" "FRACTION"' (XML syntax).
    static java.lang.String SIZEUNITS_WORLD_PIXEL
    MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"WORLD\" \"PIXEL\"" (Java syntax) or '"WORLD" "PIXEL"' (XML syntax).
    static java.lang.String SIZEUNITS_WORLD_WORLD
    MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"WORLD\" \"WORLD\"" (Java syntax) or '"WORLD" "WORLD"' (XML syntax).
    static java.lang.String toField_ALIGN
    toField ROUTE name for MFString field named align.
    static java.lang.String toField_METADATA
    toField ROUTE name for SFNode field named metadata.
    static java.lang.String toField_OFFSET
    toField ROUTE name for MFFloat field named offset.
    static java.lang.String toField_OFFSETUNITS
    toField ROUTE name for MFString field named offsetUnits.
    static java.lang.String toField_SCALEMODE
    toField ROUTE name for MFString field named scaleMode.
    static java.lang.String toField_SIZEUNITS
    toField ROUTE name for MFString field named sizeUnits.

    Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

    validationResult
  • Constructor Summary

    Constructors 
    Constructor Description
    LayoutObject()
    Constructor for LayoutObject to initialize member variables with default values.
    LayoutObject​(java.lang.String DEFlabel)
    Utility constructor that assigns DEF label after initializing member variables with default values.
  • Method Summary

    Modifier and Type Method Description
    LayoutObject addAlign​(java.lang.String newValue)
    Add singleton String value to MFString align field.
    LayoutObject addAlign​(SFStringObject newValue)
    Add singleton SFStringObject value to MFString align field.
    LayoutObject addComments​(java.lang.String newComment)
    Add comment as String to contained commentsList.
    LayoutObject addComments​(java.lang.String[] newComments)
    Add comments as String[] array to contained commentsList.
    LayoutObject addComments​(CommentsBlock newCommentsBlock)
    Add CommentsBlock to contained commentsList.
    LayoutObject addOffset​(float newValue)
    Add singleton float value to MFFloat offset field.
    LayoutObject addOffset​(SFFloatObject newValue)
    Add singleton SFFloatObject value to MFFloat offset field.
    LayoutObject addOffsetUnits​(java.lang.String newValue)
    Add singleton String value to MFString offsetUnits field.
    LayoutObject addOffsetUnits​(SFStringObject newValue)
    Add singleton SFStringObject value to MFString offsetUnits field.
    LayoutObject addScaleMode​(java.lang.String newValue)
    Add singleton String value to MFString scaleMode field.
    LayoutObject addScaleMode​(SFStringObject newValue)
    Add singleton SFStringObject value to MFString scaleMode field.
    LayoutObject addSize​(float newValue)
    Add singleton float value to MFFloat size field.
    LayoutObject addSize​(SFFloatObject newValue)
    Add singleton SFFloatObject value to MFFloat size field.
    LayoutObject addSizeUnits​(java.lang.String newValue)
    Add singleton String value to MFString sizeUnits field.
    LayoutObject addSizeUnits​(SFStringObject newValue)
    Add singleton SFStringObject value to MFString sizeUnits field.
    LayoutObject clearAlign()
    Utility method to clear MFString value of align field.
    LayoutObject clearIS()
    Utility method to clear SFNode value of IS field.
    LayoutObject clearMetadata()
    Utility method to clear SFNode value of metadata field.
    LayoutObject clearOffset()
    Utility method to clear MFFloat value of offset field.
    LayoutObject clearOffsetUnits()
    Utility method to clear MFString value of offsetUnits field.
    LayoutObject clearScaleMode()
    Utility method to clear MFString value of scaleMode field.
    LayoutObject clearSize()
    Utility method to clear MFFloat value of size field.
    LayoutObject clearSizeUnits()
    Utility method to clear MFString value of sizeUnits field.
    X3DConcreteElement findElementByNameValue​(java.lang.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.
    X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.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.
    X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
    Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
    java.lang.String getAccessType​(java.lang.String fieldName)
    Indicate accessType corresponding to given fieldName.
    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.
    java.util.ArrayList<java.lang.String> getAlignList()
    Utility method to get ArrayList value of MFString align field, similar to getAlign().
    java.lang.String getComponent()
    Defines X3D component for the Layout element: Layout
    int getComponentLevel()
    Provides default X3D component level for this element: 1
    java.lang.String getContainerFieldDefault()
    containerField describes typical field relationship of a node to its parent.
    java.lang.String getCssClass()
    Provide String value from inputOutput SFString field named class.
    java.lang.String getDEF()
    Provide String value from inputOutput SFString field named DEF.
    java.lang.String getElementName()
    Provides name of this element: Layout
    java.lang.String getFieldType​(java.lang.String fieldName)
    Indicate type corresponding to given fieldName.
    ISObject getIS()
    Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.
    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.util.ArrayList<java.lang.Float> getOffsetList()
    Utility method to get ArrayList value of MFFloat offset field, similar to getOffset().
    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.util.ArrayList<java.lang.String> getOffsetUnitsList()
    Utility method to get ArrayList value of MFString offsetUnits field, similar to getOffsetUnits().
    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.
    java.util.ArrayList<java.lang.String> getScaleModeList()
    Utility method to get ArrayList value of MFString scaleMode field, similar to getScaleMode().
    float[] getSize()
    Provide array of Float results from initializeOnly MFFloat field named size.
    java.util.ArrayList<java.lang.Float> getSizeList()
    Utility method to get ArrayList value of MFFloat size field, similar to getSize().
    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.
    java.util.ArrayList<java.lang.String> getSizeUnitsList()
    Utility method to get ArrayList value of MFString sizeUnits field, similar to getSizeUnits().
    java.lang.String getUSE()
    Provide String value from inputOutput SFString field named USE.
    boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.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.
    boolean hasIS()
    Indicate whether an object is available for inputOutput SFNode field IS.
    boolean hasMetadata()
    Indicate whether an object is available for inputOutput SFNode field metadata.
    boolean hasNodeByDEF​(java.lang.String DEFvalue)
    Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
    void initialize()
    Initialize all member variables to default values.
    LayoutObject setAlign​(java.lang.String newValue)
    Assign singleton String value to MFString align field, similar to setAlign(String[]).
    LayoutObject 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.
    LayoutObject setAlign​(java.util.ArrayList<java.lang.String> newValue)
    Assign ArrayList value of MFString align field, similar to setAlign(String[]).
    LayoutObject setAlign​(MFStringObject newValue)
    Assign typed object value to MFString align field, similar to setAlign(String[]).
    LayoutObject setAlign​(SFStringObject newValue)
    Assign single SFString object value to MFString align field, similar to setAlign(String[]).
    LayoutObject setCssClass​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named class.
    LayoutObject setCssClass​(SFStringObject newValue)
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    LayoutObject setDEF​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named DEF.
    LayoutObject setDEF​(SFStringObject newValue)
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    LayoutObject setIS​(ISObject newValue)
    Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.
    LayoutObject setMetadata​(ProtoInstanceObject newValue)
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
    LayoutObject setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    LayoutObject setOffset​(double[] newArray)
    Utility method: double-precision set-array accessor for X3D floating-point type, similar to setOffset(float[]).
    LayoutObject setOffset​(float[] newValue)
    Accessor method to assign Float array to inputOutput MFFloat field named offset.
    LayoutObject setOffset​(int[] newValue)
    Assign floating-point array value of MFFloat offset field, similar to setOffset(float[]).
    LayoutObject setOffset​(java.util.ArrayList<java.lang.Float> newValue)
    Assign ArrayList value of MFFloat offset field, similar to setOffset(float[]).
    LayoutObject setOffset​(MFFloatObject newValue)
    Assign typed object value to MFFloat offset field, similar to setOffset(float[]).
    LayoutObject setOffsetUnits​(java.lang.String newValue)
    Assign singleton String value to MFString offsetUnits field, similar to setOffsetUnits(String[]).
    LayoutObject 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.
    LayoutObject setOffsetUnits​(java.util.ArrayList<java.lang.String> newValue)
    Assign ArrayList value of MFString offsetUnits field, similar to setOffsetUnits(String[]).
    LayoutObject setOffsetUnits​(MFStringObject newValue)
    Assign typed object value to MFString offsetUnits field, similar to setOffsetUnits(String[]).
    LayoutObject setOffsetUnits​(SFStringObject newValue)
    Assign single SFString object value to MFString offsetUnits field, similar to setOffsetUnits(String[]).
    LayoutObject setScaleMode​(java.lang.String newValue)
    Assign singleton String value to MFString scaleMode field, similar to setScaleMode(String[]).
    LayoutObject 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.
    LayoutObject setScaleMode​(java.util.ArrayList<java.lang.String> newValue)
    Assign ArrayList value of MFString scaleMode field, similar to setScaleMode(String[]).
    LayoutObject setScaleMode​(MFStringObject newValue)
    Assign typed object value to MFString scaleMode field, similar to setScaleMode(String[]).
    LayoutObject setScaleMode​(SFStringObject newValue)
    Assign single SFString object value to MFString scaleMode field, similar to setScaleMode(String[]).
    LayoutObject setSize​(double[] newArray)
    Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSize(float[]).
    LayoutObject setSize​(float[] newValue)
    Accessor method to assign Float array to initializeOnly MFFloat field named size.
    LayoutObject setSize​(int[] newValue)
    Assign floating-point array value of MFFloat size field, similar to setSize(float[]).
    LayoutObject setSize​(java.util.ArrayList<java.lang.Float> newValue)
    Assign ArrayList value of MFFloat size field, similar to setSize(float[]).
    LayoutObject setSize​(MFFloatObject newValue)
    Assign typed object value to MFFloat size field, similar to setSize(float[]).
    LayoutObject setSizeUnits​(java.lang.String newValue)
    Assign singleton String value to MFString sizeUnits field, similar to setSizeUnits(String[]).
    LayoutObject 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.
    LayoutObject setSizeUnits​(java.util.ArrayList<java.lang.String> newValue)
    Assign ArrayList value of MFString sizeUnits field, similar to setSizeUnits(String[]).
    LayoutObject setSizeUnits​(MFStringObject newValue)
    Assign typed object value to MFString sizeUnits field, similar to setSizeUnits(String[]).
    LayoutObject setSizeUnits​(SFStringObject newValue)
    Assign single SFString object value to MFString sizeUnits field, similar to setSizeUnits(String[]).
    LayoutObject setUSE​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named USE.
    LayoutObject setUSE​(SFStringObject newValue)
    Assign typed object value to SFString USE field, similar to setUSE(String).
    LayoutObject setUSE​(LayoutObject DEFnode)
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    java.lang.String toStringClassicVRML​(int indentLevel)
    Recursive method to provide ClassicVRML string serialization.
    java.lang.String toStringVRML97​(int indentLevel)
    Recursive method to provide VRML97 string serialization.
    java.lang.String toStringX3D​(int indentLevel)
    Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
    java.lang.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.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • layoutAlignChoices

      public static final java.util.ArrayList<java.lang.String> layoutAlignChoices
      List of specification-defined enumeration values, with additional author-defined enumeration values not allowed.

      Allowed values: ""LEFT" "BOTTOM"", ""LEFT" "CENTER"", ""LEFT" "TOP"", ""CENTER" "BOTTOM"", ""CENTER" "CENTER"", ""CENTER" "TOP"", ""RIGHT" "BOTTOM"", ""RIGHT" "CENTER"", ""RIGHT" "TOP"".

      Permitted combinations of horizontal and vertical values for the align field in the Layout node. Note that intermediate commas and extraneous whitespace are disallowed by these strictly defined enumeration values.
      See Also:
      https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/layout.html#Layout
    • ALIGN_LEFT_BOTTOM

      public static final java.lang.String ALIGN_LEFT_BOTTOM
      MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"LEFT\" \"BOTTOM\"" (Java syntax) or '"LEFT" "BOTTOM"' (XML syntax).
      See Also:
      layoutAlignChoices, Constant Field Values
    • ALIGN_LEFT_CENTER

      public static final java.lang.String ALIGN_LEFT_CENTER
      MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"LEFT\" \"CENTER\"" (Java syntax) or '"LEFT" "CENTER"' (XML syntax).
      See Also:
      layoutAlignChoices, Constant Field Values
    • ALIGN_LEFT_TOP

      public static final java.lang.String ALIGN_LEFT_TOP
      MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"LEFT\" \"TOP\"" (Java syntax) or '"LEFT" "TOP"' (XML syntax).
      See Also:
      layoutAlignChoices, Constant Field Values
    • ALIGN_CENTER_BOTTOM

      public static final java.lang.String ALIGN_CENTER_BOTTOM
      MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"CENTER\" \"BOTTOM\"" (Java syntax) or '"CENTER" "BOTTOM"' (XML syntax).
      See Also:
      layoutAlignChoices, Constant Field Values
    • ALIGN_CENTER_CENTER

      public static final java.lang.String ALIGN_CENTER_CENTER
      MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"CENTER\" \"CENTER\"" (Java syntax) or '"CENTER" "CENTER"' (XML syntax).
      See Also:
      layoutAlignChoices, Constant Field Values
    • ALIGN_CENTER_TOP

      public static final java.lang.String ALIGN_CENTER_TOP
      MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"CENTER\" \"TOP\"" (Java syntax) or '"CENTER" "TOP"' (XML syntax).
      See Also:
      layoutAlignChoices, Constant Field Values
    • ALIGN_RIGHT_BOTTOM

      public static final java.lang.String ALIGN_RIGHT_BOTTOM
      MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"RIGHT\" \"BOTTOM\"" (Java syntax) or '"RIGHT" "BOTTOM"' (XML syntax).
      See Also:
      layoutAlignChoices, Constant Field Values
    • ALIGN_RIGHT_CENTER

      public static final java.lang.String ALIGN_RIGHT_CENTER
      MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"RIGHT\" \"CENTER\"" (Java syntax) or '"RIGHT" "CENTER"' (XML syntax).
      See Also:
      layoutAlignChoices, Constant Field Values
    • ALIGN_RIGHT_TOP

      public static final java.lang.String ALIGN_RIGHT_TOP
      MFString field named align with X3DUOM baseType layoutAlignChoices is an array that can only include one of the quoted enumeration values "\"RIGHT\" \"TOP\"" (Java syntax) or '"RIGHT" "TOP"' (XML syntax).
      See Also:
      layoutAlignChoices, Constant Field Values
    • layoutUnitsChoices

      public static final java.util.ArrayList<java.lang.String> layoutUnitsChoices
      List of specification-defined enumeration values, with additional author-defined enumeration values not allowed.

      Allowed values: ""WORLD" "WORLD"", ""WORLD" "FRACTION"", ""WORLD" "PIXEL"", ""FRACTION" "WORLD"", ""FRACTION" "FRACTION"", ""FRACTION" "PIXEL"", ""PIXEL" "WORLD"", ""PIXEL" "FRACTION"", ""PIXEL" "PIXEL"".

      Permitted combinations of horizontal and vertical values for the offsetUnits field in the Layout node. Note that intermediate commas and extraneous whitespace are disallowed by these strictly defined enumeration values.
      See Also:
      https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/layout.html#Layout
    • OFFSETUNITS_WORLD_WORLD

      public static final java.lang.String OFFSETUNITS_WORLD_WORLD
      MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"WORLD\" \"WORLD\"" (Java syntax) or '"WORLD" "WORLD"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • OFFSETUNITS_WORLD_FRACTION

      public static final java.lang.String OFFSETUNITS_WORLD_FRACTION
      MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"WORLD\" \"FRACTION\"" (Java syntax) or '"WORLD" "FRACTION"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • OFFSETUNITS_WORLD_PIXEL

      public static final java.lang.String OFFSETUNITS_WORLD_PIXEL
      MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"WORLD\" \"PIXEL\"" (Java syntax) or '"WORLD" "PIXEL"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • OFFSETUNITS_FRACTION_WORLD

      public static final java.lang.String OFFSETUNITS_FRACTION_WORLD
      MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"WORLD\"" (Java syntax) or '"FRACTION" "WORLD"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • OFFSETUNITS_FRACTION_FRACTION

      public static final java.lang.String OFFSETUNITS_FRACTION_FRACTION
      MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"FRACTION\"" (Java syntax) or '"FRACTION" "FRACTION"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • OFFSETUNITS_FRACTION_PIXEL

      public static final java.lang.String OFFSETUNITS_FRACTION_PIXEL
      MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"PIXEL\"" (Java syntax) or '"FRACTION" "PIXEL"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • OFFSETUNITS_PIXEL_WORLD

      public static final java.lang.String OFFSETUNITS_PIXEL_WORLD
      MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"WORLD\"" (Java syntax) or '"PIXEL" "WORLD"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • OFFSETUNITS_PIXEL_FRACTION

      public static final java.lang.String OFFSETUNITS_PIXEL_FRACTION
      MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"FRACTION\"" (Java syntax) or '"PIXEL" "FRACTION"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • OFFSETUNITS_PIXEL_PIXEL

      public static final java.lang.String OFFSETUNITS_PIXEL_PIXEL
      MFString field named offsetUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"PIXEL\"" (Java syntax) or '"PIXEL" "PIXEL"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • layoutScaleModeChoices

      public static final java.util.ArrayList<java.lang.String> layoutScaleModeChoices
      List of specification-defined enumeration values, with additional author-defined enumeration values not allowed.

      Allowed values: ""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"".

      Permitted combinations of horizontal and vertical values for the scaleMode field in the Layout node. Note that intermediate commas and extraneous whitespace are disallowed by these strictly defined enumeration values.
      See Also:
      https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/layout.html#Layout
    • SCALEMODE_NONE_NONE

      public static final java.lang.String SCALEMODE_NONE_NONE
      MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"NONE\" \"NONE\"" (Java syntax) or '"NONE" "NONE"' (XML syntax).
      See Also:
      layoutScaleModeChoices, Constant Field Values
    • SCALEMODE_NONE_FRACTION

      public static final java.lang.String SCALEMODE_NONE_FRACTION
      MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"NONE\" \"FRACTION\"" (Java syntax) or '"NONE" "FRACTION"' (XML syntax).
      See Also:
      layoutScaleModeChoices, Constant Field Values
    • SCALEMODE_NONE_STRETCH

      public static final java.lang.String SCALEMODE_NONE_STRETCH
      MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"NONE\" \"STRETCH\"" (Java syntax) or '"NONE" "STRETCH"' (XML syntax).
      See Also:
      layoutScaleModeChoices, Constant Field Values
    • SCALEMODE_NONE_PIXEL

      public static final java.lang.String SCALEMODE_NONE_PIXEL
      MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"NONE\" \"PIXEL\"" (Java syntax) or '"NONE" "PIXEL"' (XML syntax).
      See Also:
      layoutScaleModeChoices, Constant Field Values
    • SCALEMODE_FRACTION_NONE

      public static final java.lang.String SCALEMODE_FRACTION_NONE
      MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"NONE\"" (Java syntax) or '"FRACTION" "NONE"' (XML syntax).
      See Also:
      layoutScaleModeChoices, Constant Field Values
    • SCALEMODE_FRACTION_FRACTION

      public static final java.lang.String SCALEMODE_FRACTION_FRACTION
      MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"FRACTION\"" (Java syntax) or '"FRACTION" "FRACTION"' (XML syntax).
      See Also:
      layoutScaleModeChoices, Constant Field Values
    • SCALEMODE_FRACTION_STRETCH

      public static final java.lang.String SCALEMODE_FRACTION_STRETCH
      MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"STRETCH\"" (Java syntax) or '"FRACTION" "STRETCH"' (XML syntax).
      See Also:
      layoutScaleModeChoices, Constant Field Values
    • SCALEMODE_FRACTION_PIXEL

      public static final java.lang.String SCALEMODE_FRACTION_PIXEL
      MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"PIXEL\"" (Java syntax) or '"FRACTION" "PIXEL"' (XML syntax).
      See Also:
      layoutScaleModeChoices, Constant Field Values
    • SCALEMODE_STRETCH_NONE

      public static final java.lang.String SCALEMODE_STRETCH_NONE
      MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"STRETCH\" \"NONE\"" (Java syntax) or '"STRETCH" "NONE"' (XML syntax).
      See Also:
      layoutScaleModeChoices, Constant Field Values
    • SCALEMODE_STRETCH_FRACTION

      public static final java.lang.String SCALEMODE_STRETCH_FRACTION
      MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"STRETCH\" \"FRACTION\"" (Java syntax) or '"STRETCH" "FRACTION"' (XML syntax).
      See Also:
      layoutScaleModeChoices, Constant Field Values
    • SCALEMODE_STRETCH_STRETCH

      public static final java.lang.String SCALEMODE_STRETCH_STRETCH
      MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"STRETCH\" \"STRETCH\"" (Java syntax) or '"STRETCH" "STRETCH"' (XML syntax).
      See Also:
      layoutScaleModeChoices, Constant Field Values
    • SCALEMODE_STRETCH_PIXEL

      public static final java.lang.String SCALEMODE_STRETCH_PIXEL
      MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"STRETCH\" \"PIXEL\"" (Java syntax) or '"STRETCH" "PIXEL"' (XML syntax).
      See Also:
      layoutScaleModeChoices, Constant Field Values
    • SCALEMODE_PIXEL_NONE

      public static final java.lang.String SCALEMODE_PIXEL_NONE
      MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"NONE\"" (Java syntax) or '"PIXEL" "NONE"' (XML syntax).
      See Also:
      layoutScaleModeChoices, Constant Field Values
    • SCALEMODE_PIXEL_FRACTION

      public static final java.lang.String SCALEMODE_PIXEL_FRACTION
      MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"FRACTION\"" (Java syntax) or '"PIXEL" "FRACTION"' (XML syntax).
      See Also:
      layoutScaleModeChoices, Constant Field Values
    • SCALEMODE_PIXEL_STRETCH

      public static final java.lang.String SCALEMODE_PIXEL_STRETCH
      MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"STRETCH\"" (Java syntax) or '"PIXEL" "STRETCH"' (XML syntax).
      See Also:
      layoutScaleModeChoices, Constant Field Values
    • SCALEMODE_PIXEL_PIXEL

      public static final java.lang.String SCALEMODE_PIXEL_PIXEL
      MFString field named scaleMode with X3DUOM baseType layoutScaleModeChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"PIXEL\"" (Java syntax) or '"PIXEL" "PIXEL"' (XML syntax).
      See Also:
      layoutScaleModeChoices, Constant Field Values
    • SIZEUNITS_WORLD_WORLD

      public static final java.lang.String SIZEUNITS_WORLD_WORLD
      MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"WORLD\" \"WORLD\"" (Java syntax) or '"WORLD" "WORLD"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • SIZEUNITS_WORLD_FRACTION

      public static final java.lang.String SIZEUNITS_WORLD_FRACTION
      MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"WORLD\" \"FRACTION\"" (Java syntax) or '"WORLD" "FRACTION"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • SIZEUNITS_WORLD_PIXEL

      public static final java.lang.String SIZEUNITS_WORLD_PIXEL
      MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"WORLD\" \"PIXEL\"" (Java syntax) or '"WORLD" "PIXEL"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • SIZEUNITS_FRACTION_WORLD

      public static final java.lang.String SIZEUNITS_FRACTION_WORLD
      MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"WORLD\"" (Java syntax) or '"FRACTION" "WORLD"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • SIZEUNITS_FRACTION_FRACTION

      public static final java.lang.String SIZEUNITS_FRACTION_FRACTION
      MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"FRACTION\"" (Java syntax) or '"FRACTION" "FRACTION"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • SIZEUNITS_FRACTION_PIXEL

      public static final java.lang.String SIZEUNITS_FRACTION_PIXEL
      MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"FRACTION\" \"PIXEL\"" (Java syntax) or '"FRACTION" "PIXEL"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • SIZEUNITS_PIXEL_WORLD

      public static final java.lang.String SIZEUNITS_PIXEL_WORLD
      MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"WORLD\"" (Java syntax) or '"PIXEL" "WORLD"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • SIZEUNITS_PIXEL_FRACTION

      public static final java.lang.String SIZEUNITS_PIXEL_FRACTION
      MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"FRACTION\"" (Java syntax) or '"PIXEL" "FRACTION"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • SIZEUNITS_PIXEL_PIXEL

      public static final java.lang.String SIZEUNITS_PIXEL_PIXEL
      MFString field named sizeUnits with X3DUOM baseType layoutUnitsChoices is an array that can only include one of the quoted enumeration values "\"PIXEL\" \"PIXEL\"" (Java syntax) or '"PIXEL" "PIXEL"' (XML syntax).
      See Also:
      layoutUnitsChoices, Constant Field Values
    • NAME

      public static final java.lang.String NAME
      String constant NAME provides name of this element: Layout.
      See Also:
      Constant Field Values
    • COMPONENT

      public static final java.lang.String COMPONENT
      String constant COMPONENT defines X3D component for the Layout element: Layout
      See Also:
      Constant Field Values
    • LEVEL

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

      public static final java.util.ArrayList<java.lang.String> ALIGN_DEFAULT_VALUE
      MFString field named align has default quoted value new String[] {"CENTER","CENTER"} (Java syntax) or quoted value "CENTER" "CENTER" (XML syntax).
    • IS_DEFAULT_VALUE

      public static final ISObject IS_DEFAULT_VALUE
      SFNode field named IS 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).
    • OFFSET_DEFAULT_VALUE

      public static final java.util.ArrayList<java.lang.Float> OFFSET_DEFAULT_VALUE
      MFFloat field named offset has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).
    • OFFSETUNITS_DEFAULT_VALUE

      public static final java.util.ArrayList<java.lang.String> OFFSETUNITS_DEFAULT_VALUE
      MFString field named offsetUnits has default quoted value new String[] {"WORLD","WORLD"} (Java syntax) or quoted value "WORLD" "WORLD" (XML syntax).
    • SCALEMODE_DEFAULT_VALUE

      public static final java.util.ArrayList<java.lang.String> SCALEMODE_DEFAULT_VALUE
      MFString field named scaleMode has default quoted value new String[] {"NONE","NONE"} (Java syntax) or quoted value "NONE" "NONE" (XML syntax).
    • SIZE_DEFAULT_VALUE

      public static final java.util.ArrayList<java.lang.Float> SIZE_DEFAULT_VALUE
      MFFloat field named size has default value {1f,1f} (Java syntax) or 1 1 (XML syntax).
    • SIZEUNITS_DEFAULT_VALUE

      public static final java.util.ArrayList<java.lang.String> SIZEUNITS_DEFAULT_VALUE
      MFString field named sizeUnits has default quoted value new String[] {"WORLD","WORLD"} (Java syntax) or quoted value "WORLD" "WORLD" (XML syntax).
    • containerField_DEFAULT_VALUE

      public static final java.lang.String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
    • fromField_ALIGN

      public static final java.lang.String fromField_ALIGN
      fromField ROUTE name for MFString field named align.
      See Also:
      Constant Field Values
    • toField_ALIGN

      public static final java.lang.String toField_ALIGN
      toField ROUTE name for MFString field named align.
      See Also:
      Constant Field Values
    • fromField_IS

      public static final java.lang.String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:
      Constant Field Values
    • fromField_METADATA

      public static final java.lang.String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:
      Constant Field Values
    • toField_METADATA

      public static final java.lang.String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:
      Constant Field Values
    • fromField_OFFSET

      public static final java.lang.String fromField_OFFSET
      fromField ROUTE name for MFFloat field named offset.
      See Also:
      Constant Field Values
    • toField_OFFSET

      public static final java.lang.String toField_OFFSET
      toField ROUTE name for MFFloat field named offset.
      See Also:
      Constant Field Values
    • fromField_OFFSETUNITS

      public static final java.lang.String fromField_OFFSETUNITS
      fromField ROUTE name for MFString field named offsetUnits.
      See Also:
      Constant Field Values
    • toField_OFFSETUNITS

      public static final java.lang.String toField_OFFSETUNITS
      toField ROUTE name for MFString field named offsetUnits.
      See Also:
      Constant Field Values
    • fromField_SCALEMODE

      public static final java.lang.String fromField_SCALEMODE
      fromField ROUTE name for MFString field named scaleMode.
      See Also:
      Constant Field Values
    • toField_SCALEMODE

      public static final java.lang.String toField_SCALEMODE
      toField ROUTE name for MFString field named scaleMode.
      See Also:
      Constant Field Values
    • fromField_SIZEUNITS

      public static final java.lang.String fromField_SIZEUNITS
      fromField ROUTE name for MFString field named sizeUnits.
      See Also:
      Constant Field Values
    • toField_SIZEUNITS

      public static final java.lang.String toField_SIZEUNITS
      toField ROUTE name for MFString field named sizeUnits.
      See Also:
      Constant Field Values
  • Constructor Details

    • LayoutObject

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

      public LayoutObject​(java.lang.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 java.lang.String getElementName()
      Provides name of this element: Layout
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the Layout 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 java.lang.String getFieldType​(java.lang.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:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
    • getAccessType

      public java.lang.String getAccessType​(java.lang.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:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
    • getContainerFieldDefault

      public final java.lang.String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
    • initialize

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

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


      Available enumeration values for string comparison: LEFT_BOTTOM, LEFT_CENTER, LEFT_TOP, CENTER_BOTTOM, CENTER_CENTER, CENTER_TOP, RIGHT_BOTTOM, RIGHT_CENTER, RIGHT_TOP.
      Specified by:
      getAlign in interface Layout
      Returns:
      value of align field
    • getAlignList

      public java.util.ArrayList<java.lang.String> getAlignList()
      Utility method to get ArrayList value of MFString align field, similar to getAlign().
      Returns:
      value of align field
    • setAlign

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

      Warning: authors can only choose from a strict list of enumeration values (LEFT_BOTTOM, LEFT_CENTER, LEFT_TOP, CENTER_BOTTOM, CENTER_CENTER, CENTER_TOP, RIGHT_BOTTOM, RIGHT_CENTER, RIGHT_TOP).

      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".
      Specified by:
      setAlign in interface Layout
      Parameters:
      newValue - is new value for the align field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAlign

      public LayoutObject setAlign​(MFStringObject newValue)
      Assign typed object value to MFString align field, similar to setAlign(String[]).
      Parameters:
      newValue - is new value for the align field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAlign

      public LayoutObject setAlign​(SFStringObject newValue)
      Assign single SFString object value to MFString align field, similar to setAlign(String[]).
      Parameters:
      newValue - is new value for the align field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • setAlign

      public LayoutObject setAlign​(java.lang.String newValue)
      Assign singleton String value to MFString align field, similar to setAlign(String[]).
      Parameters:
      newValue - is new value for the align field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • setAlign

      public LayoutObject setAlign​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString align field, similar to setAlign(String[]).
      Parameters:
      newValue - is new value for the align field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearAlign

      public LayoutObject clearAlign()
      Utility method to clear MFString value of align field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addAlign

      public LayoutObject addAlign​(java.lang.String newValue)
      Add singleton String value to MFString align field.
      Parameters:
      newValue - is new value to add to the align field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • addAlign

      public LayoutObject addAlign​(SFStringObject newValue)
      Add singleton SFStringObject value to MFString align field.
      Parameters:
      newValue - is new value to add to the align field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • getIS

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

      public LayoutObject setIS​(ISObject newValue)
      Accessor method to assign ISObject 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:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • clearIS

      public LayoutObject clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      LayoutObject - 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:
      getIS()
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface Layout
      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:
      getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public LayoutObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface Layout
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DLayoutNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

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

      public LayoutObject setMetadata​(ProtoInstanceObject 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:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(X3DMetadataObject)
    • 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:
      getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • getOffset

      public 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.
      Specified by:
      getOffset in interface Layout
      Returns:
      value of offset field
    • getOffsetList

      public java.util.ArrayList<java.lang.Float> getOffsetList()
      Utility method to get ArrayList value of MFFloat offset field, similar to getOffset().
      Returns:
      value of offset field
    • setOffset

      public LayoutObject 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.
      Specified by:
      setOffset in interface Layout
      Parameters:
      newValue - is new value for the offset field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setOffset

      public LayoutObject setOffset​(MFFloatObject newValue)
      Assign typed object value to MFFloat offset field, similar to setOffset(float[]).
      Parameters:
      newValue - is new value for the offset field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setOffset

      public LayoutObject setOffset​(java.util.ArrayList<java.lang.Float> newValue)
      Assign ArrayList value of MFFloat offset field, similar to setOffset(float[]).
      Parameters:
      newValue - is new value for the offset field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearOffset

      public LayoutObject clearOffset()
      Utility method to clear MFFloat value of offset field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setOffset

      public LayoutObject setOffset​(int[] newValue)
      Assign floating-point array value of MFFloat offset field, similar to setOffset(float[]).
      Parameters:
      newValue - is new value for the offset field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addOffset

      public LayoutObject addOffset​(float newValue)
      Add singleton float value to MFFloat offset field.
      Parameters:
      newValue - is new value to add to the offset field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addOffset

      public LayoutObject addOffset​(SFFloatObject newValue)
      Add singleton SFFloatObject value to MFFloat offset field.
      Parameters:
      newValue - is new value to add to the offset field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setOffset

      public LayoutObject setOffset​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setOffset(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getOffsetUnits

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


      Available enumeration values for string comparison: WORLD_WORLD, WORLD_FRACTION, WORLD_PIXEL, FRACTION_WORLD, FRACTION_FRACTION, FRACTION_PIXEL, PIXEL_WORLD, PIXEL_FRACTION, PIXEL_PIXEL.
      Specified by:
      getOffsetUnits in interface Layout
      Returns:
      value of offsetUnits field
    • getOffsetUnitsList

      public java.util.ArrayList<java.lang.String> getOffsetUnitsList()
      Utility method to get ArrayList value of MFString offsetUnits field, similar to getOffsetUnits().
      Returns:
      value of offsetUnits field
    • setOffsetUnits

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

      Warning: authors can only choose from a strict list of enumeration values (WORLD_WORLD, WORLD_FRACTION, WORLD_PIXEL, FRACTION_WORLD, FRACTION_FRACTION, FRACTION_PIXEL, PIXEL_WORLD, PIXEL_FRACTION, PIXEL_PIXEL).

      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".
      Specified by:
      setOffsetUnits in interface Layout
      Parameters:
      newValue - is new value for the offsetUnits field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setOffsetUnits

      public LayoutObject setOffsetUnits​(MFStringObject newValue)
      Assign typed object value to MFString offsetUnits field, similar to setOffsetUnits(String[]).
      Parameters:
      newValue - is new value for the offsetUnits field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setOffsetUnits

      public LayoutObject setOffsetUnits​(SFStringObject newValue)
      Assign single SFString object value to MFString offsetUnits field, similar to setOffsetUnits(String[]).
      Parameters:
      newValue - is new value for the offsetUnits field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • setOffsetUnits

      public LayoutObject setOffsetUnits​(java.lang.String newValue)
      Assign singleton String value to MFString offsetUnits field, similar to setOffsetUnits(String[]).
      Parameters:
      newValue - is new value for the offsetUnits field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • setOffsetUnits

      public LayoutObject setOffsetUnits​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString offsetUnits field, similar to setOffsetUnits(String[]).
      Parameters:
      newValue - is new value for the offsetUnits field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearOffsetUnits

      public LayoutObject clearOffsetUnits()
      Utility method to clear MFString value of offsetUnits field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addOffsetUnits

      public LayoutObject addOffsetUnits​(java.lang.String newValue)
      Add singleton String value to MFString offsetUnits field.
      Parameters:
      newValue - is new value to add to the offsetUnits field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • addOffsetUnits

      public LayoutObject addOffsetUnits​(SFStringObject newValue)
      Add singleton SFStringObject value to MFString offsetUnits field.
      Parameters:
      newValue - is new value to add to the offsetUnits field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • getScaleMode

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


      Available enumeration values for string comparison: 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.
      Specified by:
      getScaleMode in interface Layout
      Returns:
      value of scaleMode field
    • getScaleModeList

      public java.util.ArrayList<java.lang.String> getScaleModeList()
      Utility method to get ArrayList value of MFString scaleMode field, similar to getScaleMode().
      Returns:
      value of scaleMode field
    • setScaleMode

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

      Warning: authors can only choose from a strict list of enumeration values (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).

      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".
      Specified by:
      setScaleMode in interface Layout
      Parameters:
      newValue - is new value for the scaleMode field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScaleMode

      public LayoutObject setScaleMode​(MFStringObject newValue)
      Assign typed object value to MFString scaleMode field, similar to setScaleMode(String[]).
      Parameters:
      newValue - is new value for the scaleMode field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScaleMode

      public LayoutObject setScaleMode​(SFStringObject newValue)
      Assign single SFString object value to MFString scaleMode field, similar to setScaleMode(String[]).
      Parameters:
      newValue - is new value for the scaleMode field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • setScaleMode

      public LayoutObject setScaleMode​(java.lang.String newValue)
      Assign singleton String value to MFString scaleMode field, similar to setScaleMode(String[]).
      Parameters:
      newValue - is new value for the scaleMode field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • setScaleMode

      public LayoutObject setScaleMode​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString scaleMode field, similar to setScaleMode(String[]).
      Parameters:
      newValue - is new value for the scaleMode field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearScaleMode

      public LayoutObject clearScaleMode()
      Utility method to clear MFString value of scaleMode field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addScaleMode

      public LayoutObject addScaleMode​(java.lang.String newValue)
      Add singleton String value to MFString scaleMode field.
      Parameters:
      newValue - is new value to add to the scaleMode field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • addScaleMode

      public LayoutObject addScaleMode​(SFStringObject newValue)
      Add singleton SFStringObject value to MFString scaleMode field.
      Parameters:
      newValue - is new value to add to the scaleMode field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • getSize

      public 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.
      Specified by:
      getSize in interface Layout
      Returns:
      value of size field
    • getSizeList

      public java.util.ArrayList<java.lang.Float> getSizeList()
      Utility method to get ArrayList value of MFFloat size field, similar to getSize().
      Returns:
      value of size field
    • setSize

      public LayoutObject 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.
      Specified by:
      setSize in interface Layout
      Parameters:
      newValue - is new value for the size field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSize

      public LayoutObject setSize​(MFFloatObject newValue)
      Assign typed object value to MFFloat size field, similar to setSize(float[]).
      Parameters:
      newValue - is new value for the size field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSize

      public LayoutObject setSize​(java.util.ArrayList<java.lang.Float> newValue)
      Assign ArrayList value of MFFloat size field, similar to setSize(float[]).
      Parameters:
      newValue - is new value for the size field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearSize

      public LayoutObject clearSize()
      Utility method to clear MFFloat value of size field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setSize

      public LayoutObject setSize​(int[] newValue)
      Assign floating-point array value of MFFloat size field, similar to setSize(float[]).
      Parameters:
      newValue - is new value for the size field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addSize

      public LayoutObject addSize​(float newValue)
      Add singleton float value to MFFloat size field.
      Parameters:
      newValue - is new value to add to the size field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addSize

      public LayoutObject addSize​(SFFloatObject newValue)
      Add singleton SFFloatObject value to MFFloat size field.
      Parameters:
      newValue - is new value to add to the size field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSize

      public LayoutObject setSize​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSize(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSizeUnits

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


      Available enumeration values for string comparison: WORLD_WORLD, WORLD_FRACTION, WORLD_PIXEL, FRACTION_WORLD, FRACTION_FRACTION, FRACTION_PIXEL, PIXEL_WORLD, PIXEL_FRACTION, PIXEL_PIXEL.
      Specified by:
      getSizeUnits in interface Layout
      Returns:
      value of sizeUnits field
    • getSizeUnitsList

      public java.util.ArrayList<java.lang.String> getSizeUnitsList()
      Utility method to get ArrayList value of MFString sizeUnits field, similar to getSizeUnits().
      Returns:
      value of sizeUnits field
    • setSizeUnits

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

      Warning: authors can only choose from a strict list of enumeration values (WORLD_WORLD, WORLD_FRACTION, WORLD_PIXEL, FRACTION_WORLD, FRACTION_FRACTION, FRACTION_PIXEL, PIXEL_WORLD, PIXEL_FRACTION, PIXEL_PIXEL).

      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".
      Specified by:
      setSizeUnits in interface Layout
      Parameters:
      newValue - is new value for the sizeUnits field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSizeUnits

      public LayoutObject setSizeUnits​(MFStringObject newValue)
      Assign typed object value to MFString sizeUnits field, similar to setSizeUnits(String[]).
      Parameters:
      newValue - is new value for the sizeUnits field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSizeUnits

      public LayoutObject setSizeUnits​(SFStringObject newValue)
      Assign single SFString object value to MFString sizeUnits field, similar to setSizeUnits(String[]).
      Parameters:
      newValue - is new value for the sizeUnits field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • setSizeUnits

      public LayoutObject setSizeUnits​(java.lang.String newValue)
      Assign singleton String value to MFString sizeUnits field, similar to setSizeUnits(String[]).
      Parameters:
      newValue - is new value for the sizeUnits field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • setSizeUnits

      public LayoutObject setSizeUnits​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString sizeUnits field, similar to setSizeUnits(String[]).
      Parameters:
      newValue - is new value for the sizeUnits field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearSizeUnits

      public LayoutObject clearSizeUnits()
      Utility method to clear MFString value of sizeUnits field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addSizeUnits

      public LayoutObject addSizeUnits​(java.lang.String newValue)
      Add singleton String value to MFString sizeUnits field.
      Parameters:
      newValue - is new value to add to the sizeUnits field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • addSizeUnits

      public LayoutObject addSizeUnits​(SFStringObject newValue)
      Add singleton SFStringObject value to MFString sizeUnits field.
      Parameters:
      newValue - is new value to add to the sizeUnits field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • getDEF

      public java.lang.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:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

      public final LayoutObject setDEF​(java.lang.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:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

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

      public java.lang.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:
      X3D Scene Authoring Hints: Naming Conventions
    • setUSE

      public final LayoutObject setUSE​(java.lang.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:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

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

      public java.lang.String getCssClass()
      Provide String value from inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final LayoutObject setCssClass​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

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

      public LayoutObject setUSE​(LayoutObject 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:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

      public LayoutObject addComments​(java.lang.String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public LayoutObject addComments​(java.lang.String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public LayoutObject addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      LayoutObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • toStringX3D

      public java.lang.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:
      X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • toStringClassicVRML

      public java.lang.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:
      X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
    • toStringVRML97

      public java.lang.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:
      X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • hasElementByNameValue

      public boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.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:
      findElementByNameValue(String, String)
    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF​(java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • hasNodeByDEF

      public boolean hasNodeByDEF​(java.lang.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:
      findNodeByDEF(String)
    • validate

      public java.lang.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.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)