Package org.web3d.x3d.sai.Shape

Interface PointProperties

All Superinterfaces:
X3DAppearanceChildNode, X3DNode
All Known Implementing Classes:
PointPropertiesObject
public interface PointProperties
extends X3DAppearanceChildNode
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 interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification: TODO, X3D Abstract Specification: PointProperties, X3D Tooltips: PointProperties, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getColorMode()
    Provide String enumeration value using RGB values [0..1] from inputOutput SFString field named colorMode.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float[] getPointSizeAttenuation()
    Provide array of float results from inputOutput MFFloat field named pointSizeAttenuation.
    float getPointSizeMaxValue()
    Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named pointSizeMaxValue.
    float getPointSizeMinValue()
    Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named pointSizeMinValue.
    float getPointSizeScaleFactor()
    Provide float value within allowed range of [1,infinity) from inputOutput SFFloat field named pointSizeScaleFactor.
    PointProperties 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.
    PointProperties setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    PointProperties setPointSizeAttenuation​(float[] newValue)
    Accessor method to assign float array to inputOutput MFFloat field named pointSizeAttenuation.
    PointProperties setPointSizeMaxValue​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named pointSizeMaxValue.
    PointProperties setPointSizeMinValue​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named pointSizeMinValue.
    PointProperties setPointSizeScaleFactor​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named pointSizeScaleFactor.

  • Method Details

    • getColorMode

      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.
      Returns:
      value of colorMode field

    • setColorMode

      PointProperties 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.

      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.
      Parameters:
      newValue - is new value for the colorMode field.
      Returns:
      PointProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      getMetadata in interface X3DAppearanceChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      PointProperties setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DAppearanceChildNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      PointProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • getPointSizeAttenuation

      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.
      Returns:
      value of pointSizeAttenuation field

    • setPointSizeAttenuation

      PointProperties 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.
      Parameters:
      newValue - is new value for the pointSizeAttenuation field.
      Returns:
      PointProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getPointSizeMaxValue

      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 <= pointSizeMaxValue.
      Returns:
      value of pointSizeMaxValue field

    • setPointSizeMaxValue

      PointProperties 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 <= pointSizeMaxValue.
      Parameters:
      newValue - is new value for the pointSizeMaxValue field.
      Returns:
      PointProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getPointSizeMinValue

      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 <= pointSizeMaxValue.
      Returns:
      value of pointSizeMinValue field

    • setPointSizeMinValue

      PointProperties 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 <= pointSizeMaxValue.
      Parameters:
      newValue - is new value for the pointSizeMinValue field.
      Returns:
      PointProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getPointSizeScaleFactor

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

      Tooltip: [1,+infinity) Nominal rendered point size is a browser-dependent minimum renderable point size, which is then multiplied by an additional pointSizeScaleFactor (which is greater than or equal to 1).
      • Hint: additional sizing modifications are determined by pointSizeMinValue, pointSizeMaxValue, and pointSizeAttenuation array.
      Returns:
      value of pointSizeScaleFactor field

    • setPointSizeScaleFactor

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

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