LineProperties (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DAppearanceChildNode, X3DNode

All Known Implementing Classes:

LinePropertiesObject
```
public interface LineProperties
extends X3DAppearanceChildNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D 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.
- Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
- Warning: requires X3D profile='Full' or else include <component name='Shape' level='2'/>
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: LineProperties, X3D Tooltips: LineProperties, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`getApplied()` Provide boolean value from inputOutput SFBool field named applied.
`int`	`getLinetype()` Provide int value within allowed range of [1,infinity) from inputOutput SFInt32 field named linetype.
`float`	`getLinewidthScaleFactor()` Provide float value from inputOutput SFFloat field named linewidthScaleFactor.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`LineProperties`	`setApplied(boolean newValue)` Assign boolean value to inputOutput SFBool field named applied.
`LineProperties`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`LineProperties`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`LineProperties`	`setLinetype(int newValue)` Assign int value within allowed range of [1,infinity) to inputOutput SFInt32 field named linetype.
`LineProperties`	`setLinewidthScaleFactor(float newValue)` Assign float value to inputOutput SFFloat field named linewidthScaleFactor.
`LineProperties`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`LineProperties`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - 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)
```
    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 value within allowed range of [1,infinity) 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.
    - Hint: detailed descriptions of lineType values are found at the ISO/IEC International Register of Graphical Items
      http://www.iso.org/jtc1/sc24/register (may require login)
    Returns:
    
    value of linetype field
  - setLinetype
```
LineProperties setLinetype(int newValue)
```
    Assign int value within allowed range of [1,infinity) 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. Hint: detailed descriptions of lineType values are found at the ISO/IEC International Register of Graphical Items http://www.iso.org/jtc1/sc24/register (may require login)
    
    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)
```
    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 X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    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
```
LineProperties setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    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:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setDEF
```
LineProperties setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DAppearanceChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
LineProperties setUSE(java.lang.String newValue)
```
    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 interface X3DAppearanceChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
LineProperties setCssClass(java.lang.String newValue)
```
    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 interface X3DAppearanceChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface LineProperties

Method Summary

Method Detail

getApplied

setApplied

getLinetype

setLinetype

getLinewidthScaleFactor

setLinewidthScaleFactor

getMetadata

setMetadata

setDEF

setUSE

setCssClass