LinePropertiesObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteNode
  - - org.web3d.x3d.jsail.Shape.LinePropertiesObject

All Implemented Interfaces:

X3DNode, LineProperties, X3DAppearanceChildNode
```
public class LinePropertiesObject
extends X3DConcreteNode
implements LineProperties
```
X3D node tooltip: LineProperties allows fine control over rendering 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.
- Hint: include <component name='Shape' level='2'/>
* Note that SFColorObject also provides a variety of color constants.

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 using the org.web3d.x3d.sai package instead.
See Also:

X3D Abstract Specification: LineProperties, X3D Tooltips: LineProperties, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`APPLIED_DEFAULT_VALUE` SFBool field named applied has default value true (Java syntax) or true (XML syntax).
`static java.lang.String`	`COMPONENT` String constant COMPONENT provides X3D component for this element: Shape.
`static java.lang.String`	`fromField_APPLIED` fromField ROUTE name for SFBool field named applied.
`static java.lang.String`	`fromField_LINETYPE` fromField ROUTE name for SFInt32 field named linetype.
`static java.lang.String`	`fromField_LINEWIDTHSCALEFACTOR` fromField ROUTE name for SFFloat field named linewidthScaleFactor.
`static java.lang.String`	`fromField_METADATA` fromField ROUTE name for SFNode field named metadata.
`static int`	`LEVEL` Integer constant LEVEL provides default X3D component level for this element: 2.
`static int`	`LINETYPE_DEFAULT_VALUE` SFInt32 field named linetype has default value 1 (Java syntax) or 1 (XML syntax).
`static float`	`LINEWIDTHSCALEFACTOR_DEFAULT_VALUE` SFFloat field named linewidthScaleFactor has default value 0f (Java syntax) or 0 (XML syntax).
`static java.lang.String`	`NAME` String constant NAME provides name of this element: LineProperties.
`static java.lang.String`	`toField_APPLIED` toField ROUTE name for SFBool field named applied.
`static java.lang.String`	`toField_LINETYPE` toField ROUTE name for SFInt32 field named linetype.
`static java.lang.String`	`toField_LINEWIDTHSCALEFACTOR` toField ROUTE name for SFFloat field named linewidthScaleFactor.
`static java.lang.String`	`toField_METADATA` toField ROUTE name for SFNode field named metadata.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
validationResult

Constructor Summary

Constructors
Constructor and Description
`LinePropertiesObject()` Constructor for LinePropertiesObject to initialize member variables with default values.
`LinePropertiesObject(java.lang.String DEFname)` Utility constructor that assigns DEF name after initializing member variables with default values

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LinePropertiesObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`LinePropertiesObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`LinePropertiesObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`LinePropertiesObject`	`clearMetadata()` Utility method to clear SFNode value of metadata field.
`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.
`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.
`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.
`java.lang.String`	`getAccessType(java.lang.String fieldName)` Indicate accessType corresponding to given fieldName.
`boolean`	`getApplied()` Provide boolean value from inputOutput SFBool field named applied.
`java.lang.String`	`getComponent()` Provides X3D component for this element: Shape.
`int`	`getComponentLevel()` Provides default X3D component level for this element: 2.
`java.lang.String`	`getElementName()` Provides name of this element: LineProperties.
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`ISObject`	`getIS()` Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`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.
`ProtoInstanceObject`	`getMetadataProtoInstance()` Provide properly typed ProtoInstance for inputOutput SFNode field metadata, if available.
`X3DConcreteNode`	`getNodeByDEF(java.lang.String DEFname)` Recursive method to provide object reference to node by DEF name, if found as this node or in a contained node.
`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.
`boolean`	`hasMetadata()` Indicate whether an object is available for inputOutput SFNode field metadata.
`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.
`void`	`initialize()` Initialize all member variables to default values.
`LinePropertiesObject`	`setApplied(boolean newValue)` Assign boolean value to inputOutput SFBool field named applied.
`LinePropertiesObject`	`setApplied(SFBoolObject newValue)` Assign typed object value to SFBool applied field, similar to `setApplied(boolean)`.
`LinePropertiesObject`	`setCssClass(SFStringObject newValue)` Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`LinePropertiesObject`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`LinePropertiesObject`	`setDEF(SFStringObject newValue)` Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`LinePropertiesObject`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`LinePropertiesObject`	`setIS(ISObject newValue)` Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`LinePropertiesObject`	`setLinetype(int newValue)` Assign int value within allowed range of [1,infinity) to inputOutput SFInt32 field named linetype.
`LinePropertiesObject`	`setLinetype(SFInt32Object newValue)` Assign typed object value to SFInt32 linetype field, similar to `setLinetype(int)`.
`LinePropertiesObject`	`setLinewidthScaleFactor(float newValue)` Assign float value to inputOutput SFFloat field named linewidthScaleFactor.
`LinePropertiesObject`	`setLinewidthScaleFactor(SFFloatObject newValue)` Assign typed object value to SFFloat linewidthScaleFactor field, similar to `setLinewidthScaleFactor(float)`.
`LinePropertiesObject`	`setMetadata(ProtoInstanceObject newProtoInstanceNode)` Assign ProtoInstance to metadata field; WARNING: ProtoInstance must match acceptable node type X3DMetadataObject.
`LinePropertiesObject`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`LinePropertiesObject`	`setUSE(LinePropertiesObject DEFnode)` Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`LinePropertiesObject`	`setUSE(SFStringObject newValue)` Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`LinePropertiesObject`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`java.lang.String`	`toStringClassicVRML(int level)` Recursive method to provide ClassicVRML string serialization.
`java.lang.String`	`toStringVRML97(int level)` Recursive method to provide VRML97 string serialization.
`java.lang.String`	`toStringX3D(int level)` Recursive method to provide X3D string serialization of this model subgraph.
`java.lang.String`	`validate()` Recursive method to validate this element plus all contained nodes and statements.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: LineProperties.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT provides X3D component for this element: Shape.
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D component level for this element: 2.
    
    See Also:
    
    Constant Field Values
  - APPLIED_DEFAULT_VALUE
