public class PointSetObject extends X3DConcreteNode implements PointSet
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
COMPONENT
String constant COMPONENT defines X3D component for the PointSet element: Rendering
|
static java.lang.String |
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.
|
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_METADATA
fromField ROUTE name for SFNode field named metadata.
|
static int |
LEVEL
Integer constant LEVEL provides default X3D Rendering component level for this element: 1
|
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.
|
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUEvalidationResult| Constructor and 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.
|
| Modifier and Type | Method and Description |
|---|---|
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(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.
|
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 |
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 |
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 to
getAttrib(). |
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: Rendering
|
int |
getComponentLevel()
Provides default X3D component level for this element: 1
|
java.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 |
getElementName()
Provides name of this element: PointSet
|
java.lang.String |
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.
|
FogCoordinate |
getFogCoord()
Provide FogCoordinate instance (using a properly typed node) from inputOutput SFNode field fogCoord.
|
ISObject |
getIS()
Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
|
X3DMetadataObject |
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
|
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 |
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 to
setAttrib(X3DNode[]). |
PointSetObject |
setAttrib(X3DConcreteNode newValue)
Utility method to set single SFNode as PointSetObject attrib.
|
void |
setAttrib(X3DNode newValue)
Set single child attrib node, replacing prior array of existing nodes (if any).
|
PointSetObject |
setAttrib(X3DNode[] newValue)
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)
Assign X3DColorNode instance (using a properly typed node) using RGB values [0..1] 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)
Assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.
|
PointSetObject |
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar to
setCssClass(String). |
PointSetObject |
setCssClass(java.lang.String newValue)
Assign String value to inputOutput SFString field named class.
|
PointSetObject |
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar to
setDEF(String). |
PointSetObject |
setDEF(java.lang.String newValue)
Assign String value to inputOutput SFString field named DEF.
|
PointSetObject |
setFogCoord(FogCoordinate newValue)
Assign FogCoordinate instance (using a properly typed node) to inputOutput SFNode field fogCoord.
|
PointSetObject |
setFogCoord(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fogCoord.
|
PointSetObject |
setIS(ISObject newValue)
Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
|
PointSetObject |
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
|
PointSetObject |
setMetadata(X3DMetadataObject newValue)
Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
|
PointSetObject |
setUSE(PointSetObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar to
setUSE(String). |
PointSetObject |
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar to
setUSE(String). |
PointSetObject |
setUSE(java.lang.String newValue)
Assign String value to inputOutput SFString field named USE.
|
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.
|
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverrideclearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3Dpublic static final java.lang.String NAME
public static final java.lang.String COMPONENT
public static final int LEVEL
public static final java.lang.String containerField_DEFAULT_VALUE
public static final java.lang.String fromField_ATTRIB
public static final java.lang.String toField_ATTRIB
public static final java.lang.String fromField_COLOR
public static final java.lang.String toField_COLOR
public static final java.lang.String fromField_COORD
public static final java.lang.String toField_COORD
public static final java.lang.String fromField_FOGCOORD
public static final java.lang.String toField_FOGCOORD
public static final java.lang.String fromField_METADATA
public static final java.lang.String toField_METADATA
public PointSetObject()
public PointSetObject(java.lang.String DEFlabel)
DEFlabel - unique DEF name for this X3D nodepublic final java.lang.String getElementName()
getElementName in class X3DConcreteElementpublic final java.lang.String getComponent()
getComponent in class X3DConcreteElementpublic final int getComponentLevel()
getComponentLevel in class X3DConcreteElementpublic java.lang.String getFieldType(java.lang.String fieldName)
getFieldType in class X3DConcreteElementfieldName - name of field in this X3D nodeConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPEpublic java.lang.String getAccessType(java.lang.String fieldName)
getAccessType in class X3DConcreteElementfieldName - name of field in this X3D nodeConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPEpublic final java.lang.String getContainerFieldDefault()
getContainerFieldDefault in class X3DConcreteNodepublic final void initialize()
initialize in class X3DConcreteNodepublic X3DNode[] getAttrib()
getAttrib in interface PointSetX3DVertexAttributeNodepublic java.util.ArrayList<X3DNode> getAttribList()
getAttrib().public PointSetObject setAttrib(X3DNode[] newValue)
setAttrib in interface PointSetnewValue - is new value for the attrib field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public PointSetObject setAttrib(java.util.ArrayList<X3DVertexAttributeNode> newValue)
setAttrib(X3DNode[]).newValue - is new value for the attrib field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public PointSetObject addAttrib(X3DNode newValue)
newValue - is new value to be appended the attrib field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public void addAttrib(X3DNode[] newValue)
public void setAttrib(X3DNode newValue)
public PointSetObject setAttrib(X3DConcreteNode newValue)
newValue - PointSetObject node to setPointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public PointSetObject clearAttrib()
PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public boolean hasAttrib()
getAttrib()public X3DColorNode getColor()
getColor in interface PointSet
Tooltip: [X3DColorNode] Single contained Color or ColorRGBA node that specifies color values applied to corresponding vertices according to colorIndex and colorPerVertex fields. *
public PointSetObject setColor(X3DColorNode newValue)
setColor in interface PointSetnewValue - is new value for the color field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
Tooltip: [X3DColorNode] Single contained Color or ColorRGBA node that specifies color values applied to corresponding vertices according to colorIndex and colorPerVertex fields.public PointSetObject clearColor()
PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public PointSetObject setColor(ProtoInstanceObject newValue)
newValue - is new value for the color field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).setColor(X3DColorNode)public boolean hasColor()
getColor(),
getColorProtoInstance()public X3DCoordinateNode getCoord()
getCoord in interface PointSet
Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies a list of vertex values. *
public PointSetObject setCoord(X3DCoordinateNode newValue)
setCoord in interface PointSetnewValue - is new value for the coord field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies a list of vertex values.public PointSetObject clearCoord()
PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public PointSetObject setCoord(ProtoInstanceObject newValue)
newValue - is new value for the coord field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).setCoord(X3DCoordinateNode)public boolean hasCoord()
getCoord(),
getCoordProtoInstance()public FogCoordinate getFogCoord()
getFogCoord in interface PointSet
Tooltip: [FogCoordinate] Single contained FogCoordinate node that specifies depth parameters for fog in corresponding geometry. *
public PointSetObject setFogCoord(FogCoordinate newValue)
setFogCoord in interface PointSetnewValue - is new value for the fogCoord field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
Tooltip: [FogCoordinate] Single contained FogCoordinate node that specifies depth parameters for fog in corresponding geometry.public PointSetObject clearFogCoord()
PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public PointSetObject setFogCoord(ProtoInstanceObject newValue)
newValue - is new value for the fogCoord field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).setFogCoord(FogCoordinate)public boolean hasFogCoord()
getFogCoord(),
getFogCoordProtoInstance()public X3DMetadataObject getMetadata()
getMetadata in interface X3DNodegetMetadata in interface PointSetgetMetadata in interface X3DGeometryNodegetMetadataProtoInstance(),
X3D Scene Authoring Hints: Metadata Nodespublic PointSetObject setMetadata(X3DMetadataObject newValue)
setMetadata in interface X3DNodesetMetadata in interface PointSetsetMetadata in interface X3DGeometryNodesetMetadata in class X3DConcreteNodenewValue - is new value for the metadata field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).setMetadata(ProtoInstanceObject),
X3D Scene Authoring Hints: Metadata Nodespublic PointSetObject clearMetadata()
PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public PointSetObject setMetadata(ProtoInstanceObject newValue)
setMetadata in class X3DConcreteNodenewValue - is new value for the metadata field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).setMetadata(X3DMetadataObject)public boolean hasMetadata()
getMetadata(),
getMetadataProtoInstance(),
X3D Scene Authoring Hints: Metadata Nodespublic final PointSetObject setDEF(java.lang.String newValue)
setDEF in interface X3DNodesetDEF in interface PointSetsetDEF in interface X3DGeometryNodesetDEF in class X3DConcreteNodenewValue - is new value for the DEF field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public PointSetObject setDEF(SFStringObject newValue)
setDEF(String).newValue - is new value for the DEF field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public final PointSetObject setUSE(java.lang.String newValue)
USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.setUSE in interface X3DNodesetUSE in interface PointSetsetUSE in interface X3DGeometryNodesetUSE in class X3DConcreteNodenewValue - is new value for the USE field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public PointSetObject setUSE(SFStringObject newValue)
setUSE(String).newValue - is new value for the USE field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public final PointSetObject setCssClass(java.lang.String newValue)
setCssClass in interface X3DNodesetCssClass in interface PointSetsetCssClass in interface X3DGeometryNodesetCssClass in class X3DConcreteNodenewValue - is new value for the class field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public PointSetObject setCssClass(SFStringObject newValue)
setCssClass(String).newValue - is new value for the class field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public PointSetObject setIS(ISObject newValue)
setIS in class X3DConcreteNodenewValue - is new value for the description field.PointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public ISObject getIS()
getIS in class X3DConcreteNodepublic PointSetObject setUSE(PointSetObject DEFnode)
setUSE(String).
setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
DEFnode - must have a DEF value definedPointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).public PointSetObject addComments(java.lang.String newComment)
addComments in class X3DConcreteElementnewComment - initial valuePointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public PointSetObject addComments(java.lang.String[] newComments)
addComments in class X3DConcreteElementnewComments - array of commentsPointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public PointSetObject addComments(CommentsBlock newCommentsBlock)
addComments in class X3DConcreteElementnewCommentsBlock - block of comments to addPointSetObject - namely this same object to allow sequential method pipelining (i.e. consecutive
setAttribute method invocations).public java.lang.String toStringX3D(int indentLevel)
toStringX3D in class X3DConcreteElementindentLevel - number of levels of indentation for this elementX3DObject.FILE_EXTENSION_X3D,
X3DObject.FILE_EXTENSION_XML,
X3DObject.toStringXML(),
X3DObject.toFileXML(String),
X3DObject.toFileX3D(String),
X3D XML Encoding,
X3D Compressed Binary Encoding: X3D Canonical Formpublic java.lang.String toStringClassicVRML(int indentLevel)
toStringClassicVRML in class X3DConcreteElementindentLevel - number of levels of indentation for this elementX3DObject.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: Grammarpublic java.lang.String toStringVRML97(int indentLevel)
toStringVRML97 in class X3DConcreteElementindentLevel - number of levels of indentation for this elementX3DObject.FILE_EXTENSION_VRML97,
X3D Resources: Virtual Reality Modeling Language (VRML) 97,
Virtual Reality Modeling Language (VRML) 97 specification,
VRML 97 v2.1 Amendmentpublic X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
findElementByNameValue in class X3DConcreteElementnameValue - is value of the name field being searched for in this element and child elements(if any)findNodeByDEF(String),
X3DConcreteElement.hasAncestorSceneObject(),
X3DConcreteElement.findAncestorX3DObject()public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
findElementByNameValue in class X3DConcreteElementnameValue - 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.)findNodeByDEF(String),
X3DConcreteElement.hasAncestorSceneObject(),
X3DConcreteElement.findAncestorX3DObject()public boolean hasElementByNameValue(java.lang.String nameValue,
java.lang.String elementName)
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.)findElementByNameValue(String, String)public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
findNodeByDEF in class X3DConcreteElementDEFvalue - is value of the name field being searched for in this element and child elements(if any)findElementByNameValue(String),
X3DConcreteElement.hasAncestorSceneObject(),
X3DConcreteElement.findAncestorX3DObject()public boolean hasNodeByDEF(java.lang.String DEFvalue)
DEFvalue - is value of the name field being searched for in this element and child elements(if any)findNodeByDEF(String)public java.lang.String validate()
validate in class X3DConcreteElementCopyright ©2005-2017 Web3D Consortium under an open-source license, free for any use. Feedback is welcome.