Package org.web3d.x3d.jsail.Rendering
Class LineSet
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Rendering.LineSet
- All Implemented Interfaces:
X3DNode
,LineSet
,X3DGeometryNode
LineSet is a geometry node that can contain a Coordinate|CoordinateDouble node and optionally a Color|ColorRGBA node.
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
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.
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.
LineSet node tooltip: [X3DGeometryNode] LineSet 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: 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 LineSet (LS).
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final X3DColorNode
SFNode field named color has default value null (Java syntax) or NULL (XML syntax).static final String
String constant COMPONENT defines X3D component for the LineSet element: Renderingstatic final String
containerField describes typical field relationship of a node to its parent.static final X3DCoordinateNode
SFNode field named coord has default value null (Java syntax) or NULL (XML syntax).static final FogCoordinate
SFNode field named fogCoord has default value null (Java syntax) or NULL (XML syntax).static final String
fromField ROUTE name for MFNode field named attrib.static final String
fromField ROUTE name for SFNode field named color.static final String
fromField ROUTE name for SFNode field named coord.static final String
fromField ROUTE name for SFNode field named fogCoord.static final String
fromField ROUTE name for SFNode field named IS.static final String
fromField ROUTE name for SFNode field named metadata.static final String
fromField ROUTE name for SFNode field named normal.static final String
fromField ROUTE name for MFInt32 field named vertexCount.static final IS
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static final int
Integer constant LEVEL provides default X3D Rendering component level for this element: 1static final X3DMetadataObject
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static final String
String constant NAME provides name of this element: LineSet.static final X3DNormalNode
SFNode field named normal has default value null (Java syntax) or NULL (XML syntax).static final String
toField ROUTE name for MFNode field named attrib.static final String
toField ROUTE name for SFNode field named color.static final String
toField ROUTE name for SFNode field named coord.static final String
toField ROUTE name for SFNode field named fogCoord.static final String
toField ROUTE name for SFNode field named metadata.static final String
toField ROUTE name for SFNode field named normal.static final String
toField ROUTE name for MFInt32 field named vertexCount.MFInt32 field named vertexCount has default value equal to an empty list.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
containerField_ALLOWED_VALUES, containerFieldOverride, 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 -
Method Summary
Modifier and TypeMethodDescriptionaddAttrib
(ProtoInstance newValue) Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for attrib field.Add single child node to existing array of attrib nodes (if any).void
Add array of child attrib nodes to array of existing nodes (if any).addComments
(String newComment) Add comment as String to contained commentsList.addComments
(String[] newComments) Add comments as String[] array to contained commentsList.addComments
(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.addVertexCount
(int newValue) Add singleton int value to MFInt32 vertexCount field.addVertexCount
(SFInt32 newValue) Add singleton SFInt32 value to MFInt32 vertexCount field.Utility method to clear MFNode value of attrib field.Utility method to clear SFNode value of color field.Utility method to clear SFNode value of coord field.Utility method to clear SFNode value of fogCoord field.clearIS()
Utility method to clear SFNode value of IS field.Utility method to clear SFNode value of metadata field.Utility method to clear SFNode value of normal field.Utility method to clear MFInt32 value of vertexCount field.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.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.findNodeByDEF
(String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.getAccessType
(String fieldName) Indicate accessType corresponding to given fieldName.X3DNode[]
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.Utility method to get ArrayList value of MFNode attrib field, similar togetAttrib()
.getColor()
Provide org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.final String
Defines X3D component for the LineSet element: Renderingfinal int
Provides default X3D component level for this element: 1final String
containerField describes typical field relationship of a node to its parent.getCoord()
Provide org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.Provide String value from inputOutput SFString field named class.Provide String value from inputOutput SFString field named style.getDEF()
Provide String value from inputOutput SFString field named DEF.final String
Provides name of this element: LineSetgetFieldType
(String fieldName) Indicate type corresponding to given fieldName.Provide org.web3d.x3d.sai.EnvironmentalEffects.FogCoordinate instance (using a properly typed node) from inputOutput SFNode field fogCoord.Provide String value from inputOutput SFString field named id.getIS()
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.Provide org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field normal.getUSE()
Provide String value from inputOutput SFString field named USE.int[]
Provide array of Integer results within allowed range of [2,infinity) from inputOutput MFInt32 field named vertexCount.Utility method to get ArrayList value of MFInt32 vertexCount field, similar togetVertexCount()
.Utility method to get String value of MFInt32 vertexCount field, similar togetVertexCount()
.boolean
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
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
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
Indicate whether an object is available for inputOutput SFNode field normal.final void
Initialize all member variables to default values.setAttrib
(ArrayList<X3DVertexAttributeNode> newValue) Assign ArrayList value of MFNode attrib field, similar tosetAttrib(org.web3d.x3d.sai.Core.X3DNode[])
.void
Set single child attrib node, replacing prior array of existing nodes (if any).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.setColor
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field color.setColor
(X3DColorNode newValue) Accessor method to assign org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.setCoord
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field coord.setCoord
(X3DCoordinateNode newValue) Accessor method to assign org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.final LineSet
setCssClass
(String newValue) Accessor method to assign String value to inputOutput SFString field named class.setCssClass
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.final LineSet
setCssStyle
(String newValue) Accessor method to assign String value to inputOutput SFString field named style.setCssStyle
(SFString newValue) Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.final LineSet
Accessor method to assign String value to inputOutput SFString field named DEF.Assign typed object value to SFString DEF field, similar tosetDEF(String)
.setFogCoord
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fogCoord.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 LineSet
Accessor method to assign String value to inputOutput SFString field named id.Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.setMetadata
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setNormal
(ProtoInstance newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field normal.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 LineSet
Accessor method to assign String value to inputOutput SFString field named USE.Assign typed object value to SFString USE field, similar tosetUSE(String)
.Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.setVertexCount
(int[] newValue) Accessor method to assign Integer array to inputOutput MFInt32 field named vertexCount.setVertexCount
(ArrayList<Integer> newValue) Assign ArrayList value of MFInt32 vertexCount field, similar tosetVertexCount(int[])
.setVertexCount
(MFInt32 newValue) Assign typed object value to MFInt32 vertexCount field, similar tosetVertexCount(int[])
.toStringClassicVRML
(int indentLevel) Recursive method to provide ClassicVRML string serialization.toStringVRML97
(int indentLevel) Recursive method to provide VRML97 string serialization.toStringX3D
(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.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
getContainerFieldAllowedValues, 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
-
Field Details
-
NAME
String constant NAME provides name of this element: LineSet.- See Also:
-
COMPONENT
String constant COMPONENT defines X3D component for the LineSet element: Rendering- See Also:
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Rendering component level for this element: 1- See Also:
-
COLOR_DEFAULT_VALUE
SFNode field named color has default value null (Java syntax) or NULL (XML syntax). -
COORD_DEFAULT_VALUE
SFNode field named coord has default value null (Java syntax) or NULL (XML syntax). -
FOGCOORD_DEFAULT_VALUE
SFNode field named fogCoord has default value null (Java syntax) or NULL (XML syntax). -
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
NORMAL_DEFAULT_VALUE
SFNode field named normal has default value null (Java syntax) or NULL (XML syntax). -
VERTEXCOUNT_DEFAULT_VALUE
-
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "geometry";
containerField_ALLOWED_VALUES = {"geometry" }; type xs:NMTOKEN- See Also:
-
fromField_ATTRIB
fromField ROUTE name for MFNode field named attrib.- See Also:
-
toField_ATTRIB
toField ROUTE name for MFNode field named attrib.- See Also:
-
fromField_COLOR
fromField ROUTE name for SFNode field named color.- See Also:
-
toField_COLOR
-
fromField_COORD
fromField ROUTE name for SFNode field named coord.- See Also:
-
toField_COORD
-
fromField_FOGCOORD
fromField ROUTE name for SFNode field named fogCoord.- See Also:
-
toField_FOGCOORD
toField ROUTE name for SFNode field named fogCoord.- See Also:
-
fromField_IS
-
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.- See Also:
-
toField_METADATA
toField ROUTE name for SFNode field named metadata.- See Also:
-
fromField_NORMAL
fromField ROUTE name for SFNode field named normal.- See Also:
-
toField_NORMAL
toField ROUTE name for SFNode field named normal.- See Also:
-
fromField_VERTEXCOUNT
fromField ROUTE name for MFInt32 field named vertexCount.- See Also:
-
toField_VERTEXCOUNT
toField ROUTE name for MFInt32 field named vertexCount.- See Also:
-
-
Constructor Details
-
LineSet
public LineSet()Constructor for LineSet to initialize member variables with default values. -
LineSet
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
Provides name of this element: LineSet- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
Defines X3D component for the LineSet element: Rendering- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- 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:
-
getAccessType
Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- 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:
-
getContainerFieldDefault
containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
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. -
getAttribList
Utility method to get ArrayList value of MFNode attrib field, similar togetAttrib()
.- Returns:
- value of attrib field
-
setAttrib
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. -
setAttrib
Assign ArrayList value of MFNode attrib field, similar tosetAttrib(org.web3d.x3d.sai.Core.X3DNode[])
.- Parameters:
newValue
- is new value for the attrib field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addAttrib
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:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addAttrib
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:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addAttrib
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. -
setAttrib
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. -
clearAttrib
-
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:
-
getColor
Provide org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color. -
setColor
Accessor method to assign org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color. -
clearColor
-
setColor
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field color.- Parameters:
newValue
- is new value for the color field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
getCoord
Provide org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord. -
setCoord
Accessor method to assign org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord. -
clearCoord
-
setCoord
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field coord.- Parameters:
newValue
- is new value for the coord field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
getFogCoord
Provide org.web3d.x3d.sai.EnvironmentalEffects.FogCoordinate instance (using a properly typed node) from inputOutput SFNode field fogCoord.- Specified by:
getFogCoord
in interfaceLineSet
- Returns:
- value of fogCoord field
- See Also:
-
setFogCoord
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 interfaceLineSet
- Parameters:
newValue
- is new value for the fogCoord field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearFogCoord
-
setFogCoord
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fogCoord.- Parameters:
newValue
- is new value for the fogCoord field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
getIS
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
-
setIS
Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearIS
-
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:
-
getMetadata
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceLineSet
- Specified by:
getMetadata
in interfaceX3DGeometryNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
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 interfaceLineSet
- Specified by:
setMetadata
in interfaceX3DGeometryNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
clearMetadata
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
getNormal
Provide org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field normal. -
setNormal
Accessor method to assign org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal. -
clearNormal
-
setNormal
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field normal.- Parameters:
newValue
- is new value for the normal field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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:
-
getVertexCount
public int[] getVertexCount()Provide array of Integer results within allowed range of [2,infinity) from inputOutput MFInt32 field named vertexCount.
Tooltip: [2,+infinity) vertexCount describes how many vertices are used in each individual polyline segment from the Coordinate point values. Coordinate point values are assigned as a block of points to each line by taking vertexCount[n] vertices at a time. *- Specified by:
getVertexCount
in interfaceLineSet
- Returns:
- value of vertexCount field
-
getVertexCountList
Utility method to get ArrayList value of MFInt32 vertexCount field, similar togetVertexCount()
.- Returns:
- value of vertexCount field
-
getVertexCountString
Utility method to get String value of MFInt32 vertexCount field, similar togetVertexCount()
.- Returns:
- value of vertexCount field
-
setVertexCount
Accessor method to assign Integer array to inputOutput MFInt32 field named vertexCount.
Tooltip: [2,+infinity) vertexCount describes how many vertices are used in each individual polyline segment from the Coordinate point values. Coordinate point values are assigned as a block of points to each line by taking vertexCount[n] vertices at a time. *- Specified by:
setVertexCount
in interfaceLineSet
- Parameters:
newValue
- is new value for the vertexCount field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setVertexCount
Assign typed object value to MFInt32 vertexCount field, similar tosetVertexCount(int[])
.- Parameters:
newValue
- is new value for the vertexCount field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setVertexCount
Assign ArrayList value of MFInt32 vertexCount field, similar tosetVertexCount(int[])
.- Parameters:
newValue
- is new value for the vertexCount field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearVertexCount
-
addVertexCount
Add singleton int value to MFInt32 vertexCount field.- Parameters:
newValue
- is new value to add to the vertexCount field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addVertexCount
Add singleton SFInt32 value to MFInt32 vertexCount field.- Parameters:
newValue
- is new value to add to the vertexCount field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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 classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
-
setDEF
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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 classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
-
setUSE
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: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
Provide String value from inputOutput SFString field named class.- Overrides:
getCssClass
in classX3DConcreteElement
- Returns:
- value of class field
- See Also:
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getHtmlID
Provide String value from inputOutput SFString field named id.- Overrides:
getHtmlID
in classX3DConcreteElement
- Returns:
- value of id field
- See Also:
-
setHtmlID
Accessor method to assign String value to inputOutput SFString field named id.- Specified by:
setHtmlID
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the id field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setHtmlID
Assign typed object value to SFString HtmlID field, similar tosetHtmlID(String)
.- Parameters:
newValue
- is new value for the id field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssStyle
Provide String value from inputOutput SFString field named style.- Overrides:
getCssStyle
in classX3DConcreteElement
- Returns:
- value of style field
- See Also:
-
setCssStyle
Accessor method to assign String value to inputOutput SFString field named style.- Specified by:
setCssStyle
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the style field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
setCssStyle
Assign typed object value to SFString cssClass field, similar tosetCssStyle(String)
.- Parameters:
newValue
- is new value for the style field.- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
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:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
LineSet
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
-
toStringClassicVRML
Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
-
toStringVRML97
Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
-
findElementByNameValue
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 classX3DConcreteElement
- 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:
-
findElementByNameValue
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 classX3DConcreteElement
- 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:
-
hasElementByNameValue
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:
-
findNodeByDEF
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 classX3DConcreteElement
- 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:
-
hasNodeByDEF
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:
-
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 classX3DConcreteElement
- Returns:
- validation results (if any)
-