```
public static final boolean APPLIED_DEFAULT_VALUE
```
    SFBool field named applied has default value true (Java syntax) or true (XML syntax).
    
    See Also:
    
    Constant Field Values
  - LINETYPE_DEFAULT_VALUE
```
public static final int LINETYPE_DEFAULT_VALUE
```
    SFInt32 field named linetype has default value 1 (Java syntax) or 1 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - LINEWIDTHSCALEFACTOR_DEFAULT_VALUE
```
public static final float LINEWIDTHSCALEFACTOR_DEFAULT_VALUE
```
    SFFloat field named linewidthScaleFactor has default value 0f (Java syntax) or 0 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - fromField_APPLIED
```
public static final java.lang.String fromField_APPLIED
```
    fromField ROUTE name for SFBool field named applied.
    
    See Also:
    
    Constant Field Values
  - toField_APPLIED
```
public static final java.lang.String toField_APPLIED
```
    toField ROUTE name for SFBool field named applied.
    
    See Also:
    
    Constant Field Values
  - fromField_LINETYPE
```
public static final java.lang.String fromField_LINETYPE
```
    fromField ROUTE name for SFInt32 field named linetype.
    
    See Also:
    
    Constant Field Values
  - toField_LINETYPE
```
public static final java.lang.String toField_LINETYPE
```
    toField ROUTE name for SFInt32 field named linetype.
    
    See Also:
    
    Constant Field Values
  - fromField_LINEWIDTHSCALEFACTOR
```
public static final java.lang.String fromField_LINEWIDTHSCALEFACTOR
```
    fromField ROUTE name for SFFloat field named linewidthScaleFactor.
    
    See Also:
    
    Constant Field Values
  - toField_LINEWIDTHSCALEFACTOR
```
public static final java.lang.String toField_LINEWIDTHSCALEFACTOR
```
    toField ROUTE name for SFFloat field named linewidthScaleFactor.
    
    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
  - LinePropertiesObject
```
public LinePropertiesObject()
```
    Constructor for LinePropertiesObject to initialize member variables with default values.
  - LinePropertiesObject
```
public LinePropertiesObject(java.lang.String DEFname)
```
    Utility constructor that assigns DEF name after initializing member variables with default values
    
    Parameters:
    
    DEFname - unique DEF name for this X3D node
- Method Detail
  - getElementName
```
public final java.lang.String getElementName()
```
    Provides name of this element: LineProperties.
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Provides X3D component for this 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: 2.
    
    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
  - getApplied
