Class 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 Detail

      • appliedParametersChoices

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

        Allowed values: ""BOUNCE"", ""USER_FRICTION"", ""FRICTION_COEFFICIENT-2"", ""ERROR_REDUCTION"", ""CONSTANT_FORCE"", ""SPEED-1"", ""SPEED-2"", ""SLIP-1"", ""SLIP-2"".

        Default global parameters for collision outputs of rigid body physics system. Contact node can override parent CollisionCollection node. Multiple optional values, but appliedParameters enumerations cannot be extended.
        See Also:
        https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/rigid_physics.html#t-AppliedParametersValidValues
      • APPLIEDPARAMETERS_BOUNCE

        public static final java.lang.String APPLIEDPARAMETERS_BOUNCE
        Tooltip: The bounce field value is used. MFString field named appliedParameters with X3DUOM baseType appliedParametersChoices is an array that can only include one of the quoted enumeration values "BOUNCE" (Java syntax) or '"BOUNCE"' (XML syntax).
        See Also:
        appliedParametersChoices, Constant Field Values
      • APPLIEDPARAMETERS_USER_FRICTION

        public static final java.lang.String APPLIEDPARAMETERS_USER_FRICTION
        Tooltip: The system will normally calculate the friction direction vector that is perpendicular to the contact normal. This setting indicates that the user-supplied value in this contact should be used. MFString field named appliedParameters with X3DUOM baseType appliedParametersChoices is an array that can only include one of the quoted enumeration values "USER_FRICTION" (Java syntax) or '"USER_FRICTION"' (XML syntax).
        See Also:
        appliedParametersChoices, Constant Field Values
      • APPLIEDPARAMETERS_FRICTION_COEFFICIENT_2

        public static final java.lang.String APPLIEDPARAMETERS_FRICTION_COEFFICIENT_2
        Tooltip: Apply frictionCoefficients values. MFString field named appliedParameters with X3DUOM baseType appliedParametersChoices is an array that can only include one of the quoted enumeration values "FRICTION_COEFFICIENT-2" (Java syntax) or '"FRICTION_COEFFICIENT-2"' (XML syntax).
        See Also:
        appliedParametersChoices, Constant Field Values
      • APPLIEDPARAMETERS_ERROR_REDUCTION

        public static final java.lang.String APPLIEDPARAMETERS_ERROR_REDUCTION
        Tooltip: Apply softnessErrorCorrection value. MFString field named appliedParameters with X3DUOM baseType appliedParametersChoices is an array that can only include one of the quoted enumeration values "ERROR_REDUCTION" (Java syntax) or '"ERROR_REDUCTION"' (XML syntax).
        See Also:
        appliedParametersChoices, Constant Field Values
      • APPLIEDPARAMETERS_CONSTANT_FORCE

        public static final java.lang.String APPLIEDPARAMETERS_CONSTANT_FORCE
        Tooltip: Apply softnessConstantForceMix value. MFString field named appliedParameters with X3DUOM baseType appliedParametersChoices is an array that can only include one of the quoted enumeration values "CONSTANT_FORCE" (Java syntax) or '"CONSTANT_FORCE"' (XML syntax).
        See Also:
        appliedParametersChoices, Constant Field Values
      • APPLIEDPARAMETERS_SPEED_1

        public static final java.lang.String APPLIEDPARAMETERS_SPEED_1
        Tooltip: Apply first component of surfaceSpeed array. MFString field named appliedParameters with X3DUOM baseType appliedParametersChoices is an array that can only include one of the quoted enumeration values "SPEED-1" (Java syntax) or '"SPEED-1"' (XML syntax).
        See Also:
        appliedParametersChoices, Constant Field Values
      • APPLIEDPARAMETERS_SPEED_2

        public static final java.lang.String APPLIEDPARAMETERS_SPEED_2
        Tooltip: Apply second component of surfaceSpeed array. MFString field named appliedParameters with X3DUOM baseType appliedParametersChoices is an array that can only include one of the quoted enumeration values "SPEED-2" (Java syntax) or '"SPEED-2"' (XML syntax).
        See Also:
        appliedParametersChoices, Constant Field Values
      • APPLIEDPARAMETERS_SLIP_1

        public static final java.lang.String APPLIEDPARAMETERS_SLIP_1
        Tooltip: Apply first component of slipFactors array. MFString field named appliedParameters with X3DUOM baseType appliedParametersChoices is an array that can only include one of the quoted enumeration values "SLIP-1" (Java syntax) or '"SLIP-1"' (XML syntax).
        See Also:
        appliedParametersChoices, Constant Field Values
      • APPLIEDPARAMETERS_SLIP_2

        public static final java.lang.String APPLIEDPARAMETERS_SLIP_2
        Tooltip: Apply second component of slipFactors array. MFString field named appliedParameters with X3DUOM baseType appliedParametersChoices is an array that can only include one of the quoted enumeration values "SLIP-2" (Java syntax) or '"SLIP-2"' (XML syntax).
        See Also:
        appliedParametersChoices, Constant Field Values
      • NAME

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

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

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

        public static final java.util.ArrayList<java.lang.String> APPLIEDPARAMETERS_DEFAULT_VALUE
        MFString field named appliedParameters has default quoted value new String[] {"BOUNCE"} (Java syntax) or quoted value "BOUNCE" (XML syntax).
      • BOUNCE_DEFAULT_VALUE

        public static final float BOUNCE_DEFAULT_VALUE
        SFFloat field named bounce has default value 0f (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • ENABLED_DEFAULT_VALUE

        public static final boolean ENABLED_DEFAULT_VALUE
        SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
        See Also:
        Constant Field Values
      • FRICTIONCOEFFICIENTS_DEFAULT_VALUE

        public static final float[] FRICTIONCOEFFICIENTS_DEFAULT_VALUE
        SFVec2f field named frictionCoefficients has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).
      • IS_DEFAULT_VALUE

        public static final ISObject IS_DEFAULT_VALUE
        SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
      • METADATA_DEFAULT_VALUE

        public static final X3DMetadataObject METADATA_DEFAULT_VALUE
        SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
      • MINBOUNCESPEED_DEFAULT_VALUE

        public static final float MINBOUNCESPEED_DEFAULT_VALUE
        SFFloat field named minBounceSpeed has default value 0.1f (Java syntax) or 0.1 (XML syntax).
        See Also:
        Constant Field Values
      • SLIPFACTORS_DEFAULT_VALUE

        public static final float[] SLIPFACTORS_DEFAULT_VALUE
        SFVec2f field named slipFactors has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).
      • SOFTNESSCONSTANTFORCEMIX_DEFAULT_VALUE

        public static final float SOFTNESSCONSTANTFORCEMIX_DEFAULT_VALUE
        SFFloat field named softnessConstantForceMix has default value 0.0001f (Java syntax) or 0.0001 (XML syntax).
        See Also:
        Constant Field Values
      • SOFTNESSERRORCORRECTION_DEFAULT_VALUE

        public static final float SOFTNESSERRORCORRECTION_DEFAULT_VALUE
        SFFloat field named softnessErrorCorrection has default value 0.8f (Java syntax) or 0.8 (XML syntax).
        See Also:
        Constant Field Values
      • SURFACESPEED_DEFAULT_VALUE

        public static final float[] SURFACESPEED_DEFAULT_VALUE
        SFVec2f field named surfaceSpeed has default value {0f,0f} (Java syntax) or 0 0 (XML syntax).
      • fromField_APPLIEDPARAMETERS

        public static final java.lang.String fromField_APPLIEDPARAMETERS
        fromField ROUTE name for MFString field named appliedParameters.
        See Also:
        Constant Field Values
      • toField_APPLIEDPARAMETERS

        public static final java.lang.String toField_APPLIEDPARAMETERS
        toField ROUTE name for MFString field named appliedParameters.
        See Also:
        Constant Field Values
      • fromField_BOUNCE

        public static final java.lang.String fromField_BOUNCE
        fromField ROUTE name for SFFloat field named bounce.
        See Also:
        Constant Field Values
      • toField_BOUNCE

        public static final java.lang.String toField_BOUNCE
        toField ROUTE name for SFFloat field named bounce.
        See Also:
        Constant Field Values
      • fromField_COLLIDABLES

        public static final java.lang.String fromField_COLLIDABLES
        fromField ROUTE name for MFNode field named collidables.
        See Also:
        Constant Field Values
      • toField_COLLIDABLES

        public static final java.lang.String toField_COLLIDABLES
        toField ROUTE name for MFNode field named collidables.
        See Also:
        Constant Field Values
      • fromField_ENABLED

        public static final java.lang.String fromField_ENABLED
        fromField ROUTE name for SFBool field named enabled.
        See Also:
        Constant Field Values
      • toField_ENABLED

        public static final java.lang.String toField_ENABLED
        toField ROUTE name for SFBool field named enabled.
        See Also:
        Constant Field Values
      • fromField_FRICTIONCOEFFICIENTS

        public static final java.lang.String fromField_FRICTIONCOEFFICIENTS
        fromField ROUTE name for SFVec2f field named frictionCoefficients.
        See Also:
        Constant Field Values
      • toField_FRICTIONCOEFFICIENTS

        public static final java.lang.String toField_FRICTIONCOEFFICIENTS
        toField ROUTE name for SFVec2f field named frictionCoefficients.
        See Also:
        Constant Field Values
      • fromField_IS

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

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

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

        public static final java.lang.String fromField_MINBOUNCESPEED
        fromField ROUTE name for SFFloat field named minBounceSpeed.
        See Also:
        Constant Field Values
      • toField_MINBOUNCESPEED

        public static final java.lang.String toField_MINBOUNCESPEED
        toField ROUTE name for SFFloat field named minBounceSpeed.
        See Also:
        Constant Field Values
      • fromField_SLIPFACTORS

        public static final java.lang.String fromField_SLIPFACTORS
        fromField ROUTE name for SFVec2f field named slipFactors.
        See Also:
        Constant Field Values
      • toField_SLIPFACTORS

        public static final java.lang.String toField_SLIPFACTORS
        toField ROUTE name for SFVec2f field named slipFactors.
        See Also:
        Constant Field Values
      • fromField_SOFTNESSCONSTANTFORCEMIX

        public static final java.lang.String fromField_SOFTNESSCONSTANTFORCEMIX
        fromField ROUTE name for SFFloat field named softnessConstantForceMix.
        See Also:
        Constant Field Values
      • toField_SOFTNESSCONSTANTFORCEMIX

        public static final java.lang.String toField_SOFTNESSCONSTANTFORCEMIX
        toField ROUTE name for SFFloat field named softnessConstantForceMix.
        See Also:
        Constant Field Values
      • fromField_SOFTNESSERRORCORRECTION

        public static final java.lang.String fromField_SOFTNESSERRORCORRECTION
        fromField ROUTE name for SFFloat field named softnessErrorCorrection.
        See Also:
        Constant Field Values
      • toField_SOFTNESSERRORCORRECTION

        public static final java.lang.String toField_SOFTNESSERRORCORRECTION
        toField ROUTE name for SFFloat field named softnessErrorCorrection.
        See Also:
        Constant Field Values
      • fromField_SURFACESPEED

        public static final java.lang.String fromField_SURFACESPEED
        fromField ROUTE name for SFVec2f field named surfaceSpeed.
        See Also:
        Constant Field Values
      • toField_SURFACESPEED

        public static final java.lang.String toField_SURFACESPEED
        toField ROUTE name for SFVec2f field named surfaceSpeed.
        See Also:
        Constant Field Values
    • Constructor Detail

      • 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 Detail

      • 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
      • 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​(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).
      • 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​(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).
      • 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​(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).
      • 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()
      • 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).
      • 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​(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​(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​(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​(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​(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).
      • 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).
      • 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).
      • 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
      • setUSE

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

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

        Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
        Parameters:
        DEFnode - must have a DEF value defined
        Returns:
        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[] 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).
      • 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)
      • 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)