Package org.web3d.x3d.jsail.Shape

Class LineProperties

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Shape.LineProperties

All Implemented Interfaces:

X3DNode, LineProperties, X3DAppearanceChildNode

public class LineProperties
extends X3DConcreteNode
implements LineProperties

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.

• Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
• Hint: LineProperties illustration model https://X3dGraphics.com/examples/X3dForWebAuthors/Chapter05AppearanceMaterialTextures/LinePropertiesExampleIndex.html
• Warning: requires X3D profile='Full' or else include <component name='Shape' level='2'/>

Note that SFColor 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 separate code using only 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	Description
static final boolean	APPLIED_DEFAULT_VALUE	SFBool field named applied has default value true (Java syntax) or true (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the LineProperties element: Shape
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	fromField_APPLIED	fromField ROUTE name for SFBool field named applied.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_LINETYPE	fromField ROUTE name for SFInt32 field named linetype.
static final String	fromField_LINEWIDTHSCALEFACTOR	fromField ROUTE name for SFFloat field named linewidthScaleFactor.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D Shape component level for this element: 2
static final String	LINETYPE_1_ALIAS	SFString SFInt32 enumeration value "1" has alias "SOLID"
static final String	LINETYPE_10_ALIAS	SFString SFInt32 enumeration value "10" has alias "CHAIN_LINE"
static final String	LINETYPE_11_ALIAS	SFString SFInt32 enumeration value "11" has alias "CENTER_LINE"
static final String	LINETYPE_12_ALIAS	SFString SFInt32 enumeration value "12" has alias "HIDDEN_LINE"
static final String	LINETYPE_13_ALIAS	SFString SFInt32 enumeration value "13" has alias "PHANTOM_LINE"
static final String	LINETYPE_14_ALIAS	SFString SFInt32 enumeration value "14" has alias "BREAK_LINE_STYLE_1"
static final String	LINETYPE_15_ALIAS	SFString SFInt32 enumeration value "15" has alias "BREAK_LINE_STYLE_2"
static final String	LINETYPE_16_ALIAS	SFString SFInt32 enumeration value "16" has alias "USER_SPECIFIED_DASH_PATTERN"
static final String	LINETYPE_2_ALIAS	SFString SFInt32 enumeration value "2" has alias "DASHED"
static final String	LINETYPE_3_ALIAS	SFString SFInt32 enumeration value "3" has alias "DOTTED"
static final String	LINETYPE_4_ALIAS	SFString SFInt32 enumeration value "4" has alias "DASHED_DOTTED"
static final String	LINETYPE_5_ALIAS	SFString SFInt32 enumeration value "5" has alias "DASHED_DOT_DOT"
static final String	LINETYPE_6_ALIAS	SFString SFInt32 enumeration value "6" has alias "SINGLE_ARROW"
static final String	LINETYPE_7_ALIAS	SFString SFInt32 enumeration value "7" has alias "SINGLE_DOT"
static final String	LINETYPE_8_ALIAS	SFString SFInt32 enumeration value "8" has alias "DOUBLE_ARROW"
static final String	LINETYPE_9_ALIAS	SFString SFInt32 enumeration value "9" has alias "STITCH_LINE"
static final String	LINETYPE_BREAK_LINE_STYLE_1	Tooltip: (break line - style 1).
static final String	LINETYPE_BREAK_LINE_STYLE_2	Tooltip: (break line - style 2).
static final String	LINETYPE_CENTER_LINE	Tooltip: (center line).
static final String	LINETYPE_CHAIN_LINE	Tooltip: (chain line).
static final String	LINETYPE_DASHED	Tooltip: Dashed.
static final String	LINETYPE_DASHED_DOT_DOT	Tooltip: Dash-dot-dot.
static final String	LINETYPE_DASHED_DOTTED	Tooltip: Dashed-dotted.
static final int	LINETYPE_DEFAULT_VALUE	SFInt32 field named linetype has default value 1 (Java syntax) or 1 (XML syntax).
static final String	LINETYPE_DOTTED	Tooltip: Dotted.
static final String	LINETYPE_DOUBLE_ARROW	Tooltip: (double arrow).
static final String	LINETYPE_HIDDEN_LINE	Tooltip: (hidden line).
static final String	LINETYPE_PHANTOM_LINE	Tooltip: (phantom line).
static final String	LINETYPE_SINGLE_ARROW	Tooltip: (single arrow).
static final String	LINETYPE_SINGLE_DOT	Tooltip: (single dot).
static final String	LINETYPE_SOLID	Tooltip: Solid.
static final String	LINETYPE_STITCH_LINE	Tooltip: (stitch line).
static final String	LINETYPE_USER_SPECIFIED_DASH_PATTERN	Tooltip: User-specified dash pattern.
static final float	LINEWIDTHSCALEFACTOR_DEFAULT_VALUE	SFFloat field named linewidthScaleFactor has default value 0f (Java syntax) or 0 (XML syntax).
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: LineProperties.
static final String	toField_APPLIED	toField ROUTE name for SFBool field named applied.
static final String	toField_LINETYPE	toField ROUTE name for SFInt32 field named linetype.
static final String	toField_LINEWIDTHSCALEFACTOR	toField ROUTE name for SFFloat field named linewidthScaleFactor.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.

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

containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
LineProperties()	Constructor for LineProperties to initialize member variables with default values.
LineProperties(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
LineProperties	addComments(String newComment)	Add comment as String to contained commentsList.
LineProperties	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
LineProperties	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
LineProperties	clearIS()	Utility method to clear SFNode value of IS field.
LineProperties	clearMetadata()	Utility method to clear SFNode value of metadata field.
X3DConcreteElement	findElementByNameValue(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(String nameValue, 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(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
boolean	getApplied()	Provide boolean value from inputOutput SFBool field named applied.
final String	getComponent()	Defines X3D component for the LineProperties element: Shape
final int	getComponentLevel()	Provides default X3D component level for this element: 2
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
final String	getElementName()	Provides name of this element: LineProperties
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
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.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasElementByNameValue(String nameValue, 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	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
final void	initialize()	Initialize all member variables to default values.
LineProperties	setApplied(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named applied.
LineProperties	setApplied(SFBool newValue)	Assign typed object value to SFBool applied field, similar to setApplied(boolean).
final LineProperties	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
LineProperties	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final LineProperties	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
LineProperties	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final LineProperties	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
LineProperties	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
final LineProperties	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
LineProperties	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
LineProperties	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
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	setLinetype(SFInt32 newValue)	Assign typed object value to SFInt32 linetype field, similar to setLinetype(int).
LineProperties	setLinewidthScaleFactor(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setLinewidthScaleFactor(float).
LineProperties	setLinewidthScaleFactor(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named linewidthScaleFactor.
LineProperties	setLinewidthScaleFactor(SFFloat newValue)	Assign typed object value to SFFloat linewidthScaleFactor field, similar to setLinewidthScaleFactor(float).
LineProperties	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
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.
final LineProperties	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
LineProperties	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
LineProperties	setUSE(LineProperties DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
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.

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

getContainerFieldAlternateValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

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

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LINETYPE_SOLID

public static final String LINETYPE_SOLID

Tooltip: Solid. SFInt32 field named linetype with X3DUOM simpleType lineTypeValues and with X3DUOM baseType SFInt32 "1" (Java syntax) or 1 (XML syntax).

See Also:

• LINETYPE_1_ALIAS
• XML Schema: lineTypeValues
• Constant Field Values

LINETYPE_1_ALIAS

public static final String LINETYPE_1_ALIAS

SFString SFInt32 enumeration value "1" has alias "SOLID"

See Also:

• LINETYPE_SOLID
• Constant Field Values

LINETYPE_DASHED

public static final String LINETYPE_DASHED

Tooltip: Dashed. SFInt32 field named linetype with X3DUOM simpleType lineTypeValues and with X3DUOM baseType SFInt32 "2" (Java syntax) or 2 (XML syntax).

See Also:

• LINETYPE_2_ALIAS
• XML Schema: lineTypeValues
• Constant Field Values

LINETYPE_2_ALIAS

public static final String LINETYPE_2_ALIAS

SFString SFInt32 enumeration value "2" has alias "DASHED"

See Also:

• LINETYPE_DASHED
• Constant Field Values

LINETYPE_DOTTED

public static final String LINETYPE_DOTTED

Tooltip: Dotted. SFInt32 field named linetype with X3DUOM simpleType lineTypeValues and with X3DUOM baseType SFInt32 "3" (Java syntax) or 3 (XML syntax).

See Also:

• LINETYPE_3_ALIAS
• XML Schema: lineTypeValues
• Constant Field Values

LINETYPE_3_ALIAS

public static final String LINETYPE_3_ALIAS

SFString SFInt32 enumeration value "3" has alias "DOTTED"

See Also:

• LINETYPE_DOTTED
• Constant Field Values

LINETYPE_DASHED_DOTTED

public static final String LINETYPE_DASHED_DOTTED

Tooltip: Dashed-dotted. SFInt32 field named linetype with X3DUOM simpleType lineTypeValues and with X3DUOM baseType SFInt32 "4" (Java syntax) or 4 (XML syntax).

See Also:

• LINETYPE_4_ALIAS
• XML Schema: lineTypeValues
• Constant Field Values

LINETYPE_4_ALIAS

public static final String LINETYPE_4_ALIAS

SFString SFInt32 enumeration value "4" has alias "DASHED_DOTTED"

See Also:

• LINETYPE_DASHED_DOTTED
• Constant Field Values

LINETYPE_DASHED_DOT_DOT

public static final String LINETYPE_DASHED_DOT_DOT

Tooltip: Dash-dot-dot. SFInt32 field named linetype with X3DUOM simpleType lineTypeValues and with X3DUOM baseType SFInt32 "5" (Java syntax) or 5 (XML syntax).

See Also:

• LINETYPE_5_ALIAS
• XML Schema: lineTypeValues
• Constant Field Values

LINETYPE_5_ALIAS

public static final String LINETYPE_5_ALIAS

SFString SFInt32 enumeration value "5" has alias "DASHED_DOT_DOT"

See Also:

• LINETYPE_DASHED_DOT_DOT
• Constant Field Values

LINETYPE_SINGLE_ARROW

public static final String LINETYPE_SINGLE_ARROW

Tooltip: (single arrow). SFInt32 field named linetype with X3DUOM simpleType lineTypeValues and with X3DUOM baseType SFInt32 "6" (Java syntax) or 6 (XML syntax).

See Also:

• LINETYPE_6_ALIAS
• XML Schema: lineTypeValues
• Constant Field Values

LINETYPE_6_ALIAS

public static final String LINETYPE_6_ALIAS

SFString SFInt32 enumeration value "6" has alias "SINGLE_ARROW"

See Also:

• LINETYPE_SINGLE_ARROW
• Constant Field Values

LINETYPE_SINGLE_DOT

public static final String LINETYPE_SINGLE_DOT

Tooltip: (single dot). SFInt32 field named linetype with X3DUOM simpleType lineTypeValues and with X3DUOM baseType SFInt32 "7" (Java syntax) or 7 (XML syntax).

See Also:

• LINETYPE_7_ALIAS
• XML Schema: lineTypeValues
• Constant Field Values

LINETYPE_7_ALIAS

public static final String LINETYPE_7_ALIAS

SFString SFInt32 enumeration value "7" has alias "SINGLE_DOT"

See Also:

• LINETYPE_SINGLE_DOT
• Constant Field Values

LINETYPE_DOUBLE_ARROW

public static final String LINETYPE_DOUBLE_ARROW

Tooltip: (double arrow). SFInt32 field named linetype with X3DUOM simpleType lineTypeValues and with X3DUOM baseType SFInt32 "8" (Java syntax) or 8 (XML syntax).

See Also:

• LINETYPE_8_ALIAS
• XML Schema: lineTypeValues
• Constant Field Values

LINETYPE_8_ALIAS

public static final String LINETYPE_8_ALIAS

SFString SFInt32 enumeration value "8" has alias "DOUBLE_ARROW"

See Also:

• LINETYPE_DOUBLE_ARROW
• Constant Field Values

LINETYPE_STITCH_LINE

public static final String LINETYPE_STITCH_LINE

Tooltip: (stitch line). SFInt32 field named linetype with X3DUOM simpleType lineTypeValues and with X3DUOM baseType SFInt32 "9" (Java syntax) or 9 (XML syntax).

See Also:

• LINETYPE_9_ALIAS
• XML Schema: lineTypeValues
• Constant Field Values

LINETYPE_9_ALIAS

public static final String LINETYPE_9_ALIAS

SFString SFInt32 enumeration value "9" has alias "STITCH_LINE"

See Also:

• LINETYPE_STITCH_LINE
• Constant Field Values

LINETYPE_CHAIN_LINE

public static final String LINETYPE_CHAIN_LINE

Tooltip: (chain line). SFInt32 field named linetype with X3DUOM simpleType lineTypeValues and with X3DUOM baseType SFInt32 "10" (Java syntax) or 10 (XML syntax).

See Also:

• LINETYPE_10_ALIAS
• XML Schema: lineTypeValues
• Constant Field Values

LINETYPE_10_ALIAS

public static final String LINETYPE_10_ALIAS

SFString SFInt32 enumeration value "10" has alias "CHAIN_LINE"

See Also:

• LINETYPE_CHAIN_LINE
• Constant Field Values

LINETYPE_CENTER_LINE

public static final String LINETYPE_CENTER_LINE

Tooltip: (center line). SFInt32 field named linetype with X3DUOM simpleType lineTypeValues and with X3DUOM baseType SFInt32 "11" (Java syntax) or 11 (XML syntax).

See Also:

• LINETYPE_11_ALIAS
• XML Schema: lineTypeValues
• Constant Field Values

LINETYPE_11_ALIAS

public static final String LINETYPE_11_ALIAS

SFString SFInt32 enumeration value "11" has alias "CENTER_LINE"

See Also:

• LINETYPE_CENTER_LINE
• Constant Field Values

LINETYPE_HIDDEN_LINE

public static final String LINETYPE_HIDDEN_LINE

Tooltip: (hidden line). SFInt32 field named linetype with X3DUOM simpleType lineTypeValues and with X3DUOM baseType SFInt32 "12" (Java syntax) or 12 (XML syntax).

See Also:

• LINETYPE_12_ALIAS
• XML Schema: lineTypeValues
• Constant Field Values

LINETYPE_12_ALIAS

public static final String LINETYPE_12_ALIAS

SFString SFInt32 enumeration value "12" has alias "HIDDEN_LINE"

See Also:

• LINETYPE_HIDDEN_LINE
• Constant Field Values

LINETYPE_PHANTOM_LINE

public static final String LINETYPE_PHANTOM_LINE

Tooltip: (phantom line). SFInt32 field named linetype with X3DUOM simpleType lineTypeValues and with X3DUOM baseType SFInt32 "13" (Java syntax) or 13 (XML syntax).

See Also:

• LINETYPE_13_ALIAS
• XML Schema: lineTypeValues
• Constant Field Values

LINETYPE_13_ALIAS

public static final String LINETYPE_13_ALIAS

SFString SFInt32 enumeration value "13" has alias "PHANTOM_LINE"

See Also:

• LINETYPE_PHANTOM_LINE
• Constant Field Values

LINETYPE_BREAK_LINE_STYLE_1

public static final String LINETYPE_BREAK_LINE_STYLE_1

Tooltip: (break line - style 1). SFInt32 field named linetype with X3DUOM simpleType lineTypeValues and with X3DUOM baseType SFInt32 "14" (Java syntax) or 14 (XML syntax).

See Also:

• LINETYPE_14_ALIAS
• XML Schema: lineTypeValues
• Constant Field Values

LINETYPE_14_ALIAS

public static final String LINETYPE_14_ALIAS

SFString SFInt32 enumeration value "14" has alias "BREAK_LINE_STYLE_1"

See Also:

• LINETYPE_BREAK_LINE_STYLE_1
• Constant Field Values

LINETYPE_BREAK_LINE_STYLE_2

public static final String LINETYPE_BREAK_LINE_STYLE_2

Tooltip: (break line - style 2). SFInt32 field named linetype with X3DUOM simpleType lineTypeValues and with X3DUOM baseType SFInt32 "15" (Java syntax) or 15 (XML syntax).

See Also:

• LINETYPE_15_ALIAS
• XML Schema: lineTypeValues
• Constant Field Values

LINETYPE_15_ALIAS

public static final String LINETYPE_15_ALIAS

SFString SFInt32 enumeration value "15" has alias "BREAK_LINE_STYLE_2"

See Also:

• LINETYPE_BREAK_LINE_STYLE_2
• Constant Field Values

LINETYPE_USER_SPECIFIED_DASH_PATTERN

public static final String LINETYPE_USER_SPECIFIED_DASH_PATTERN

Tooltip: User-specified dash pattern. SFInt32 field named linetype with X3DUOM simpleType lineTypeValues and with X3DUOM baseType SFInt32 "16" (Java syntax) or 16 (XML syntax).

See Also:

• LINETYPE_16_ALIAS
• XML Schema: lineTypeValues
• Constant Field Values

LINETYPE_16_ALIAS

public static final String LINETYPE_16_ALIAS

SFString SFInt32 enumeration value "16" has alias "USER_SPECIFIED_DASH_PATTERN"

See Also:

• LINETYPE_USER_SPECIFIED_DASH_PATTERN
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: LineProperties.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the LineProperties element: Shape

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D Shape 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

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

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

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

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.

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_APPLIED

public static final String fromField_APPLIED

fromField ROUTE name for SFBool field named applied.

See Also:

• Constant Field Values

toField_APPLIED

public static final String toField_APPLIED

toField ROUTE name for SFBool field named applied.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_LINETYPE

public static final String fromField_LINETYPE

fromField ROUTE name for SFInt32 field named linetype.

See Also:

• Constant Field Values

toField_LINETYPE

public static final String toField_LINETYPE

toField ROUTE name for SFInt32 field named linetype.

See Also:

• Constant Field Values

fromField_LINEWIDTHSCALEFACTOR

public static final String fromField_LINEWIDTHSCALEFACTOR

fromField ROUTE name for SFFloat field named linewidthScaleFactor.

See Also:

• Constant Field Values

toField_LINEWIDTHSCALEFACTOR

public static final String toField_LINEWIDTHSCALEFACTOR

toField ROUTE name for SFFloat field named linewidthScaleFactor.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

Constructor Details

LineProperties

public LineProperties()

Constructor for LineProperties to initialize member variables with default values.

LineProperties

public LineProperties(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 String getElementName()

Provides name of this element: LineProperties

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the LineProperties 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 String getFieldType(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 String getAccessType(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 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

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

Specified by:

setApplied in interface LineProperties

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

setApplied

public LineProperties setApplied(SFBool newValue)

Assign typed object value to SFBool applied field, similar to setApplied(boolean).

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

getIS

public IS getIS()

Provide IS 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 LineProperties setIS(IS newValue)

Accessor method to assign IS 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:

LineProperties - 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 LineProperties clearIS()

Utility method to clear SFNode value of IS field.

Returns:

LineProperties - 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()

getLinetype

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

• Hint: detailed descriptions of lineType values are found at the ISO/IEC 9973 International Register of Graphical Items https://www.iso.org/jtc1/sc24/register at https://isotc.iso.org/livelink/livelink/fetch/-8916524/8916549/8916590/6208440/class_pages/linetype.html

Specified by:

getLinetype in interface LineProperties

Returns:

value of linetype field

setLinetype

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

• Hint: detailed descriptions of lineType values are found at the ISO/IEC 9973 International Register of Graphical Items https://www.iso.org/jtc1/sc24/register at https://isotc.iso.org/livelink/livelink/fetch/-8916524/8916549/8916590/6208440/class_pages/linetype.html

Specified by:

setLinetype in interface LineProperties

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

setLinetype

public LineProperties setLinetype(SFInt32 newValue)

Assign typed object value to SFInt32 linetype field, similar to setLinetype(int).

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

public 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. *

Specified by:

getLinewidthScaleFactor in interface LineProperties

Returns:

value of linewidthScaleFactor field

setLinewidthScaleFactor

public 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. *

Specified by:

setLinewidthScaleFactor in interface LineProperties

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

setLinewidthScaleFactor

public LineProperties setLinewidthScaleFactor(SFFloat newValue)

Assign typed object value to SFFloat linewidthScaleFactor field, similar to setLinewidthScaleFactor(float).

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

setLinewidthScaleFactor

public LineProperties setLinewidthScaleFactor(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setLinewidthScaleFactor(float).

Parameters:

newValue - is new value for field

Returns:

LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getMetadata

public X3DMetadataObject getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface LineProperties

Specified by:

getMetadata in interface X3DAppearanceChildNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

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

Specified by:

setMetadata in interface LineProperties

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:

LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public LineProperties clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public LineProperties setMetadata(ProtoInstance 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:

LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setMetadata(org.web3d.x3d.sai.Core.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

getDEF

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

• 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final LineProperties setDEF(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.

• 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

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:

LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

public LineProperties setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

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

getUSE

public 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 LineProperties setUSE(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:

LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public LineProperties setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

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

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final LineProperties setCssClass(String newValue)

Accessor method to assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in class X3DConcreteNode

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public LineProperties setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

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

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final LineProperties setHtmlID(String newValue)

Accessor method to assign String value to inputOutput SFString field named id.

Specified by:

setHtmlID in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public LineProperties setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Parameters:

newValue - is new value for the id field.

Returns:

LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final LineProperties setCssStyle(String newValue)

Accessor method to assign String value to inputOutput SFString field named style.

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public LineProperties setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public LineProperties setUSE(LineProperties 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:

LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addComments

public LineProperties addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public LineProperties addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public LineProperties addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

LineProperties - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

toStringX3D

public 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:

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D.toStringXML()
• X3D.toFileXML(String)
• X3D.toFileX3D(String)
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

public 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:

• X3D.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 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:

• X3D.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(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue,
 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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasElementByNameValue

public boolean hasElementByNameValue(String nameValue,
 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(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasNodeByDEF

public boolean hasNodeByDEF(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 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. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)