```
public boolean getApplied()
```
    Provide boolean value from inputOutput SFBool field named applied.
    
    Tooltip: Whether or not LineProperties are applied to associated geometry.
    
    Specified by:
    
    getApplied in interface LineProperties
    
    Returns:
    
    value of applied field
  - setApplied
```
public LinePropertiesObject setApplied(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named applied.
    
    Tooltip: Whether or not LineProperties are applied to associated geometry.
    
    Specified by:
    
    setApplied in interface LineProperties
    
    Parameters:
    
    newValue - is new value for the applied field.
    
    Returns:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setApplied
```
public LinePropertiesObject setApplied(SFBoolObject newValue)
```
    Assign typed object value to SFBool applied field, similar to setApplied(boolean).
    
    Parameters:
    
    newValue - is new value for the applied field.
    
    Returns:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getLinetype
```
public 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).
    
    Specified by:
    
    getLinetype in interface LineProperties
    
    Returns:
    
    value of linetype field
  - setLinetype
```
public LinePropertiesObject 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).
    
    Specified by:
    
    setLinetype in interface LineProperties
    
    Parameters:
    
    newValue - is new value for the linetype field.
    
    Returns:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setLinetype
```
public LinePropertiesObject setLinetype(SFInt32Object newValue)
```
    Assign typed object value to SFInt32 linetype field, similar to setLinetype(int).
    
    Parameters:
    
    newValue - is new value for the linetype field.
    
    Returns:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getLinewidthScaleFactor
```
public float getLinewidthScaleFactor()
```
    Provide float value from inputOutput SFFloat field named linewidthScaleFactor.
    
    Tooltip: (X3D version 3.1 or later) 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.
    
    Specified by:
    
    getLinewidthScaleFactor in interface LineProperties
    
    Returns:
    
    value of linewidthScaleFactor field
  - setLinewidthScaleFactor
```
public LinePropertiesObject setLinewidthScaleFactor(float newValue)
```
    Assign float value to inputOutput SFFloat field named linewidthScaleFactor.
    
    Tooltip: (X3D version 3.1 or later) 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.
    
    Specified by:
    
    setLinewidthScaleFactor in interface LineProperties
    
    Parameters:
    
    newValue - is new value for the linewidthScaleFactor field.
    
    Returns:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setLinewidthScaleFactor
```
public LinePropertiesObject setLinewidthScaleFactor(SFFloatObject newValue)
```
    Assign typed object value to SFFloat linewidthScaleFactor field, similar to setLinewidthScaleFactor(float).
    
    Parameters:
    
    newValue - is new value for the linewidthScaleFactor field.
    
    Returns:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - getMetadata
```
public X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface LineProperties
    
    Specified by:
    
    getMetadata in interface X3DAppearanceChildNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
public LinePropertiesObject setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface LineProperties
    
    Specified by:
    
    setMetadata in interface X3DAppearanceChildNode
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
  - clearMetadata
```
public LinePropertiesObject clearMetadata()
```
    Utility method to clear SFNode value of metadata field.
    
    Returns:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setMetadata
```
public LinePropertiesObject setMetadata(ProtoInstanceObject newProtoInstanceNode)
```
    Assign ProtoInstance to metadata field; WARNING: ProtoInstance must match acceptable node type X3DMetadataObject.
    
    Parameters:
    
    newProtoInstanceNode - is the new ProtoInstance node for the metadata field
    
    Returns:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    
    See Also:
    
    setMetadata(X3DMetadataObject), X3D Scene Authoring Hints: Metadata Nodes
  - getMetadataProtoInstance
```
public ProtoInstanceObject getMetadataProtoInstance()
```
    Provide properly typed ProtoInstance for inputOutput SFNode field metadata, if available.
    
    Returns:
    
    ProtoInstance value of geometry field
    
    See Also:
    
    getMetadata(), X3D Scene Authoring Hints: Metadata Nodes
  - 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 LinePropertiesObject 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 X3DNode
    
    Specified by:
    
    setDEF in interface LineProperties
    
    Specified by:
    
    setDEF in interface X3DAppearanceChildNode
    
    Specified by:
    
    setDEF in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setDEF
