Package org.web3d.x3d.jsail.CADGeometry
Class QuadSetObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.CADGeometry.QuadSetObject
- All Implemented Interfaces:
QuadSet,X3DNode,X3DComposedGeometryNode,X3DGeometryNode
public class QuadSetObject extends X3DConcreteNode implements QuadSet
QuadSet is a geometry node that defines quadrilaterals.
X3D node tooltip: (X3D version 3.1 or later) [X3DComposedGeometryNode] QuadSet is a geometry node that defines planar quadrilaterals. QuadSet contains a Coordinate|CoordinateDouble node, and can also contain Color|ColorRGBA, Normal and TextureCoordinate 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: (X3D version 3.1 or later) [X3DComposedGeometryNode] QuadSet is a geometry node that defines planar quadrilaterals. QuadSet contains a Coordinate|CoordinateDouble node, and can also contain Color|ColorRGBA, Normal and TextureCoordinate nodes.
- Hint: Quadrilateral https://en.wikipedia.org/wiki/Quadrilateral
- Hint: color, normal and texCoord values are applied in the same order as coord values.
- 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: X3D for Advanced Modeling (X3D4AM) slideset http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/ComputerAidedDesignInterchangeProfile.pdf
- Warning: requires X3D profile='Full' or else include <component name='CADGeometry' level='1'/>
- Warning: rendering characteristics are undefined if polygons are not planar.
- Warning: avoid self-intersecting polygon line segments, otherwise defined geometry is irregular and rendering results are undefined.
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 booleanCCW_DEFAULT_VALUESFBool field named ccw has default value true (Java syntax) or true (XML syntax).static X3DColorNodeCOLOR_DEFAULT_VALUESFNode field named color has default value null (Java syntax) or NULL (XML syntax).static booleanCOLORPERVERTEX_DEFAULT_VALUESFBool field named colorPerVertex has default value true (Java syntax) or true (XML syntax).static java.lang.StringCOMPONENTString constant COMPONENT defines X3D component for the QuadSet element: CADGeometrystatic java.lang.StringcontainerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent.static X3DCoordinateNodeCOORD_DEFAULT_VALUESFNode field named coord has default value null (Java syntax) or NULL (XML syntax).static FogCoordinateObjectFOGCOORD_DEFAULT_VALUESFNode field named fogCoord has default value null (Java syntax) or NULL (XML syntax).static java.lang.StringfromField_ATTRIBfromField ROUTE name for MFNode field named attrib.static java.lang.StringfromField_COLORfromField ROUTE name for SFNode field named color.static java.lang.StringfromField_COORDfromField ROUTE name for SFNode field named coord.static java.lang.StringfromField_FOGCOORDfromField ROUTE name for SFNode field named fogCoord.static java.lang.StringfromField_ISfromField ROUTE name for SFNode field named IS.static java.lang.StringfromField_METADATAfromField ROUTE name for SFNode field named metadata.static java.lang.StringfromField_NORMALfromField ROUTE name for SFNode field named normal.static java.lang.StringfromField_TEXCOORDfromField ROUTE name for SFNode field named texCoord.static ISObjectIS_DEFAULT_VALUESFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static intLEVELInteger constant LEVEL provides default X3D CADGeometry component level for this element: 1static X3DMetadataObjectMETADATA_DEFAULT_VALUESFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.StringNAMEString constant NAME provides name of this element: QuadSet.static X3DNormalNodeNORMAL_DEFAULT_VALUESFNode field named normal has default value null (Java syntax) or NULL (XML syntax).static booleanNORMALPERVERTEX_DEFAULT_VALUESFBool field named normalPerVertex has default value true (Java syntax) or true (XML syntax).static booleanSOLID_DEFAULT_VALUESFBool field named solid has default value true (Java syntax) or true (XML syntax).static X3DTextureCoordinateNodeTEXCOORD_DEFAULT_VALUESFNode field named texCoord has default value null (Java syntax) or NULL (XML syntax).static java.lang.StringtoField_ATTRIBtoField ROUTE name for MFNode field named attrib.static java.lang.StringtoField_COLORtoField ROUTE name for SFNode field named color.static java.lang.StringtoField_COORDtoField ROUTE name for SFNode field named coord.static java.lang.StringtoField_FOGCOORDtoField ROUTE name for SFNode field named fogCoord.static java.lang.StringtoField_METADATAtoField ROUTE name for SFNode field named metadata.static java.lang.StringtoField_NORMALtoField ROUTE name for SFNode field named normal.static java.lang.StringtoField_TEXCOORDtoField ROUTE name for SFNode field named texCoord.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 QuadSetObject()Constructor for QuadSetObject to initialize member variables with default values.QuadSetObject(java.lang.String DEFlabel)Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description QuadSetObjectaddAttrib(ProtoInstanceObject newValue)Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for attrib field.QuadSetObjectaddAttrib(X3DNode newValue)Add single child node to existing array of attrib nodes (if any).voidaddAttrib(X3DNode[] newValue)Add array of child attrib nodes to array of existing nodes (if any).QuadSetObjectaddComments(java.lang.String newComment)Add comment as String to contained commentsList.QuadSetObjectaddComments(java.lang.String[] newComments)Add comments as String[] array to contained commentsList.QuadSetObjectaddComments(CommentsBlock newCommentsBlock)Add CommentsBlock to contained commentsList.QuadSetObjectclearAttrib()Utility method to clear MFNode value of attrib field.QuadSetObjectclearColor()Utility method to clear SFNode value of color field.QuadSetObjectclearCoord()Utility method to clear SFNode value of coord field.QuadSetObjectclearFogCoord()Utility method to clear SFNode value of fogCoord field.QuadSetObjectclearIS()Utility method to clear SFNode value of IS field.QuadSetObjectclearMetadata()Utility method to clear SFNode value of metadata field.QuadSetObjectclearNormal()Utility method to clear SFNode value of normal field.QuadSetObjectclearTexCoord()Utility method to clear SFNode value of texCoord field.X3DConcreteElementfindElementByNameValue(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.X3DConcreteElementfindElementByNameValue(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.X3DConcreteNodefindNodeByDEF(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.StringgetAccessType(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().booleangetCcw()Provide boolean value from initializeOnly SFBool field named ccw.X3DColorNodegetColor()Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.booleangetColorPerVertex()Provide boolean value from initializeOnly SFBool field named colorPerVertex.java.lang.StringgetComponent()Defines X3D component for the QuadSet element: CADGeometryintgetComponentLevel()Provides default X3D component level for this element: 1java.lang.StringgetContainerFieldDefault()containerField describes typical field relationship of a node to its parent.X3DCoordinateNodegetCoord()Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.java.lang.StringgetCssClass()Provide String value from inputOutput SFString field named class.java.lang.StringgetDEF()Provide String value from inputOutput SFString field named DEF.java.lang.StringgetElementName()Provides name of this element: QuadSetjava.lang.StringgetFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.FogCoordinategetFogCoord()Provide FogCoordinateObject instance (using a properly typed node) from inputOutput SFNode field fogCoord.ISObjectgetIS()Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.X3DMetadataObjectgetMetadata()Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.X3DNormalNodegetNormal()Provide X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field normal.booleangetNormalPerVertex()Provide boolean value from initializeOnly SFBool field named normalPerVertex.booleangetSolid()Provide boolean value from initializeOnly SFBool field named solid.X3DTextureCoordinateNodegetTexCoord()Provide X3DTextureCoordinateNode instance (using a properly typed node) from inputOutput SFNode field texCoord.java.lang.StringgetUSE()Provide String value from inputOutput SFString field named USE.booleanhasAttrib()Indicate whether an object is available for inputOutput MFNode field attrib.booleanhasColor()Indicate whether an object is available for inputOutput SFNode field color.booleanhasCoord()Indicate whether an object is available for inputOutput SFNode field coord.booleanhasElementByNameValue(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.booleanhasFogCoord()Indicate whether an object is available for inputOutput SFNode field fogCoord.booleanhasIS()Indicate whether an object is available for inputOutput SFNode field IS.booleanhasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.booleanhasNodeByDEF(java.lang.String DEFvalue)Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.booleanhasNormal()Indicate whether an object is available for inputOutput SFNode field normal.booleanhasTexCoord()Indicate whether an object is available for inputOutput SFNode field texCoord.voidinitialize()Initialize all member variables to default values.QuadSetObjectsetAttrib(java.util.ArrayList<X3DVertexAttributeNode> newValue)Assign ArrayList value of MFNode attrib field, similar tosetAttrib(X3DNode[]).voidsetAttrib(X3DNode newValue)Set single child attrib node, replacing prior array of existing nodes (if any).QuadSetObjectsetAttrib(X3DNode[] newValue)Accessor method to assign X3DVertexAttributeNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field attrib.QuadSetObjectsetCcw(boolean newValue)Accessor method to assign boolean value to initializeOnly SFBool field named ccw.QuadSetObjectsetCcw(SFBoolObject newValue)Assign typed object value to SFBool ccw field, similar tosetCcw(boolean).QuadSetObjectsetColor(ProtoInstanceObject newValue)Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field color.QuadSetObjectsetColor(X3DColorNode newValue)Accessor method to assign X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.QuadSetObjectsetColorPerVertex(boolean newValue)Accessor method to assign boolean value to initializeOnly SFBool field named colorPerVertex.QuadSetObjectsetColorPerVertex(SFBoolObject newValue)Assign typed object value to SFBool colorPerVertex field, similar tosetColorPerVertex(boolean).QuadSetObjectsetCoord(ProtoInstanceObject newValue)Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field coord.QuadSetObjectsetCoord(X3DCoordinateNode newValue)Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.QuadSetObjectsetCssClass(java.lang.String newValue)Accessor method to assign String value to inputOutput SFString field named class.QuadSetObjectsetCssClass(SFStringObject newValue)Assign typed object value to SFString cssClass field, similar tosetCssClass(String).QuadSetObjectsetDEF(java.lang.String newValue)Accessor method to assign String value to inputOutput SFString field named DEF.QuadSetObjectsetDEF(SFStringObject newValue)Assign typed object value to SFString DEF field, similar tosetDEF(String).QuadSetObjectsetFogCoord(ProtoInstanceObject newValue)Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fogCoord.QuadSetObjectsetFogCoord(FogCoordinate newValue)Accessor method to assign FogCoordinateObject instance (using a properly typed node) to inputOutput SFNode field fogCoord.QuadSetObjectsetIS(ISObject newValue)Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.QuadSetObjectsetMetadata(ProtoInstanceObject newValue)Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.QuadSetObjectsetMetadata(X3DMetadataObject newValue)Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.QuadSetObjectsetNormal(ProtoInstanceObject newValue)Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field normal.QuadSetObjectsetNormal(X3DNormalNode newValue)Accessor method to assign X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.QuadSetObjectsetNormalPerVertex(boolean newValue)Accessor method to assign boolean value to initializeOnly SFBool field named normalPerVertex.QuadSetObjectsetNormalPerVertex(SFBoolObject newValue)Assign typed object value to SFBool normalPerVertex field, similar tosetNormalPerVertex(boolean).QuadSetObjectsetSolid(boolean newValue)Accessor method to assign boolean value to initializeOnly SFBool field named solid.QuadSetObjectsetSolid(SFBoolObject newValue)Assign typed object value to SFBool solid field, similar tosetSolid(boolean).QuadSetObjectsetTexCoord(ProtoInstanceObject newValue)Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field texCoord.QuadSetObjectsetTexCoord(X3DTextureCoordinateNode newValue)Accessor method to assign X3DTextureCoordinateNode instance (using a properly typed node) to inputOutput SFNode field texCoord.QuadSetObjectsetUSE(java.lang.String newValue)Accessor method to assign String value to inputOutput SFString field named USE.QuadSetObjectsetUSE(QuadSetObject DEFnode)Assign a USE reference to another DEF node of same node type, similar tosetUSE(String).QuadSetObjectsetUSE(SFStringObject newValue)Assign typed object value to SFString USE field, similar tosetUSE(String).java.lang.StringtoStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.java.lang.StringtoStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.java.lang.StringtoStringX3D(int indentLevel)Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.Stringvalidate()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, setContainerFieldOverrideMethods 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: QuadSet.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the QuadSet element: CADGeometry- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D CADGeometry component level for this element: 1- See Also:
- Constant Field Values
-
CCW_DEFAULT_VALUE
public static final boolean CCW_DEFAULT_VALUESFBool field named ccw has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
COLOR_DEFAULT_VALUE
SFNode field named color has default value null (Java syntax) or NULL (XML syntax). -
COLORPERVERTEX_DEFAULT_VALUE
public static final boolean COLORPERVERTEX_DEFAULT_VALUESFBool field named colorPerVertex has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
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). -
NORMALPERVERTEX_DEFAULT_VALUE
public static final boolean NORMALPERVERTEX_DEFAULT_VALUESFBool field named normalPerVertex has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
SOLID_DEFAULT_VALUE
public static final boolean SOLID_DEFAULT_VALUESFBool field named solid has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
TEXCOORD_DEFAULT_VALUE
SFNode field named texCoord 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
-
fromField_NORMAL
public static final java.lang.String fromField_NORMALfromField ROUTE name for SFNode field named normal.- See Also:
- Constant Field Values
-
toField_NORMAL
public static final java.lang.String toField_NORMALtoField ROUTE name for SFNode field named normal.- See Also:
- Constant Field Values
-
fromField_TEXCOORD
public static final java.lang.String fromField_TEXCOORDfromField ROUTE name for SFNode field named texCoord.- See Also:
- Constant Field Values
-
toField_TEXCOORD
public static final java.lang.String toField_TEXCOORDtoField ROUTE name for SFNode field named texCoord.- See Also:
- Constant Field Values
-
-
Constructor Details
-
QuadSetObject
public QuadSetObject()Constructor for QuadSetObject to initialize member variables with default values. -
QuadSetObject
public QuadSetObject(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: QuadSet- Specified by:
getElementNamein classX3DConcreteElement- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the QuadSet element: CADGeometry- Specified by:
getComponentin classX3DConcreteElement- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevelin 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:
getFieldTypein 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:
getAccessTypein 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:
getContainerFieldDefaultin 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:
initializein 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:
getAttribin interfaceQuadSet- Specified by:
getAttribin interfaceX3DComposedGeometryNode- 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:
setAttribin interfaceQuadSet- Specified by:
setAttribin interfaceX3DComposedGeometryNode- Parameters:
newValue- is new value for the attrib field.- Returns:
QuadSetObject- 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:
QuadSetObject- 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:
QuadSetObject- 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:
QuadSetObject- 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.- Specified by:
addAttribin interfaceQuadSet- Specified by:
addAttribin interfaceX3DComposedGeometryNode- Parameters:
newValue- is new value array to be appended the attrib field.
-
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.- Specified by:
setAttribin interfaceQuadSet- Specified by:
setAttribin interfaceX3DComposedGeometryNode- Parameters:
newValue- is new node for the attrib field (restricted to X3DVertexAttributeNode)
-
clearAttrib
Utility method to clear MFNode value of attrib field.- Returns:
QuadSetObject- 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()
-
getCcw
public boolean getCcw()Provide boolean value from initializeOnly SFBool field named ccw.
Tooltip: ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in turn defines front/back orientation of polygon normals according to Right-Hand Rule (RHR).- Hint: a good debugging technique for problematic polygons is to try changing the value of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector direction.
- Warning: consistent and correct ordering of left-handed or right-handed point sequences is important throughout the coord array of point values.
- Hint: clockwise https://en.wikipedia.org/wiki/Clockwise
- Specified by:
getCcwin interfaceQuadSet- Specified by:
getCcwin interfaceX3DComposedGeometryNode- Returns:
- value of ccw field
-
setCcw
Accessor method to assign boolean value to initializeOnly SFBool field named ccw.
Tooltip: ccw defines clockwise/counterclockwise ordering of vertex coordinates, which in turn defines front/back orientation of polygon normals according to Right-Hand Rule (RHR).- Hint: a good debugging technique for problematic polygons is to try changing the value of ccw, which can reverse solid effects (single-sided backface culling) and normal-vector direction.
- Warning: consistent and correct ordering of left-handed or right-handed point sequences is important throughout the coord array of point values.
- Hint: clockwise https://en.wikipedia.org/wiki/Clockwise
- Specified by:
setCcwin interfaceQuadSet- Specified by:
setCcwin interfaceX3DComposedGeometryNode- Parameters:
newValue- is new value for the ccw field.- Returns:
QuadSetObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCcw
Assign typed object value to SFBool ccw field, similar tosetCcw(boolean).- Parameters:
newValue- is new value for the ccw field.- Returns:
QuadSetObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getColor
Provide X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.- Specified by:
getColorin interfaceQuadSet- Specified by:
getColorin interfaceX3DComposedGeometryNode- Returns:
- value of color field
- See Also:
Tooltip: [X3DColorNode] Single contained Color or ColorRGBA node that specifies color values applied to corresponding vertices according to colorIndex and colorPerVertex fields. *
-
setColor
Accessor method to assign X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.- Specified by:
setColorin interfaceQuadSet- Specified by:
setColorin interfaceX3DComposedGeometryNode- Parameters:
newValue- is new value for the color field.- Returns:
QuadSetObject- 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:
QuadSetObject- 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:
QuadSetObject- 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()
-
getColorPerVertex
public boolean getColorPerVertex()Provide boolean value from initializeOnly SFBool field named colorPerVertex.
Tooltip: Whether Color|ColorRGBA values are applied to each point vertex (true) or to each polygon face (false).- Warning: the provided value of QuadSet colorPerVertex field is ignored and always treated as true.
- Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding Appearance and material/texture values.
- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Specified by:
getColorPerVertexin interfaceQuadSet- Specified by:
getColorPerVertexin interfaceX3DComposedGeometryNode- Returns:
- value of colorPerVertex field
-
setColorPerVertex
Accessor method to assign boolean value to initializeOnly SFBool field named colorPerVertex.
Tooltip: Whether Color|ColorRGBA values are applied to each point vertex (true) or to each polygon face (false).- Warning: the provided value of QuadSet colorPerVertex field is ignored and always treated as true.
- Warning: if child Color|ColorRGBA node is not provided, then geometry is rendered using corresponding Appearance and material/texture values.
- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Specified by:
setColorPerVertexin interfaceQuadSet- Specified by:
setColorPerVertexin interfaceX3DComposedGeometryNode- Parameters:
newValue- is new value for the colorPerVertex field.- Returns:
QuadSetObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setColorPerVertex
Assign typed object value to SFBool colorPerVertex field, similar tosetColorPerVertex(boolean).- Parameters:
newValue- is new value for the colorPerVertex field.- Returns:
QuadSetObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCoord
Provide X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.- Specified by:
getCoordin interfaceQuadSet- Specified by:
getCoordin interfaceX3DComposedGeometryNode- Returns:
- value of coord field
- See Also:
Tooltip: [X3DCoordinateNode] Single contained Coordinate or CoordinateDouble node that specifies a list of vertex values. *
-
setCoord
Accessor method to assign X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.- Specified by:
setCoordin interfaceQuadSet- Specified by:
setCoordin interfaceX3DComposedGeometryNode- Parameters:
newValue- is new value for the coord field.- Returns:
QuadSetObject- 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:
QuadSetObject- 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:
QuadSetObject- 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:
getFogCoordin interfaceQuadSet- Specified by:
getFogCoordin interfaceX3DComposedGeometryNode- 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:
setFogCoordin interfaceQuadSet- Specified by:
setFogCoordin interfaceX3DComposedGeometryNode- Parameters:
newValue- is new value for the fogCoord field.- Returns:
QuadSetObject- 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:
QuadSetObject- 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:
QuadSetObject- 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:
getISin 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:
setISin classX3DConcreteNode- Parameters:
newValue- is new value for the IS field.- Returns:
QuadSetObject- 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:
QuadSetObject- 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:
getMetadatain interfaceQuadSet- Specified by:
getMetadatain interfaceX3DComposedGeometryNode- Specified by:
getMetadatain interfaceX3DGeometryNode- Specified by:
getMetadatain 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:
setMetadatain interfaceQuadSet- Specified by:
setMetadatain interfaceX3DComposedGeometryNode- Specified by:
setMetadatain interfaceX3DGeometryNode- Specified by:
setMetadatain interfaceX3DNode- Specified by:
setMetadatain classX3DConcreteNode- Parameters:
newValue- is new value for the metadata field.- Returns:
QuadSetObject- 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:
QuadSetObject- 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:
setMetadatain classX3DConcreteNode- Parameters:
newValue- is new value for the metadata field.- Returns:
QuadSetObject- 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
-
getNormal
Provide X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field normal.- Specified by:
getNormalin interfaceQuadSet- Specified by:
getNormalin interfaceX3DComposedGeometryNode- Returns:
- value of normal field
- See Also:
Tooltip: [X3DNormalNode] Single contained Normal node that specifies perpendicular vectors for corresponding vertices to support rendering computations, applied according to the normalPerVertex field. Hint: useful for special effects. Normal vector computation by 3D graphics hardware is quite fast so adding normals to a scene is typically unnecessary. Warning: normal vectors increase file size, typically doubling geometry definitions.
-
setNormal
Accessor method to assign X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.- Specified by:
setNormalin interfaceQuadSet- Specified by:
setNormalin interfaceX3DComposedGeometryNode- Parameters:
newValue- is new value for the normal field.- Returns:
QuadSetObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DNormalNode] Single contained Normal node that specifies perpendicular vectors for corresponding vertices to support rendering computations, applied according to the normalPerVertex field. Hint: useful for special effects. Normal vector computation by 3D graphics hardware is quite fast so adding normals to a scene is typically unnecessary. Warning: normal vectors increase file size, typically doubling geometry definitions.
-
clearNormal
Utility method to clear SFNode value of normal field.- Returns:
QuadSetObject- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setNormal
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field normal.- Parameters:
newValue- is new value for the normal field.- Returns:
QuadSetObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setNormal(X3DNormalNode)
-
hasNormal
public boolean hasNormal()Indicate whether an object is available for inputOutput SFNode field normal.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getNormal(),getNormalProtoInstance()
-
getNormalPerVertex
public boolean getNormalPerVertex()Provide boolean value from initializeOnly SFBool field named normalPerVertex.
Tooltip: Whether Normal node vector values are applied to each point vertex (true) or to each polygon face (false).- Hint: if no child Normal node is provided, the X3D browser shall automatically generate normals, using creaseAngle to determine smoothed shading across shared vertices.
- Specified by:
getNormalPerVertexin interfaceQuadSet- Specified by:
getNormalPerVertexin interfaceX3DComposedGeometryNode- Returns:
- value of normalPerVertex field
-
setNormalPerVertex
Accessor method to assign boolean value to initializeOnly SFBool field named normalPerVertex.
Tooltip: Whether Normal node vector values are applied to each point vertex (true) or to each polygon face (false).- Hint: if no child Normal node is provided, the X3D browser shall automatically generate normals, using creaseAngle to determine smoothed shading across shared vertices.
- Specified by:
setNormalPerVertexin interfaceQuadSet- Specified by:
setNormalPerVertexin interfaceX3DComposedGeometryNode- Parameters:
newValue- is new value for the normalPerVertex field.- Returns:
QuadSetObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setNormalPerVertex
Assign typed object value to SFBool normalPerVertex field, similar tosetNormalPerVertex(boolean).- Parameters:
newValue- is new value for the normalPerVertex field.- Returns:
QuadSetObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getSolid
public boolean getSolid()Provide boolean value from initializeOnly SFBool field named solid.
Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).- Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
- Warning: default value true can completely hide geometry if viewed from wrong side!
- Hint: if in doubt, use solid='false' for maximum visibility.
- Specified by:
getSolidin interfaceQuadSet- Specified by:
getSolidin interfaceX3DComposedGeometryNode- Returns:
- value of solid field
-
setSolid
Accessor method to assign boolean value to initializeOnly SFBool field named solid.
Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).- Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
- Warning: default value true can completely hide geometry if viewed from wrong side!
- Hint: if in doubt, use solid='false' for maximum visibility.
- Specified by:
setSolidin interfaceQuadSet- Specified by:
setSolidin interfaceX3DComposedGeometryNode- Parameters:
newValue- is new value for the solid field.- Returns:
QuadSetObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSolid
Assign typed object value to SFBool solid field, similar tosetSolid(boolean).- Parameters:
newValue- is new value for the solid field.- Returns:
QuadSetObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getTexCoord
Provide X3DTextureCoordinateNode instance (using a properly typed node) from inputOutput SFNode field texCoord.- Specified by:
getTexCoordin interfaceQuadSet- Specified by:
getTexCoordin interfaceX3DComposedGeometryNode- Returns:
- value of texCoord field
- See Also:
Tooltip: [X3DTextureCoordinateNode] Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate node that specifies coordinates for texture mapping onto corresponding geometry. *
-
setTexCoord
Accessor method to assign X3DTextureCoordinateNode instance (using a properly typed node) to inputOutput SFNode field texCoord.- Specified by:
setTexCoordin interfaceQuadSet- Specified by:
setTexCoordin interfaceX3DComposedGeometryNode- Parameters:
newValue- is new value for the texCoord field.- Returns:
QuadSetObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DTextureCoordinateNode] Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate node that specifies coordinates for texture mapping onto corresponding geometry. *
-
clearTexCoord
Utility method to clear SFNode value of texCoord field.- Returns:
QuadSetObject- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setTexCoord
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field texCoord.- Parameters:
newValue- is new value for the texCoord field.- Returns:
QuadSetObject- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setTexCoord(X3DTextureCoordinateNode)
-
hasTexCoord
public boolean hasTexCoord()Indicate whether an object is available for inputOutput SFNode field texCoord.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getTexCoord(),getTexCoordProtoInstance()
-
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:
getDEFin 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:
setDEFin classX3DConcreteNode- Parameters:
newValue- is new value for the DEF field.- Returns:
QuadSetObject- 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:
QuadSetObject- 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:
getUSEin 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: eachUSEnode is still an independent object, with theUSEvalue matching theDEFvalue 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:
setUSEin classX3DConcreteNode- Parameters:
newValue- is new value for the USE field.- Returns:
QuadSetObject- 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:
QuadSetObject- 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:
getCssClassin 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:
setCssClassin classX3DConcreteNode- Parameters:
newValue- is new value for the class field.- Returns:
QuadSetObject- 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:
QuadSetObject- 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:
QuadSetObject- 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:
addCommentsin classX3DConcreteElement- Parameters:
newComment- initial value- Returns:
QuadSetObject- 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:
addCommentsin classX3DConcreteElement- Parameters:
newComments- array of comments- Returns:
QuadSetObject- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addCommentsin classX3DConcreteElement- Parameters:
newCommentsBlock- block of comments to add- Returns:
QuadSetObject- 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:
toStringX3Din 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:
toStringClassicVRMLin 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:
toStringVRML97in 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:
findElementByNameValuein 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:
findElementByNameValuein 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:
findNodeByDEFin 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:
validatein classX3DConcreteElement- Returns:
- validation results (if any)
-