Package org.web3d.x3d.jsail.Rendering

Class IndexedLineSet

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Rendering.IndexedLineSet

All Implemented Interfaces:

X3DNode, IndexedLineSet, X3DGeometryNode

public class IndexedLineSet
extends X3DConcreteNode
implements IndexedLineSet

IndexedLineSet defines polyline segments using index lists corresponding to vertex coordinates.

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. IndexedLineSet node tooltip: [X3DGeometryNode] IndexedLineSet defines polyline segments using index lists corresponding to vertex coordinates. IndexedLineSet is a geometry node that can contain a Coordinate|CoordinateDouble node and optionally a Color|ColorRGBA node.

• Hint: Polygonal chain https://en.wikipedia.org/wiki/Polygonal_chain
• Hint: either values in a contained Color node, or else Material emissiveColor in corresponding Appearance node, are used for rendering lines and points.
• Warning: lines are not lit, are not texture-mapped, and do not participate in collision detection.
• Warning: use a different color (or Material emissiveColor) than the Background color, otherwise geometry is invisible.
• Hint: adding LineProperties to the corresponding Appearance node can modify the rendering style of these lines.
• Hint: if rendering Coordinate points originally defined for an IndexedFaceSet, index values may need to repeat each initial vertex to close each polygon outline.
• Hint: step-wise variation or linear interpolation of color values can be used as a good scientific visualization technique to map arbitrary function values to a color map.
• Hint: insert a Shape node before adding geometry or Appearance.
• Hint: for advanced extensibility, authors can substitute a type-matched ProtoInstance node (with correct containerField value) for contained node content.
• Hint: consider including Fog (with Fog color matching Background color) to provide further depth cueing for IndexedLineSet (ILS).

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: IndexedLineSet
• X3D Tooltips: IndexedLineSet
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final X3DColorNode	COLOR_DEFAULT_VALUE	SFNode field named color has default value null (Java syntax) or NULL (XML syntax).
static final ArrayList<Integer>	COLORINDEX_DEFAULT_VALUE	MFInt32 field named colorIndex has default value equal to an empty list.
static final boolean	COLORPERVERTEX_DEFAULT_VALUE	SFBool field named colorPerVertex has default value true (Java syntax) or true (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the IndexedLineSet element: Rendering
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final X3DCoordinateNode	COORD_DEFAULT_VALUE	SFNode field named coord has default value null (Java syntax) or NULL (XML syntax).
static final ArrayList<Integer>	COORDINDEX_DEFAULT_VALUE	MFInt32 field named coordIndex has default value equal to an empty list.
static final FogCoordinate	FOGCOORD_DEFAULT_VALUE	SFNode field named fogCoord has default value null (Java syntax) or NULL (XML syntax).
static final String	fromField_ATTRIB	fromField ROUTE name for MFNode field named attrib.
static final String	fromField_COLOR	fromField ROUTE name for SFNode field named color.
static final String	fromField_COORD	fromField ROUTE name for SFNode field named coord.
static final String	fromField_FOGCOORD	fromField ROUTE name for SFNode field named fogCoord.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_NORMAL	fromField ROUTE name for SFNode field named normal.
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 Rendering component level for this element: 1
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: IndexedLineSet.
static final X3DNormalNode	NORMAL_DEFAULT_VALUE	SFNode field named normal has default value null (Java syntax) or NULL (XML syntax).
static final String	toField_ATTRIB	toField ROUTE name for MFNode field named attrib.
static final String	toField_COLOR	toField ROUTE name for SFNode field named color.
static final String	toField_COORD	toField ROUTE name for SFNode field named coord.
static final String	toField_FOGCOORD	toField ROUTE name for SFNode field named fogCoord.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_NORMAL	toField ROUTE name for SFNode field named normal.
static final String	toField_SET_COLORINDEX	toField ROUTE name for MFInt32 field named set_colorIndex.
static final String	toField_SET_COORDINDEX	toField ROUTE name for MFInt32 field named set_coordIndex.

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
IndexedLineSet()	Constructor for IndexedLineSet to initialize member variables with default values.
IndexedLineSet(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
IndexedLineSet	addAttrib(ProtoInstance newValue)	Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for attrib field.
IndexedLineSet	addAttrib(X3DNode newValue)	Add single child node to existing array of attrib nodes (if any).
void	addAttrib(X3DNode[] newValue)	Add array of child attrib nodes to array of existing nodes (if any).
IndexedLineSet	addColorIndex(int newValue)	Add singleton int value to MFInt32 colorIndex field.
IndexedLineSet	addColorIndex(SFInt32 newValue)	Add singleton SFInt32 value to MFInt32 colorIndex field.
IndexedLineSet	addComments(String newComment)	Add comment as String to contained commentsList.
IndexedLineSet	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
IndexedLineSet	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
IndexedLineSet	addCoordIndex(int newValue)	Add singleton int value to MFInt32 coordIndex field.
IndexedLineSet	addCoordIndex(SFInt32 newValue)	Add singleton SFInt32 value to MFInt32 coordIndex field.
IndexedLineSet	clearAttrib()	Utility method to clear MFNode value of attrib field.
IndexedLineSet	clearColor()	Utility method to clear SFNode value of color field.
IndexedLineSet	clearColorIndex()	Utility method to clear MFInt32 value of colorIndex field.
IndexedLineSet	clearCoord()	Utility method to clear SFNode value of coord field.
IndexedLineSet	clearCoordIndex()	Utility method to clear MFInt32 value of coordIndex field.
IndexedLineSet	clearFogCoord()	Utility method to clear SFNode value of fogCoord field.
IndexedLineSet	clearIS()	Utility method to clear SFNode value of IS field.
IndexedLineSet	clearMetadata()	Utility method to clear SFNode value of metadata field.
IndexedLineSet	clearNormal()	Utility method to clear SFNode value of normal 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.
X3DNode[]	getAttrib()	Provide array of org.web3d.x3d.sai.Shaders.X3DVertexAttributeNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field attrib.
ArrayList<X3DNode>	getAttribList()	Utility method to get ArrayList value of MFNode attrib field, similar to getAttrib().
X3DColorNode	getColor()	Provide org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.
int	getColorCount()	Utility method to get number of 3-tuple Color RGB values (or 4-tuple ColorRGBA values) in contained Color/ColorRGBA or ProtoInstance node
int[]	getColorIndex()	Provide array of Integer results using RGB values [0..1] from initializeOnly MFInt32 field named colorIndex.
ArrayList<Integer>	getColorIndexList()	Utility method to get ArrayList value of MFInt32 colorIndex field, similar to getColorIndex().
String	getColorIndexString()	Utility method to get String value of MFInt32 colorIndex field, similar to getColorIndex().
boolean	getColorPerVertex()	Provide boolean value from initializeOnly SFBool field named colorPerVertex.
final String	getComponent()	Defines X3D component for the IndexedLineSet element: Rendering
final int	getComponentLevel()	Provides default X3D component level for this element: 1
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
X3DCoordinateNode	getCoord()	Provide org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.
int	getCoordCount()	Utility method to get number of coordinate 3-tuple values in contained Coordinate/CoordinateDouble or ProtoInstance node
int[]	getCoordIndex()	Provide array of Integer results within allowed range of [-1,infinity) from initializeOnly MFInt32 field named coordIndex.
ArrayList<Integer>	getCoordIndexList()	Utility method to get ArrayList value of MFInt32 coordIndex field, similar to getCoordIndex().
String	getCoordIndexString()	Utility method to get String value of MFInt32 coordIndex field, similar to getCoordIndex().
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: IndexedLineSet
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
FogCoordinate	getFogCoord()	Provide org.web3d.x3d.sai.EnvironmentalEffects.FogCoordinate instance (using a properly typed node) from inputOutput SFNode field fogCoord.
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.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
X3DNormalNode	getNormal()	Provide org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field normal.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasAttrib()	Indicate whether an object is available for inputOutput MFNode field attrib.
boolean	hasColor()	Indicate whether an object is available for inputOutput SFNode field color.
boolean	hasCoord()	Indicate whether an object is available for inputOutput SFNode field coord.
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	hasFogCoord()	Indicate whether an object is available for inputOutput SFNode field fogCoord.
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.
boolean	hasNormal()	Indicate whether an object is available for inputOutput SFNode field normal.
final void	initialize()	Initialize all member variables to default values.
IndexedLineSet	setAttrib(ArrayList<X3DVertexAttributeNode> newValue)	Assign ArrayList value of MFNode attrib field, similar to setAttrib(org.web3d.x3d.sai.Core.X3DNode[]).
void	setAttrib(X3DNode newValue)	Set single child attrib node, replacing prior array of existing nodes (if any).
IndexedLineSet	setAttrib(X3DNode[] newValue)	Accessor method to assign org.web3d.x3d.sai.Shaders.X3DVertexAttributeNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field attrib.
IndexedLineSet	setColor(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field color.
IndexedLineSet	setColor(X3DColorNode newValue)	Accessor method to assign org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.
IndexedLineSet	setColorIndex(int[] newValue)	Accessor method to assign Integer array to initializeOnly MFInt32 field named colorIndex.
IndexedLineSet	setColorIndex(ArrayList<Integer> newValue)	Assign ArrayList value of MFInt32 colorIndex field, similar to setColorIndex(int[]).
IndexedLineSet	setColorIndex(MFInt32 newValue)	Assign typed object value to MFInt32 colorIndex field, similar to setColorIndex(int[]).
IndexedLineSet	setColorPerVertex(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named colorPerVertex.
IndexedLineSet	setColorPerVertex(SFBool newValue)	Assign typed object value to SFBool colorPerVertex field, similar to setColorPerVertex(boolean).
IndexedLineSet	setCoord(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field coord.
IndexedLineSet	setCoord(X3DCoordinateNode newValue)	Accessor method to assign org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.
IndexedLineSet	setCoordIndex(int[] newValue)	Accessor method to assign Integer array to initializeOnly MFInt32 field named coordIndex.
IndexedLineSet	setCoordIndex(ArrayList<Integer> newValue)	Assign ArrayList value of MFInt32 coordIndex field, similar to setCoordIndex(int[]).
IndexedLineSet	setCoordIndex(MFInt32 newValue)	Assign typed object value to MFInt32 coordIndex field, similar to setCoordIndex(int[]).
final IndexedLineSet	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
IndexedLineSet	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final IndexedLineSet	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
IndexedLineSet	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final IndexedLineSet	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
IndexedLineSet	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
IndexedLineSet	setFogCoord(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fogCoord.
IndexedLineSet	setFogCoord(FogCoordinate newValue)	Accessor method to assign org.web3d.x3d.sai.EnvironmentalEffects.FogCoordinate instance (using a properly typed node) to inputOutput SFNode field fogCoord.
final IndexedLineSet	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
IndexedLineSet	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
IndexedLineSet	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
IndexedLineSet	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
IndexedLineSet	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
IndexedLineSet	setNormal(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field normal.
IndexedLineSet	setNormal(X3DNormalNode newValue)	Accessor method to assign org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.
final IndexedLineSet	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
IndexedLineSet	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
IndexedLineSet	setUSE(IndexedLineSet 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

NAME

public static final String NAME

String constant NAME provides name of this element: IndexedLineSet.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the IndexedLineSet element: Rendering

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D Rendering component level for this element: 1

See Also:

• Constant Field Values

COLOR_DEFAULT_VALUE

public static final X3DColorNode COLOR_DEFAULT_VALUE

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

COLORINDEX_DEFAULT_VALUE

public static final ArrayList<Integer> COLORINDEX_DEFAULT_VALUE

MFInt32 field named colorIndex has default value equal to an empty list.

COLORPERVERTEX_DEFAULT_VALUE

public static final boolean COLORPERVERTEX_DEFAULT_VALUE

SFBool field named colorPerVertex has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

COORD_DEFAULT_VALUE

public static final X3DCoordinateNode COORD_DEFAULT_VALUE

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

COORDINDEX_DEFAULT_VALUE

public static final ArrayList<Integer> COORDINDEX_DEFAULT_VALUE

MFInt32 field named coordIndex has default value equal to an empty list.

FOGCOORD_DEFAULT_VALUE

public static final FogCoordinate FOGCOORD_DEFAULT_VALUE

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

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

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

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

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

NORMAL_DEFAULT_VALUE

public static final X3DNormalNode NORMAL_DEFAULT_VALUE

SFNode field named normal 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_ATTRIB

public static final String fromField_ATTRIB

fromField ROUTE name for MFNode field named attrib.

See Also:

• Constant Field Values

toField_ATTRIB

public static final String toField_ATTRIB

toField ROUTE name for MFNode field named attrib.

See Also:

• Constant Field Values

fromField_COLOR

public static final String fromField_COLOR

fromField ROUTE name for SFNode field named color.

See Also:

• Constant Field Values

toField_COLOR

public static final String toField_COLOR

toField ROUTE name for SFNode field named color.

See Also:

• Constant Field Values

fromField_COORD

public static final String fromField_COORD

fromField ROUTE name for SFNode field named coord.

See Also:

• Constant Field Values

toField_COORD

public static final String toField_COORD

toField ROUTE name for SFNode field named coord.

See Also:

• Constant Field Values

fromField_FOGCOORD

public static final String fromField_FOGCOORD

fromField ROUTE name for SFNode field named fogCoord.

See Also:

• Constant Field Values

toField_FOGCOORD

public static final String toField_FOGCOORD

toField ROUTE name for SFNode field named fogCoord.

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_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

fromField_NORMAL

public static final String fromField_NORMAL

fromField ROUTE name for SFNode field named normal.

See Also:

• Constant Field Values

toField_NORMAL

public static final String toField_NORMAL

toField ROUTE name for SFNode field named normal.

See Also:

• Constant Field Values

toField_SET_COLORINDEX

public static final String toField_SET_COLORINDEX

toField ROUTE name for MFInt32 field named set_colorIndex.

See Also:

• Constant Field Values

toField_SET_COORDINDEX

public static final String toField_SET_COORDINDEX

toField ROUTE name for MFInt32 field named set_coordIndex.

See Also:

• Constant Field Values

Constructor Details

IndexedLineSet

public IndexedLineSet()

Constructor for IndexedLineSet to initialize member variables with default values.

IndexedLineSet

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the IndexedLineSet element: Rendering

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

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

getAttrib

public X3DNode[] getAttrib()

Provide array of org.web3d.x3d.sai.Shaders.X3DVertexAttributeNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field attrib.

Tooltip: [X3DVertexAttributeNode] Single contained FloatVertexAttribute node that can specify list of per-vertex attribute information for programmable shaders.

• Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/shaders.html#Pervertexattributes

Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVertexAttributeNode.

Specified by:

getAttrib in interface IndexedLineSet

Returns:

value of attrib field

See Also:

• X3DVertexAttributeNode

getAttribList

public ArrayList<X3DNode> getAttribList()

Utility method to get ArrayList value of MFNode attrib field, similar to getAttrib().

Returns:

value of attrib field

setAttrib

public IndexedLineSet setAttrib(X3DNode[] newValue)

Accessor method to assign org.web3d.x3d.sai.Shaders.X3DVertexAttributeNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field attrib.

Tooltip: [X3DVertexAttributeNode] Single contained FloatVertexAttribute node that can specify list of per-vertex attribute information for programmable shaders.

• Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/shaders.html#Pervertexattributes

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVertexAttributeNode.

Specified by:

setAttrib in interface IndexedLineSet

Parameters:

newValue - is new value for the attrib field.

Returns:

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

setAttrib

public IndexedLineSet setAttrib(ArrayList<X3DVertexAttributeNode> newValue)

Assign ArrayList value of MFNode attrib field, similar to setAttrib(org.web3d.x3d.sai.Core.X3DNode[]).

Parameters:

newValue - is new value for the attrib field.

Returns:

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

addAttrib

public IndexedLineSet addAttrib(X3DNode newValue)

Add single child node to existing array of attrib nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVertexAttributeNode and ProtoInstance.

Parameters:

newValue - is new value to be appended the attrib field.

Returns:

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

addAttrib

public IndexedLineSet addAttrib(ProtoInstance newValue)

Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for attrib field.

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.

Parameters:

newValue - is new value to be appended the parts field.

Returns:

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

addAttrib

public void addAttrib(X3DNode[] newValue)

Add array of child attrib nodes to array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVertexAttributeNode.

Specified by:

addAttrib in interface IndexedLineSet

Parameters:

newValue - is new value array to be appended the attrib field.

setAttrib

public void setAttrib(X3DNode newValue)

Set single child attrib node, replacing prior array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DVertexAttributeNode.

Specified by:

setAttrib in interface IndexedLineSet

Parameters:

newValue - is new node for the attrib field (restricted to X3DVertexAttributeNode)

clearAttrib

public IndexedLineSet clearAttrib()

Utility method to clear MFNode value of attrib field.

Returns:

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

hasAttrib

public boolean hasAttrib()

Indicate whether an object is available for inputOutput MFNode field attrib.

Returns:

whether a properly typed node or ProtoInstance array or CommentsBlock is available.

See Also:

• getAttrib()

getColor

public X3DColorNode getColor()

Provide org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.

Specified by:

getColor in interface IndexedLineSet

Returns:

value of color field

See Also:

• 
  
  Tooltip: [X3DColorNode] Single contained Color or ColorRGBA node that can specify color values applied to corresponding vertices according to colorIndex and colorPerVertex fields. *
  

setColor

public IndexedLineSet setColor(X3DColorNode newValue)

Accessor method to assign org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.

Specified by:

setColor in interface IndexedLineSet

Parameters:

newValue - is new value for the color field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DColorNode] Single contained Color or ColorRGBA node that can specify color values applied to corresponding vertices according to colorIndex and colorPerVertex fields. *
  

clearColor

public IndexedLineSet clearColor()

Utility method to clear SFNode value of color field.

Returns:

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

setColor

public IndexedLineSet setColor(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field color.

Parameters:

newValue - is new value for the color field.

Returns:

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

See Also:

• setColor(org.web3d.x3d.sai.Rendering.X3DColorNode)

hasColor

public boolean hasColor()

Indicate whether an object is available for inputOutput SFNode field color.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getColor()
• getColorProtoInstance()

getColorIndex

public int[] getColorIndex()

Provide array of Integer results using RGB values [0..1] from initializeOnly MFInt32 field named colorIndex.

Tooltip: [-1,+infinity) colorIndex values define the order in which Color|ColorRGBA values are applied to polygons (or vertices).

• Hint: if colorIndex array is not provided, then Color|ColorRGBA values are indexed according to the coordIndex field.
• Hint: If colorPerVertex='false' then one index is provided for each polygon defined by the coordIndex array. No sentinel -1 values are included.
• Hint: If colorPerVertex='true' then a matching set of indices is provided, each separated by sentinel -1, that exactly corresponds to individual values in the coordIndex array polygon definitions.
• Hint: if rendering Coordinate points originally defined for an IndexedFaceSet, index values may need to repeat initial each initial vertex to close the polygons.
• Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding Appearance and material/texture values.

Specified by:

getColorIndex in interface IndexedLineSet

Returns:

value of colorIndex field

getColorIndexList

public ArrayList<Integer> getColorIndexList()

Utility method to get ArrayList value of MFInt32 colorIndex field, similar to getColorIndex().

Returns:

value of colorIndex field

getColorIndexString

public String getColorIndexString()

Utility method to get String value of MFInt32 colorIndex field, similar to getColorIndex().

Returns:

value of colorIndex field

setColorIndex

public IndexedLineSet setColorIndex(int[] newValue)

Accessor method to assign Integer array to initializeOnly MFInt32 field named colorIndex.

Tooltip: [-1,+infinity) colorIndex values define the order in which Color|ColorRGBA values are applied to polygons (or vertices).

• Hint: if colorIndex array is not provided, then Color|ColorRGBA values are indexed according to the coordIndex field.
• Hint: If colorPerVertex='false' then one index is provided for each polygon defined by the coordIndex array. No sentinel -1 values are included.
• Hint: If colorPerVertex='true' then a matching set of indices is provided, each separated by sentinel -1, that exactly corresponds to individual values in the coordIndex array polygon definitions.
• Hint: if rendering Coordinate points originally defined for an IndexedFaceSet, index values may need to repeat initial each initial vertex to close the polygons.
• Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding Appearance and material/texture values.

Specified by:

setColorIndex in interface IndexedLineSet

Parameters:

newValue - is new value for the colorIndex field.

Returns:

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

setColorIndex

public IndexedLineSet setColorIndex(MFInt32 newValue)

Assign typed object value to MFInt32 colorIndex field, similar to setColorIndex(int[]).

Parameters:

newValue - is new value for the colorIndex field.

Returns:

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

setColorIndex

public IndexedLineSet setColorIndex(ArrayList<Integer> newValue)

Assign ArrayList value of MFInt32 colorIndex field, similar to setColorIndex(int[]).

Parameters:

newValue - is new value for the colorIndex field.

Returns:

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

clearColorIndex

public IndexedLineSet clearColorIndex()

Utility method to clear MFInt32 value of colorIndex field.

Returns:

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

addColorIndex

public IndexedLineSet addColorIndex(int newValue)

Add singleton int value to MFInt32 colorIndex field.

Parameters:

newValue - is new value to add to the colorIndex field.

Returns:

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

addColorIndex

public IndexedLineSet addColorIndex(SFInt32 newValue)

Add singleton SFInt32 value to MFInt32 colorIndex field.

Parameters:

newValue - is new value to add to the colorIndex field.

Returns:

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

getColorPerVertex

public boolean getColorPerVertex()

Provide boolean value from initializeOnly SFBool field named colorPerVertex.

Tooltip: Whether Color node color values are applied to each point vertex (true) or per polyline (false).

• Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Specified by:

getColorPerVertex in interface IndexedLineSet

Returns:

value of colorPerVertex field

setColorPerVertex

public IndexedLineSet setColorPerVertex(boolean newValue)

Accessor method to assign boolean value to initializeOnly SFBool field named colorPerVertex.

Tooltip: Whether Color node color values are applied to each point vertex (true) or per polyline (false).

• Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color

Specified by:

setColorPerVertex in interface IndexedLineSet

Parameters:

newValue - is new value for the colorPerVertex field.

Returns:

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

setColorPerVertex

public IndexedLineSet setColorPerVertex(SFBool newValue)

Assign typed object value to SFBool colorPerVertex field, similar to setColorPerVertex(boolean).

Parameters:

newValue - is new value for the colorPerVertex field.

Returns:

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

getCoord

public X3DCoordinateNode getCoord()

Provide org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.

Specified by:

getCoord in interface IndexedLineSet

Returns:

value of coord field

See Also:

• 
  
  Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that can specify a list of vertex values. *
  

setCoord

public IndexedLineSet setCoord(X3DCoordinateNode newValue)

Accessor method to assign org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.

Specified by:

setCoord in interface IndexedLineSet

Parameters:

newValue - is new value for the coord field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that can specify a list of vertex values. *
  

clearCoord

public IndexedLineSet clearCoord()

Utility method to clear SFNode value of coord field.

Returns:

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

setCoord

public IndexedLineSet setCoord(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field coord.

Parameters:

newValue - is new value for the coord field.

Returns:

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

See Also:

• setCoord(org.web3d.x3d.sai.Rendering.X3DCoordinateNode)

hasCoord

public boolean hasCoord()

Indicate whether an object is available for inputOutput SFNode field coord.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getCoord()
• getCoordProtoInstance()

getCoordIndex

public int[] getCoordIndex()

Provide array of Integer results within allowed range of [-1,infinity) from initializeOnly MFInt32 field named coordIndex.

Tooltip: [-1,+infinity) coordIndex indices provide the order in which coordinates are applied to construct each polygon face. Order starts at index 0, commas are optional between sets, use -1 to separate indices for each polyline.

• Hint: if rendering Coordinate points originally defined for an IndexedFaceSet, index values may need to repeat initial each initial vertex to close the polygons.
• Hint: sentinel value -1 is used to separate indices for each successive polyline.
• Warning: coordIndex is required in order to connect contained coordinate point values.

Specified by:

getCoordIndex in interface IndexedLineSet

Returns:

value of coordIndex field

getCoordIndexList

public ArrayList<Integer> getCoordIndexList()

Utility method to get ArrayList value of MFInt32 coordIndex field, similar to getCoordIndex().

Returns:

value of coordIndex field

getCoordIndexString

public String getCoordIndexString()

Utility method to get String value of MFInt32 coordIndex field, similar to getCoordIndex().

Returns:

value of coordIndex field

setCoordIndex

public IndexedLineSet setCoordIndex(int[] newValue)

Accessor method to assign Integer array to initializeOnly MFInt32 field named coordIndex.

Tooltip: [-1,+infinity) coordIndex indices provide the order in which coordinates are applied to construct each polygon face. Order starts at index 0, commas are optional between sets, use -1 to separate indices for each polyline.

• Hint: if rendering Coordinate points originally defined for an IndexedFaceSet, index values may need to repeat initial each initial vertex to close the polygons.
• Hint: sentinel value -1 is used to separate indices for each successive polyline.
• Warning: coordIndex is required in order to connect contained coordinate point values.

Specified by:

setCoordIndex in interface IndexedLineSet

Parameters:

newValue - is new value for the coordIndex field.

Returns:

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

setCoordIndex

public IndexedLineSet setCoordIndex(MFInt32 newValue)

Assign typed object value to MFInt32 coordIndex field, similar to setCoordIndex(int[]).

Parameters:

newValue - is new value for the coordIndex field.

Returns:

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

setCoordIndex

public IndexedLineSet setCoordIndex(ArrayList<Integer> newValue)

Assign ArrayList value of MFInt32 coordIndex field, similar to setCoordIndex(int[]).

Parameters:

newValue - is new value for the coordIndex field.

Returns:

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

clearCoordIndex

public IndexedLineSet clearCoordIndex()

Utility method to clear MFInt32 value of coordIndex field.

Returns:

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

addCoordIndex

public IndexedLineSet addCoordIndex(int newValue)

Add singleton int value to MFInt32 coordIndex field.

Parameters:

newValue - is new value to add to the coordIndex field.

Returns:

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

addCoordIndex

public IndexedLineSet addCoordIndex(SFInt32 newValue)

Add singleton SFInt32 value to MFInt32 coordIndex field.

Parameters:

newValue - is new value to add to the coordIndex field.

Returns:

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

getFogCoord

public FogCoordinate getFogCoord()

Provide org.web3d.x3d.sai.EnvironmentalEffects.FogCoordinate instance (using a properly typed node) from inputOutput SFNode field fogCoord.

Specified by:

getFogCoord in interface IndexedLineSet

Returns:

value of fogCoord field

See Also:

• 
  
  Tooltip: [FogCoordinate] Single contained FogCoordinate node that can specify depth parameters for fog in corresponding geometry. *
  

setFogCoord

public IndexedLineSet setFogCoord(FogCoordinate newValue)

Accessor method to assign org.web3d.x3d.sai.EnvironmentalEffects.FogCoordinate instance (using a properly typed node) to inputOutput SFNode field fogCoord.

Specified by:

setFogCoord in interface IndexedLineSet

Parameters:

newValue - is new value for the fogCoord field.

Returns:

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

See Also:

• 
  
  Tooltip: [FogCoordinate] Single contained FogCoordinate node that can specify depth parameters for fog in corresponding geometry. *
  

clearFogCoord

public IndexedLineSet clearFogCoord()

Utility method to clear SFNode value of fogCoord field.

Returns:

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

setFogCoord

public IndexedLineSet setFogCoord(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fogCoord.

Parameters:

newValue - is new value for the fogCoord field.

Returns:

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

See Also:

• setFogCoord(org.web3d.x3d.sai.EnvironmentalEffects.FogCoordinate)

hasFogCoord

public boolean hasFogCoord()

Indicate whether an object is available for inputOutput SFNode field fogCoord.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getFogCoord()
• getFogCoordProtoInstance()

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

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 IndexedLineSet

Specified by:

getMetadata in interface X3DGeometryNode

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 IndexedLineSet 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 IndexedLineSet

Specified by:

setMetadata in interface X3DGeometryNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

IndexedLineSet - 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 IndexedLineSet clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

IndexedLineSet - 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

getNormal

public X3DNormalNode getNormal()

Provide org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field normal.

Specified by:

getNormal in interface IndexedLineSet

Returns:

value of normal field

See Also:

• 
  
  Tooltip: [X3DNormalNode] Single contained Normal node that can specify perpendicular vectors for corresponding vertices to support rendering computations, applied according to the normalPerVertex field.
  • Hint: useful for special effects. Normal vector computation by 3D graphics hardware is quite fast so adding normals to a scene is typically unnecessary.
  • Warning: normal vectors increase file size, typically doubling geometry definitions.

setNormal

public IndexedLineSet setNormal(X3DNormalNode newValue)

Accessor method to assign org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.

Specified by:

setNormal in interface IndexedLineSet

Parameters:

newValue - is new value for the normal field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DNormalNode] Single contained Normal node that can specify perpendicular vectors for corresponding vertices to support rendering computations, applied according to the normalPerVertex field.
  • Hint: useful for special effects. Normal vector computation by 3D graphics hardware is quite fast so adding normals to a scene is typically unnecessary.
  • Warning: normal vectors increase file size, typically doubling geometry definitions.

clearNormal

public IndexedLineSet clearNormal()

Utility method to clear SFNode value of normal field.

Returns:

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

setNormal

public IndexedLineSet setNormal(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field normal.

Parameters:

newValue - is new value for the normal field.

Returns:

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

See Also:

• setNormal(org.web3d.x3d.sai.Rendering.X3DNormalNode)

hasNormal

public boolean hasNormal()

Indicate whether an object is available for inputOutput SFNode field normal.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getNormal()
• getNormalProtoInstance()

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

addComments

public IndexedLineSet addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

IndexedLineSet - 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 IndexedLineSet addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public IndexedLineSet addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

getCoordCount

public int getCoordCount()

Utility method to get number of coordinate 3-tuple values in contained Coordinate/CoordinateDouble or ProtoInstance node

Returns:

number of coordinate 3-tuple values

See Also:

• Coordinate
• CoordinateDouble
• ProtoInstance

getColorCount

public int getColorCount()

Utility method to get number of 3-tuple Color RGB values (or 4-tuple ColorRGBA values) in contained Color/ColorRGBA or ProtoInstance node

Returns:

number of color values

See Also:

• Color
• ColorRGBA
• ProtoInstance