```
public LinePropertiesObject 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:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setUSE
```
public final LinePropertiesObject 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 resets all other fields to their default values 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 X3DNode
    
    Specified by:
    
    setUSE in interface LineProperties
    
    Specified by:
    
    setUSE in interface X3DAppearanceChildNode
    
    Specified by:
    
    setUSE in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setUSE
```
public LinePropertiesObject 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:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setCssClass
```
public final LinePropertiesObject 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 X3DNode
    
    Specified by:
    
    setCssClass in interface LineProperties
    
    Specified by:
    
    setCssClass in interface X3DAppearanceChildNode
    
    Specified by:
    
    setCssClass in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    W3C Cascading Style Sheets
  - setCssClass
```
public LinePropertiesObject 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:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - setIS
```
public LinePropertiesObject setIS(ISObject newValue)
```
    Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    setIS in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - getIS
```
public ISObject getIS()
```
    Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    getIS in class X3DConcreteNode
    
    Returns:
    
    current ISObject, if any.
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - setUSE
```
public LinePropertiesObject setUSE(LinePropertiesObject DEFnode)
```
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    
    WARNING: note that the setUSE() method resets all other fields to their default values 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:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same node object).
  - addComments
```
public LinePropertiesObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public LinePropertiesObject 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:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public LinePropertiesObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    LinePropertiesObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - toStringX3D
```
public java.lang.String toStringX3D(int level)
```
    Recursive method to provide X3D string serialization of this model subgraph.
    
    Specified by:
    
    toStringX3D in class X3DConcreteElement
    
    Parameters:
    
    level - number of levels of indentation for this element
    
    Returns:
    
    X3D string
  - toStringClassicVRML
```
public java.lang.String toStringClassicVRML(int level)
```
    Recursive method to provide ClassicVRML string serialization.
    
    Specified by:
    
    toStringClassicVRML in class X3DConcreteElement
    
    Parameters:
    
    level - number of levels of indentation for this element
    
    Returns:
    
    ClassicVRML string
    
    See Also:
    
    X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
  - toStringVRML97
```
public java.lang.String toStringVRML97(int level)
```
    Recursive method to provide VRML97 string serialization.
    
    Specified by:
    
    toStringVRML97 in class X3DConcreteElement
    
    Parameters:
    
    level - number of levels of indentation for this element
    
    Returns:
    
    VRML97 string
    
    See Also:
    
    X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
  - getNodeByDEF
```
public X3DConcreteNode getNodeByDEF(java.lang.String DEFname)
```
    Recursive method to provide object reference to node by DEF name, if found as this node or in a contained node.
    
    Specified by:
    
    getNodeByDEF in class X3DConcreteNode
    
    Parameters:
    
    DEFname - DEF name of node to find
    
    Returns:
    
    object reference to node
  - 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, HAnim nodes.
    
    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)
  - 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, HAnim nodes.
    
    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)
  - 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: 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)
  - 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.
    
    Specified by:
    
    validate in class X3DConcreteElement
    
    Returns:
    
    validation results (if any)

Class LinePropertiesObject

Field Summary

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Constructor Summary

Method Summary

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Methods inherited from class java.lang.Object

Field Detail

NAME

COMPONENT

LEVEL

APPLIED_DEFAULT_VALUE

LINETYPE_DEFAULT_VALUE

LINEWIDTHSCALEFACTOR_DEFAULT_VALUE

fromField_APPLIED

toField_APPLIED

fromField_LINETYPE

toField_LINETYPE

fromField_LINEWIDTHSCALEFACTOR

toField_LINEWIDTHSCALEFACTOR

fromField_METADATA

toField_METADATA

Constructor Detail

LinePropertiesObject

LinePropertiesObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

initialize

getApplied

setApplied

setApplied

getLinetype

setLinetype

setLinetype

getLinewidthScaleFactor

setLinewidthScaleFactor

setLinewidthScaleFactor

getMetadata

setMetadata

clearMetadata

setMetadata

getMetadataProtoInstance

hasMetadata

setDEF

setDEF

setUSE

setUSE

setCssClass

setCssClass

setIS

getIS

setUSE

addComments

addComments

addComments

toStringX3D

toStringClassicVRML

toStringVRML97

getNodeByDEF

findElementByNameValue

findElementByNameValue

hasElementByNameValue

findNodeByDEF

hasNodeByDEF

validate