Package org.web3d.x3d.jsail.Rendering
Class PointSetObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Rendering.PointSetObject
- All Implemented Interfaces:
X3DNode
,PointSet
,X3DGeometryNode
public class PointSetObject extends X3DConcreteNode implements PointSet
PointSet is a node that contains a set of colored 3D points, represented by contained Color|ColorRGBA and Coordinate|CoordinateDouble nodes.
X3D node tooltip: [X3DGeometryNode] PointSet is a node that contains a set of colored 3D points, represented by contained Color|ColorRGBA and Coordinate|CoordinateDouble nodes.
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.
X3D node tooltip: [X3DGeometryNode] PointSet is a node that contains a set of colored 3D points, represented by contained Color|ColorRGBA and Coordinate|CoordinateDouble nodes.
- Hint: Point (geometry) https://en.wikipedia.org/wiki/Point_(geometry)
- Hint: either values in a contained Color node, or else Material emissiveColor in corresponding Appearance node, are used for rendering lines and points.
- Warning: use a different color (or Material emissiveColor) than the Background color, otherwise geometry is invisible.
- Hint: insert a Shape node before adding geometry or Appearance.
- Hint: each point is displayed independently, no other PointSet attributes for rendering are provided.
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.
-
Field Summary
Fields Modifier and Type Field Description static X3DColorNode
COLOR_DEFAULT_VALUE
SFNode field named color has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the PointSet element: Renderingstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static X3DCoordinateNode
COORD_DEFAULT_VALUE
SFNode field named coord has default value null (Java syntax) or NULL (XML syntax).static FogCoordinateObject
FOGCOORD_DEFAULT_VALUE
SFNode field named fogCoord has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
fromField_ATTRIB
fromField ROUTE name for MFNode field named attrib.static java.lang.String
fromField_COLOR
fromField ROUTE name for SFNode field named color.static java.lang.String
fromField_COORD
fromField ROUTE name for SFNode field named coord.static java.lang.String
fromField_FOGCOORD
fromField ROUTE name for SFNode field named fogCoord.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D Rendering component level for this element: 1static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: PointSet.static java.lang.String
toField_ATTRIB
toField ROUTE name for MFNode field named attrib.static java.lang.String
toField_COLOR
toField ROUTE name for SFNode field named color.static java.lang.String
toField_COORD
toField ROUTE name for SFNode field named coord.static java.lang.String
toField_FOGCOORD
toField ROUTE name for SFNode field named fogCoord.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description PointSetObject()
Constructor for PointSetObject to initialize member variables with default values.PointSetObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description PointSetObject
addAttrib(ProtoInstanceObject newValue)
Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for attrib field.PointSetObject
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).PointSetObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.PointSetObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.PointSetObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.PointSetObject
clearAttrib()
Utility method to clear MFNode value of attrib field.PointSetObject
clearColor()
Utility method to clear SFNode value of color field.PointSetObject
clearCoord()
Utility method to clear SFNode value of coord field.PointSetObject
clearFogCoord()
Utility method to clear SFNode value of fogCoord field.PointSetObject
clearIS()
Utility method to clear SFNode value of IS field.PointSetObject
clearMetadata()
Utility method to clear SFNode value of metadata field.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteNode
findNodeByDEF(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.X3DNode[]
getAttrib()
Provide array of X3DVertexAttributeNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field attrib.java.util.ArrayList<X3DNode>
getAttribList()
Utility method to get ArrayList value of MFNode attrib field, similar togetAttrib()
.X3DColorNode
getColor()
Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.java.lang.String
getComponent()
Defines X3D component for the PointSet element: Renderingint
getComponentLevel()
Provides default X3D component level for this element: 1java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.X3DCoordinateNode
getCoord()
Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.String
getElementName()
Provides name of this element: PointSetjava.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.FogCoordinate
getFogCoord()
Provide FogCoordinateObject instance (using a properly typed node) from inputOutput SFNode field fogCoord.ISObject
getIS()
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.java.lang.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(java.lang.String nameValue, java.lang.String elementName)
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.boolean
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(java.lang.String DEFvalue)
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.void
initialize()
Initialize all member variables to default values.PointSetObject
setAttrib(java.util.ArrayList<X3DVertexAttributeNode> newValue)
Assign ArrayList value of MFNode attrib field, similar tosetAttrib(X3DNode[])
.void
setAttrib(X3DNode newValue)
Set single child attrib node, replacing prior array of existing nodes (if any).PointSetObject
setAttrib(X3DNode[] newValue)
Accessor method to assign X3DVertexAttributeNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field attrib.PointSetObject
setColor(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field color.PointSetObject
setColor(X3DColorNode newValue)
Accessor method to assign X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.PointSetObject
setCoord(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field coord.PointSetObject
setCoord(X3DCoordinateNode newValue)
Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.PointSetObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.PointSetObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.PointSetObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.PointSetObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.PointSetObject
setFogCoord(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fogCoord.PointSetObject
setFogCoord(FogCoordinate newValue)
Accessor method to assign FogCoordinateObject instance (using a properly typed node) to inputOutput SFNode field fogCoord.PointSetObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.PointSetObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.PointSetObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.PointSetObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.PointSetObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.PointSetObject
setUSE(PointSetObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.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, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: PointSet.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the PointSet element: Rendering- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Rendering component level for this element: 1- See Also:
- Constant Field Values
-
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). -
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField 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. -
fromField_ATTRIB
public static final java.lang.String fromField_ATTRIBfromField ROUTE name for MFNode field named attrib.- See Also:
- Constant Field Values
-
toField_ATTRIB
public static final java.lang.String toField_ATTRIBtoField ROUTE name for MFNode field named attrib.- See Also:
- Constant Field Values
-
fromField_COLOR
public static final java.lang.String fromField_COLORfromField ROUTE name for SFNode field named color.- See Also:
- Constant Field Values
-
toField_COLOR
public static final java.lang.String toField_COLORtoField ROUTE name for SFNode field named color.- See Also:
- Constant Field Values
-
fromField_COORD
public static final java.lang.String fromField_COORDfromField ROUTE name for SFNode field named coord.- See Also:
- Constant Field Values
-
toField_COORD
public static final java.lang.String toField_COORDtoField ROUTE name for SFNode field named coord.- See Also:
- Constant Field Values
-
fromField_FOGCOORD
public static final java.lang.String fromField_FOGCOORDfromField ROUTE name for SFNode field named fogCoord.- See Also:
- Constant Field Values
-
toField_FOGCOORD
public static final java.lang.String toField_FOGCOORDtoField ROUTE name for SFNode field named fogCoord.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
-
Constructor Details
-
PointSetObject
public PointSetObject()Constructor for PointSetObject to initialize member variables with default values. -
PointSetObject
public PointSetObject(java.lang.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 java.lang.String getElementName()Provides name of this element: PointSet- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the PointSet 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
public java.lang.String getFieldType(java.lang.String fieldName)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:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
-
getAccessType
public java.lang.String getAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in 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:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
-
getContainerFieldDefault
public final java.lang.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 classX3DConcreteNode
- 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 classX3DConcreteNode
-
getAttrib
Provide array of X3DVertexAttributeNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field attrib.
Tooltip: [X3DVertexAttributeNode] Single contained FloatVertexAttribute node that specifies list of per-vertex attribute information for programmable shaders.- Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shaders.html#Pervertexattributes
Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVertexAttributeNode.- Specified by:
getAttrib
in interfacePointSet
- Returns:
- value of attrib field
- See Also:
X3DVertexAttributeNode
-
getAttribList
Utility method to get ArrayList value of MFNode attrib field, similar togetAttrib()
.- Returns:
- value of attrib field
-
setAttrib
Accessor method to assign X3DVertexAttributeNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field attrib.
Tooltip: [X3DVertexAttributeNode] Single contained FloatVertexAttribute node that specifies list of per-vertex attribute information for programmable shaders.- Hint: X3D Architecture 32.2.2.4 Per-vertex attributes, https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shaders.html#Pervertexattributes
Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DVertexAttributeNode.- Specified by:
setAttrib
in interfacePointSet
- Parameters:
newValue
- is new value for the attrib field.- Returns:
PointSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAttrib
Assign ArrayList value of MFNode attrib field, similar tosetAttrib(X3DNode[])
.- Parameters:
newValue
- is new value for the attrib field.- Returns:
PointSetObject
- 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:
PointSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addAttrib
Add single ProtoInstanceObject (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:
PointSetObject
- 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
Utility method to clear MFNode value of attrib field.- Returns:
PointSetObject
- 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
Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color. -
setColor
Accessor method to assign X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.- Specified by:
setColor
in interfacePointSet
- Parameters:
newValue
- is new value for the color field.- Returns:
PointSetObject
- 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 specifies color values applied to corresponding vertices according to colorIndex and colorPerVertex fields. *
-
clearColor
Utility method to clear SFNode value of color field.- Returns:
PointSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setColor
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field color.- Parameters:
newValue
- is new value for the color field.- Returns:
PointSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setColor(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()
-
getCoord
Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord. -
setCoord
Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.- Specified by:
setCoord
in interfacePointSet
- Parameters:
newValue
- is new value for the coord field.- Returns:
PointSetObject
- 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 specifies a list of vertex values. *
-
clearCoord
Utility method to clear SFNode value of coord field.- Returns:
PointSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setCoord
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field coord.- Parameters:
newValue
- is new value for the coord field.- Returns:
PointSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setCoord(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()
-
getFogCoord
Provide FogCoordinateObject instance (using a properly typed node) from inputOutput SFNode field fogCoord.- Specified by:
getFogCoord
in interfacePointSet
- Returns:
- value of fogCoord field
- See Also:
Tooltip: [FogCoordinate] Single contained FogCoordinate node that specifies depth parameters for fog in corresponding geometry. *
-
setFogCoord
Accessor method to assign FogCoordinateObject instance (using a properly typed node) to inputOutput SFNode field fogCoord.- Specified by:
setFogCoord
in interfacePointSet
- Parameters:
newValue
- is new value for the fogCoord field.- Returns:
PointSetObject
- 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 specifies depth parameters for fog in corresponding geometry. *
-
clearFogCoord
Utility method to clear SFNode value of fogCoord field.- Returns:
PointSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setFogCoord
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fogCoord.- Parameters:
newValue
- is new value for the fogCoord field.- Returns:
PointSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setFogCoord(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
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject 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:
PointSetObject
- 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
Utility method to clear SFNode value of IS field.- Returns:
PointSetObject
- 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
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfacePointSet
- Specified by:
getMetadata
in interfaceX3DGeometryNode
- Specified by:
getMetadata
in interfaceX3DNode
- 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfacePointSet
- 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:
PointSetObject
- 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
PointSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
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:
PointSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMetadata(X3DMetadataObject)
-
hasMetadata
public boolean hasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getMetadata()
,getMetadataProtoInstance()
, X3D Scene Authoring Hints: Metadata Nodes
-
getDEF
public java.lang.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 classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
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:
PointSetObject
- 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:
PointSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.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 classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
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:
PointSetObject
- 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:
PointSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
PointSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
PointSetObject
- 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:
PointSetObject
- 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:
PointSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
PointSetObject
- 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:
PointSetObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
public java.lang.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 classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
X3DObject.FILE_EXTENSION_X3D
,X3DObject.FILE_EXTENSION_XML
,X3DObject.toStringXML()
,X3DObject.toFileXML(String)
,X3DObject.toFileX3D(String)
, X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)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:
X3DObject.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 java.lang.String toStringVRML97(int indentLevel)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:
X3DObject.FILE_EXTENSION_VRML97
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
-
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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
findElementByNameValue
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasElementByNameValue
public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
findElementByNameValue(String, String)
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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:
findElementByNameValue(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasNodeByDEF
public boolean hasNodeByDEF(java.lang.String DEFvalue)Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
findNodeByDEF(String)
-
validate
public java.lang.String validate()Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-