Class PointPropertiesObject

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Shape.PointPropertiesObject
All Implemented Interfaces:
X3DNode, PointProperties, X3DAppearanceChildNode

public class PointPropertiesObject
extends X3DConcreteNode
implements PointProperties
PointProperties allows precise fine-grained control over the rendering style of PointSet node points inside the same Shape.

X3D node tooltip: (X3D version 4.0 draft) [X3DAppearanceChildNode] PointProperties allows precise fine-grained control over the rendering style of PointSet node points inside the same Shape.
  • Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
  • Hint: When an X3DTextureNode is defined in the same Appearance instance as PointProperties node, the points of a PointSet shall be displayed as point sprites using the given texture(s).
  • Warning: requires X3D profile='Full' or else include <component name='Shape' level='5'/>

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

  • Constructor Details

    • PointPropertiesObject

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

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

    • getElementName

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

      public final java.lang.String getComponent()
      Defines X3D component for the PointProperties element: Shape
      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: 5
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element
    • getFieldType

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

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

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

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

      public java.lang.String getColorMode()
      Provide String enumeration value using RGB values [0..1] from inputOutput SFString field named colorMode.

      Tooltip: colorMode has blending effect on the rendering of point sprites, applying supplied color (Color node or Material emissiveColor) and texture color.
      • Hint: POINT_COLOR shall display the RGB channels of the color instance defined in X3DMaterialNode or X3DColorNode, and the A channel of the texture if any. If no color is associated to the point, the default RGB color (0, 0, 0) shall be used.
      • Hint: TEXTURE_COLOR shall display the original texture with its RGBA channels and regardless to the X3DMaterialNode or X3DColorNode which might be associated to the point set.
      • Hint: TEXTURE_AND_POINT_COLOR shall display the RGBA channels of a texture added to the RGB channels of the color defined in X3DMaterialNode or X3DColorNode node, and the A channel of the texture if any. If no color is associated to the point, the result shall be exactly the same as TEXTURE_COLOR.


      Available enumeration values for string comparison: POINT_COLOR, TEXTURE_COLOR, TEXTURE_AND_POINT_COLOR.
      Specified by:
      getColorMode in interface PointProperties
      Returns:
      value of colorMode field
    • setColorMode

      public PointPropertiesObject setColorMode​(java.lang.String newValue)
      Accessor method to assign String enumeration value ("POINT_COLOR" | "TEXTURE_COLOR" | "TEXTURE_AND_POINT_COLOR") to inputOutput SFString field named colorMode.

      Warning: authors can only choose from a strict list of enumeration values (POINT_COLOR, TEXTURE_COLOR, TEXTURE_AND_POINT_COLOR).

      Tooltip: colorMode has blending effect on the rendering of point sprites, applying supplied color (Color node or Material emissiveColor) and texture color.
      • Hint: POINT_COLOR shall display the RGB channels of the color instance defined in X3DMaterialNode or X3DColorNode, and the A channel of the texture if any. If no color is associated to the point, the default RGB color (0, 0, 0) shall be used.
      • Hint: TEXTURE_COLOR shall display the original texture with its RGBA channels and regardless to the X3DMaterialNode or X3DColorNode which might be associated to the point set.
      • Hint: TEXTURE_AND_POINT_COLOR shall display the RGBA channels of a texture added to the RGB channels of the color defined in X3DMaterialNode or X3DColorNode node, and the A channel of the texture if any. If no color is associated to the point, the result shall be exactly the same as TEXTURE_COLOR.
      Specified by:
      setColorMode in interface PointProperties
      Parameters:
      newValue - is new value for the colorMode field.
      Returns:
      PointPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setColorMode

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

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

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

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

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

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

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

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

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

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

      public float[] getPointSizeAttenuation()
      Provide array of Float results from inputOutput MFFloat field named pointSizeAttenuation.

      Tooltip: [0,+infinity) pointSizeAttenuation array values [a, b, c] are set to default values if undefined. Together these parameters define attenuation factor 1/(a + b×r + c×r^2) where r is the distance from observer position (current viewpoint) to each point.
      • Hint: nominal point size is multiplied by attenuation factor and then clipped to aminimum value of pointSizeMinValue × minimum renderable point size, then clipped to maximum size of pointSizeMaxValue × minimum renderable point size.
      Specified by:
      getPointSizeAttenuation in interface PointProperties
      Returns:
      value of pointSizeAttenuation field
    • getPointSizeAttenuationList

      public java.util.ArrayList<java.lang.Float> getPointSizeAttenuationList()
      Utility method to get ArrayList value of MFFloat pointSizeAttenuation field, similar to getPointSizeAttenuation().
      Returns:
      value of pointSizeAttenuation field
    • setPointSizeAttenuation

      public PointPropertiesObject setPointSizeAttenuation​(float[] newValue)
      Accessor method to assign Float array to inputOutput MFFloat field named pointSizeAttenuation.

      Tooltip: [0,+infinity) pointSizeAttenuation array values [a, b, c] are set to default values if undefined. Together these parameters define attenuation factor 1/(a + b×r + c×r^2) where r is the distance from observer position (current viewpoint) to each point.
      • Hint: nominal point size is multiplied by attenuation factor and then clipped to aminimum value of pointSizeMinValue × minimum renderable point size, then clipped to maximum size of pointSizeMaxValue × minimum renderable point size.
      Specified by:
      setPointSizeAttenuation in interface PointProperties
      Parameters:
      newValue - is new value for the pointSizeAttenuation field.
      Returns:
      PointPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPointSizeAttenuation

      public PointPropertiesObject setPointSizeAttenuation​(MFFloatObject newValue)
      Assign typed object value to MFFloat pointSizeAttenuation field, similar to setPointSizeAttenuation(float[]).
      Parameters:
      newValue - is new value for the pointSizeAttenuation field.
      Returns:
      PointPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPointSizeAttenuation

      public PointPropertiesObject setPointSizeAttenuation​(java.util.ArrayList<java.lang.Float> newValue)
      Assign ArrayList value of MFFloat pointSizeAttenuation field, similar to setPointSizeAttenuation(float[]).
      Parameters:
      newValue - is new value for the pointSizeAttenuation field.
      Returns:
      PointPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearPointSizeAttenuation

      public PointPropertiesObject clearPointSizeAttenuation()
      Utility method to clear MFFloat value of pointSizeAttenuation field.
      Returns:
      PointPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setPointSizeAttenuation

      public PointPropertiesObject setPointSizeAttenuation​(int[] newValue)
      Assign floating-point array value of MFFloat pointSizeAttenuation field, similar to setPointSizeAttenuation(float[]).
      Parameters:
      newValue - is new value for the pointSizeAttenuation field.
      Returns:
      PointPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addPointSizeAttenuation

      public PointPropertiesObject addPointSizeAttenuation​(float newValue)
      Add singleton float value to MFFloat pointSizeAttenuation field.
      Parameters:
      newValue - is new value to add to the pointSizeAttenuation field.
      Returns:
      PointPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addPointSizeAttenuation

      public PointPropertiesObject addPointSizeAttenuation​(SFFloatObject newValue)
      Add singleton SFFloatObject value to MFFloat pointSizeAttenuation field.
      Parameters:
      newValue - is new value to add to the pointSizeAttenuation field.
      Returns:
      PointPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPointSizeAttenuation

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

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

      Tooltip: [0,+infinity) pointSizeMaxValue is maximum allowed scaling factor on nominal browser point scaling.
      • Warning: maintain pointSizeMinValue &lt;= pointSizeMaxValue.
      Specified by:
      getPointSizeMaxValue in interface PointProperties
      Returns:
      value of pointSizeMaxValue field
    • setPointSizeMaxValue

      public PointPropertiesObject setPointSizeMaxValue​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named pointSizeMaxValue.

      Tooltip: [0,+infinity) pointSizeMaxValue is maximum allowed scaling factor on nominal browser point scaling.
      • Warning: maintain pointSizeMinValue &lt;= pointSizeMaxValue.
      Specified by:
      setPointSizeMaxValue in interface PointProperties
      Parameters:
      newValue - is new value for the pointSizeMaxValue field.
      Returns:
      PointPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPointSizeMaxValue

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

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

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

      Tooltip: [0,+infinity) pointSizeMinValue is minimum allowed scaling factor on nominal browser point scaling.
      • Warning: maintain pointSizeMinValue &lt;= pointSizeMaxValue.
      Specified by:
      getPointSizeMinValue in interface PointProperties
      Returns:
      value of pointSizeMinValue field
    • setPointSizeMinValue

      public PointPropertiesObject setPointSizeMinValue​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named pointSizeMinValue.

      Tooltip: [0,+infinity) pointSizeMinValue is minimum allowed scaling factor on nominal browser point scaling.
      • Warning: maintain pointSizeMinValue &lt;= pointSizeMaxValue.
      Specified by:
      setPointSizeMinValue in interface PointProperties
      Parameters:
      newValue - is new value for the pointSizeMinValue field.
      Returns:
      PointPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPointSizeMinValue

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

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

      public float getPointSizeScaleFactor()
      Provide float value within allowed range of [1,infinity) from inputOutput SFFloat field named pointSizeScaleFactor.

      Tooltip: [0,+infinity) Nominal rendered point size is a browser-dependent minimum renderable point size, which is then multiplied by pointSizeScaleFactor.
      • Hint: additional sizing modifications are determined by pointSizeMinValue, pointSizeMaxValue, and pointSizeAttenuation array.
      Specified by:
      getPointSizeScaleFactor in interface PointProperties
      Returns:
      value of pointSizeScaleFactor field
    • setPointSizeScaleFactor

      public PointPropertiesObject setPointSizeScaleFactor​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named pointSizeScaleFactor.

      Tooltip: [0,+infinity) Nominal rendered point size is a browser-dependent minimum renderable point size, which is then multiplied by pointSizeScaleFactor.
      • Hint: additional sizing modifications are determined by pointSizeMinValue, pointSizeMaxValue, and pointSizeAttenuation array.
      Specified by:
      setPointSizeScaleFactor in interface PointProperties
      Parameters:
      newValue - is new value for the pointSizeScaleFactor field.
      Returns:
      PointPropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPointSizeScaleFactor

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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