Class HAnimHumanoid
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.HAnim.HAnimHumanoid
- All Implemented Interfaces:
X3DChildNode
,X3DNode
,X3DBoundedObject
,HAnimHumanoid
The HAnimHumanoid node is used to: (a) store references to the joints, segments, sites, skeleton, optional skin, and fixed viewpoints, (b) serve as a container for the entire humanoid, (c) provide a convenient way of moving the humanoid through its environment, and (d) store human-readable metadata such as name, version, author, copyright, age, gender and other information.
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.
HAnimHumanoid node tooltip: [X3DChildNode,X3DBoundedObject,X3DVisibleObject] The HAnimHumanoid node is used to: (a) store references to the joints, segments, sites, skeleton, optional skin, and fixed viewpoints, (b) serve as a container for the entire humanoid, (c) provide a convenient way of moving the humanoid through its environment, and (d) store human-readable metadata such as name, version, author, copyright, age, gender and other information. HAnimHumanoid contains a skeleton consisting of HAnimJoint, HAnimSegment and HAnimSite nodes. HAnimHumanoid can also contain an optional skin consisting of an IndexedFaceSet mesh with corresponding skinCoord Coordinate|CoordinateDouble vertices and skinNormal Normal vectors.
- Hint: MFNode arrays for the joints, segments, sites, and viewpoints fields provide lists for all HAnim nodes found in the skeleton hierarchy and thus only contain USE node references.
- Hint: HAnim Specification https://www.web3d.org/documents/specifications/19774/V2.0
- Hint: HAnim Specification part 1, Humanoid https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/ObjectInterfaces.html#Humanoid
- Hint: HAnim Specification part 2, clause 6.4 Extended definition of Humanoid object https://www.web3d.org/documents/specifications/19774/V2.0/MotionDataAnimation/MotionNodes.html#HumanoidObjectExtension
- Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/HumanoidAnimation.pdf
- Warning: requires X3D profile='Full' or else include <component name='HAnim' level='1'/>
- Warning: for X3D3 HAnim1, previous spelling of component name was 'H-Anim' (including hyphen)
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 float[]
SFVec3f field named center has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static final String
String constant COMPONENT defines X3D component for the HAnimHumanoid element: HAnimstatic 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 SFVec3f field named center.static final String
fromField ROUTE name for SFString field named description.static final String
fromField ROUTE name for MFString field named info.static final String
fromField ROUTE name for SFNode field named IS.static final String
fromField ROUTE name for MFVec3f field named jointBindingPositions.static final String
fromField ROUTE name for MFRotation field named jointBindingRotations.static final String
fromField ROUTE name for MFVec3f field named jointBindingScales.static final String
fromField ROUTE name for MFNode field named joints.static final String
fromField ROUTE name for SFInt32 field named loa.static final String
fromField ROUTE name for SFNode field named metadata.static final String
fromField ROUTE name for MFNode field named motions.static final String
fromField ROUTE name for MFBool field named motionsEnabled.static final String
fromField ROUTE name for SFString field named name.static final String
fromField ROUTE name for SFRotation field named rotation.static final String
fromField ROUTE name for SFVec3f field named scale.static final String
fromField ROUTE name for SFRotation field named scaleOrientation.static final String
fromField ROUTE name for MFNode field named segments.static final String
fromField ROUTE name for MFNode field named sites.static final String
fromField ROUTE name for SFString field named skeletalConfiguration.static final String
fromField ROUTE name for MFNode field named skeleton.static final String
fromField ROUTE name for MFNode field named skin.static final String
fromField ROUTE name for SFNode field named skinBindingCoords.static final String
fromField ROUTE name for SFNode field named skinBindingNormals.static final String
fromField ROUTE name for SFNode field named skinCoord.static final String
fromField ROUTE name for SFNode field named skinNormal.static final String
fromField ROUTE name for SFVec3f field named translation.static final String
fromField ROUTE name for SFString field named version.static final String
fromField ROUTE name for MFNode field named viewpoints.static final String
fromField ROUTE name for SFBool field named visible.MFString field named info has default value equal to an empty list.static final IS
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static final float[]
MFVec3f field named jointBindingPositions has default value equal to an empty list.static final float[]
MFRotation field named jointBindingRotations has default value equal to an empty list.static final float[]
MFVec3f field named jointBindingScales has default value equal to an empty list.static final int
Integer constant LEVEL provides default X3D HAnim component level for this element: 1static final int
SFInt32 field named loa has default value -1 (Java syntax) or -1 (XML syntax).static final X3DMetadataObject
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).MFBool field named motionsEnabled has default value equal to an empty list.static final String
String constant NAME provides name of this element: HAnimHumanoid.static final String
SFString field named name has default value equal to an empty string.static final float[]
SFRotation field named rotation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).static final float[]
SFVec3f field named scale has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).static final float[]
SFRotation field named scaleOrientation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax).static final String
SFString field named skeletalConfiguration has default value "BASIC" (Java syntax) or BASIC (XML syntax).static final X3DNode
SFNode field named skinBindingCoords has default value null (Java syntax) or NULL (XML syntax).static final X3DNormalNode
SFNode field named skinBindingNormals has default value null (Java syntax) or NULL (XML syntax).static final X3DNode
SFNode field named skinCoord has default value null (Java syntax) or NULL (XML syntax).static final X3DNormalNode
SFNode field named skinNormal has default value null (Java syntax) or NULL (XML syntax).static final String
toField ROUTE name for SFBool field named bboxDisplay.static final String
toField ROUTE name for SFVec3f field named center.static final String
toField ROUTE name for SFString field named description.static final String
toField ROUTE name for MFString field named info.static final String
toField ROUTE name for MFVec3f field named jointBindingPositions.static final String
toField ROUTE name for MFRotation field named jointBindingRotations.static final String
toField ROUTE name for MFVec3f field named jointBindingScales.static final String
toField ROUTE name for MFNode field named joints.static final String
toField ROUTE name for SFInt32 field named loa.static final String
toField ROUTE name for SFNode field named metadata.static final String
toField ROUTE name for MFNode field named motions.static final String
toField ROUTE name for MFBool field named motionsEnabled.static final String
toField ROUTE name for SFString field named name.static final String
toField ROUTE name for SFRotation field named rotation.static final String
toField ROUTE name for SFVec3f field named scale.static final String
toField ROUTE name for SFRotation field named scaleOrientation.static final String
toField ROUTE name for MFNode field named segments.static final String
toField ROUTE name for MFNode field named sites.static final String
toField ROUTE name for SFString field named skeletalConfiguration.static final String
toField ROUTE name for MFNode field named skeleton.static final String
toField ROUTE name for MFNode field named skin.static final String
toField ROUTE name for SFNode field named skinBindingCoords.static final String
toField ROUTE name for SFNode field named skinBindingNormals.static final String
toField ROUTE name for SFNode field named skinCoord.static final String
toField ROUTE name for SFNode field named skinNormal.static final String
toField ROUTE name for SFVec3f field named translation.static final String
toField ROUTE name for SFString field named version.static final String
toField ROUTE name for MFNode field named viewpoints.static final String
toField ROUTE name for SFBool field named visible.static final float[]
SFVec3f field named translation has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static final String
Tooltip: Revised standard HAnim 19774 version 2 (parts 1 and 2) were approved by ISO in November 2019, published by Web3D Consortium May 2020.static final String
SFString field named version has default value "2.0" (Java syntax) or 2.0 (XML syntax).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 HAnimHumanoid to initialize member variables with default values.HAnimHumanoid
(String DEFlabel) Utility constructor that assigns DEF label after initializing member variables with default values.HAnimHumanoid
(String DEFlabel, String newName) Utility constructor that assigns both DEF label and name, after initializing member variables with default values. -
Method Summary
Modifier and TypeMethodDescriptionaddComments
(String newComment) Add comment as String to contained commentsList.addComments
(String[] newComments) Add comments as String[] array to contained commentsList.addComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.Add singleton String value to MFString info field.Add singleton SFString value to MFString info field.addJointBindingPositions
(SFVec3f newValue) Add singleton SFVec3f value to MFVec3f jointBindingPositions field.addJointBindingRotations
(SFRotation newValue) Add singleton SFRotation value to MFRotation jointBindingRotations field.addJointBindingScales
(SFVec3f newValue) Add singleton SFVec3f value to MFVec3f jointBindingScales field.addJoints
(ProtoInstance newValue) Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for joints field.addJoints
(HAnimJoint newValue) Add single child node to existing array of joints nodes (if any).void
Add array of child joints nodes to array of existing nodes (if any).addMotions
(ProtoInstance newValue) Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for motions field.addMotions
(HAnimMotion newValue) Add single child node to existing array of motions nodes (if any).void
addMotions
(X3DNode[] newValue) Add array of child motions nodes to array of existing nodes (if any).addMotionsEnabled
(boolean newValue) Add singleton boolean value to MFBool motionsEnabled field.addMotionsEnabled
(SFBool newValue) Add singleton SFBool value to MFBool motionsEnabled field.addSegments
(ProtoInstance newValue) Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for segments field.addSegments
(HAnimSegment newValue) Add single child node to existing array of segments nodes (if any).void
addSegments
(X3DNode[] newValue) Add array of child segments nodes to array of existing nodes (if any).addSites
(ProtoInstance newValue) Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for sites field.Add single child node to existing array of sites nodes (if any).void
Add array of child sites nodes to array of existing nodes (if any).addSkeleton
(ProtoInstance newValue) Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for skeleton field.addSkeleton
(X3DNode newValue) Add single child node to existing array of skeleton nodes (if any).void
addSkeleton
(X3DNode[] newValue) Add array of child skeleton nodes to array of existing nodes (if any).addSkin
(ProtoInstance newValue) Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for skin field.Add single child node to existing array of skin nodes (if any).void
Add array of child skin nodes to array of existing nodes (if any).addViewpoints
(ProtoInstance newValue) Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for viewpoints field.addViewpoints
(HAnimSite newValue) Add single child node to existing array of viewpoints nodes (if any).void
addViewpoints
(X3DNode[] newValue) Add array of child viewpoints nodes to array of existing nodes (if any).Utility method to clear MFString value of info field.clearIS()
Utility method to clear SFNode value of IS field.Utility method to clear MFNode value of joints field.Utility method to clear SFNode value of metadata field.Utility method to clear MFNode value of motions field.Utility method to clear MFBool value of motionsEnabled field.Utility method to clear MFNode value of segments field.Utility method to clear MFNode value of sites field.Utility method to clear MFNode value of skeleton field.Utility method to clear MFNode value of skin field.Utility method to clear SFNode value of skinBindingCoords field.Utility method to clear SFNode value of skinBindingNormals field.Utility method to clear SFNode value of skinCoord field.Utility method to clear SFNode value of skinNormal field.Utility method to clear MFNode value of viewpoints 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.float[]
Provide array of 3-tuple float results from inputOutput SFVec3f field named center.final String
Defines X3D component for the HAnimHumanoid element: HAnimfinal 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: HAnimHumanoidgetFieldType
(String fieldName) Indicate type corresponding to given fieldName.Return version of this HAnimHumanoidProvide String value from inputOutput SFString field named id.String[]
getInfo()
Provide array of String results from inputOutput MFString field named info.Utility method to get ArrayList value of MFString info field, similar togetInfo()
.Utility method to get String value of MFString info field, similar togetInfo()
.getIS()
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.float[]
Provide array of 3-tuple float results from inputOutput MFVec3f field named jointBindingPositions.float[]
Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput MFRotation field named jointBindingRotations.float[]
Provide array of 3-tuple float results from inputOutput MFVec3f field named jointBindingScales.X3DNode[]
Provide array of org.web3d.x3d.sai.HAnim.HAnimJoint results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field joints.Utility method to get ArrayList value of MFNode joints field, similar togetJoints()
.int
getLoa()
Provide int value within allowed range of [-1,4] from inputOutput SFInt32 field named loa.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.X3DNode[]
Provide array of org.web3d.x3d.sai.HAnim.HAnimMotion results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field motions.boolean[]
Provide array of Boolean results from inputOutput MFBool field named motionsEnabled.Utility method to get ArrayList value of MFBool motionsEnabled field, similar togetMotionsEnabled()
.Utility method to get String value of MFBool motionsEnabled field, similar togetMotionsEnabled()
.Utility method to get ArrayList value of MFNode motions field, similar togetMotions()
.getName()
Provide String value from inputOutput SFString field named name.float[]
Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named rotation.float[]
getScale()
Provide array of 3-tuple float results within allowed range of (0,infinity) from inputOutput SFVec3f field named scale.float[]
Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named scaleOrientation.X3DNode[]
Provide array of org.web3d.x3d.sai.HAnim.HAnimSegment results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field segments.Utility method to get ArrayList value of MFNode segments field, similar togetSegments()
.X3DNode[]
getSites()
Provide array of org.web3d.x3d.sai.HAnim.HAnimSite results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field sites.Utility method to get ArrayList value of MFNode sites field, similar togetSites()
.Provide String value from inputOutput SFString field named skeletalConfiguration.X3DNode[]
Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to HAnimJoint|HAnimSite, from inputOutput MFNode field skeleton.Utility method to get ArrayList value of MFNode skeleton field, similar togetSkeleton()
.X3DNode[]
getSkin()
Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to Group|Transform|Shape|IndexedFaceSet, from inputOutput MFNode field skin.Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to Coordinate|CoordinateDouble, from inputOutput SFNode field skinBindingCoords.Provide org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field skinBindingNormals.Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to Coordinate|CoordinateDouble, from inputOutput SFNode field skinCoord.Utility method to get ArrayList value of MFNode skin field, similar togetSkin()
.Provide org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field skinNormal.float[]
Provide array of 3-tuple float results from inputOutput SFVec3f field named translation.getUSE()
Provide String value from inputOutput SFString field named USE.Provide String enumeration value (baseType xs:NMTOKEN) ["2.0"] from inputOutput SFString field named version.X3DNode[]
Provide array of org.web3d.x3d.sai.HAnim.HAnimSite results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field viewpoints.Utility method to get ArrayList value of MFNode viewpoints field, similar togetViewpoints()
.boolean
Provide boolean value from inputOutput SFBool field named visible.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 MFNode field joints.boolean
Indicate whether an object is available for inputOutput SFNode field metadata.boolean
Indicate whether an object is available for inputOutput MFNode field motions.boolean
hasNodeByDEF
(String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.boolean
Indicate whether an object is available for inputOutput MFNode field segments.boolean
hasSites()
Indicate whether an object is available for inputOutput MFNode field sites.boolean
Indicate whether an object is available for inputOutput MFNode field skeleton.boolean
hasSkin()
Indicate whether an object is available for inputOutput MFNode field skin.boolean
Indicate whether an object is available for inputOutput SFNode field skinBindingCoords.boolean
Indicate whether an object is available for inputOutput SFNode field skinBindingNormals.boolean
Indicate whether an object is available for inputOutput SFNode field skinCoord.boolean
Indicate whether an object is available for inputOutput SFNode field skinNormal.boolean
Indicate whether an object is available for inputOutput MFNode field viewpoints.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[])
.setCenter
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetCenter(float[])
.setCenter
(double x, double y, double z) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetCenter(float[])
.setCenter
(float[] newValue) Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named center.setCenter
(float x, float y, float z) Assign values to SFVec3f center field, similar tosetCenter(float[])
.Assign typed object value to SFVec3f center field, similar tosetCenter(float[])
.final HAnimHumanoid
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 HAnimHumanoid
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 HAnimHumanoid
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 HAnimHumanoid
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.Assign singleton String value to MFString info field, similar tosetInfo(String[])
.Accessor method to assign String array to inputOutput MFString field named info.Assign ArrayList value of MFString info field, similar tosetInfo(String[])
.Assign typed object value to MFString info field, similar tosetInfo(String[])
.Assign single SFString object value to MFString info field, similar tosetInfo(String[])
.Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.setJointBindingPositions
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetJointBindingPositions(float[])
.setJointBindingPositions
(float[] newValue) Accessor method to assign 3-tuple float array to inputOutput MFVec3f field named jointBindingPositions.setJointBindingPositions
(MFVec3f newValue) Assign typed object value to MFVec3f jointBindingPositions field, similar tosetJointBindingPositions(float[])
.setJointBindingRotations
(float[] newValue) Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput MFRotation field named jointBindingRotations.setJointBindingRotations
(MFRotation newValue) Assign typed object value to MFRotation jointBindingRotations field, similar tosetJointBindingRotations(float[])
.setJointBindingScales
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetJointBindingScales(float[])
.setJointBindingScales
(float[] newValue) Accessor method to assign 3-tuple float array to inputOutput MFVec3f field named jointBindingScales.setJointBindingScales
(MFVec3f newValue) Assign typed object value to MFVec3f jointBindingScales field, similar tosetJointBindingScales(float[])
.setJoints
(ArrayList<HAnimJoint> newValue) Assign ArrayList value of MFNode joints field, similar tosetJoints(org.web3d.x3d.sai.Core.X3DNode[])
.void
Set single child joints node, replacing prior array of existing nodes (if any).Accessor method to assign org.web3d.x3d.sai.HAnim.HAnimJoint array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field joints.setLoa
(int newValue) Accessor method to assign int value to inputOutput SFInt32 field named loa.Assign typed object value to SFInt32 loa field, similar tosetLoa(int)
.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.setMotions
(ArrayList<HAnimMotion> newValue) Assign ArrayList value of MFNode motions field, similar tosetMotions(org.web3d.x3d.sai.Core.X3DNode[])
.void
setMotions
(X3DNode newValue) Set single child motions node, replacing prior array of existing nodes (if any).setMotions
(X3DNode[] newValue) Accessor method to assign org.web3d.x3d.sai.HAnim.HAnimMotion array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field motions.setMotionsEnabled
(boolean[] newValue) Accessor method to assign Boolean array to inputOutput MFBool field named motionsEnabled.setMotionsEnabled
(ArrayList<Boolean> newValue) Assign ArrayList value of MFBool motionsEnabled field, similar tosetMotionsEnabled(boolean[])
.setMotionsEnabled
(MFBool newValue) Assign typed object value to MFBool motionsEnabled field, similar tosetMotionsEnabled(boolean[])
.final HAnimHumanoid
Accessor method to assign String value to inputOutput SFString field named name.Assign typed object value to SFString name field, similar tosetName(String)
.setRotation
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetRotation(float[])
.setRotation
(double x, double y, double z, double angleRadians) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetRotation(float[])
.setRotation
(float[] newValue) Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.setRotation
(float x, float y, float z, float angleRadians) Assign values to SFRotation rotation field, similar tosetRotation(float[])
.setRotation
(SFRotation newValue) Assign typed object value to SFRotation rotation field, similar tosetRotation(float[])
.setScale
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetScale(float[])
.setScale
(double x, double y, double z) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetScale(float[])
.setScale
(float[] newValue) Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named scale.setScale
(float x, float y, float z) Assign values to SFVec3f scale field, similar tosetScale(float[])
.Assign typed object value to SFVec3f scale field, similar tosetScale(float[])
.setScaleOrientation
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetScaleOrientation(float[])
.setScaleOrientation
(double x, double y, double z, double angleRadians) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetScaleOrientation(float[])
.setScaleOrientation
(float[] newValue) Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named scaleOrientation.setScaleOrientation
(float x, float y, float z, float angleRadians) Assign values to SFRotation scaleOrientation field, similar tosetScaleOrientation(float[])
.setScaleOrientation
(SFRotation newValue) Assign typed object value to SFRotation scaleOrientation field, similar tosetScaleOrientation(float[])
.setSegments
(ArrayList<HAnimSegment> newValue) Assign ArrayList value of MFNode segments field, similar tosetSegments(org.web3d.x3d.sai.Core.X3DNode[])
.void
setSegments
(X3DNode newValue) Set single child segments node, replacing prior array of existing nodes (if any).setSegments
(X3DNode[] newValue) Accessor method to assign org.web3d.x3d.sai.HAnim.HAnimSegment array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field segments.Assign ArrayList value of MFNode sites field, similar tosetSites(org.web3d.x3d.sai.Core.X3DNode[])
.void
Set single child sites node, replacing prior array of existing nodes (if any).Accessor method to assign org.web3d.x3d.sai.HAnim.HAnimSite array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field sites.setSkeletalConfiguration
(String newValue) Accessor method to assign String value to inputOutput SFString field named skeletalConfiguration.setSkeletalConfiguration
(SFString newValue) Assign typed object value to SFString skeletalConfiguration field, similar tosetSkeletalConfiguration(String)
.setSkeleton
(ArrayList<X3DNode> newValue) Assign ArrayList value of MFNode skeleton field, similar tosetSkeleton(org.web3d.x3d.sai.Core.X3DNode[])
.void
setSkeleton
(X3DNode newValue) Set single child skeleton node, replacing prior array of existing nodes (if any).setSkeleton
(X3DNode[] newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field skeleton.Assign ArrayList value of MFNode skin field, similar tosetSkin(org.web3d.x3d.sai.Core.X3DNode[])
.void
Set single child skin node, replacing prior array of existing nodes (if any).Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field skin.setSkinBindingCoords
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field skinBindingCoords.setSkinBindingCoords
(X3DNode newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field skinBindingCoords.setSkinBindingNormals
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field skinBindingNormals.setSkinBindingNormals
(X3DNormalNode newValue) Accessor method to assign org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field skinBindingNormals.setSkinCoord
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field skinCoord.setSkinCoord
(X3DNode newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field skinCoord.setSkinNormal
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field skinNormal.setSkinNormal
(X3DNormalNode newValue) Accessor method to assign org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field skinNormal.setTranslation
(double[] newArray) Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetTranslation(float[])
.setTranslation
(double x, double y, double z) Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetTranslation(float[])
.setTranslation
(float[] newValue) Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named translation.setTranslation
(float x, float y, float z) Assign values to SFVec3f translation field, similar tosetTranslation(float[])
.setTranslation
(SFVec3f newValue) Assign typed object value to SFVec3f translation field, similar tosetTranslation(float[])
.final HAnimHumanoid
Accessor method to assign String value to inputOutput SFString field named USE.Assign typed object value to SFString USE field, similar tosetUSE(String)
.setUSE
(HAnimHumanoid DEFnode) Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.setVersion
(String newValue) Accessor method to assign String enumeration value ("2.0") to inputOutput SFString field named version.setVersion
(SFString newValue) Assign typed object value to SFString version field, similar tosetVersion(String)
.setViewpoints
(ArrayList<HAnimSite> newValue) Assign ArrayList value of MFNode viewpoints field, similar tosetViewpoints(org.web3d.x3d.sai.Core.X3DNode[])
.void
setViewpoints
(X3DNode newValue) Set single child viewpoints node, replacing prior array of existing nodes (if any).setViewpoints
(X3DNode[] newValue) Accessor method to assign org.web3d.x3d.sai.HAnim.HAnimSite array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field viewpoints.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, 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
-
VERSION_2_0
Tooltip: Revised standard HAnim 19774 version 2 (parts 1 and 2) were approved by ISO in November 2019, published by Web3D Consortium May 2020. SFString field named version with X3DUOM simpleType hanimVersionChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "2.0" (Java syntax) or 2.0 (XML syntax).- See Also:
-
NAME
String constant NAME provides name of this element: HAnimHumanoid.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the HAnimHumanoid element: HAnim- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D HAnim 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). -
CENTER_DEFAULT_VALUE
public static final float[] CENTER_DEFAULT_VALUESFVec3f field named center has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
DESCRIPTION_DEFAULT_VALUE
SFString field named description has default value equal to an empty string.- See Also:
-
INFO_DEFAULT_VALUE
-
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
JOINTBINDINGPOSITIONS_DEFAULT_VALUE
public static final float[] JOINTBINDINGPOSITIONS_DEFAULT_VALUEMFVec3f field named jointBindingPositions has default value equal to an empty list. -
JOINTBINDINGROTATIONS_DEFAULT_VALUE
public static final float[] JOINTBINDINGROTATIONS_DEFAULT_VALUEMFRotation field named jointBindingRotations has default value equal to an empty list. -
JOINTBINDINGSCALES_DEFAULT_VALUE
public static final float[] JOINTBINDINGSCALES_DEFAULT_VALUEMFVec3f field named jointBindingScales has default value equal to an empty list. -
LOA_DEFAULT_VALUE
public static final int LOA_DEFAULT_VALUESFInt32 field named loa has default value -1 (Java syntax) or -1 (XML syntax).- See Also:
-
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
MOTIONSENABLED_DEFAULT_VALUE
-
NAME_DEFAULT_VALUE
SFString field named name has default value equal to an empty string.- See Also:
-
ROTATION_DEFAULT_VALUE
public static final float[] ROTATION_DEFAULT_VALUESFRotation field named rotation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax). -
SCALE_DEFAULT_VALUE
public static final float[] SCALE_DEFAULT_VALUESFVec3f field named scale has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax). -
SCALEORIENTATION_DEFAULT_VALUE
public static final float[] SCALEORIENTATION_DEFAULT_VALUESFRotation field named scaleOrientation has default value {0f,0f,1f,0f} (Java syntax) or 0 0 1 0 (XML syntax). -
SKELETALCONFIGURATION_DEFAULT_VALUE
SFString field named skeletalConfiguration has default value "BASIC" (Java syntax) or BASIC (XML syntax).- See Also:
-
SKINBINDINGCOORDS_DEFAULT_VALUE
SFNode field named skinBindingCoords has default value null (Java syntax) or NULL (XML syntax). -
SKINBINDINGNORMALS_DEFAULT_VALUE
SFNode field named skinBindingNormals has default value null (Java syntax) or NULL (XML syntax). -
SKINCOORD_DEFAULT_VALUE
SFNode field named skinCoord has default value null (Java syntax) or NULL (XML syntax). -
SKINNORMAL_DEFAULT_VALUE
SFNode field named skinNormal has default value null (Java syntax) or NULL (XML syntax). -
TRANSLATION_DEFAULT_VALUE
public static final float[] TRANSLATION_DEFAULT_VALUESFVec3f field named translation has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
VERSION_DEFAULT_VALUE
SFString field named version has default value "2.0" (Java syntax) or 2.0 (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:
-
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_CENTER
fromField ROUTE name for SFVec3f field named center.- See Also:
-
toField_CENTER
toField ROUTE name for SFVec3f field named center.- 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_INFO
fromField ROUTE name for MFString field named info.- See Also:
-
toField_INFO
-
fromField_IS
-
fromField_JOINTBINDINGPOSITIONS
fromField ROUTE name for MFVec3f field named jointBindingPositions.- See Also:
-
toField_JOINTBINDINGPOSITIONS
toField ROUTE name for MFVec3f field named jointBindingPositions.- See Also:
-
fromField_JOINTBINDINGROTATIONS
fromField ROUTE name for MFRotation field named jointBindingRotations.- See Also:
-
toField_JOINTBINDINGROTATIONS
toField ROUTE name for MFRotation field named jointBindingRotations.- See Also:
-
fromField_JOINTBINDINGSCALES
fromField ROUTE name for MFVec3f field named jointBindingScales.- See Also:
-
toField_JOINTBINDINGSCALES
toField ROUTE name for MFVec3f field named jointBindingScales.- See Also:
-
fromField_JOINTS
fromField ROUTE name for MFNode field named joints.- See Also:
-
toField_JOINTS
toField ROUTE name for MFNode field named joints.- See Also:
-
fromField_LOA
fromField ROUTE name for SFInt32 field named loa.- See Also:
-
toField_LOA
-
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_MOTIONS
fromField ROUTE name for MFNode field named motions.- See Also:
-
toField_MOTIONS
toField ROUTE name for MFNode field named motions.- See Also:
-
fromField_MOTIONSENABLED
fromField ROUTE name for MFBool field named motionsEnabled.- See Also:
-
toField_MOTIONSENABLED
toField ROUTE name for MFBool field named motionsEnabled.- See Also:
-
fromField_NAME
fromField ROUTE name for SFString field named name.- See Also:
-
toField_NAME
-
fromField_ROTATION
fromField ROUTE name for SFRotation field named rotation.- See Also:
-
toField_ROTATION
toField ROUTE name for SFRotation field named rotation.- See Also:
-
fromField_SCALE
fromField ROUTE name for SFVec3f field named scale.- See Also:
-
toField_SCALE
toField ROUTE name for SFVec3f field named scale.- See Also:
-
fromField_SCALEORIENTATION
fromField ROUTE name for SFRotation field named scaleOrientation.- See Also:
-
toField_SCALEORIENTATION
toField ROUTE name for SFRotation field named scaleOrientation.- See Also:
-
fromField_SEGMENTS
fromField ROUTE name for MFNode field named segments.- See Also:
-
toField_SEGMENTS
toField ROUTE name for MFNode field named segments.- See Also:
-
fromField_SITES
fromField ROUTE name for MFNode field named sites.- See Also:
-
toField_SITES
-
fromField_SKELETALCONFIGURATION
fromField ROUTE name for SFString field named skeletalConfiguration.- See Also:
-
toField_SKELETALCONFIGURATION
toField ROUTE name for SFString field named skeletalConfiguration.- See Also:
-
fromField_SKELETON
fromField ROUTE name for MFNode field named skeleton.- See Also:
-
toField_SKELETON
toField ROUTE name for MFNode field named skeleton.- See Also:
-
fromField_SKIN
fromField ROUTE name for MFNode field named skin.- See Also:
-
toField_SKIN
-
fromField_SKINBINDINGCOORDS
fromField ROUTE name for SFNode field named skinBindingCoords.- See Also:
-
toField_SKINBINDINGCOORDS
toField ROUTE name for SFNode field named skinBindingCoords.- See Also:
-
fromField_SKINBINDINGNORMALS
fromField ROUTE name for SFNode field named skinBindingNormals.- See Also:
-
toField_SKINBINDINGNORMALS
toField ROUTE name for SFNode field named skinBindingNormals.- See Also:
-
fromField_SKINCOORD
fromField ROUTE name for SFNode field named skinCoord.- See Also:
-
toField_SKINCOORD
toField ROUTE name for SFNode field named skinCoord.- See Also:
-
fromField_SKINNORMAL
fromField ROUTE name for SFNode field named skinNormal.- See Also:
-
toField_SKINNORMAL
toField ROUTE name for SFNode field named skinNormal.- See Also:
-
fromField_TRANSLATION
fromField ROUTE name for SFVec3f field named translation.- See Also:
-
toField_TRANSLATION
toField ROUTE name for SFVec3f field named translation.- See Also:
-
fromField_VERSION
fromField ROUTE name for SFString field named version.- See Also:
-
toField_VERSION
toField ROUTE name for SFString field named version.- See Also:
-
fromField_VIEWPOINTS
fromField ROUTE name for MFNode field named viewpoints.- See Also:
-
toField_VIEWPOINTS
toField ROUTE name for MFNode field named viewpoints.- 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
-
HAnimHumanoid
public HAnimHumanoid()Constructor for HAnimHumanoid to initialize member variables with default values. -
HAnimHumanoid
Utility constructor that assigns DEF label after initializing member variables with default values.- Parameters:
DEFlabel
- unique DEF name for this X3D node
-
HAnimHumanoid
-
-
Method Details
-
getElementName
Provides name of this element: HAnimHumanoid- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the HAnimHumanoid element: HAnim- 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 interfaceHAnimHumanoid
- Specified by:
getBboxCenter
in interfaceX3DBoundedObject
- 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 interfaceHAnimHumanoid
- Specified by:
setBboxCenter
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the bboxCenter field.- Returns:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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 interfaceHAnimHumanoid
- Specified by:
getBboxDisplay
in interfaceX3DBoundedObject
- 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 interfaceHAnimHumanoid
- Specified by:
setBboxDisplay
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the bboxDisplay field.- Returns:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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 interfaceHAnimHumanoid
- Specified by:
getBboxSize
in interfaceX3DBoundedObject
- 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 interfaceHAnimHumanoid
- Specified by:
setBboxSize
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the bboxSize field.- Returns:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCenter
public float[] getCenter()Provide array of 3-tuple float results from inputOutput SFVec3f field named center.
Tooltip: Translation offset from origin of local coordinate system. *- Specified by:
getCenter
in interfaceHAnimHumanoid
- Returns:
- value of center field
-
setCenter
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named center.
Tooltip: Translation offset from origin of local coordinate system. *- Specified by:
setCenter
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the center field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCenter
Assign typed object value to SFVec3f center field, similar tosetCenter(float[])
.- Parameters:
newValue
- is new value for the center field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCenter
Assign values to SFVec3f center field, similar tosetCenter(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCenter
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetCenter(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCenter
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetCenter(float[])
.- Parameters:
newArray
- is new value for field- Returns:
HAnimHumanoid
- 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 this 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 interfaceHAnimHumanoid
- 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 this 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 interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the description field.- Returns:
HAnimHumanoid
- 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:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getInfo
Provide array of String results from inputOutput MFString field named info.
Tooltip: Contains metadata keyword=value pairs, where approved keyword terms are humanoidVersion authorName authorEmail copyright creationDate usageRestrictions age gender height and weight.- Hint: height and weight are in base units (typically meters), hanimVersion is for author use and separate from HAnimHumanoid version field.
- Hint: alternate metadata keywords are also allowed.
- Specified by:
getInfo
in interfaceHAnimHumanoid
- Returns:
- value of info field
-
getInfoList
-
getInfoString
-
setInfo
Accessor method to assign String array to inputOutput MFString field named info.
Tooltip: Contains metadata keyword=value pairs, where approved keyword terms are humanoidVersion authorName authorEmail copyright creationDate usageRestrictions age gender height and weight.- Hint: height and weight are in base units (typically meters), hanimVersion is for author use and separate from HAnimHumanoid version field.
- Hint: alternate metadata keywords are also allowed.
- Specified by:
setInfo
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the info field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setInfo
Assign typed object value to MFString info field, similar tosetInfo(String[])
.- Parameters:
newValue
- is new value for the info field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setInfo
Assign single SFString object value to MFString info field, similar tosetInfo(String[])
.- Parameters:
newValue
- is new value for the info field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setInfo
Assign singleton String value to MFString info field, similar tosetInfo(String[])
.- Parameters:
newValue
- is new value for the info field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setInfo
Assign ArrayList value of MFString info field, similar tosetInfo(String[])
.- Parameters:
newValue
- is new value for the info field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearInfo
Utility method to clear MFString value of info field. This method does not initialize withINFO_DEFAULT_VALUE.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addInfo
Add singleton String value to MFString info field.- Parameters:
newValue
- is new value to add to the info field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addInfo
Add singleton SFString value to MFString info field.- Parameters:
newValue
- is new value to add to the info field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
-
getJointBindingPositions
public float[] getJointBindingPositions()Provide array of 3-tuple float results from inputOutput MFVec3f field named jointBindingPositions.
Tooltip: Specifies an array of position values for each HAnimJoint node in the joints field, in order, corresponding to each binding pose.- Hint: if only one value is provided, it is provided to each Joint equivalently.
- Warning: not used when skeletalConfiguration='BASIC'.
- Specified by:
getJointBindingPositions
in interfaceHAnimHumanoid
- Returns:
- value of jointBindingPositions field
-
setJointBindingPositions
Accessor method to assign 3-tuple float array to inputOutput MFVec3f field named jointBindingPositions.
Tooltip: Specifies an array of position values for each HAnimJoint node in the joints field, in order, corresponding to each binding pose.- Hint: if only one value is provided, it is provided to each Joint equivalently.
- Warning: not used when skeletalConfiguration='BASIC'.
- Specified by:
setJointBindingPositions
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the jointBindingPositions field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setJointBindingPositions
Assign typed object value to MFVec3f jointBindingPositions field, similar tosetJointBindingPositions(float[])
.- Parameters:
newValue
- is new value for the jointBindingPositions field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addJointBindingPositions
Add singleton SFVec3f value to MFVec3f jointBindingPositions field.- Parameters:
newValue
- is new value to add to the jointBindingPositions field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setJointBindingPositions
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetJointBindingPositions(float[])
.- Parameters:
newArray
- is new value for field- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getJointBindingRotations
public float[] getJointBindingRotations()Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput MFRotation field named jointBindingRotations.
Tooltip: Specifies an array of rotation values for each HAnimJoint node in the joints field, in order, corresponding to each binding pose.- Hint: if only one value is provided, it is provided to each Joint equivalently.
- Warning: not used when skeletalConfiguration='BASIC'.
- Specified by:
getJointBindingRotations
in interfaceHAnimHumanoid
- Returns:
- value of jointBindingRotations field
-
setJointBindingRotations
Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput MFRotation field named jointBindingRotations.
Tooltip: Specifies an array of rotation values for each HAnimJoint node in the joints field, in order, corresponding to each binding pose.- Hint: if only one value is provided, it is provided to each Joint equivalently.
- Warning: not used when skeletalConfiguration='BASIC'.
- Specified by:
setJointBindingRotations
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the jointBindingRotations field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setJointBindingRotations
Assign typed object value to MFRotation jointBindingRotations field, similar tosetJointBindingRotations(float[])
.- Parameters:
newValue
- is new value for the jointBindingRotations field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addJointBindingRotations
Add singleton SFRotation value to MFRotation jointBindingRotations field.- Parameters:
newValue
- is new value to add to the jointBindingRotations field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getJointBindingScales
public float[] getJointBindingScales()Provide array of 3-tuple float results from inputOutput MFVec3f field named jointBindingScales.
Tooltip: Specifies an array of scale values for each HAnimJoint node in the joints field, in order, corresponding to each binding pose.- Hint: if only one value is provided, it is provided to each Joint equivalently.
- Warning: not used when skeletalConfiguration='BASIC'.
- Specified by:
getJointBindingScales
in interfaceHAnimHumanoid
- Returns:
- value of jointBindingScales field
-
setJointBindingScales
Accessor method to assign 3-tuple float array to inputOutput MFVec3f field named jointBindingScales.
Tooltip: Specifies an array of scale values for each HAnimJoint node in the joints field, in order, corresponding to each binding pose.- Hint: if only one value is provided, it is provided to each Joint equivalently.
- Warning: not used when skeletalConfiguration='BASIC'.
- Specified by:
setJointBindingScales
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the jointBindingScales field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setJointBindingScales
Assign typed object value to MFVec3f jointBindingScales field, similar tosetJointBindingScales(float[])
.- Parameters:
newValue
- is new value for the jointBindingScales field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addJointBindingScales
Add singleton SFVec3f value to MFVec3f jointBindingScales field.- Parameters:
newValue
- is new value to add to the jointBindingScales field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setJointBindingScales
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetJointBindingScales(float[])
.- Parameters:
newArray
- is new value for field- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getJoints
Provide array of org.web3d.x3d.sai.HAnim.HAnimJoint results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field joints.
Tooltip: [HAnimJoint] The joints field contains a list of USE references for all HAnimJoint node instances found within the preceding skeleton hierarchy.- Hint: order is irrelevant since names are contained in the original DEF objects.
- Hint: these USE nodes can be utilitized by inverse kinematics (IK) and animation engines.
- Warning: the number of contained <HAnimJoint USE='*' containerField='joints'/> nodes at top level of HAnimHumanoid needs to match the number of corresponding HAnimJoint node instances found within the preceding skeleton hierarchy.
- Warning: top-level HAnimJoint USE nodes must include containerField='joints' for proper validation and operation.
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimJoint.- Specified by:
getJoints
in interfaceHAnimHumanoid
- Returns:
- value of joints field
- See Also:
-
getJointsList
Utility method to get ArrayList value of MFNode joints field, similar togetJoints()
.- Returns:
- value of joints field
-
setJoints
Accessor method to assign org.web3d.x3d.sai.HAnim.HAnimJoint array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field joints.
Tooltip: [HAnimJoint] The joints field contains a list of USE references for all HAnimJoint node instances found within the preceding skeleton hierarchy.- Hint: order is irrelevant since names are contained in the original DEF objects.
- Hint: these USE nodes can be utilitized by inverse kinematics (IK) and animation engines.
- Warning: the number of contained <HAnimJoint USE='*' containerField='joints'/> nodes at top level of HAnimHumanoid needs to match the number of corresponding HAnimJoint node instances found within the preceding skeleton hierarchy.
- Warning: top-level HAnimJoint USE nodes must include containerField='joints' for proper validation and operation.
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimJoint.- Specified by:
setJoints
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the joints field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setJoints
Assign ArrayList value of MFNode joints field, similar tosetJoints(org.web3d.x3d.sai.Core.X3DNode[])
.- Parameters:
newValue
- is new value for the joints field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addJoints
Add single child node to existing array of joints nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimJoint and ProtoInstance.- Parameters:
newValue
- is new value to be appended the joints field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addJoints
Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for joints 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:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addJoints
Add array of child joints nodes to array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimJoint.- Specified by:
addJoints
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value array to be appended the joints field.
-
setJoints
Set single child joints node, replacing prior array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to HAnimJoint.- Specified by:
setJoints
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new node for the joints field (restricted to HAnimJoint)
-
clearJoints
Utility method to clear MFNode value of joints field. This method does not initialize withJOINTS_DEFAULT_VALUE.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasJoints
public boolean hasJoints()Indicate whether an object is available for inputOutput MFNode field joints.- Returns:
- whether a properly typed node or ProtoInstance array or CommentsBlock is available.
- See Also:
-
getLoa
public int getLoa()Provide int value within allowed range of [-1,4] from inputOutput SFInt32 field named loa.
Tooltip: [-1,4] Level Of Articulation 0..4 indicates complexity and detail of joints for given humanoid skeletal hierarchy.- Hint: loa value of -1 indicates that no LOA conformance is provided.
- Hint: Humanoid Animation (HAnim) Specification, Part 1 Architecture, 4.8.4 Levels of articulation, https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/concepts.html#LevelsOfArticulation
- Specified by:
getLoa
in interfaceHAnimHumanoid
- Returns:
- value of loa field
-
setLoa
Accessor method to assign int value to inputOutput SFInt32 field named loa.
Tooltip: [-1,4] Level Of Articulation 0..4 indicates complexity and detail of joints for given humanoid skeletal hierarchy.- Hint: loa value of -1 indicates that no LOA conformance is provided.
- Hint: Humanoid Animation (HAnim) Specification, Part 1 Architecture, 4.8.4 Levels of articulation, https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/concepts.html#LevelsOfArticulation
- Specified by:
setLoa
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the loa field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setLoa
Assign typed object value to SFInt32 loa field, similar tosetLoa(int)
.- Parameters:
newValue
- is new value for the loa field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceHAnimHumanoid
- Specified by:
getMetadata
in interfaceX3DChildNode
- 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 interfaceHAnimHumanoid
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
-
getMotions
Provide array of org.web3d.x3d.sai.HAnim.HAnimMotion results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field motions.
Tooltip: [HAnimMotion] Contains any HAnimMotion nodes that can animate the HAnimHumanoid. *
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimMotion.- Specified by:
getMotions
in interfaceHAnimHumanoid
- Returns:
- value of motions field
- See Also:
-
getMotionsList
Utility method to get ArrayList value of MFNode motions field, similar togetMotions()
.- Returns:
- value of motions field
-
setMotions
Accessor method to assign org.web3d.x3d.sai.HAnim.HAnimMotion array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field motions.
Tooltip: [HAnimMotion] Contains any HAnimMotion nodes that can animate the HAnimHumanoid. *
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimMotion.- Specified by:
setMotions
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the motions field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMotions
Assign ArrayList value of MFNode motions field, similar tosetMotions(org.web3d.x3d.sai.Core.X3DNode[])
.- Parameters:
newValue
- is new value for the motions field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addMotions
Add single child node to existing array of motions nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimMotion and ProtoInstance.- Parameters:
newValue
- is new value to be appended the motions field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addMotions
Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for motions 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:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addMotions
Add array of child motions nodes to array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimMotion.- Specified by:
addMotions
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value array to be appended the motions field.
-
setMotions
Set single child motions node, replacing prior array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to HAnimMotion.- Specified by:
setMotions
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new node for the motions field (restricted to HAnimMotion)
-
clearMotions
Utility method to clear MFNode value of motions field. This method does not initialize withMOTIONS_DEFAULT_VALUE.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasMotions
public boolean hasMotions()Indicate whether an object is available for inputOutput MFNode field motions.- Returns:
- whether a properly typed node or ProtoInstance array or CommentsBlock is available.
- See Also:
-
getMotionsEnabled
public boolean[] getMotionsEnabled()Provide array of Boolean results from inputOutput MFBool field named motionsEnabled.
Tooltip: Array of boolean values corresponding to HAnimMotion nodes indicating which can animate the HAnimHumanoid. *- Specified by:
getMotionsEnabled
in interfaceHAnimHumanoid
- Returns:
- value of motionsEnabled field
-
getMotionsEnabledList
Utility method to get ArrayList value of MFBool motionsEnabled field, similar togetMotionsEnabled()
.- Returns:
- value of motionsEnabled field
-
getMotionsEnabledString
Utility method to get String value of MFBool motionsEnabled field, similar togetMotionsEnabled()
.- Returns:
- value of motionsEnabled field
-
setMotionsEnabled
Accessor method to assign Boolean array to inputOutput MFBool field named motionsEnabled.
Tooltip: Array of boolean values corresponding to HAnimMotion nodes indicating which can animate the HAnimHumanoid. *- Specified by:
setMotionsEnabled
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the motionsEnabled field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMotionsEnabled
Assign typed object value to MFBool motionsEnabled field, similar tosetMotionsEnabled(boolean[])
.- Parameters:
newValue
- is new value for the motionsEnabled field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMotionsEnabled
Assign ArrayList value of MFBool motionsEnabled field, similar tosetMotionsEnabled(boolean[])
.- Parameters:
newValue
- is new value for the motionsEnabled field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearMotionsEnabled
Utility method to clear MFBool value of motionsEnabled field. This method does not initialize withMOTIONSENABLED_DEFAULT_VALUE.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addMotionsEnabled
Add singleton boolean value to MFBool motionsEnabled field.- Parameters:
newValue
- is new value to add to the motionsEnabled field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addMotionsEnabled
Add singleton SFBool value to MFBool motionsEnabled field.- Parameters:
newValue
- is new value to add to the motionsEnabled field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getName
Provide String value from inputOutput SFString field named name.
Tooltip: Unique name attribute must be defined so that each HAnimHumanoid node in a scene can be identified at run time for animation purposes.- Hint: this same name is a required name prefix for all other HAnim nodes within the HAnimHumanoid, if more than one humanoid appears within a scene file.
- Warning: name field is not included if this instance is a USE node, in order to avoid potential mismatches.
- 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
- Hint: HAnim2 Names HAnim1 Alias Tables https://www.web3d.org/x3d/content/examples/HumanoidAnimation/HAnim2NameHAnim1AliasTables.txt
- Specified by:
getName
in interfaceHAnimHumanoid
- Overrides:
getName
in classX3DConcreteNode
- Returns:
- value of name field
-
setName
Accessor method to assign String value to inputOutput SFString field named name.
Tooltip: Unique name attribute must be defined so that each HAnimHumanoid node in a scene can be identified at run time for animation purposes.- Hint: this same name is a required name prefix for all other HAnim nodes within the HAnimHumanoid, if more than one humanoid appears within a scene file.
- Warning: name field is not included if this instance is a USE node, in order to avoid potential mismatches.
- 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
- Hint: HAnim2 Names HAnim1 Alias Tables https://www.web3d.org/x3d/content/examples/HumanoidAnimation/HAnim2NameHAnim1AliasTables.txt
@see X3D Scene Authoring Hints: Naming Conventions- Specified by:
setName
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the name field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setName
Assign typed object value to SFString name field, similar tosetName(String)
.- Parameters:
newValue
- is new value for the name field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getRotation
public float[] getRotation()Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named rotation.
Tooltip: Orientation of children relative to local coordinate system.- Warning: default pose is typically empty (or an identity rotation) to avoid distorted body animations.
- Specified by:
getRotation
in interfaceHAnimHumanoid
- Returns:
- value of rotation field
-
setRotation
Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.
Tooltip: Orientation of children relative to local coordinate system.- Warning: default pose is typically empty (or an identity rotation) to avoid distorted body animations.
- Specified by:
setRotation
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the rotation field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRotation
Assign typed object value to SFRotation rotation field, similar tosetRotation(float[])
.- Parameters:
newValue
- is new value for the rotation field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRotation
Assign values to SFRotation rotation field, similar tosetRotation(float[])
.- Parameters:
x
- first component of axisy
- second component of axisz
- third component of axisangleRadians
- fourth component of rotation around axis- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRotation
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetRotation(float[])
.- Parameters:
x
- first componenty
- second componentz
- third componentangleRadians
- fourth component- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRotation
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetRotation(float[])
.- Parameters:
newArray
- is new value for field- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getScale
public float[] getScale()Provide array of 3-tuple float results within allowed range of (0,infinity) from inputOutput SFVec3f field named scale.
Tooltip: Non-uniform x-y-z scale of child coordinate system, adjusted by center and scaleOrientation.- Warning: HAnimHumanoid scale values must be positive.
- Specified by:
getScale
in interfaceHAnimHumanoid
- Returns:
- value of scale field
-
setScale
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named scale.
Tooltip: Non-uniform x-y-z scale of child coordinate system, adjusted by center and scaleOrientation.- Warning: HAnimHumanoid scale values must be positive.
- Specified by:
setScale
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the scale field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setScale
Assign typed object value to SFVec3f scale field, similar tosetScale(float[])
.- Parameters:
newValue
- is new value for the scale field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setScale
Assign values to SFVec3f scale field, similar tosetScale(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setScale
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetScale(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setScale
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetScale(float[])
.- Parameters:
newArray
- is new value for field- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getScaleOrientation
public float[] getScaleOrientation()Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named scaleOrientation.
Tooltip: Preliminary rotation of coordinate system before scaling (to allow scaling around arbitrary orientations). *- Specified by:
getScaleOrientation
in interfaceHAnimHumanoid
- Returns:
- value of scaleOrientation field
-
setScaleOrientation
Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named scaleOrientation.
Tooltip: Preliminary rotation of coordinate system before scaling (to allow scaling around arbitrary orientations). *- Specified by:
setScaleOrientation
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the scaleOrientation field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setScaleOrientation
Assign typed object value to SFRotation scaleOrientation field, similar tosetScaleOrientation(float[])
.- Parameters:
newValue
- is new value for the scaleOrientation field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setScaleOrientation
Assign values to SFRotation scaleOrientation field, similar tosetScaleOrientation(float[])
.- Parameters:
x
- first component of axisy
- second component of axisz
- third component of axisangleRadians
- fourth component of rotation around axis- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setScaleOrientation
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetScaleOrientation(float[])
.- Parameters:
x
- first componenty
- second componentz
- third componentangleRadians
- fourth component- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setScaleOrientation
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetScaleOrientation(float[])
.- Parameters:
newArray
- is new value for field- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getSegments
Provide array of org.web3d.x3d.sai.HAnim.HAnimSegment results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field segments.
Tooltip: [HAnimSegment] The segments field contains a list of USE references for all HAnimSegment node instances found within the preceding skeleton hierarchy.- Hint: order is irrelevant since names are contained in the original DEF objects.
- Hint: these USE nodes can be utilitized by inverse kinematics (IK) and animation engines.
- Warning: the number of contained <HAnimSegment USE='*' containerField='segments'/> nodes at top level of HAnimHumanoid needs to match the number of corresponding HAnimSegment node instances found within the preceding skeleton hierarchy.
- Warning: top-level HAnimSegment USE nodes must include containerField='segments' for proper validation and operation.
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSegment.- Specified by:
getSegments
in interfaceHAnimHumanoid
- Returns:
- value of segments field
- See Also:
-
getSegmentsList
Utility method to get ArrayList value of MFNode segments field, similar togetSegments()
.- Returns:
- value of segments field
-
setSegments
Accessor method to assign org.web3d.x3d.sai.HAnim.HAnimSegment array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field segments.
Tooltip: [HAnimSegment] The segments field contains a list of USE references for all HAnimSegment node instances found within the preceding skeleton hierarchy.- Hint: order is irrelevant since names are contained in the original DEF objects.
- Hint: these USE nodes can be utilitized by inverse kinematics (IK) and animation engines.
- Warning: the number of contained <HAnimSegment USE='*' containerField='segments'/> nodes at top level of HAnimHumanoid needs to match the number of corresponding HAnimSegment node instances found within the preceding skeleton hierarchy.
- Warning: top-level HAnimSegment USE nodes must include containerField='segments' for proper validation and operation.
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSegment.- Specified by:
setSegments
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the segments field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSegments
Assign ArrayList value of MFNode segments field, similar tosetSegments(org.web3d.x3d.sai.Core.X3DNode[])
.- Parameters:
newValue
- is new value for the segments field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addSegments
Add single child node to existing array of segments nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSegment and ProtoInstance.- Parameters:
newValue
- is new value to be appended the segments field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addSegments
Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for segments 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:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addSegments
Add array of child segments nodes to array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSegment.- Specified by:
addSegments
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value array to be appended the segments field.
-
setSegments
Set single child segments node, replacing prior array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to HAnimSegment.- Specified by:
setSegments
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new node for the segments field (restricted to HAnimSegment)
-
clearSegments
Utility method to clear MFNode value of segments field. This method does not initialize withSEGMENTS_DEFAULT_VALUE.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasSegments
public boolean hasSegments()Indicate whether an object is available for inputOutput MFNode field segments.- Returns:
- whether a properly typed node or ProtoInstance array or CommentsBlock is available.
- See Also:
-
getSites
Provide array of org.web3d.x3d.sai.HAnim.HAnimSite results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field sites.
Tooltip: [HAnimSite] sites field contains a list of USE references for all HAnimSite node instances found within the preceding skeleton hierarchy.- Hint: order is irrelevant since names are contained in the original DEF objects.
- Hint: these USE nodes can be utilitized by inverse kinematics (IK) and animation engines.
- Warning: the number of contained <HAnimSite USE='*' containerField='sites, skeleton or viewpoints'/> nodes at top level of HAnimHumanoid needs to match the number of corresponding HAnimSite node instances found within the preceding skeleton hierarchy.
- Warning: top-level HAnimSite USE nodes must include containerField='sites' for proper validation and operation.
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSite.- Specified by:
getSites
in interfaceHAnimHumanoid
- Returns:
- value of sites field
- See Also:
-
getSitesList
Utility method to get ArrayList value of MFNode sites field, similar togetSites()
.- Returns:
- value of sites field
-
setSites
Accessor method to assign org.web3d.x3d.sai.HAnim.HAnimSite array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field sites.
Tooltip: [HAnimSite] sites field contains a list of USE references for all HAnimSite node instances found within the preceding skeleton hierarchy.- Hint: order is irrelevant since names are contained in the original DEF objects.
- Hint: these USE nodes can be utilitized by inverse kinematics (IK) and animation engines.
- Warning: the number of contained <HAnimSite USE='*' containerField='sites, skeleton or viewpoints'/> nodes at top level of HAnimHumanoid needs to match the number of corresponding HAnimSite node instances found within the preceding skeleton hierarchy.
- Warning: top-level HAnimSite USE nodes must include containerField='sites' for proper validation and operation.
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSite.- Specified by:
setSites
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the sites field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSites
Assign ArrayList value of MFNode sites field, similar tosetSites(org.web3d.x3d.sai.Core.X3DNode[])
.- Parameters:
newValue
- is new value for the sites field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addSites
Add single child node to existing array of sites nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSite and ProtoInstance.- Parameters:
newValue
- is new value to be appended the sites field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addSites
Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for sites 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:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addSites
Add array of child sites nodes to array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSite.- Specified by:
addSites
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value array to be appended the sites field.
-
setSites
Set single child sites node, replacing prior array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to HAnimSite.- Specified by:
setSites
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new node for the sites field (restricted to HAnimSite)
-
clearSites
Utility method to clear MFNode value of sites field. This method does not initialize withSITES_DEFAULT_VALUE.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasSites
public boolean hasSites()Indicate whether an object is available for inputOutput MFNode field sites.- Returns:
- whether a properly typed node or ProtoInstance array or CommentsBlock is available.
- See Also:
-
getSkeletalConfiguration
Provide String value from inputOutput SFString field named skeletalConfiguration.
Tooltip: Models sharing a common skeletal configuration can share animations and binding poses.- Hint: a value of 'BASIC' conforms to restrictive skeletal model in X3D Humanoid Animation (HAnim) Specification, Part 1 Architecture, 4.8 Modelling of humanoids, https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/concepts.html#ModellingOfHumanoids
- Specified by:
getSkeletalConfiguration
in interfaceHAnimHumanoid
- Returns:
- value of skeletalConfiguration field
-
setSkeletalConfiguration
Accessor method to assign String value to inputOutput SFString field named skeletalConfiguration.
Tooltip: Models sharing a common skeletal configuration can share animations and binding poses.- Hint: a value of 'BASIC' conforms to restrictive skeletal model in X3D Humanoid Animation (HAnim) Specification, Part 1 Architecture, 4.8 Modelling of humanoids, https://www.web3d.org/documents/specifications/19774/V2.0/Architecture/concepts.html#ModellingOfHumanoids
- Specified by:
setSkeletalConfiguration
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the skeletalConfiguration field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSkeletalConfiguration
Assign typed object value to SFString skeletalConfiguration field, similar tosetSkeletalConfiguration(String)
.- Parameters:
newValue
- is new value for the skeletalConfiguration field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getSkeleton
Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to HAnimJoint|HAnimSite, from inputOutput MFNode field skeleton.
Tooltip: [HAnimJoint|HAnimSite] List of top-level HAnimJoint and HAnimSite nodes that create the skeleton model. The skeleton field contains the humanoid_root Joint object, and thus the entire hierarchy of HAnimJoint/HAnimSegment nodes making up the articulated skeleton model.- Hint: typically contains HAnimJoint with name='humanoid_root'.
- Hint: immediate children in the skeleton field can also include top-level HAnimSite node declarations, which are landmarks for the overall humanoid figure that are not affected by HAnimJoint movement.
- Warning: top-level HAnimJoint and HAnimSite nodes must include containerField='skeleton' for proper validation and operation.
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimJoint|HAnimSite.- Specified by:
getSkeleton
in interfaceHAnimHumanoid
- Returns:
- value of skeleton field
- See Also:
-
getSkeletonList
Utility method to get ArrayList value of MFNode skeleton field, similar togetSkeleton()
.- Returns:
- value of skeleton field
-
setSkeleton
Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field skeleton.
Tooltip: [HAnimJoint|HAnimSite] List of top-level HAnimJoint and HAnimSite nodes that create the skeleton model. The skeleton field contains the humanoid_root Joint object, and thus the entire hierarchy of HAnimJoint/HAnimSegment nodes making up the articulated skeleton model.- Hint: typically contains HAnimJoint with name='humanoid_root'.
- Hint: immediate children in the skeleton field can also include top-level HAnimSite node declarations, which are landmarks for the overall humanoid figure that are not affected by HAnimJoint movement.
- Warning: top-level HAnimJoint and HAnimSite nodes must include containerField='skeleton' for proper validation and operation.
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimJoint|HAnimSite.- Specified by:
setSkeleton
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the skeleton field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSkeleton
Assign ArrayList value of MFNode skeleton field, similar tosetSkeleton(org.web3d.x3d.sai.Core.X3DNode[])
.- Parameters:
newValue
- is new value for the skeleton field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addSkeleton
Add single child node to existing array of skeleton nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimJoint|HAnimSite and ProtoInstance.- Parameters:
newValue
- is new value to be appended the skeleton field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addSkeleton
Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for skeleton 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:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addSkeleton
Add array of child skeleton nodes to array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimJoint|HAnimSite.- Specified by:
addSkeleton
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value array to be appended the skeleton field.
-
setSkeleton
Set single child skeleton node, replacing prior array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to HAnimJoint|HAnimSite.- Specified by:
setSkeleton
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new node for the skeleton field (restricted to HAnimJoint|HAnimSite)
-
clearSkeleton
Utility method to clear MFNode value of skeleton field. This method does not initialize withSKELETON_DEFAULT_VALUE.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasSkeleton
public boolean hasSkeleton()Indicate whether an object is available for inputOutput MFNode field skeleton.- Returns:
- whether a properly typed node or ProtoInstance array or CommentsBlock is available.
- See Also:
-
getSkin
Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to Group|Transform|Shape|IndexedFaceSet, from inputOutput MFNode field skin.
Tooltip: [Group|LOD|Shape|Switch|Transform|IndexedFaceSet|IndexedTriangleFanSet|IndexedLineSet|IndexedQuadSet|IndexedTriangleSet|IndexedTriangleStripSet] List of one or more indexed mesh definitions (such as IndexedFaceSet) that utilize skinCoord point and skinNormal normal data.- Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer nodes for proper skin animation.
- Warning: top-level node must include containerField='skin' for proper validation and operation.
- Hint: put skin node first and provide DEF label to simplify USE node usage within the skeleton hierarchy.
- Warning: requires X3D profile='Full' or else include <component name='HAnim' level='2'/>
- Warning: for X3D3 HAnim1, previous spelling of component name was 'H-Anim' (including hyphen).
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Group|Transform|Shape|IndexedFaceSet.- Specified by:
getSkin
in interfaceHAnimHumanoid
- Returns:
- value of skin field
- See Also:
-
getSkinList
-
setSkin
Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field skin.
Tooltip: [Group|LOD|Shape|Switch|Transform|IndexedFaceSet|IndexedTriangleFanSet|IndexedLineSet|IndexedQuadSet|IndexedTriangleSet|IndexedTriangleStripSet] List of one or more indexed mesh definitions (such as IndexedFaceSet) that utilize skinCoord point and skinNormal normal data.- Warning: index values for HanimHumanoid skin IndexedFaceSet, skinCoord and skinNormal nodes must all be consistently defined together with HAnimJoint HAnimSegment and HAnimDisplacer nodes for proper skin animation.
- Warning: top-level node must include containerField='skin' for proper validation and operation.
- Hint: put skin node first and provide DEF label to simplify USE node usage within the skeleton hierarchy.
- Warning: requires X3D profile='Full' or else include <component name='HAnim' level='2'/>
- Warning: for X3D3 HAnim1, previous spelling of component name was 'H-Anim' (including hyphen).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Group|Transform|Shape|IndexedFaceSet.- Specified by:
setSkin
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the skin field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSkin
Assign ArrayList value of MFNode skin field, similar tosetSkin(org.web3d.x3d.sai.Core.X3DNode[])
.- Parameters:
newValue
- is new value for the skin field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addSkin
Add single child node to existing array of skin nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Group|Transform|Shape|IndexedFaceSet and ProtoInstance.- Parameters:
newValue
- is new value to be appended the skin field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addSkin
Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for skin 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:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addSkin
Add array of child skin nodes to array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Group|Transform|Shape|IndexedFaceSet.- Specified by:
addSkin
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value array to be appended the skin field.
-
setSkin
Set single child skin node, replacing prior array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to Group|Transform|Shape|IndexedFaceSet.- Specified by:
setSkin
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new node for the skin field (restricted to Group|Transform|Shape|IndexedFaceSet)
-
clearSkin
Utility method to clear MFNode value of skin field. This method does not initialize withSKIN_DEFAULT_VALUE.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasSkin
public boolean hasSkin()Indicate whether an object is available for inputOutput MFNode field skin.- Returns:
- whether a properly typed node or ProtoInstance array or CommentsBlock is available.
- See Also:
-
getSkinBindingCoords
Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to Coordinate|CoordinateDouble, from inputOutput SFNode field skinBindingCoords.- Specified by:
getSkinBindingCoords
in interfaceHAnimHumanoid
- Returns:
- value of skinBindingCoords field
- See Also:
-
setSkinBindingCoords
Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field skinBindingCoords.- Specified by:
setSkinBindingCoords
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the skinBindingCoords field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearSkinBindingCoords
Utility method to clear SFNode value of skinBindingCoords field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setSkinBindingCoords
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field skinBindingCoords.- Parameters:
newValue
- is new value for the skinBindingCoords field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
hasSkinBindingCoords
public boolean hasSkinBindingCoords()Indicate whether an object is available for inputOutput SFNode field skinBindingCoords.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
-
getSkinBindingNormals
Provide org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field skinBindingNormals.- Specified by:
getSkinBindingNormals
in interfaceHAnimHumanoid
- Returns:
- value of skinBindingNormals field
- See Also:
-
setSkinBindingNormals
Accessor method to assign org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field skinBindingNormals.- Specified by:
setSkinBindingNormals
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the skinBindingNormals field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearSkinBindingNormals
Utility method to clear SFNode value of skinBindingNormals field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setSkinBindingNormals
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field skinBindingNormals.- Parameters:
newValue
- is new value for the skinBindingNormals field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
hasSkinBindingNormals
public boolean hasSkinBindingNormals()Indicate whether an object is available for inputOutput SFNode field skinBindingNormals.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
-
getSkinCoord
Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to Coordinate|CoordinateDouble, from inputOutput SFNode field skinCoord.- Specified by:
getSkinCoord
in interfaceHAnimHumanoid
- Returns:
- value of skinCoord field
- See Also:
-
setSkinCoord
Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field skinCoord.- Specified by:
setSkinCoord
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the skinCoord field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearSkinCoord
Utility method to clear SFNode value of skinCoord field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setSkinCoord
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field skinCoord.- Parameters:
newValue
- is new value for the skinCoord field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
hasSkinCoord
public boolean hasSkinCoord()Indicate whether an object is available for inputOutput SFNode field skinCoord.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
-
getSkinNormal
Provide org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field skinNormal.- Specified by:
getSkinNormal
in interfaceHAnimHumanoid
- Returns:
- value of skinNormal field
- See Also:
-
setSkinNormal
Accessor method to assign org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field skinNormal.- Specified by:
setSkinNormal
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the skinNormal field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearSkinNormal
Utility method to clear SFNode value of skinNormal field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setSkinNormal
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field skinNormal.- Parameters:
newValue
- is new value for the skinNormal field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
hasSkinNormal
public boolean hasSkinNormal()Indicate whether an object is available for inputOutput SFNode field skinNormal.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
-
getTranslation
public float[] getTranslation()Provide array of 3-tuple float results from inputOutput SFVec3f field named translation.
Tooltip: Position of children relative to local coordinate system.- Hint: since default pose faces along +Z axis, -x values are right side and +x values are left side within HAnimHumanoid.
- Specified by:
getTranslation
in interfaceHAnimHumanoid
- Returns:
- value of translation field
-
setTranslation
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named translation.
Tooltip: Position of children relative to local coordinate system.- Hint: since default pose faces along +Z axis, -x values are right side and +x values are left side within HAnimHumanoid.
- Specified by:
setTranslation
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the translation field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTranslation
Assign typed object value to SFVec3f translation field, similar tosetTranslation(float[])
.- Parameters:
newValue
- is new value for the translation field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTranslation
Assign values to SFVec3f translation field, similar tosetTranslation(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTranslation
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetTranslation(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTranslation
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetTranslation(float[])
.- Parameters:
newArray
- is new value for field- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getVersion
Provide String enumeration value (baseType xs:NMTOKEN) ["2.0"] from inputOutput SFString field named version.
Tooltip: HAnimHumanoid version, where allowed value is 2.0 for final ISO 19774 version 2019.- Hint: default HAnimHumanoid version is 1.0 for X3D version 3, and HAnimHumanoid required version is 2.0 for X3D version 4.
- Warning: no other values are allowed for strict validation.
- Warning: prior developmental versions of HAnim nodes, such as version 1 of standardized ISO 19774 version 2006, might not validate correctly due to small changes in the contained-node content model, so conversion of such models is recommended.
Available enumeration values for string comparison:2_0
.- Specified by:
getVersion
in interfaceHAnimHumanoid
- Returns:
- value of version field
-
setVersion
Accessor method to assign String enumeration value ("2.0") to inputOutput SFString field named version.
Warning: authors can only choose from a strict list of enumeration values (2_0
).
Tooltip: HAnimHumanoid version, where allowed value is 2.0 for final ISO 19774 version 2019.- Hint: default HAnimHumanoid version is 1.0 for X3D version 3, and HAnimHumanoid required version is 2.0 for X3D version 4.
- Warning: no other values are allowed for strict validation.
- Warning: prior developmental versions of HAnim nodes, such as version 1 of standardized ISO 19774 version 2006, might not validate correctly due to small changes in the contained-node content model, so conversion of such models is recommended.
- Specified by:
setVersion
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the version field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setVersion
Assign typed object value to SFString version field, similar tosetVersion(String)
.- Parameters:
newValue
- is new value for the version field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getViewpoints
Provide array of org.web3d.x3d.sai.HAnim.HAnimSite results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field viewpoints.
Tooltip: [HAnimSite] List of HAnimSite nodes containing Viewpoint nodes that appear in the skeleton model, usually as USE node references. The viewpoints field contains zero or more special HAnimSite nodes that are only affected by HAnimHumanoid transformations (and no HAnimJoint transformations). Each HAnimSite can contain a Viewpoint as virtual camera in the HAnimHumanoid reference frame (such as viewing the face or profile of the human figure).- Warning: these are actual node declarations, not USE nodes.
- Hint: the viewpoint field has different functionality than the joints, segments and sites fields.
- Hint: the viewpoints field connects internal Site nodes that in turn hold relative Viewpoint nodes, such as <HAnimSite USE='ObserveFaceSite_view' containerField='viewpoints'/> which has corresponding counterpart nodes <HAnimSite DEF='ObserveFaceSite_view' name='ObserveFaceSite_view' containerField='children'> <Viewpoint description='look at me!'/> </HAnimSite>.
- Warning: top-level HAnimSite nodes (in turn containing Viewpoint nodes) must include containerField='viewpoints' for proper validation and operation.
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSite.- Specified by:
getViewpoints
in interfaceHAnimHumanoid
- Returns:
- value of viewpoints field
- See Also:
-
getViewpointsList
Utility method to get ArrayList value of MFNode viewpoints field, similar togetViewpoints()
.- Returns:
- value of viewpoints field
-
setViewpoints
Accessor method to assign org.web3d.x3d.sai.HAnim.HAnimSite array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field viewpoints.
Tooltip: [HAnimSite] List of HAnimSite nodes containing Viewpoint nodes that appear in the skeleton model, usually as USE node references. The viewpoints field contains zero or more special HAnimSite nodes that are only affected by HAnimHumanoid transformations (and no HAnimJoint transformations). Each HAnimSite can contain a Viewpoint as virtual camera in the HAnimHumanoid reference frame (such as viewing the face or profile of the human figure).- Warning: these are actual node declarations, not USE nodes.
- Hint: the viewpoint field has different functionality than the joints, segments and sites fields.
- Hint: the viewpoints field connects internal Site nodes that in turn hold relative Viewpoint nodes, such as <HAnimSite USE='ObserveFaceSite_view' containerField='viewpoints'/> which has corresponding counterpart nodes <HAnimSite DEF='ObserveFaceSite_view' name='ObserveFaceSite_view' containerField='children'> <Viewpoint description='look at me!'/> </HAnimSite>.
- Warning: top-level HAnimSite nodes (in turn containing Viewpoint nodes) must include containerField='viewpoints' for proper validation and operation.
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSite.- Specified by:
setViewpoints
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value for the viewpoints field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setViewpoints
Assign ArrayList value of MFNode viewpoints field, similar tosetViewpoints(org.web3d.x3d.sai.Core.X3DNode[])
.- Parameters:
newValue
- is new value for the viewpoints field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addViewpoints
Add single child node to existing array of viewpoints nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSite and ProtoInstance.- Parameters:
newValue
- is new value to be appended the viewpoints field.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addViewpoints
Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for viewpoints 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:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addViewpoints
Add array of child viewpoints nodes to array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to HAnimSite.- Specified by:
addViewpoints
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new value array to be appended the viewpoints field.
-
setViewpoints
Set single child viewpoints node, replacing prior array of existing nodes (if any).
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to HAnimSite.- Specified by:
setViewpoints
in interfaceHAnimHumanoid
- Parameters:
newValue
- is new node for the viewpoints field (restricted to HAnimSite)
-
clearViewpoints
Utility method to clear MFNode value of viewpoints field. This method does not initialize withVIEWPOINTS_DEFAULT_VALUE.- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasViewpoints
public boolean hasViewpoints()Indicate whether an object is available for inputOutput MFNode field viewpoints.- Returns:
- whether a properly typed node or ProtoInstance array or CommentsBlock is available.
- See Also:
-
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 interfaceHAnimHumanoid
- Specified by:
getVisible
in interfaceX3DBoundedObject
- 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 interfaceHAnimHumanoid
- Specified by:
setVisible
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the visible field.- Returns:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- 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:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHAnimVersion
-
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:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
HAnimHumanoid
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
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)
-