Interface LineProperties

All Superinterfaces:
X3DAppearanceChildNode, X3DNode
All Known Implementing Classes:
LineProperties
public interface LineProperties extends X3DAppearanceChildNode
LineProperties allows precise fine-grained control over the rendering style of lines and edges for associated geometry nodes inside the same Shape.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. LineProperties node tooltip: [X3DAppearanceChildNode] LineProperties allows precise fine-grained control over the rendering style of lines and edges for associated geometry nodes inside the same Shape.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getApplied()
    Provide boolean value from inputOutput SFBool field named applied.
    int
    getLinetype()
    Provide int enumeration value (baseType SFInt32) ["1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12" | "13" | "14" | "15" | "16"] from inputOutput SFInt32 field named linetype.
    float
    getLinewidthScaleFactor()
    Provide float value from inputOutput SFFloat field named linewidthScaleFactor.
    X3DMetadataObject
    getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    LineProperties
    setApplied(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named applied.
    LineProperties
    setLinetype(int newValue)
    Accessor method to assign int enumeration value ("1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12" | "13" | "14" | "15" | "16") to inputOutput SFInt32 field named linetype.
    LineProperties
    setLinewidthScaleFactor(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named linewidthScaleFactor.
    LineProperties
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

  • Method Details

    • getApplied

      boolean getApplied()
      Provide boolean value from inputOutput SFBool field named applied.

      Tooltip: Whether or not LineProperties are applied to associated geometry. *
      Returns:
      value of applied field

    • setApplied

      LineProperties setApplied(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named applied.

      Tooltip: Whether or not LineProperties are applied to associated geometry. *
      Parameters:
      newValue - is new value for the applied field.
      Returns:
      LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getLinetype

      int getLinetype()
      Provide int enumeration value (baseType SFInt32) ["1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12" | "13" | "14" | "15" | "16"] from inputOutput SFInt32 field named linetype.

      Tooltip: linetype selects a line pattern, with solid default if defined value isn't supported. Values with guaranteed support are 1 Solid, 2 Dashed, 3 Dotted, 4 Dashed-dotted, 5 Dash-dot-dot. Optionally supported values are 6 single-headed arrow (arrow tip occurs at last point of each individual list of points), 7 single dot, 8 double-headed arrow, 10 chain line, 11 center line, 12 hidden line, 13 phantom line, 14 break line 1, 15 break line 2, 16 User-specified dash pattern.
      Returns:
      value of linetype field

    • setLinetype

      LineProperties setLinetype(int newValue)
      Accessor method to assign int enumeration value ("1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12" | "13" | "14" | "15" | "16") to inputOutput SFInt32 field named linetype.

      Tooltip: linetype selects a line pattern, with solid default if defined value isn't supported. Values with guaranteed support are 1 Solid, 2 Dashed, 3 Dotted, 4 Dashed-dotted, 5 Dash-dot-dot. Optionally supported values are 6 single-headed arrow (arrow tip occurs at last point of each individual list of points), 7 single dot, 8 double-headed arrow, 10 chain line, 11 center line, 12 hidden line, 13 phantom line, 14 break line 1, 15 break line 2, 16 User-specified dash pattern.
      Parameters:
      newValue - is new value for the linetype field.
      Returns:
      LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getLinewidthScaleFactor

      float getLinewidthScaleFactor()
      Provide float value from inputOutput SFFloat field named linewidthScaleFactor.

      Tooltip: linewidthScaleFactor is a scale factor multiplied by browser-dependent nominal linewidth, mapped to nearest available line width. Values zero or less provide minimum available line width. *
      Returns:
      value of linewidthScaleFactor field

    • setLinewidthScaleFactor

      LineProperties setLinewidthScaleFactor(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named linewidthScaleFactor.

      Tooltip: linewidthScaleFactor is a scale factor multiplied by browser-dependent nominal linewidth, mapped to nearest available line width. Values zero or less provide minimum available line width. *
      Parameters:
      newValue - is new value for the linewidthScaleFactor field.
      Returns:
      LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.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:

    • setMetadata

      LineProperties setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.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:
      LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also: