Class Contour2DObject

  • All Implemented Interfaces:
    X3DNode, Contour2D

    public class Contour2DObject
    extends X3DConcreteNode
    implements Contour2D
    X3D node tooltip: [X3DNode] Contour2D groups a set of curve segments into a composite contour. The children segments form a closed loop, with first point of first child repeated as last point of last child, and last point of each segment repeated as the first point of the next consecutive segment. The children segments are type NurbsCurve2D or ContourPolyline2D, enumerated in the consecutive order of contour topology.
    • Warning: Contour2D is not a renderable geometry node.
    • Hint: Contour2D is used as the trimmingContour field of the NurbsTrimmedSurface node.

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

      • NAME

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

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

        public static final int LEVEL
        Integer constant LEVEL provides default X3D NURBS component level for this element: 4
        See Also:
        Constant Field Values
      • 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).
      • toField_ADDCHILDREN

        public static final java.lang.String toField_ADDCHILDREN
        toField ROUTE name for MFNode field named addChildren.
        See Also:
        Constant Field Values
      • fromField_CHILDREN

        public static final java.lang.String fromField_CHILDREN
        fromField ROUTE name for MFNode field named children.
        See Also:
        Constant Field Values
      • toField_CHILDREN

        public static final java.lang.String toField_CHILDREN
        toField ROUTE name for MFNode field named children.
        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
      • toField_REMOVECHILDREN

        public static final java.lang.String toField_REMOVECHILDREN
        toField ROUTE name for MFNode field named removeChildren.
        See Also:
        Constant Field Values
    • Constructor Detail

      • Contour2DObject

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

        public Contour2DObject​(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: Contour2D
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.String getComponent()
        Defines X3D component for the Contour2D element: NURBS
        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: 4
        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
      • getChildren

        public X3DNode[] getChildren()
        Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to NurbsCurve2D|ContourPolyline2D, from inputOutput MFNode field children.

        Tooltip: [NurbsCurve2D|ContourPolyline2D] The children form a closed loop with first point of first child repeated as last point of last child, and the last point of a segment repeated as first point of the consecutive one.
        • Hint: children nodes are listed in consecutive order according to topology of the contour.


        Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to NurbsCurve2D|ContourPolyline2D.
        Specified by:
        getChildren in interface Contour2D
        Returns:
        value of children field
        See Also:
        NurbsCurve2DObject, ContourPolyline2DObject
      • getChildrenList

        public java.util.ArrayList<X3DNode> getChildrenList()
        Utility method to get ArrayList value of MFNode children field, similar to getChildren().
        Returns:
        value of children field
      • setChildren

        public Contour2DObject setChildren​(X3DNode[] newValue)
        Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (newValue instanceof org.web3d.x3d.jsail.Core.CommentsBlock) || (newValue instanceof org.web3d.x3d.jsail.Core.ROUTEObject) || (newValue instanceof org.web3d.x3d.jsail.Networking.IMPORTObject) || (newValue instanceof org.web3d.x3d.jsail.Networking.EXPORTObject) || (newValue instanceof org.web3d.x3d.jsail.Core.ProtoDeclareObject) || (newValue instanceof org.web3d.x3d.jsail.Core.ExternProtoDeclareObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.NURBS.NurbsCurve2DObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.NURBS.ContourPolyline2DObject); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes NurbsCurve2D|ContourPolyline2D; newValue=" + newValue); }

        Tooltip: [NurbsCurve2D|ContourPolyline2D] The children form a closed loop with first point of first child repeated as last point of last child, and the last point of a segment repeated as first point of the consecutive one.
        • Hint: children nodes are listed in consecutive order according to topology of the contour.


        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to NurbsCurve2D|ContourPolyline2D.
        Specified by:
        setChildren in interface Contour2D
        Parameters:
        newValue - is new value for the children field.
        Returns:
        Contour2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setChildren

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

        public void addChildren​(X3DNode newValue)
        Add single node to existing array of children nodes (if any).

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to NurbsCurve2D|ContourPolyline2D and ProtoInstance.
        Parameters:
        newValue - is new value to be appended the children field.
      • addChildren

        public Contour2DObject addChildren​(ProtoInstanceObject newValue)
        Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for children field.

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

        public Contour2DObject addChild​(X3DChildNode newValue)
        Utility method to add single child element to contained list of existing children nodes (if any).
        Parameters:
        newValue - is new node value to be appended the children field.
        Returns:
        Contour2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addChild

        public Contour2DObject addChild​(NurbsCurve2DObject newValue)
        Add single children node to array of existing children nodes (if any) for Contour2D.
        Parameters:
        newValue - is new node value to be appended the children field.
        Returns:
        Contour2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addChild

        public Contour2DObject addChild​(ContourPolyline2DObject newValue)
        Add single children node to array of existing children nodes (if any) for Contour2D.
        Parameters:
        newValue - is new node value to be appended the children field.
        Returns:
        Contour2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addChildren

        public void addChildren​(X3DNode[] newValue)
        Add array of children nodes to array of existing nodes (if any).

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to NurbsCurve2D|ContourPolyline2D.
        Specified by:
        addChildren in interface Contour2D
        Parameters:
        newValue - is new value array to be appended the children field.
      • setChildren

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

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to NurbsCurve2D|ContourPolyline2D.
        Specified by:
        setChildren in interface Contour2D
        Parameters:
        newValue - is new node for the children field (restricted to NurbsCurve2D|ContourPolyline2D)
      • clearChildren

        public Contour2DObject clearChildren()
        Utility method to clear MFNode value of children field.
        Returns:
        Contour2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasChildren

        public boolean hasChildren()
        Indicate whether an object is available for inputOutput MFNode field children.
        Returns:
        whether a properly typed node or ProtoInstance array or CommentsBlock is available.
        See Also:
        getChildren()
      • addComments

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

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

        public Contour2DObject addComments​(CommentsBlock newCommentsBlock)
        Add CommentsBlock to children field
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newCommentsBlock - block of comments to add
        Returns:
        Contour2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearIS

        public Contour2DObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        Contour2DObject - 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 Contour2DObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        Contour2DObject - 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
      • setDEF

        public final Contour2DObject 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:
        Contour2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDEF

        public Contour2DObject 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:
        Contour2DObject - 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 Contour2DObject 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:
        Contour2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUSE

        public Contour2DObject 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:
        Contour2DObject - 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 Contour2DObject 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:
        Contour2DObject - 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 Contour2DObject 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:
        Contour2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUSE

        public Contour2DObject setUSE​(Contour2DObject 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:
        Contour2DObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • 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)