Package org.web3d.x3d.jsail.Layout
Class LayoutGroupObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Layout.LayoutGroupObject
- All Implemented Interfaces:
X3DChildNode
,X3DNode
,X3DBoundedObject
,X3DGroupingNode
,LayoutGroup
public class LayoutGroupObject extends X3DConcreteNode implements LayoutGroup
LayoutGroup is a Grouping node that can contain most nodes, whose children are related by a common layout within a parent layout.
X3D node tooltip: (X3D version 3.2 or later) [X3DGroupingNode,X3DVisibleObject] LayoutGroup is a Grouping node that can contain most nodes, whose children are related by a common layout within a parent layout. The layout field contains an X3DLayoutNode node that provides the information required to locate and size the layout region of the LayoutGroup node relative to its parent’s layout region. LayoutGroup content is clipped by the specified viewport node.
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.
X3D node tooltip: (X3D version 3.2 or later) [X3DGroupingNode,X3DVisibleObject] LayoutGroup is a Grouping node that can contain most nodes, whose children are related by a common layout within a parent layout. The layout field contains an X3DLayoutNode node that provides the information required to locate and size the layout region of the LayoutGroup node relative to its parent’s layout region. LayoutGroup content is clipped by the specified viewport node.
- Hint: The origin of the node is always in the center of its layout region. Thus, children (with the exception of LayoutGroup) are specified in a coordinate system whose origin is located at the center of the rectangle and can be transformed from that location.
- Warning: a LayoutGroup can only be a child of a LayoutLayer node or another LayoutGroup node.
- Hint: insert a Shape node before adding geometry or Appearance.
- Hint: LayoutGroup does not directly have any pixel-dependent concepts. However, it can contain a Layout node that does have pixel-specific options.
Package hint: This 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.
-
Field Summary
Fields Modifier and Type Field Description static float[]
BBOXCENTER_DEFAULT_VALUE
SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static boolean
BBOXDISPLAY_DEFAULT_VALUE
SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).static float[]
BBOXSIZE_DEFAULT_VALUE
SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the LayoutGroup element: Layoutstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static java.lang.String
fromField_BBOXDISPLAY
fromField ROUTE name for SFBool field named bboxDisplay.static java.lang.String
fromField_CHILDREN
fromField ROUTE name for MFNode field named children.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_LAYOUT
fromField ROUTE name for SFNode field named layout.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_VIEWPORT
fromField ROUTE name for SFNode field named viewport.static java.lang.String
fromField_VISIBLE
fromField ROUTE name for SFBool field named visible.static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static X3DLayoutNode
LAYOUT_DEFAULT_VALUE
SFNode field named layout has default value null (Java syntax) or NULL (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D Layout component level for this element: 1static 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: LayoutGroup.static java.lang.String
toField_ADDCHILDREN
toField ROUTE name for MFNode field named addChildren.static java.lang.String
toField_BBOXDISPLAY
toField ROUTE name for SFBool field named bboxDisplay.static java.lang.String
toField_CHILDREN
toField ROUTE name for MFNode field named children.static java.lang.String
toField_LAYOUT
toField ROUTE name for SFNode field named layout.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_REMOVECHILDREN
toField ROUTE name for MFNode field named removeChildren.static java.lang.String
toField_VIEWPORT
toField ROUTE name for SFNode field named viewport.static java.lang.String
toField_VISIBLE
toField ROUTE name for SFBool field named visible.static X3DViewportNode
VIEWPORT_DEFAULT_VALUE
SFNode field named viewport has default value null (Java syntax) or NULL (XML syntax).static boolean
VISIBLE_DEFAULT_VALUE
SFBool field named visible has default value true (Java syntax) or true (XML syntax).Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description LayoutGroupObject()
Constructor for LayoutGroupObject to initialize member variables with default values.LayoutGroupObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description LayoutGroupObject
addChild(X3DChildNode newValue)
Utility method to add single child element to contained list of existing children nodes (if any).LayoutGroupObject
addChildren(ProtoInstanceObject newValue)
Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for children field.void
addChildren(X3DNode newValue)
Add single node to existing array of children nodes (if any).void
addChildren(X3DNode[] newValue)
Add array of children nodes to array of existing nodes (if any).LayoutGroupObject
addComments(java.lang.String newComment)
Add comment as CommentsBlock to children fieldLayoutGroupObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to children fieldLayoutGroupObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to children fieldLayoutGroupObject
clearChildren()
Utility method to clear MFNode value of children field.LayoutGroupObject
clearIS()
Utility method to clear SFNode value of IS field.LayoutGroupObject
clearLayout()
Utility method to clear SFNode value of layout field.LayoutGroupObject
clearMetadata()
Utility method to clear SFNode value of metadata field.LayoutGroupObject
clearViewport()
Utility method to clear SFNode value of viewport 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.float[]
getBboxCenter()
Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.boolean
getBboxDisplay()
Provide boolean value from inputOutput SFBool field named bboxDisplay.float[]
getBboxSize()
Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.X3DNode[]
getChildren()
Provide array of X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.java.util.ArrayList<X3DNode>
getChildrenList()
Utility method to get ArrayList value of MFNode children field, similar togetChildren()
.java.lang.String
getComponent()
Defines X3D component for the LayoutGroup element: Layoutint
getComponentLevel()
Provides default X3D component level for this element: 1java.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: LayoutGroupjava.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.X3DLayoutNode
getLayout()
Provide X3DLayoutNode instance (using a properly typed node) from inputOutput SFNode field layout.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.java.lang.String
getUSE()
Provide String value from inputOutput SFString field named USE.X3DViewportNode
getViewport()
Provide X3DViewportNode instance (using a properly typed node) from inputOutput SFNode field viewport.boolean
getVisible()
Provide boolean value from inputOutput SFBool field named visible.boolean
hasChildren()
Indicate whether an object is available for inputOutput MFNode field children.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
hasLayout()
Indicate whether an object is available for inputOutput SFNode field layout.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.boolean
hasViewport()
Indicate whether an object is available for inputOutput SFNode field viewport.void
initialize()
Initialize all member variables to default values.LayoutGroupObject
setBboxCenter(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.LayoutGroupObject
setBboxCenter(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.LayoutGroupObject
setBboxCenter(float[] newValue)
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.LayoutGroupObject
setBboxCenter(float x, float y, float z)
Assign values to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.LayoutGroupObject
setBboxCenter(SFVec3fObject newValue)
Assign typed object value to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.LayoutGroupObject
setBboxDisplay(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.LayoutGroupObject
setBboxDisplay(SFBoolObject newValue)
Assign typed object value to SFBool bboxDisplay field, similar tosetBboxDisplay(boolean)
.LayoutGroupObject
setBboxSize(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxSize(float[])
.LayoutGroupObject
setBboxSize(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxSize(float[])
.LayoutGroupObject
setBboxSize(float[] newValue)
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.LayoutGroupObject
setBboxSize(float x, float y, float z)
Assign values to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.LayoutGroupObject
setBboxSize(SFVec3fObject newValue)
Assign typed object value to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.LayoutGroupObject
setChildren(java.util.ArrayList<X3DChildNode> newValue)
Assign ArrayList value of MFNode children field, similar tosetChildren(X3DNode[])
.void
setChildren(X3DNode newValue)
Set single children node, replacing prior array of existing nodes (if any).LayoutGroupObject
setChildren(X3DNode[] newValue)
Accessor method to assign X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.LayoutGroupObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.LayoutGroupObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.LayoutGroupObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.LayoutGroupObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.LayoutGroupObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.LayoutGroupObject
setLayout(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field layout.LayoutGroupObject
setLayout(X3DLayoutNode newValue)
Accessor method to assign X3DLayoutNode instance (using a properly typed node) to inputOutput SFNode field layout.LayoutGroupObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.LayoutGroupObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.LayoutGroupObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.LayoutGroupObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.LayoutGroupObject
setUSE(LayoutGroupObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.LayoutGroupObject
setViewport(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field viewport.LayoutGroupObject
setViewport(X3DViewportNode newValue)
Accessor method to assign X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.LayoutGroupObject
setVisible(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named visible.LayoutGroupObject
setVisible(SFBoolObject newValue)
Assign typed object value to SFBool visible field, similar tosetVisible(boolean)
.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 org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: LayoutGroup.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the LayoutGroup element: Layout- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Layout component level for this element: 1- See Also:
- Constant Field Values
-
BBOXCENTER_DEFAULT_VALUE
public static final float[] BBOXCENTER_DEFAULT_VALUESFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
BBOXDISPLAY_DEFAULT_VALUE
public static final boolean BBOXDISPLAY_DEFAULT_VALUESFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).- See Also:
- Constant Field Values
-
BBOXSIZE_DEFAULT_VALUE
public static final float[] BBOXSIZE_DEFAULT_VALUESFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax). -
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
LAYOUT_DEFAULT_VALUE
SFNode field named layout has default value null (Java syntax) or NULL (XML syntax). -
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
VIEWPORT_DEFAULT_VALUE
SFNode field named viewport has default value null (Java syntax) or NULL (XML syntax). -
VISIBLE_DEFAULT_VALUE
public static final boolean VISIBLE_DEFAULT_VALUESFBool field named visible has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField 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. -
toField_ADDCHILDREN
public static final java.lang.String toField_ADDCHILDRENtoField ROUTE name for MFNode field named addChildren.- See Also:
- Constant Field Values
-
fromField_BBOXDISPLAY
public static final java.lang.String fromField_BBOXDISPLAYfromField ROUTE name for SFBool field named bboxDisplay.- See Also:
- Constant Field Values
-
toField_BBOXDISPLAY
public static final java.lang.String toField_BBOXDISPLAYtoField ROUTE name for SFBool field named bboxDisplay.- See Also:
- Constant Field Values
-
fromField_CHILDREN
public static final java.lang.String fromField_CHILDRENfromField ROUTE name for MFNode field named children.- See Also:
- Constant Field Values
-
toField_CHILDREN
public static final java.lang.String toField_CHILDRENtoField ROUTE name for MFNode field named children.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_LAYOUT
public static final java.lang.String fromField_LAYOUTfromField ROUTE name for SFNode field named layout.- See Also:
- Constant Field Values
-
toField_LAYOUT
public static final java.lang.String toField_LAYOUTtoField ROUTE name for SFNode field named layout.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_REMOVECHILDREN
public static final java.lang.String toField_REMOVECHILDRENtoField ROUTE name for MFNode field named removeChildren.- See Also:
- Constant Field Values
-
fromField_VIEWPORT
public static final java.lang.String fromField_VIEWPORTfromField ROUTE name for SFNode field named viewport.- See Also:
- Constant Field Values
-
toField_VIEWPORT
public static final java.lang.String toField_VIEWPORTtoField ROUTE name for SFNode field named viewport.- See Also:
- Constant Field Values
-
fromField_VISIBLE
public static final java.lang.String fromField_VISIBLEfromField ROUTE name for SFBool field named visible.- See Also:
- Constant Field Values
-
toField_VISIBLE
public static final java.lang.String toField_VISIBLEtoField ROUTE name for SFBool field named visible.- See Also:
- Constant Field Values
-
-
Constructor Details
-
LayoutGroupObject
public LayoutGroupObject()Constructor for LayoutGroupObject to initialize member variables with default values. -
LayoutGroupObject
public LayoutGroupObject(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: LayoutGroup- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the LayoutGroup element: Layout- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevel
in classX3DConcreteElement
- 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 classX3DConcreteElement
- 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 classX3DConcreteElement
- 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 classX3DConcreteNode
- 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 classX3DConcreteNode
-
getBboxCenter
public float[] getBboxCenter()Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.- Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
- Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
getBboxCenter
in interfaceLayoutGroup
- Specified by:
getBboxCenter
in interfaceX3DBoundedObject
- Specified by:
getBboxCenter
in interfaceX3DGroupingNode
- Returns:
- value of bboxCenter field
-
setBboxCenter
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.- Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
- Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
setBboxCenter
in interfaceLayoutGroup
- Specified by:
setBboxCenter
in interfaceX3DBoundedObject
- Specified by:
setBboxCenter
in interfaceX3DGroupingNode
- Parameters:
newValue
- is new value for the bboxCenter field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Assign typed object value to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.- Parameters:
newValue
- is new value for the bboxCenter field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Assign values to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.- Parameters:
newArray
- is new value for field- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBboxDisplay
public boolean getBboxDisplay()Provide boolean value from inputOutput SFBool field named bboxDisplay.
Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.- Hint: the bounding box is displayed regardless of whether contained content is visible.
- Specified by:
getBboxDisplay
in interfaceLayoutGroup
- Specified by:
getBboxDisplay
in interfaceX3DBoundedObject
- Specified by:
getBboxDisplay
in interfaceX3DGroupingNode
- Returns:
- value of bboxDisplay field
-
setBboxDisplay
Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.- Hint: the bounding box is displayed regardless of whether contained content is visible.
- Specified by:
setBboxDisplay
in interfaceLayoutGroup
- Specified by:
setBboxDisplay
in interfaceX3DBoundedObject
- Specified by:
setBboxDisplay
in interfaceX3DGroupingNode
- Parameters:
newValue
- is new value for the bboxDisplay field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxDisplay
Assign typed object value to SFBool bboxDisplay field, similar tosetBboxDisplay(boolean)
.- Parameters:
newValue
- is new value for the bboxDisplay field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBboxSize
public float[] getBboxSize()Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.- Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
- Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
- Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
getBboxSize
in interfaceLayoutGroup
- Specified by:
getBboxSize
in interfaceX3DBoundedObject
- Specified by:
getBboxSize
in interfaceX3DGroupingNode
- Returns:
- value of bboxSize field
-
setBboxSize
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.- Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
- Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
- Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
setBboxSize
in interfaceLayoutGroup
- Specified by:
setBboxSize
in interfaceX3DBoundedObject
- Specified by:
setBboxSize
in interfaceX3DGroupingNode
- Parameters:
newValue
- is new value for the bboxSize field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Assign typed object value to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.- Parameters:
newValue
- is new value for the bboxSize field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Assign values to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxSize(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxSize(float[])
.- Parameters:
newArray
- is new value for field- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getChildren
Provide array of X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.
Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.- Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
- Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
- Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
- Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.- Specified by:
getChildren
in interfaceLayoutGroup
- Specified by:
getChildren
in interfaceX3DGroupingNode
- Returns:
- value of children field
- See Also:
X3DChildNode
-
getChildrenList
Utility method to get ArrayList value of MFNode children field, similar togetChildren()
.- Returns:
- value of children field
-
setChildren
Accessor method to assign X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.- Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
- Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
- Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
- Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.- Specified by:
setChildren
in interfaceLayoutGroup
- Specified by:
setChildren
in interfaceX3DGroupingNode
- Parameters:
newValue
- is new value for the children field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setChildren
Assign ArrayList value of MFNode children field, similar tosetChildren(X3DNode[])
.- Parameters:
newValue
- is new value for the children field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addChildren
Add single node to existing array of children nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode and ProtoInstance.- Parameters:
newValue
- is new value to be appended the children field.
-
addChildren
Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for children field.
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.- Parameters:
newValue
- is new value to be appended the parts field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addChild
Utility method to add single child element to contained list of existing children nodes (if any).- Parameters:
newValue
- is new node value to be appended the children field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addChildren
Add array of children nodes to array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.- Specified by:
addChildren
in interfaceLayoutGroup
- Specified by:
addChildren
in interfaceX3DGroupingNode
- Parameters:
newValue
- is new value array to be appended the children field.
-
setChildren
Set single children node, replacing prior array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DChildNode.- Specified by:
setChildren
in interfaceLayoutGroup
- Specified by:
setChildren
in interfaceX3DGroupingNode
- Parameters:
newValue
- is new node for the children field (restricted to X3DChildNode)
-
clearChildren
Utility method to clear MFNode value of children field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasChildren
public boolean hasChildren()Indicate whether an object is available for inputOutput MFNode field children.- Returns:
- whether a properly typed node or ProtoInstance array or CommentsBlock is available.
- See Also:
getChildren()
-
addComments
Add comment as CommentsBlock to children field- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to children field- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to children field- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
LayoutGroupObject
- 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
Utility method to clear SFNode value of IS field.- Returns:
LayoutGroupObject
- 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()
-
getLayout
Provide X3DLayoutNode instance (using a properly typed node) from inputOutput SFNode field layout.- Specified by:
getLayout
in interfaceLayoutGroup
- Returns:
- value of layout field
- See Also:
Tooltip: [X3DLayoutNode] The layout field contains an X3DLayoutNode node that provides the information required to locate and size the layout region of the LayoutGroup node relative to its parent’s layout region, and also to scale the contents of the LayoutGroup. *
-
setLayout
Accessor method to assign X3DLayoutNode instance (using a properly typed node) to inputOutput SFNode field layout.- Specified by:
setLayout
in interfaceLayoutGroup
- Parameters:
newValue
- is new value for the layout field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DLayoutNode] The layout field contains an X3DLayoutNode node that provides the information required to locate and size the layout region of the LayoutGroup node relative to its parent’s layout region, and also to scale the contents of the LayoutGroup. *
-
clearLayout
Utility method to clear SFNode value of layout field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setLayout
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field layout.- Parameters:
newValue
- is new value for the layout field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setLayout(X3DLayoutNode)
-
hasLayout
public boolean hasLayout()Indicate whether an object is available for inputOutput SFNode field layout.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getLayout()
,getLayoutProtoInstance()
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceLayoutGroup
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DGroupingNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceLayoutGroup
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DGroupingNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
LayoutGroupObject
- 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
-
getViewport
Provide X3DViewportNode instance (using a properly typed node) from inputOutput SFNode field viewport.- Specified by:
getViewport
in interfaceLayoutGroup
- Returns:
- value of viewport field
- See Also:
Tooltip: [X3DViewportNode] The content of the LayoutGroup is clipped by the specified viewport. *
-
setViewport
Accessor method to assign X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.- Specified by:
setViewport
in interfaceLayoutGroup
- Parameters:
newValue
- is new value for the viewport field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DViewportNode] The content of the LayoutGroup is clipped by the specified viewport. *
-
clearViewport
Utility method to clear SFNode value of viewport field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setViewport
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field viewport.- Parameters:
newValue
- is new value for the viewport field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setViewport(X3DViewportNode)
-
hasViewport
public boolean hasViewport()Indicate whether an object is available for inputOutput SFNode field viewport.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getViewport()
,getViewportProtoInstance()
-
getVisible
public boolean getVisible()Provide boolean value from inputOutput SFBool field named visible.
Tooltip: Whether or not renderable content within this node is visually displayed.- Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
- Hint: content must be visible to be collidable and to be pickable.
- Specified by:
getVisible
in interfaceLayoutGroup
- Specified by:
getVisible
in interfaceX3DBoundedObject
- Specified by:
getVisible
in interfaceX3DGroupingNode
- Returns:
- value of visible field
-
setVisible
Accessor method to assign boolean value to inputOutput SFBool field named visible.
Tooltip: Whether or not renderable content within this node is visually displayed.- Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
- Hint: content must be visible to be collidable and to be pickable.
- Specified by:
setVisible
in interfaceLayoutGroup
- Specified by:
setVisible
in interfaceX3DBoundedObject
- Specified by:
setVisible
in interfaceX3DGroupingNode
- Parameters:
newValue
- is new value for the visible field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setVisible
Assign typed object value to SFBool visible field, similar tosetVisible(boolean)
.- Parameters:
newValue
- is new value for the visible field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
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.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
LayoutGroupObject
- 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 classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
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: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
LayoutGroupObject
- 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 classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
LayoutGroupObject
- 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
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
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:
LayoutGroupObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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 classX3DConcreteElement
- 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 classX3DConcreteElement
- 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 classX3DConcreteElement
- 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
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 classX3DConcreteElement
- 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 classX3DConcreteElement
- 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
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 classX3DConcreteElement
- 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 classX3DConcreteElement
- Returns:
- validation results (if any)
-