Class CollisionCollectionObject

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.RigidBodyPhysics.CollisionCollectionObject
All Implemented Interfaces:
X3DNode, CollisionCollection

public class CollisionCollectionObject
extends X3DConcreteNode
implements CollisionCollection
CollisionCollection holds a collection of objects that can be managed as a single entity for resolution of inter-object collisions.

X3D node tooltip: (X3D version 3.2 or later) [X3DChildNode] CollisionCollection holds a collection of objects that can be managed as a single entity for resolution of inter-object collisions.
  • Hint: contains an array of CollisionSpace, CollidableShape or CollidableOffset nodes (containerField='collidables').

Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:
X3D Abstract Specification: CollisionCollection, X3D Tooltips: CollisionCollection, X3D Scene Authoring Hints
  • Field Details

  • Constructor Details

    • CollisionCollectionObject

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

      public CollisionCollectionObject​(java.lang.String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node
  • Method Details

    • getElementName

      public final java.lang.String getElementName()
      Provides name of this element: CollisionCollection
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the CollisionCollection element: RigidBodyPhysics
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element
    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 1
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element
    • getFieldType

      public java.lang.String getFieldType​(java.lang.String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
    • getAccessType

      public java.lang.String getAccessType​(java.lang.String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
    • getContainerFieldDefault

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

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

      public java.lang.String[] getAppliedParameters()
      Provide array of String enumeration results ( baseType appliedParametersChoices) [""BOUNCE"" | ""USER_FRICTION"" | ""FRICTION_COEFFICIENT-2"" | ""ERROR_REDUCTION"" | ""CONSTANT_FORCE"" | ""SPEED-1"" | ""SPEED-2"" | ""SLIP-1"" | ""SLIP-2""] from inputOutput MFString field named appliedParameters.

      Tooltip: Default global parameters for collision outputs of rigid body physics system. Contact node can override parent CollisionCollection node. Selectable values for array: "BOUNCE" "USER_FRICTION" "FRICTION_COEFFICIENT-2" "ERROR_REDUCTION" "CONSTANT_FORCE" "SPEED-1" "SPEED-2" "SLIP-1" "SLIP-2".
      • Hint: BOUNCE: bounce value is used; USER_FRICTION: apply user-supplied value; FRICTION_COEFFICIENT-2: apply frictionCoefficients values; ERROR_REDUCTION: apply softnessErrorCorrection value; CONSTANT_FORCE: apply softnessConstantForceMix value; SPEED-1: apply first component of surfaceSpeed array; SPEED-2: apply second component of surfaceSpeed array; SLIP-1: apply first component of slipFactors array; SLIP-2: apply second component of slipFactors array.


      Available enumeration values for string comparison: BOUNCE, USER_FRICTION, FRICTION_COEFFICIENT_2, ERROR_REDUCTION, CONSTANT_FORCE, SPEED_1, SPEED_2, SLIP_1, SLIP_2.
      Specified by:
      getAppliedParameters in interface CollisionCollection
      Returns:
      value of appliedParameters field
    • getAppliedParametersList

      public java.util.ArrayList<java.lang.String> getAppliedParametersList()
      Utility method to get ArrayList value of MFString appliedParameters field, similar to getAppliedParameters().
      Returns:
      value of appliedParameters field
    • setAppliedParameters

      public CollisionCollectionObject setAppliedParameters​(java.lang.String[] newValue)
      Accessor method to assign String enumeration array (""BOUNCE"" | ""USER_FRICTION"" | ""FRICTION_COEFFICIENT-2"" | ""ERROR_REDUCTION"" | ""CONSTANT_FORCE"" | ""SPEED-1"" | ""SPEED-2"" | ""SLIP-1"" | ""SLIP-2"") to inputOutput MFString field named appliedParameters.

      Warning: authors can only choose from a strict list of enumeration values (BOUNCE, USER_FRICTION, FRICTION_COEFFICIENT_2, ERROR_REDUCTION, CONSTANT_FORCE, SPEED_1, SPEED_2, SLIP_1, SLIP_2).

      Tooltip: Default global parameters for collision outputs of rigid body physics system. Contact node can override parent CollisionCollection node. Selectable values for array: "BOUNCE" "USER_FRICTION" "FRICTION_COEFFICIENT-2" "ERROR_REDUCTION" "CONSTANT_FORCE" "SPEED-1" "SPEED-2" "SLIP-1" "SLIP-2".
      • Hint: BOUNCE: bounce value is used; USER_FRICTION: apply user-supplied value; FRICTION_COEFFICIENT-2: apply frictionCoefficients values; ERROR_REDUCTION: apply softnessErrorCorrection value; CONSTANT_FORCE: apply softnessConstantForceMix value; SPEED-1: apply first component of surfaceSpeed array; SPEED-2: apply second component of surfaceSpeed array; SLIP-1: apply first component of slipFactors array; SLIP-2: apply second component of slipFactors array.
      Specified by:
      setAppliedParameters in interface CollisionCollection
      Parameters:
      newValue - is new value for the appliedParameters field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAppliedParameters

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

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

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

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

      public CollisionCollectionObject clearAppliedParameters()
      Utility method to clear MFString value of appliedParameters field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addAppliedParameters

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

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

      public float getBounce()
      Provide float value within allowed range of [0,1] from inputOutput SFFloat field named bounce.

      Tooltip: [0,1] bounce indicates bounciness (0 = no bounce at all, 1 = maximum bounce). *
      Specified by:
      getBounce in interface CollisionCollection
      Returns:
      value of bounce field
    • setBounce

      public CollisionCollectionObject setBounce​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named bounce.

      Tooltip: [0,1] bounce indicates bounciness (0 = no bounce at all, 1 = maximum bounce). *
      Specified by:
      setBounce in interface CollisionCollection
      Parameters:
      newValue - is new value for the bounce field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBounce

      public CollisionCollectionObject setBounce​(SFFloatObject newValue)
      Assign typed object value to SFFloat bounce field, similar to setBounce(float).
      Parameters:
      newValue - is new value for the bounce field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBounce

      public CollisionCollectionObject setBounce​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setBounce(float).
      Parameters:
      newValue - is new value for field
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCollidables

      public X3DNode[] getCollidables()
      Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode, from inputOutput MFNode field collidables.

      Tooltip: [CollisionSpace|CollidableShape|CollidableOffset] CollisionCollection node holds a collection of objects in the collidables field that can be managed as a single entity for resolution of inter-object collisions with other groups of collidable objects. A group consists of both collidable objects as well as spaces that may be collided against each other. *


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode.
      Specified by:
      getCollidables in interface CollisionCollection
      Returns:
      value of collidables field
      See Also:
      X3DNBodyCollisionSpaceNode, X3DNBodyCollidableNode
    • getCollidablesList

      public java.util.ArrayList<X3DNode> getCollidablesList()
      Utility method to get ArrayList value of MFNode collidables field, similar to getCollidables().
      Returns:
      value of collidables field
    • setCollidables

      public CollisionCollectionObject setCollidables​(X3DNode[] newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field collidables. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollisionSpaceNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.RigidBodyPhysics.X3DNBodyCollidableNode); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode; newValue=" + newValue); }

      Tooltip: [CollisionSpace|CollidableShape|CollidableOffset] CollisionCollection node holds a collection of objects in the collidables field that can be managed as a single entity for resolution of inter-object collisions with other groups of collidable objects. A group consists of both collidable objects as well as spaces that may be collided against each other. *


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode.
      Specified by:
      setCollidables in interface CollisionCollection
      Parameters:
      newValue - is new value for the collidables field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCollidables

      public CollisionCollectionObject setCollidables​(java.util.ArrayList<X3DNode> newValue)
      Assign ArrayList value of MFNode collidables field, similar to setCollidables(X3DNode[]).
      Parameters:
      newValue - is new value for the collidables field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addCollidables

      public CollisionCollectionObject addCollidables​(X3DNode newValue)
      Add single child node to existing array of collidables nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode and ProtoInstance.
      Parameters:
      newValue - is new value to be appended the collidables field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addCollidables

      public CollisionCollectionObject addCollidables​(ProtoInstanceObject newValue)
      Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for collidables 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:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addCollidables

      public void addCollidables​(X3DNode[] newValue)
      Add array of child collidables nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode.
      Specified by:
      addCollidables in interface CollisionCollection
      Parameters:
      newValue - is new value array to be appended the collidables field.
    • setCollidables

      public void setCollidables​(X3DNode newValue)
      Set single child collidables node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode.
      Specified by:
      setCollidables in interface CollisionCollection
      Parameters:
      newValue - is new node for the collidables field (restricted to X3DNBodyCollisionSpaceNode|X3DNBodyCollidableNode)
    • clearCollidables

      public CollisionCollectionObject clearCollidables()
      Utility method to clear MFNode value of collidables field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasCollidables

      public boolean hasCollidables()
      Indicate whether an object is available for inputOutput MFNode field collidables.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:
      getCollidables()
    • getEnabled

      public boolean getEnabled()
      Provide boolean value from inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Specified by:
      getEnabled in interface CollisionCollection
      Returns:
      value of enabled field
    • setEnabled

      public CollisionCollectionObject setEnabled​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Specified by:
      setEnabled in interface CollisionCollection
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setEnabled

      public CollisionCollectionObject setEnabled​(SFBoolObject newValue)
      Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getFrictionCoefficients

      public float[] getFrictionCoefficients()
      Provide array of 2-tuple float results within allowed range of [0,infinity) from inputOutput SFVec2f field named frictionCoefficients.

      Tooltip: frictionCoefficients used for computing surface drag. *
      Specified by:
      getFrictionCoefficients in interface CollisionCollection
      Returns:
      value of frictionCoefficients field
    • setFrictionCoefficients

      public CollisionCollectionObject setFrictionCoefficients​(float[] newValue)
      Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named frictionCoefficients.

      Tooltip: frictionCoefficients used for computing surface drag. *
      Specified by:
      setFrictionCoefficients in interface CollisionCollection
      Parameters:
      newValue - is new value for the frictionCoefficients field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setFrictionCoefficients

      public CollisionCollectionObject setFrictionCoefficients​(SFVec2fObject newValue)
      Assign typed object value to SFVec2f frictionCoefficients field, similar to setFrictionCoefficients(float[]).
      Parameters:
      newValue - is new value for the frictionCoefficients field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setFrictionCoefficients

      public CollisionCollectionObject setFrictionCoefficients​(float x, float y)
      Assign values to SFVec2f frictionCoefficients field, similar to setFrictionCoefficients(float[]).
      Parameters:
      x - first component
      y - second component
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setFrictionCoefficients

      public CollisionCollectionObject setFrictionCoefficients​(double x, double y)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setFrictionCoefficients(float[]).
      Parameters:
      x - first component
      y - second component
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setFrictionCoefficients

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

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

      public CollisionCollectionObject setIS​(ISObject newValue)
      Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • clearIS

      public CollisionCollectionObject clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:
      getIS()
    • getMetadata

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

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

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

      public CollisionCollectionObject setMetadata​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(X3DMetadataObject)
    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • getMinBounceSpeed

      public float getMinBounceSpeed()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named minBounceSpeed.

      Tooltip: [0,+infinity) minBounceSpeed m/s needed to bounce. *
      Specified by:
      getMinBounceSpeed in interface CollisionCollection
      Returns:
      value of minBounceSpeed field
    • setMinBounceSpeed

      public CollisionCollectionObject setMinBounceSpeed​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named minBounceSpeed.

      Tooltip: [0,+infinity) minBounceSpeed m/s needed to bounce. *
      Specified by:
      setMinBounceSpeed in interface CollisionCollection
      Parameters:
      newValue - is new value for the minBounceSpeed field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMinBounceSpeed

      public CollisionCollectionObject setMinBounceSpeed​(SFFloatObject newValue)
      Assign typed object value to SFFloat minBounceSpeed field, similar to setMinBounceSpeed(float).
      Parameters:
      newValue - is new value for the minBounceSpeed field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMinBounceSpeed

      public CollisionCollectionObject setMinBounceSpeed​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMinBounceSpeed(float).
      Parameters:
      newValue - is new value for field
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSlipFactors

      public float[] getSlipFactors()
      Provide array of 2-tuple float results from inputOutput SFVec2f field named slipFactors.

      Tooltip: slipFactors used for computing surface drag. *
      Specified by:
      getSlipFactors in interface CollisionCollection
      Returns:
      value of slipFactors field
    • setSlipFactors

      public CollisionCollectionObject setSlipFactors​(float[] newValue)
      Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named slipFactors.

      Tooltip: slipFactors used for computing surface drag. *
      Specified by:
      setSlipFactors in interface CollisionCollection
      Parameters:
      newValue - is new value for the slipFactors field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSlipFactors

      public CollisionCollectionObject setSlipFactors​(SFVec2fObject newValue)
      Assign typed object value to SFVec2f slipFactors field, similar to setSlipFactors(float[]).
      Parameters:
      newValue - is new value for the slipFactors field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSlipFactors

      public CollisionCollectionObject setSlipFactors​(float x, float y)
      Assign values to SFVec2f slipFactors field, similar to setSlipFactors(float[]).
      Parameters:
      x - first component
      y - second component
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSlipFactors

      public CollisionCollectionObject setSlipFactors​(double x, double y)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setSlipFactors(float[]).
      Parameters:
      x - first component
      y - second component
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSlipFactors

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

      public float getSoftnessConstantForceMix()
      Provide float value within allowed range of [0,1] from inputOutput SFFloat field named softnessConstantForceMix.

      Tooltip: [0,1] softnessConstantForceMix value applies a constant force value to make colliding surfaces appear to be somewhat soft. *
      Specified by:
      getSoftnessConstantForceMix in interface CollisionCollection
      Returns:
      value of softnessConstantForceMix field
    • setSoftnessConstantForceMix

      public CollisionCollectionObject setSoftnessConstantForceMix​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named softnessConstantForceMix.

      Tooltip: [0,1] softnessConstantForceMix value applies a constant force value to make colliding surfaces appear to be somewhat soft. *
      Specified by:
      setSoftnessConstantForceMix in interface CollisionCollection
      Parameters:
      newValue - is new value for the softnessConstantForceMix field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSoftnessConstantForceMix

      public CollisionCollectionObject setSoftnessConstantForceMix​(SFFloatObject newValue)
      Assign typed object value to SFFloat softnessConstantForceMix field, similar to setSoftnessConstantForceMix(float).
      Parameters:
      newValue - is new value for the softnessConstantForceMix field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSoftnessConstantForceMix

      public CollisionCollectionObject setSoftnessConstantForceMix​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSoftnessConstantForceMix(float).
      Parameters:
      newValue - is new value for field
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSoftnessErrorCorrection

      public float getSoftnessErrorCorrection()
      Provide float value within allowed range of [0,1] from inputOutput SFFloat field named softnessErrorCorrection.

      Tooltip: [0,1] softnessErrorCorrection indicates fraction of collision error fixed in a set of evaluations (0 = no error correction, 1 = all errors corrected in single step). *
      Specified by:
      getSoftnessErrorCorrection in interface CollisionCollection
      Returns:
      value of softnessErrorCorrection field
    • setSoftnessErrorCorrection

      public CollisionCollectionObject setSoftnessErrorCorrection​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named softnessErrorCorrection.

      Tooltip: [0,1] softnessErrorCorrection indicates fraction of collision error fixed in a set of evaluations (0 = no error correction, 1 = all errors corrected in single step). *
      Specified by:
      setSoftnessErrorCorrection in interface CollisionCollection
      Parameters:
      newValue - is new value for the softnessErrorCorrection field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSoftnessErrorCorrection

      public CollisionCollectionObject setSoftnessErrorCorrection​(SFFloatObject newValue)
      Assign typed object value to SFFloat softnessErrorCorrection field, similar to setSoftnessErrorCorrection(float).
      Parameters:
      newValue - is new value for the softnessErrorCorrection field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSoftnessErrorCorrection

      public CollisionCollectionObject setSoftnessErrorCorrection​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSoftnessErrorCorrection(float).
      Parameters:
      newValue - is new value for field
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSurfaceSpeed

      public float[] getSurfaceSpeed()
      Provide array of 2-tuple float results from inputOutput SFVec2f field named surfaceSpeed.

      Tooltip: surfaceSpeed defines speed vectors for computing surface drag, if contact surfaces move independently of bodies. *
      Specified by:
      getSurfaceSpeed in interface CollisionCollection
      Returns:
      value of surfaceSpeed field
    • setSurfaceSpeed

      public CollisionCollectionObject setSurfaceSpeed​(float[] newValue)
      Accessor method to assign 2-tuple float array to inputOutput SFVec2f field named surfaceSpeed.

      Tooltip: surfaceSpeed defines speed vectors for computing surface drag, if contact surfaces move independently of bodies. *
      Specified by:
      setSurfaceSpeed in interface CollisionCollection
      Parameters:
      newValue - is new value for the surfaceSpeed field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSurfaceSpeed

      public CollisionCollectionObject setSurfaceSpeed​(SFVec2fObject newValue)
      Assign typed object value to SFVec2f surfaceSpeed field, similar to setSurfaceSpeed(float[]).
      Parameters:
      newValue - is new value for the surfaceSpeed field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSurfaceSpeed

      public CollisionCollectionObject setSurfaceSpeed​(float x, float y)
      Assign values to SFVec2f surfaceSpeed field, similar to setSurfaceSpeed(float[]).
      Parameters:
      x - first component
      y - second component
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSurfaceSpeed

      public CollisionCollectionObject setSurfaceSpeed​(double x, double y)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setSurfaceSpeed(float[]).
      Parameters:
      x - first component
      y - second component
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSurfaceSpeed

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

      public java.lang.String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

      public final CollisionCollectionObject setDEF​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

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

      public java.lang.String getUSE()
      Provide String value from inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setUSE

      public final CollisionCollectionObject setUSE​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.


      Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

      Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Specified by:
      setUSE in class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

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

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

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

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

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

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

      Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

      Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Parameters:
      DEFnode - must have a DEF value defined
      Returns:
      CollisionCollectionObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

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

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

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

      public java.lang.String toStringX3D​(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • toStringClassicVRML

      public java.lang.String toStringClassicVRML​(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
      X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
    • toStringVRML97

      public java.lang.String toStringVRML97​(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
      X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • hasElementByNameValue

      public boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:
      findElementByNameValue(String, String)
    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • hasNodeByDEF

      public boolean hasNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:
      findNodeByDEF(String)
    • validate

      public java.lang.String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)