Class PickableGroup
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Picking.PickableGroup
- All Implemented Interfaces:
X3DChildNode
,X3DNode
,X3DBoundedObject
,X3DGroupingNode
,PickableGroup
,X3DPickableObject
PickableGroup is a Grouping node that can contain most nodes.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
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.
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
PickableGroup node tooltip: (X3D version 3.2 or later) [X3DGroupingNode,X3DPickableObject,X3DVisibleObject] PickableGroup is a Grouping node that can contain most nodes. PickableGroup contains children that are marked as having a given classification of picking types, and can also enable or disable picking of the children.
- Hint: insert a Shape node before adding geometry or Appearance.
- Hint: content must be visible to be collidable and to be pickable.
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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final float[]
SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static final boolean
SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).static final float[]
SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).static final String
String constant COMPONENT defines X3D component for the PickableGroup element: Pickingstatic final String
containerField describes typical field relationship of a node to its parent.static final String
SFString field named description has default value equal to an empty string.static final String
fromField ROUTE name for SFBool field named bboxDisplay.static final String
fromField ROUTE name for MFNode field named children.static final String
fromField ROUTE name for SFString field named description.static final String
fromField ROUTE name for SFNode field named IS.static final String
fromField ROUTE name for SFNode field named metadata.static final String
fromField ROUTE name for MFString field named objectType.static final String
fromField ROUTE name for SFBool field named pickable.static final String
fromField ROUTE name for SFBool field named visible.static final IS
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static final int
Integer constant LEVEL provides default X3D Picking component level for this element: 1static final X3DMetadataObject
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static final String
String constant NAME provides name of this element: PickableGroup.static final String
Tooltip: each node is available for picking.MFString field named objectType has default quoted value new String[] {"ALL"} (Java syntax) or quoted value "ALL" (XML syntax).static final String
Tooltip: no node is available for picking.static final String
Tooltip: TERRAIN is an example value.static final boolean
SFBool field named pickable has default value true (Java syntax) or true (XML syntax).static final String
toField ROUTE name for MFNode field named addChildren.static final String
toField ROUTE name for SFBool field named bboxDisplay.static final String
toField ROUTE name for MFNode field named children.static final String
toField ROUTE name for SFString field named description.static final String
toField ROUTE name for SFNode field named metadata.static final String
toField ROUTE name for MFString field named objectType.static final String
toField ROUTE name for SFBool field named pickable.static final String
toField ROUTE name for MFNode field named removeChildren.static final String
toField ROUTE name for SFBool field named visible.static final boolean
SFBool field named visible has default value true (Java syntax) or true (XML syntax).Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult
-
Constructor Summary
ConstructorDescriptionConstructor for PickableGroup to initialize member variables with default values.PickableGroup
(String DEFlabel) Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and TypeMethodDescriptionaddChild
(X3DChildNode newValue) Utility method to add single child element to contained list of existing children nodes (if any).addChildren
(ProtoInstance newValue) Add single ProtoInstance (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).addComments
(String newComment) Add comment as CommentsBlock to children fieldaddComments
(String[] newComments) Add comments as String[] array to children fieldaddComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to children fieldaddObjectType
(String newValue) Add singleton String value to MFString objectType field.addObjectType
(SFString newValue) Add singleton SFString value to MFString objectType field.Utility method to clear MFNode value of children field.clearIS()
Utility method to clear SFNode value of IS field.Utility method to clear SFNode value of metadata field.Utility method to clear MFString value of objectType field.findElementByNameValue
(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.findElementByNameValue
(String nameValue, 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.findNodeByDEF
(String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.getAccessType
(String fieldName) Indicate accessType corresponding to given fieldName.float[]
Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.boolean
Provide boolean value from inputOutput SFBool field named bboxDisplay.float[]
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[]
Provide array of org.web3d.x3d.sai.Core.X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.Utility method to get ArrayList value of MFNode children field, similar togetChildren()
.final String
Defines X3D component for the PickableGroup element: Pickingfinal int
Provides default X3D component level for this element: 1final String
containerField describes typical field relationship of a node to its parent.Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.getDEF()
Provide String value from inputOutput SFString field named DEF.Provide String value from inputOutput SFString field named description.final String
Provides name of this element: PickableGroupgetFieldType
(String fieldName) Indicate type corresponding to given fieldName.Provide String value from inputOutput SFString field named id.getIS()
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.String[]
Provide array of String enumeration results with quoted value(s) ["ALL","NONE","TERRAIN",...] from inputOutput MFString field named objectType.Utility method to get ArrayList value of MFString objectType field, similar togetObjectType()
.Utility method to get String value of MFString objectType field, similar togetObjectType()
.boolean
Provide boolean value from inputOutput SFBool field named pickable.getUSE()
Provide String value from inputOutput SFString field named USE.boolean
Provide boolean value from inputOutput SFBool field named visible.boolean
Indicate whether an object is available for inputOutput MFNode field children.boolean
hasElementByNameValue
(String nameValue, 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
Indicate whether an object is available for inputOutput SFNode field metadata.boolean
hasNodeByDEF
(String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.final void
Initialize all member variables to default values.setBboxCenter
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.setBboxCenter
(double x, double y, double z) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.setBboxCenter
(float[] newValue) Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.setBboxCenter
(float x, float y, float z) Assign values to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.setBboxCenter
(SFVec3f newValue) Assign typed object value to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.setBboxDisplay
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.setBboxDisplay
(SFBool newValue) Assign typed object value to SFBool bboxDisplay field, similar tosetBboxDisplay(boolean)
.setBboxSize
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxSize(float[])
.setBboxSize
(double x, double y, double z) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxSize(float[])
.setBboxSize
(float[] newValue) Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.setBboxSize
(float x, float y, float z) Assign values to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.setBboxSize
(SFVec3f newValue) Assign typed object value to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.setChildren
(ArrayList<X3DChildNode> newValue) Assign ArrayList value of MFNode children field, similar tosetChildren(org.web3d.x3d.sai.Core.X3DNode[])
.void
setChildren
(X3DNode newValue) Set single children node, replacing prior array of existing nodes (if any).setChildren
(X3DNode[] newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.final PickableGroup
setCssClass
(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.final PickableGroup
setCssStyle
(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.final PickableGroup
Accessor method to assign String value to inputOutput SFString field named DEF.Assign typed object value to SFString DEF field, similar tosetDEF(String)
.setDescription
(String newValue) Accessor method to assign String value to inputOutput SFString field named description.setDescription
(SFString newValue) Assign typed object value to SFString description field, similar tosetDescription(String)
.final PickableGroup
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.setMetadata
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setObjectType
(String newValue) Assign singleton String value to MFString objectType field, similar tosetObjectType(String[])
.setObjectType
(String[] newValue) Accessor method to assign String enumeration array (""ALL"" | ""NONE"" | ""TERRAIN"") to inputOutput MFString field named objectType.setObjectType
(ArrayList<String> newValue) Assign ArrayList value of MFString objectType field, similar tosetObjectType(String[])
.setObjectType
(MFString newValue) Assign typed object value to MFString objectType field, similar tosetObjectType(String[])
.setObjectType
(SFString newValue) Assign single SFString object value to MFString objectType field, similar tosetObjectType(String[])
.setPickable
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named pickable.setPickable
(SFBool newValue) Assign typed object value to SFBool pickable field, similar tosetPickable(boolean)
.final PickableGroup
Accessor method to assign String value to inputOutput SFString field named USE.Assign typed object value to SFString USE field, similar tosetUSE(String)
.setUSE
(PickableGroup DEFnode) Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.setVisible
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named visible.setVisible
(SFBool newValue) Assign typed object value to SFBool visible field, similar tosetVisible(boolean)
.toStringClassicVRML
(int indentLevel) Recursive method to provide ClassicVRML string serialization.toStringVRML97
(int indentLevel) Recursive method to provide VRML97 string serialization.toStringX3D
(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.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
getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
OBJECTTYPE_ALL
Tooltip: each node is available for picking. MFString field named objectType with X3DUOM simpleType pickableObjectTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ALL" (Java syntax) or '"ALL"' (XML syntax).- See Also:
-
OBJECTTYPE_NONE
Tooltip: no node is available for picking. MFString field named objectType with X3DUOM simpleType pickableObjectTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "NONE" (Java syntax) or '"NONE"' (XML syntax).- See Also:
-
OBJECTTYPE_TERRAIN
Tooltip: TERRAIN is an example value. MFString field named objectType with X3DUOM simpleType pickableObjectTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "TERRAIN" (Java syntax) or '"TERRAIN"' (XML syntax).- See Also:
-
NAME
String constant NAME provides name of this element: PickableGroup.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the PickableGroup element: Picking- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Picking component level for this element: 1- See Also:
-
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:
-
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). -
DESCRIPTION_DEFAULT_VALUE
SFString field named description has default value equal to an empty string.- See Also:
-
IS_DEFAULT_VALUE
SFNode field named IS 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). -
OBJECTTYPE_DEFAULT_VALUE
-
PICKABLE_DEFAULT_VALUE
public static final boolean PICKABLE_DEFAULT_VALUESFBool field named pickable has default value true (Java syntax) or true (XML syntax).- See Also:
-
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:
-
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "children";
containerField_ALLOWED_VALUES = {"children" }; type xs:NMTOKEN- See Also:
-
toField_ADDCHILDREN
toField ROUTE name for MFNode field named addChildren.- See Also:
-
fromField_BBOXDISPLAY
fromField ROUTE name for SFBool field named bboxDisplay.- See Also:
-
toField_BBOXDISPLAY
toField ROUTE name for SFBool field named bboxDisplay.- See Also:
-
fromField_CHILDREN
fromField ROUTE name for MFNode field named children.- See Also:
-
toField_CHILDREN
toField ROUTE name for MFNode field named children.- See Also:
-
fromField_DESCRIPTION
fromField ROUTE name for SFString field named description.- See Also:
-
toField_DESCRIPTION
toField ROUTE name for SFString field named description.- See Also:
-
fromField_IS
-
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.- See Also:
-
toField_METADATA
toField ROUTE name for SFNode field named metadata.- See Also:
-
fromField_OBJECTTYPE
fromField ROUTE name for MFString field named objectType.- See Also:
-
toField_OBJECTTYPE
toField ROUTE name for MFString field named objectType.- See Also:
-
fromField_PICKABLE
fromField ROUTE name for SFBool field named pickable.- See Also:
-
toField_PICKABLE
toField ROUTE name for SFBool field named pickable.- See Also:
-
toField_REMOVECHILDREN
toField ROUTE name for MFNode field named removeChildren.- See Also:
-
fromField_VISIBLE
fromField ROUTE name for SFBool field named visible.- See Also:
-
toField_VISIBLE
toField ROUTE name for SFBool field named visible.- See Also:
-
-
Constructor Details
-
PickableGroup
public PickableGroup()Constructor for PickableGroup to initialize member variables with default values. -
PickableGroup
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
Provides name of this element: PickableGroup- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the PickableGroup element: Picking- 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
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:
-
getAccessType
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:
-
getContainerFieldDefault
containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
-
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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject
- Specified by:
getBboxCenter
in interfacePickableGroup
- 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject
- Specified by:
setBboxCenter
in interfacePickableGroup
- Specified by:
setBboxCenter
in interfaceX3DBoundedObject
- Specified by:
setBboxCenter
in interfaceX3DGroupingNode
- Parameters:
newValue
- is new value for the bboxCenter field.- Returns:
PickableGroup
- 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:
PickableGroup
- 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:
PickableGroup
- 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:
PickableGroup
- 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:
PickableGroup
- 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 interfacePickableGroup
- 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 interfacePickableGroup
- Specified by:
setBboxDisplay
in interfaceX3DBoundedObject
- Specified by:
setBboxDisplay
in interfaceX3DGroupingNode
- Parameters:
newValue
- is new value for the bboxDisplay field.- Returns:
PickableGroup
- 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:
PickableGroup
- 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: or [0,+infinity) Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.- 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject
- Specified by:
getBboxSize
in interfacePickableGroup
- 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: or [0,+infinity) Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.- 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/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject
- Specified by:
setBboxSize
in interfacePickableGroup
- Specified by:
setBboxSize
in interfaceX3DBoundedObject
- Specified by:
setBboxSize
in interfaceX3DGroupingNode
- Parameters:
newValue
- is new value for the bboxSize field.- Returns:
PickableGroup
- 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:
PickableGroup
- 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:
PickableGroup
- 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:
PickableGroup
- 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:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getChildren
Provide array of org.web3d.x3d.sai.Core.X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.
Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.- Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
- Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
- Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
- Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#GroupingAndChildrenNodes
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.- Specified by:
getChildren
in interfacePickableGroup
- Specified by:
getChildren
in interfaceX3DGroupingNode
- Returns:
- value of children field
- See Also:
-
getChildrenList
Utility method to get ArrayList value of MFNode children field, similar togetChildren()
.- Returns:
- value of children field
-
setChildren
Accessor method to assign org.web3d.x3d.sai.Core.X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.
Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.- Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
- Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
- Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
- Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#GroupingAndChildrenNodes
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode.- Specified by:
setChildren
in interfacePickableGroup
- Specified by:
setChildren
in interfaceX3DGroupingNode
- Parameters:
newValue
- is new value for the children field.- Returns:
PickableGroup
- 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(org.web3d.x3d.sai.Core.X3DNode[])
.- Parameters:
newValue
- is new value for the children field.- Returns:
PickableGroup
- 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 ProtoInstance (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:
PickableGroup
- 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:
PickableGroup
- 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 interfacePickableGroup
- 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 interfacePickableGroup
- 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. This method does not initialize withCHILDREN_DEFAULT_VALUE.- Returns:
PickableGroup
- 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:
-
addComments
Add comment as CommentsBlock to children field- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
PickableGroup
- 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:
PickableGroup
- 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:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDescription
Provide String value from inputOutput SFString field named description.
Tooltip: Author-provided prose that describes intended purpose of the node.- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Specified by:
getDescription
in interfacePickableGroup
- Returns:
- value of description field
-
setDescription
Accessor method to assign String value to inputOutput SFString field named description.
Tooltip: Author-provided prose that describes intended purpose of the node.- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Specified by:
setDescription
in interfacePickableGroup
- Parameters:
newValue
- is new value for the description field.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDescription
Assign typed object value to SFString description field, similar tosetDescription(String)
.- Parameters:
newValue
- is new value for the description field.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
-
setIS
Accessor method to assign IS 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:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearIS
Utility method to clear SFNode value of IS field.- Returns:
PickableGroup
- 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:
-
getMetadata
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfacePickableGroup
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DGroupingNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfacePickableGroup
- 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:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
PickableGroup
- 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:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
getObjectType
Provide array of String enumeration results with quoted value(s) ["ALL","NONE","TERRAIN",...] from inputOutput MFString field named objectType.
Tooltip: The objectType field specifies a set of labels used in the picking process. Each string specified is treated as an independent label that needs to be matched against the same type in one of the pick sensor instances. Example: labeling a PickableGroup with the objectType value "WATER" and then attempting to intersect a pick sensor with objectType value "GROUND" fails since the objectType values do not match. Example: the special value "ALL" means that each node is available for picking regardless of the type specified by the pick sensor. Example: the special value "NONE" effectively disables all picking for this node and is the equivalent of setting the pickable field to false.- Hint: authors may define any value for objectType.
- Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
Available enumeration values for string comparison:ALL
,NONE
,TERRAIN
.- Specified by:
getObjectType
in interfacePickableGroup
- Returns:
- value of objectType field
-
getObjectTypeList
Utility method to get ArrayList value of MFString objectType field, similar togetObjectType()
.- Returns:
- value of objectType field
-
getObjectTypeString
Utility method to get String value of MFString objectType field, similar togetObjectType()
.- Returns:
- value of objectType field
-
setObjectType
Accessor method to assign String enumeration array (""ALL"" | ""NONE"" | ""TERRAIN"") to inputOutput MFString field named objectType.
Hint: authors have option to choose from an extendible list of predefined enumeration values (ALL
,NONE
,TERRAIN
).
Tooltip: The objectType field specifies a set of labels used in the picking process. Each string specified is treated as an independent label that needs to be matched against the same type in one of the pick sensor instances. Example: labeling a PickableGroup with the objectType value "WATER" and then attempting to intersect a pick sensor with objectType value "GROUND" fails since the objectType values do not match. Example: the special value "ALL" means that each node is available for picking regardless of the type specified by the pick sensor. Example: the special value "NONE" effectively disables all picking for this node and is the equivalent of setting the pickable field to false.- Hint: authors may define any value for objectType.
- Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".
- Specified by:
setObjectType
in interfacePickableGroup
- Parameters:
newValue
- is new value for the objectType field.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setObjectType
Assign typed object value to MFString objectType field, similar tosetObjectType(String[])
.- Parameters:
newValue
- is new value for the objectType field.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setObjectType
Assign single SFString object value to MFString objectType field, similar tosetObjectType(String[])
.- Parameters:
newValue
- is new value for the objectType field.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setObjectType
Assign singleton String value to MFString objectType field, similar tosetObjectType(String[])
.- Parameters:
newValue
- is new value for the objectType field.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setObjectType
Assign ArrayList value of MFString objectType field, similar tosetObjectType(String[])
.- Parameters:
newValue
- is new value for the objectType field.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearObjectType
Utility method to clear MFString value of objectType field. This method does not initialize withOBJECTTYPE_DEFAULT_VALUE.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addObjectType
Add singleton String value to MFString objectType field.- Parameters:
newValue
- is new value to add to the objectType field.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addObjectType
Add singleton SFString value to MFString objectType field.- Parameters:
newValue
- is new value to add to the objectType field.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getPickable
public boolean getPickable()Provide boolean value from inputOutput SFBool field named pickable.
Tooltip: The pickable field determines whether pick traversal is performed on this node or its children.- Hint: pickable only affects children accessed through the transformation hierarchy of the parent.
- Warning: if one or more of the children of this instance is accessible through another transformation hierarchy through DEF/USE that still has picking enabled, they are still pickable through that path only.
- Specified by:
getPickable
in interfacePickableGroup
- Specified by:
getPickable
in interfaceX3DPickableObject
- Returns:
- value of pickable field
-
setPickable
Accessor method to assign boolean value to inputOutput SFBool field named pickable.
Tooltip: The pickable field determines whether pick traversal is performed on this node or its children.- Hint: pickable only affects children accessed through the transformation hierarchy of the parent.
- Warning: if one or more of the children of this instance is accessible through another transformation hierarchy through DEF/USE that still has picking enabled, they are still pickable through that path only.
- Specified by:
setPickable
in interfacePickableGroup
- Specified by:
setPickable
in interfaceX3DPickableObject
- Parameters:
newValue
- is new value for the pickable field.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setPickable
Assign typed object value to SFBool pickable field, similar tosetPickable(boolean)
.- Parameters:
newValue
- is new value for the pickable field.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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 interfacePickableGroup
- 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 interfacePickableGroup
- Specified by:
setVisible
in interfaceX3DBoundedObject
- Specified by:
setVisible
in interfaceX3DGroupingNode
- Parameters:
newValue
- is new value for the visible field.- Returns:
PickableGroup
- 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:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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:
-
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:
PickableGroup
- 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:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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:
-
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:
PickableGroup
- 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:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClass
in classX3DConcreteElement
- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHtmlID
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlID
in classX3DConcreteElement
- Returns:
- value of id field
- See Also:
-
setHtmlID
Accessor method to assign String value to inputOutput SFString field named id.- Specified by:
setHtmlID
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the id field.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setHtmlID
Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.- Parameters:
newValue
- is new value for the id field.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStyle
in classX3DConcreteElement
- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Specified by:
setCssStyle
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the style field.- Returns:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.- Parameters:
newValue
- is new value for the style field.- Returns:
PickableGroup
- 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:
PickableGroup
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
toStringX3D
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:
-
toStringClassicVRML
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:
-
toStringVRML97
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:
-
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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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:
-
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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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:
-
hasElementByNameValue
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:
-
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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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:
-
hasNodeByDEF
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:
-
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. TODO document specific validation methods.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-