Class PointSetObject

  • All Implemented Interfaces:
    X3DNode, PointSet, X3DGeometryNode

    public class PointSetObject
    extends X3DConcreteNode
    implements PointSet
    X3D node tooltip: [X3DGeometryNode] PointSet is a node that contains a set of colored 3D points, represented by contained Color|ColorRGBA and Coordinate|CoordinateDouble nodes.
    • Hint: Point (geometry) https://en.wikipedia.org/wiki/Point_(geometry)
    • Hint: either values in a contained Color node, or else Material emissiveColor in corresponding Appearance node, are used for rendering lines and points.
    • Warning: use a different color (or Material emissiveColor) than the Background color, otherwise geometry is invisible.
    • Hint: insert a Shape node before adding geometry or Appearance.
    • Hint: each point is displayed independently, no other PointSet attributes for rendering are provided.

    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: PointSet, X3D Tooltips: PointSet, X3D Scene Authoring Hints
    • Field Detail

      • NAME

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

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

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

        public static final X3DColorNode COLOR_DEFAULT_VALUE
        SFNode field named color has default value null (Java syntax) or NULL (XML syntax).
      • COORD_DEFAULT_VALUE

        public static final X3DCoordinateNode COORD_DEFAULT_VALUE
        SFNode field named coord has default value null (Java syntax) or NULL (XML syntax).
      • FOGCOORD_DEFAULT_VALUE

        public static final FogCoordinateObject FOGCOORD_DEFAULT_VALUE
        SFNode field named fogCoord has default value null (Java syntax) or NULL (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).
      • fromField_ATTRIB

        public static final java.lang.String fromField_ATTRIB
        fromField ROUTE name for MFNode field named attrib.
        See Also:
        Constant Field Values
      • toField_ATTRIB

        public static final java.lang.String toField_ATTRIB
        toField ROUTE name for MFNode field named attrib.
        See Also:
        Constant Field Values
      • fromField_COLOR

        public static final java.lang.String fromField_COLOR
        fromField ROUTE name for SFNode field named color.
        See Also:
        Constant Field Values
      • toField_COLOR

        public static final java.lang.String toField_COLOR
        toField ROUTE name for SFNode field named color.
        See Also:
        Constant Field Values
      • fromField_COORD

        public static final java.lang.String fromField_COORD
        fromField ROUTE name for SFNode field named coord.
        See Also:
        Constant Field Values
      • toField_COORD

        public static final java.lang.String toField_COORD
        toField ROUTE name for SFNode field named coord.
        See Also:
        Constant Field Values
      • fromField_FOGCOORD

        public static final java.lang.String fromField_FOGCOORD
        fromField ROUTE name for SFNode field named fogCoord.
        See Also:
        Constant Field Values
      • toField_FOGCOORD

        public static final java.lang.String toField_FOGCOORD
        toField ROUTE name for SFNode field named fogCoord.
        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
    • Constructor Detail

      • PointSetObject

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

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

        public final java.lang.String getComponent()
        Defines X3D component for the PointSet element: Rendering
        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
      • getAttribList

        public java.util.ArrayList<X3DNode> getAttribList()
        Utility method to get ArrayList value of MFNode attrib field, similar to getAttrib().
        Returns:
        value of attrib field
      • setAttrib

        public PointSetObject setAttrib​(X3DNode[] newValue)
        Accessor method to assign X3DVertexAttributeNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field attrib.

        Tooltip: [X3DVertexAttributeNode] Single contained FloatVertexAttribute node that specifies list of per-vertex attribute information for programmable shaders.

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVertexAttributeNode.
        Specified by:
        setAttrib in interface PointSet
        Parameters:
        newValue - is new value for the attrib field.
        Returns:
        PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setAttrib

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

        public PointSetObject addAttrib​(X3DNode newValue)
        Add single child node to existing array of attrib nodes (if any).

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

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

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

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVertexAttributeNode.
        Specified by:
        addAttrib in interface PointSet
        Parameters:
        newValue - is new value array to be appended the attrib field.
      • setAttrib

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

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DVertexAttributeNode.
        Specified by:
        setAttrib in interface PointSet
        Parameters:
        newValue - is new node for the attrib field (restricted to X3DVertexAttributeNode)
      • clearAttrib

        public PointSetObject clearAttrib()
        Utility method to clear MFNode value of attrib field.
        Returns:
        PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasAttrib

        public boolean hasAttrib()
        Indicate whether an object is available for inputOutput MFNode field attrib.
        Returns:
        whether a properly typed node or ProtoInstance array or CommentsBlock is available.
        See Also:
        getAttrib()
      • getColor

        public X3DColorNode getColor()
        Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.
        Specified by:
        getColor in interface PointSet
        Returns:
        value of color field
        See Also:
        Tooltip: [X3DColorNode] Single contained Color or ColorRGBA node that specifies color values applied to corresponding vertices according to colorIndex and colorPerVertex fields. *
      • clearColor

        public PointSetObject clearColor()
        Utility method to clear SFNode value of color field.
        Returns:
        PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setColor

        public PointSetObject setColor​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field color.
        Parameters:
        newValue - is new value for the color field.
        Returns:
        PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setColor(X3DColorNode)
      • hasColor

        public boolean hasColor()
        Indicate whether an object is available for inputOutput SFNode field color.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getColor(), getColorProtoInstance()
      • getCoord

        public X3DCoordinateNode getCoord()
        Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.
        Specified by:
        getCoord in interface PointSet
        Returns:
        value of coord field
        See Also:
        Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies a list of vertex values. *
      • clearCoord

        public PointSetObject clearCoord()
        Utility method to clear SFNode value of coord field.
        Returns:
        PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setCoord

        public PointSetObject setCoord​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field coord.
        Parameters:
        newValue - is new value for the coord field.
        Returns:
        PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setCoord(X3DCoordinateNode)
      • hasCoord

        public boolean hasCoord()
        Indicate whether an object is available for inputOutput SFNode field coord.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getCoord(), getCoordProtoInstance()
      • getFogCoord

        public FogCoordinate getFogCoord()
        Provide FogCoordinateObject instance (using a properly typed node) from inputOutput SFNode field fogCoord.
        Specified by:
        getFogCoord in interface PointSet
        Returns:
        value of fogCoord field
        See Also:
        Tooltip: [FogCoordinate] Single contained FogCoordinate node that specifies depth parameters for fog in corresponding geometry. *
      • clearFogCoord

        public PointSetObject clearFogCoord()
        Utility method to clear SFNode value of fogCoord field.
        Returns:
        PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • setFogCoord

        public PointSetObject setFogCoord​(ProtoInstanceObject newValue)
        Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fogCoord.
        Parameters:
        newValue - is new value for the fogCoord field.
        Returns:
        PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        setFogCoord(FogCoordinate)
      • hasFogCoord

        public boolean hasFogCoord()
        Indicate whether an object is available for inputOutput SFNode field fogCoord.
        Returns:
        whether a properly typed node or ProtoInstance or CommentsBlock is available.
        See Also:
        getFogCoord(), getFogCoordProtoInstance()
      • clearIS

        public PointSetObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        PointSetObject - 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 PointSetObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        PointSetObject - 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 PointSetObject 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:
        PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDEF

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

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

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

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

        public PointSetObject 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:
        PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addComments

        public PointSetObject addComments​(CommentsBlock newCommentsBlock)
        Add CommentsBlock to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newCommentsBlock - block of comments to add
        Returns:
        PointSetObject - 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)