Package org.web3d.x3d.jsail.Geometry3D

Class IndexedFaceSet

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Geometry3D.IndexedFaceSet

All Implemented Interfaces:

X3DNode, IndexedFaceSet, X3DComposedGeometryNode, X3DGeometryNode

public class IndexedFaceSet
extends X3DConcreteNode
implements IndexedFaceSet

IndexedFaceSet defines polygons using index lists corresponding to vertex coordinates.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. IndexedFaceSet node tooltip: [X3DComposedGeometryNode] IndexedFaceSet defines polygons using index lists corresponding to vertex coordinates. IndexedFaceSet is a geometry node containing a Coordinate|CoordinateDouble node, and can also contain Color|ColorRGBA, Normal and TextureCoordinate nodes.

• Hint: Polygon https://en.wikipedia.org/wiki/Polygon
• 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.
• 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.

See Also:

• X3D Abstract Specification: IndexedFaceSet
• X3D Tooltips: IndexedFaceSet
• X3D Scene Authoring Hints: Meshes

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	CCW_DEFAULT_VALUE	SFBool field named ccw has default value true (Java syntax) or true (XML syntax).
static final X3DColorNode	COLOR_DEFAULT_VALUE	SFNode field named color has default value null (Java syntax) or NULL (XML syntax).
static final ArrayList<Integer>	COLORINDEX_DEFAULT_VALUE	MFInt32 field named colorIndex has default value equal to an empty list.
static final boolean	COLORPERVERTEX_DEFAULT_VALUE	SFBool field named colorPerVertex has default value true (Java syntax) or true (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the IndexedFaceSet element: Geometry3D
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final boolean	CONVEX_DEFAULT_VALUE	SFBool field named convex has default value true (Java syntax) or true (XML syntax).
static final X3DCoordinateNode	COORD_DEFAULT_VALUE	SFNode field named coord has default value null (Java syntax) or NULL (XML syntax).
static final ArrayList<Integer>	COORDINDEX_DEFAULT_VALUE	MFInt32 field named coordIndex has default value equal to an empty list.
static final float	CREASEANGLE_DEFAULT_VALUE	SFFloat field named creaseAngle has default value 0f (Java syntax) or 0 (XML syntax).
static final FogCoordinate	FOGCOORD_DEFAULT_VALUE	SFNode field named fogCoord has default value null (Java syntax) or NULL (XML syntax).
static final String	fromField_ATTRIB	fromField ROUTE name for MFNode field named attrib.
static final String	fromField_COLOR	fromField ROUTE name for SFNode field named color.
static final String	fromField_COORD	fromField ROUTE name for SFNode field named coord.
static final String	fromField_FOGCOORD	fromField ROUTE name for SFNode field named fogCoord.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_NORMAL	fromField ROUTE name for SFNode field named normal.
static final String	fromField_TEXCOORD	fromField ROUTE name for SFNode field named texCoord.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D Geometry3D component level for this element: 2
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: IndexedFaceSet.
static final X3DNormalNode	NORMAL_DEFAULT_VALUE	SFNode field named normal has default value null (Java syntax) or NULL (XML syntax).
static final ArrayList<Integer>	NORMALINDEX_DEFAULT_VALUE	MFInt32 field named normalIndex has default value equal to an empty list.
static final boolean	NORMALPERVERTEX_DEFAULT_VALUE	SFBool field named normalPerVertex has default value true (Java syntax) or true (XML syntax).
static final boolean	SOLID_DEFAULT_VALUE	SFBool field named solid has default value true (Java syntax) or true (XML syntax).
static final X3DNode	TEXCOORD_DEFAULT_VALUE	SFNode field named texCoord has default value null (Java syntax) or NULL (XML syntax).
static final ArrayList<Integer>	TEXCOORDINDEX_DEFAULT_VALUE	MFInt32 field named texCoordIndex has default value equal to an empty list.
static final String	toField_ATTRIB	toField ROUTE name for MFNode field named attrib.
static final String	toField_COLOR	toField ROUTE name for SFNode field named color.
static final String	toField_COORD	toField ROUTE name for SFNode field named coord.
static final String	toField_FOGCOORD	toField ROUTE name for SFNode field named fogCoord.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_NORMAL	toField ROUTE name for SFNode field named normal.
static final String	toField_SET_COLORINDEX	toField ROUTE name for MFInt32 field named set_colorIndex.
static final String	toField_SET_COORDINDEX	toField ROUTE name for MFInt32 field named set_coordIndex.
static final String	toField_SET_NORMALINDEX	toField ROUTE name for MFInt32 field named set_normalIndex.
static final String	toField_SET_TEXCOORDINDEX	toField ROUTE name for MFInt32 field named set_texCoordIndex.
static final String	toField_TEXCOORD	toField ROUTE name for SFNode field named texCoord.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
IndexedFaceSet()	Constructor for IndexedFaceSet to initialize member variables with default values.
IndexedFaceSet(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
IndexedFaceSet	addAttrib(ProtoInstance newValue)	Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for attrib field.
IndexedFaceSet	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).
IndexedFaceSet	addColorIndex(int newValue)	Add singleton int value to MFInt32 colorIndex field.
IndexedFaceSet	addColorIndex(SFInt32 newValue)	Add singleton SFInt32 value to MFInt32 colorIndex field.
IndexedFaceSet	addComments(String newComment)	Add comment as String to contained commentsList.
IndexedFaceSet	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
IndexedFaceSet	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
IndexedFaceSet	addCoordIndex(int newValue)	Add singleton int value to MFInt32 coordIndex field.
IndexedFaceSet	addCoordIndex(SFInt32 newValue)	Add singleton SFInt32 value to MFInt32 coordIndex field.
IndexedFaceSet	addNormalIndex(int newValue)	Add singleton int value to MFInt32 normalIndex field.
IndexedFaceSet	addNormalIndex(SFInt32 newValue)	Add singleton SFInt32 value to MFInt32 normalIndex field.
IndexedFaceSet	addTexCoordIndex(int newValue)	Add singleton int value to MFInt32 texCoordIndex field.
IndexedFaceSet	addTexCoordIndex(SFInt32 newValue)	Add singleton SFInt32 value to MFInt32 texCoordIndex field.
IndexedFaceSet	clearAttrib()	Utility method to clear MFNode value of attrib field.
IndexedFaceSet	clearColor()	Utility method to clear SFNode value of color field.
IndexedFaceSet	clearColorIndex()	Utility method to clear MFInt32 value of colorIndex field.
IndexedFaceSet	clearCoord()	Utility method to clear SFNode value of coord field.
IndexedFaceSet	clearCoordIndex()	Utility method to clear MFInt32 value of coordIndex field.
IndexedFaceSet	clearFogCoord()	Utility method to clear SFNode value of fogCoord field.
IndexedFaceSet	clearIS()	Utility method to clear SFNode value of IS field.
IndexedFaceSet	clearMetadata()	Utility method to clear SFNode value of metadata field.
IndexedFaceSet	clearNormal()	Utility method to clear SFNode value of normal field.
IndexedFaceSet	clearNormalIndex()	Utility method to clear MFInt32 value of normalIndex field.
IndexedFaceSet	clearTexCoord()	Utility method to clear SFNode value of texCoord field.
IndexedFaceSet	clearTexCoordIndex()	Utility method to clear MFInt32 value of texCoordIndex field.
X3DConcreteElement	findElementByNameValue(String nameValue)	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteElement	findElementByNameValue(String nameValue, String elementName)	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
X3DNode[]	getAttrib()	Provide array of org.web3d.x3d.sai.Shaders.X3DVertexAttributeNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field attrib.
ArrayList<X3DNode>	getAttribList()	Utility method to get ArrayList value of MFNode attrib field, similar to getAttrib().
boolean	getCcw()	Provide boolean value from initializeOnly SFBool field named ccw.
X3DColorNode	getColor()	Provide org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) using RGB values [0..1] from inputOutput SFNode field color.
int	getColorCount()	Utility method to get number of 3-tuple Color RGB values (or 4-tuple ColorRGBA values) in contained Color/ColorRGBA or ProtoInstance node
int[]	getColorIndex()	Provide array of Integer results using RGB values [0..1] from initializeOnly MFInt32 field named colorIndex.
ArrayList<Integer>	getColorIndexList()	Utility method to get ArrayList value of MFInt32 colorIndex field, similar to getColorIndex().
String	getColorIndexString()	Utility method to get String value of MFInt32 colorIndex field, similar to getColorIndex().
boolean	getColorPerVertex()	Provide boolean value from initializeOnly SFBool field named colorPerVertex.
final String	getComponent()	Defines X3D component for the IndexedFaceSet element: Geometry3D
final int	getComponentLevel()	Provides default X3D component level for this element: 2
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
boolean	getConvex()	Provide boolean value from initializeOnly SFBool field named convex.
X3DCoordinateNode	getCoord()	Provide org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) from inputOutput SFNode field coord.
int	getCoordCount()	Utility method to get number of coordinate 3-tuple values in contained Coordinate/CoordinateDouble or ProtoInstance node
int[]	getCoordIndex()	Provide array of Integer results within allowed range of [-1,infinity) from initializeOnly MFInt32 field named coordIndex.
ArrayList<Integer>	getCoordIndexList()	Utility method to get ArrayList value of MFInt32 coordIndex field, similar to getCoordIndex().
String	getCoordIndexString()	Utility method to get String value of MFInt32 coordIndex field, similar to getCoordIndex().
float	getCreaseAngle()	Provide float value unit axis, angle (in radians) within allowed range of [0,infinity) from initializeOnly SFFloat field named creaseAngle.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
final String	getElementName()	Provides name of this element: IndexedFaceSet
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
FogCoordinate	getFogCoord()	Provide org.web3d.x3d.sai.EnvironmentalEffects.FogCoordinate instance (using a properly typed node) from inputOutput SFNode field fogCoord.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
X3DNormalNode	getNormal()	Provide org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) from inputOutput SFNode field normal.
int	getNormalCount()	Utility method to get number of 3-tuple normal vectors in contained Normal or ProtoInstance node
int[]	getNormalIndex()	Provide array of Integer results within allowed range of [-1,infinity) from initializeOnly MFInt32 field named normalIndex.
ArrayList<Integer>	getNormalIndexList()	Utility method to get ArrayList value of MFInt32 normalIndex field, similar to getNormalIndex().
String	getNormalIndexString()	Utility method to get String value of MFInt32 normalIndex field, similar to getNormalIndex().
boolean	getNormalPerVertex()	Provide boolean value from initializeOnly SFBool field named normalPerVertex.
boolean	getSolid()	Provide boolean value from initializeOnly SFBool field named solid.
X3DNode	getTexCoord()	Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DSingleTextureCoordinateNode|MultiTextureCoordinate, from inputOutput SFNode field texCoord.
int	getTexCoordCount()	Utility method to get number of 2-tuple texture coordinate values in contained TextureCoordinate or ProtoInstance node
int[]	getTexCoordIndex()	Provide array of Integer results within allowed range of [-1,infinity) from initializeOnly MFInt32 field named texCoordIndex.
ArrayList<Integer>	getTexCoordIndexList()	Utility method to get ArrayList value of MFInt32 texCoordIndex field, similar to getTexCoordIndex().
String	getTexCoordIndexString()	Utility method to get String value of MFInt32 texCoordIndex field, similar to getTexCoordIndex().
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasAttrib()	Indicate whether an object is available for inputOutput MFNode field attrib.
boolean	hasColor()	Indicate whether an object is available for inputOutput SFNode field color.
boolean	hasCoord()	Indicate whether an object is available for inputOutput SFNode field coord.
boolean	hasElementByNameValue(String nameValue, String elementName)	Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
boolean	hasFogCoord()	Indicate whether an object is available for inputOutput SFNode field fogCoord.
boolean	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
boolean	hasNormal()	Indicate whether an object is available for inputOutput SFNode field normal.
boolean	hasTexCoord()	Indicate whether an object is available for inputOutput SFNode field texCoord.
final void	initialize()	Initialize all member variables to default values.
IndexedFaceSet	setAttrib(ArrayList<X3DVertexAttributeNode> newValue)	Assign ArrayList value of MFNode attrib field, similar to setAttrib(org.web3d.x3d.sai.Core.X3DNode[]).
void	setAttrib(X3DNode newValue)	Set single child attrib node, replacing prior array of existing nodes (if any).
IndexedFaceSet	setAttrib(X3DNode[] newValue)	Accessor method to assign org.web3d.x3d.sai.Shaders.X3DVertexAttributeNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field attrib.
IndexedFaceSet	setCcw(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named ccw.
IndexedFaceSet	setCcw(SFBool newValue)	Assign typed object value to SFBool ccw field, similar to setCcw(boolean).
IndexedFaceSet	setColor(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field color.
IndexedFaceSet	setColor(X3DColorNode newValue)	Accessor method to assign org.web3d.x3d.sai.Rendering.X3DColorNode instance (using a properly typed node) to inputOutput SFNode field color.
IndexedFaceSet	setColorIndex(int[] newValue)	Accessor method to assign Integer array to initializeOnly MFInt32 field named colorIndex.
IndexedFaceSet	setColorIndex(ArrayList<Integer> newValue)	Assign ArrayList value of MFInt32 colorIndex field, similar to setColorIndex(int[]).
IndexedFaceSet	setColorIndex(MFInt32 newValue)	Assign typed object value to MFInt32 colorIndex field, similar to setColorIndex(int[]).
IndexedFaceSet	setColorPerVertex(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named colorPerVertex.
IndexedFaceSet	setColorPerVertex(SFBool newValue)	Assign typed object value to SFBool colorPerVertex field, similar to setColorPerVertex(boolean).
IndexedFaceSet	setConvex(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named convex.
IndexedFaceSet	setConvex(SFBool newValue)	Assign typed object value to SFBool convex field, similar to setConvex(boolean).
IndexedFaceSet	setCoord(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field coord.
IndexedFaceSet	setCoord(X3DCoordinateNode newValue)	Accessor method to assign org.web3d.x3d.sai.Rendering.X3DCoordinateNode instance (using a properly typed node) to inputOutput SFNode field coord.
IndexedFaceSet	setCoordIndex(int[] newValue)	Accessor method to assign Integer array to initializeOnly MFInt32 field named coordIndex.
IndexedFaceSet	setCoordIndex(ArrayList<Integer> newValue)	Assign ArrayList value of MFInt32 coordIndex field, similar to setCoordIndex(int[]).
IndexedFaceSet	setCoordIndex(MFInt32 newValue)	Assign typed object value to MFInt32 coordIndex field, similar to setCoordIndex(int[]).
IndexedFaceSet	setCreaseAngle(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setCreaseAngle(float).
IndexedFaceSet	setCreaseAngle(float newValue)	Accessor method to assign float value unit axis, angle (in radians) to initializeOnly SFFloat field named creaseAngle.
IndexedFaceSet	setCreaseAngle(SFFloat newValue)	Assign typed object value to SFFloat creaseAngle field, similar to setCreaseAngle(float).
final IndexedFaceSet	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
IndexedFaceSet	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final IndexedFaceSet	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
IndexedFaceSet	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final IndexedFaceSet	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
IndexedFaceSet	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
IndexedFaceSet	setFogCoord(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fogCoord.
IndexedFaceSet	setFogCoord(FogCoordinate newValue)	Accessor method to assign org.web3d.x3d.sai.EnvironmentalEffects.FogCoordinate instance (using a properly typed node) to inputOutput SFNode field fogCoord.
final IndexedFaceSet	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
IndexedFaceSet	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
IndexedFaceSet	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
IndexedFaceSet	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
IndexedFaceSet	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
IndexedFaceSet	setNormal(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field normal.
IndexedFaceSet	setNormal(X3DNormalNode newValue)	Accessor method to assign org.web3d.x3d.sai.Rendering.X3DNormalNode instance (using a properly typed node) to inputOutput SFNode field normal.
IndexedFaceSet	setNormalIndex(int[] newValue)	Accessor method to assign Integer array to initializeOnly MFInt32 field named normalIndex.
IndexedFaceSet	setNormalIndex(ArrayList<Integer> newValue)	Assign ArrayList value of MFInt32 normalIndex field, similar to setNormalIndex(int[]).
IndexedFaceSet	setNormalIndex(MFInt32 newValue)	Assign typed object value to MFInt32 normalIndex field, similar to setNormalIndex(int[]).
IndexedFaceSet	setNormalPerVertex(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named normalPerVertex.
IndexedFaceSet	setNormalPerVertex(SFBool newValue)	Assign typed object value to SFBool normalPerVertex field, similar to setNormalPerVertex(boolean).
IndexedFaceSet	setSolid(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named solid.
IndexedFaceSet	setSolid(SFBool newValue)	Assign typed object value to SFBool solid field, similar to setSolid(boolean).
IndexedFaceSet	setTexCoord(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field texCoord.
IndexedFaceSet	setTexCoord(X3DNode newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field texCoord.
IndexedFaceSet	setTexCoordIndex(int[] newValue)	Accessor method to assign Integer array to initializeOnly MFInt32 field named texCoordIndex.
IndexedFaceSet	setTexCoordIndex(ArrayList<Integer> newValue)	Assign ArrayList value of MFInt32 texCoordIndex field, similar to setTexCoordIndex(int[]).
IndexedFaceSet	setTexCoordIndex(MFInt32 newValue)	Assign typed object value to MFInt32 texCoordIndex field, similar to setTexCoordIndex(int[]).
final IndexedFaceSet	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
IndexedFaceSet	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
IndexedFaceSet	setUSE(IndexedFaceSet DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
String	validate()	Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

String constant NAME provides name of this element: IndexedFaceSet.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the IndexedFaceSet element: Geometry3D

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D Geometry3D component level for this element: 2

See Also:

• Constant Field Values

CCW_DEFAULT_VALUE

public static final boolean CCW_DEFAULT_VALUE

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

See Also:

• Constant Field Values

COLOR_DEFAULT_VALUE

public static final X3DColorNode COLOR_DEFAULT_VALUE

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

COLORINDEX_DEFAULT_VALUE

public static final ArrayList<Integer> COLORINDEX_DEFAULT_VALUE

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

COLORPERVERTEX_DEFAULT_VALUE

public static final boolean COLORPERVERTEX_DEFAULT_VALUE

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

See Also:

• Constant Field Values

CONVEX_DEFAULT_VALUE

public static final boolean CONVEX_DEFAULT_VALUE

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

See Also:

• Constant Field Values

COORD_DEFAULT_VALUE

public static final X3DCoordinateNode COORD_DEFAULT_VALUE

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

COORDINDEX_DEFAULT_VALUE

public static final ArrayList<Integer> COORDINDEX_DEFAULT_VALUE

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

CREASEANGLE_DEFAULT_VALUE

public static final float CREASEANGLE_DEFAULT_VALUE

SFFloat field named creaseAngle has default value 0f (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

FOGCOORD_DEFAULT_VALUE

public static final FogCoordinate FOGCOORD_DEFAULT_VALUE

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

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

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

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

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

NORMAL_DEFAULT_VALUE

public static final X3DNormalNode NORMAL_DEFAULT_VALUE

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

NORMALINDEX_DEFAULT_VALUE

public static final ArrayList<Integer> NORMALINDEX_DEFAULT_VALUE

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

NORMALPERVERTEX_DEFAULT_VALUE

public static final boolean NORMALPERVERTEX_DEFAULT_VALUE

SFBool 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_VALUE

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

See Also:

• Constant Field Values

TEXCOORD_DEFAULT_VALUE

public static final X3DNode TEXCOORD_DEFAULT_VALUE

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

TEXCOORDINDEX_DEFAULT_VALUE

public static final ArrayList<Integer> TEXCOORDINDEX_DEFAULT_VALUE

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

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "geometry";
containerField_ALLOWED_VALUES = {"geometry", "skin" *HAnimHumanoid parent* }; type xs:NMTOKEN

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_ATTRIB

public static final String fromField_ATTRIB

fromField ROUTE name for MFNode field named attrib.

See Also:

• Constant Field Values

toField_ATTRIB

public static final String toField_ATTRIB

toField ROUTE name for MFNode field named attrib.

See Also:

• Constant Field Values

fromField_COLOR

public static final String fromField_COLOR

fromField ROUTE name for SFNode field named color.

See Also:

• Constant Field Values

toField_COLOR

public static final String toField_COLOR

toField ROUTE name for SFNode field named color.

See Also:

• Constant Field Values

fromField_COORD

public static final String fromField_COORD

fromField ROUTE name for SFNode field named coord.

See Also:

• Constant Field Values

toField_COORD

public static final String toField_COORD

toField ROUTE name for SFNode field named coord.

See Also:

• Constant Field Values

fromField_FOGCOORD

public static final String fromField_FOGCOORD

fromField ROUTE name for SFNode field named fogCoord.

See Also:

• Constant Field Values

toField_FOGCOORD

public static final String toField_FOGCOORD

toField ROUTE name for SFNode field named fogCoord.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_NORMAL

public static final String fromField_NORMAL

fromField ROUTE name for SFNode field named normal.

See Also:

• Constant Field Values

toField_NORMAL

public static final String toField_NORMAL

toField ROUTE name for SFNode field named normal.

See Also:

• Constant Field Values

toField_SET_COLORINDEX

public static final String toField_SET_COLORINDEX

toField ROUTE name for MFInt32 field named set_colorIndex.

See Also:

• Constant Field Values

toField_SET_COORDINDEX

public static final String toField_SET_COORDINDEX

toField ROUTE name for MFInt32 field named set_coordIndex.

See Also:

• Constant Field Values

toField_SET_NORMALINDEX

public static final String toField_SET_NORMALINDEX

toField ROUTE name for MFInt32 field named set_normalIndex.

See Also:

• Constant Field Values

toField_SET_TEXCOORDINDEX

public static final String toField_SET_TEXCOORDINDEX

toField ROUTE name for MFInt32 field named set_texCoordIndex.

See Also:

• Constant Field Values

fromField_TEXCOORD

public static final String fromField_TEXCOORD

fromField ROUTE name for SFNode field named texCoord.

See Also:

• Constant Field Values

toField_TEXCOORD

public static final String toField_TEXCOORD

toField ROUTE name for SFNode field named texCoord.

See Also:

• Constant Field Values

Constructor Details

IndexedFaceSet

public IndexedFaceSet()

Constructor for IndexedFaceSet to initialize member variables with default values.

IndexedFaceSet

public IndexedFaceSet(String DEFlabel)

Utility constructor that assigns DEF label after initializing member variables with default values.

Parameters:

DEFlabel - unique DEF name for this X3D node

Method Details

getElementName

public final String getElementName()

Provides name of this element: IndexedFaceSet

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the IndexedFaceSet element: Geometry3D

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 2

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public String getFieldType(String fieldName)

Indicate type corresponding to given fieldName.

Specified by:

getFieldType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized

See Also:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

getAccessType

public String getAccessType(String fieldName)

Indicate accessType corresponding to given fieldName.

Specified by:

getAccessType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized

See Also:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

getContainerFieldDefault

public final String getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getAttrib

public X3DNode[] getAttrib()

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

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

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

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

Specified by:

getAttrib in interface IndexedFaceSet

Specified by:

getAttrib in interface X3DComposedGeometryNode

Returns:

value of attrib field

See Also:

• X3DVertexAttributeNode

getAttribList

public ArrayList<X3DNode> getAttribList()

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

Returns:

value of attrib field

setAttrib

public IndexedFaceSet setAttrib(X3DNode[] newValue)

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

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

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

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

Specified by:

setAttrib in interface IndexedFaceSet

Specified by:

setAttrib in interface X3DComposedGeometryNode

Parameters:

newValue - is new value for the attrib field.

Returns:

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

setAttrib

public IndexedFaceSet setAttrib(ArrayList<X3DVertexAttributeNode> newValue)

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

Parameters:

newValue - is new value for the attrib field.

Returns:

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

addAttrib

public IndexedFaceSet addAttrib(X3DNode newValue)

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

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

Parameters:

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

Returns:

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

addAttrib

public IndexedFaceSet addAttrib(ProtoInstance newValue)

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

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

Parameters:

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

Returns:

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

addAttrib

public void addAttrib(X3DNode[] newValue)

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

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

Specified by:

addAttrib in interface IndexedFaceSet

Specified by:

addAttrib in interface X3DComposedGeometryNode

Parameters:

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

setAttrib

public void setAttrib(X3DNode newValue)

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

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

Specified by:

setAttrib in interface IndexedFaceSet

Specified by:

setAttrib in interface X3DComposedGeometryNode

Parameters:

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

clearAttrib

public IndexedFaceSet clearAttrib()

Utility method to clear MFNode value of attrib field. This method does not initialize withATTRIB_DEFAULT_VALUE.

Returns:

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

getCcw in interface IndexedFaceSet

Specified by:

getCcw in interface X3DComposedGeometryNode

Returns:

value of ccw field

setCcw

public IndexedFaceSet setCcw(boolean newValue)

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:

setCcw in interface IndexedFaceSet

Specified by:

setCcw in interface X3DComposedGeometryNode

Parameters:

newValue - is new value for the ccw field.

Returns:

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

setCcw

public IndexedFaceSet setCcw(SFBool newValue)

Assign typed object value to SFBool ccw field, similar to setCcw(boolean).

Parameters:

newValue - is new value for the ccw field.

Returns:

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

getColor

public X3DColorNode getColor()

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

Specified by:

getColor in interface IndexedFaceSet

Specified by:

getColor in interface X3DComposedGeometryNode

Returns:

value of color field

See Also:

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

setColor

public IndexedFaceSet setColor(X3DColorNode newValue)

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

Specified by:

setColor in interface IndexedFaceSet

Specified by:

setColor in interface X3DComposedGeometryNode

Parameters:

newValue - is new value for the color field.

Returns:

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

See Also:

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

clearColor

public IndexedFaceSet clearColor()

Utility method to clear SFNode value of color field.

Returns:

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

setColor

public IndexedFaceSet setColor(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the color field.

Returns:

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

See Also:

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

hasColor

public boolean hasColor()

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

Returns:

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

See Also:

• getColor()
• getColorProtoInstance()

getColorIndex

public int[] getColorIndex()

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

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

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

Specified by:

getColorIndex in interface IndexedFaceSet

Returns:

value of colorIndex field

getColorIndexList

public ArrayList<Integer> getColorIndexList()

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

Returns:

value of colorIndex field

getColorIndexString

public String getColorIndexString()

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

Returns:

value of colorIndex field

setColorIndex

public IndexedFaceSet setColorIndex(int[] newValue)

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

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

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

Specified by:

setColorIndex in interface IndexedFaceSet

Parameters:

newValue - is new value for the colorIndex field.

Returns:

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

setColorIndex

public IndexedFaceSet setColorIndex(MFInt32 newValue)

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

Parameters:

newValue - is new value for the colorIndex field.

Returns:

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

setColorIndex

public IndexedFaceSet setColorIndex(ArrayList<Integer> newValue)

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

Parameters:

newValue - is new value for the colorIndex field.

Returns:

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

clearColorIndex

public IndexedFaceSet clearColorIndex()

Utility method to clear MFInt32 value of colorIndex field. This method does not initialize withCOLORINDEX_DEFAULT_VALUE.

Returns:

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

addColorIndex

public IndexedFaceSet addColorIndex(int newValue)

Add singleton int value to MFInt32 colorIndex field.

Parameters:

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

Returns:

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

addColorIndex

public IndexedFaceSet addColorIndex(SFInt32 newValue)

Add singleton SFInt32 value to MFInt32 colorIndex field.

Parameters:

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

Returns:

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

getColorPerVertex

public boolean getColorPerVertex()

Provide boolean value from initializeOnly SFBool field named colorPerVertex.

Tooltip: Whether Color|ColorRGBA values are applied to each point vertex (true) or to each polygon face (false).

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

getColorPerVertex in interface IndexedFaceSet

Specified by:

getColorPerVertex in interface X3DComposedGeometryNode

Returns:

value of colorPerVertex field

setColorPerVertex

public IndexedFaceSet setColorPerVertex(boolean newValue)

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

setColorPerVertex in interface IndexedFaceSet

Specified by:

setColorPerVertex in interface X3DComposedGeometryNode

Parameters:

newValue - is new value for the colorPerVertex field.

Returns:

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

setColorPerVertex

public IndexedFaceSet setColorPerVertex(SFBool newValue)

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

Parameters:

newValue - is new value for the colorPerVertex field.

Returns:

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

getConvex

public boolean getConvex()

Provide boolean value from initializeOnly SFBool field named convex.

Tooltip: The convex field is a hint to renderers whether all polygons in a shape are convex (true), or possibly concave (false). A convex polygon is planar, does not intersect itself, and has all interior angles < 180 degrees.

• Hint: concave is the opposite of convex. Interchange profile
• Hint: only convex=true IndexedFaceSets have guaranteed support.
• Warning: concave or inverted geometry may be invisible when using default value convex=true, since some renderers use more-efficient algorithms to perform tessellation that may inadvertently fail on concave geometry.
• Hint: select convex=false (i.e. concave) and solid=false (i.e. two-sided display) for greatest visibility of geometry.
• Hint: convex polygon https://en.wikipedia.org/wiki/Convex_polygon
• Hint: tessellation https://en.wikipedia.org/wiki/Tessellation

Specified by:

getConvex in interface IndexedFaceSet

Returns:

value of convex field

setConvex

public IndexedFaceSet setConvex(boolean newValue)

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

Tooltip: The convex field is a hint to renderers whether all polygons in a shape are convex (true), or possibly concave (false). A convex polygon is planar, does not intersect itself, and has all interior angles < 180 degrees.

• Hint: concave is the opposite of convex. Interchange profile
• Hint: only convex=true IndexedFaceSets have guaranteed support.
• Warning: concave or inverted geometry may be invisible when using default value convex=true, since some renderers use more-efficient algorithms to perform tessellation that may inadvertently fail on concave geometry.
• Hint: select convex=false (i.e. concave) and solid=false (i.e. two-sided display) for greatest visibility of geometry.
• Hint: convex polygon https://en.wikipedia.org/wiki/Convex_polygon
• Hint: tessellation https://en.wikipedia.org/wiki/Tessellation

Specified by:

setConvex in interface IndexedFaceSet

Parameters:

newValue - is new value for the convex field.

Returns:

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

setConvex

public IndexedFaceSet setConvex(SFBool newValue)

Assign typed object value to SFBool convex field, similar to setConvex(boolean).

Parameters:

newValue - is new value for the convex field.

Returns:

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

getCoord

public X3DCoordinateNode getCoord()

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

Specified by:

getCoord in interface IndexedFaceSet

Specified by:

getCoord in interface X3DComposedGeometryNode

Returns:

value of coord field

See Also:

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

setCoord

public IndexedFaceSet setCoord(X3DCoordinateNode newValue)

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

Specified by:

setCoord in interface IndexedFaceSet

Specified by:

setCoord in interface X3DComposedGeometryNode

Parameters:

newValue - is new value for the coord field.

Returns:

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

See Also:

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

clearCoord

public IndexedFaceSet clearCoord()

Utility method to clear SFNode value of coord field.

Returns:

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

setCoord

public IndexedFaceSet setCoord(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the coord field.

Returns:

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

See Also:

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

hasCoord

public boolean hasCoord()

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

Returns:

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

See Also:

• getCoord()
• getCoordProtoInstance()

getCoordIndex

public int[] getCoordIndex()

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

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

• Hint: sentinel value -1 is used to separate indices for each successive polygon.
• Warning: coordIndex is required in order to connect contained coordinate point values.

Specified by:

getCoordIndex in interface IndexedFaceSet

Returns:

value of coordIndex field

getCoordIndexList

public ArrayList<Integer> getCoordIndexList()

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

Returns:

value of coordIndex field

getCoordIndexString

public String getCoordIndexString()

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

Returns:

value of coordIndex field

setCoordIndex

public IndexedFaceSet setCoordIndex(int[] newValue)

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

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

• Hint: sentinel value -1 is used to separate indices for each successive polygon.
• Warning: coordIndex is required in order to connect contained coordinate point values.

Specified by:

setCoordIndex in interface IndexedFaceSet

Parameters:

newValue - is new value for the coordIndex field.

Returns:

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

setCoordIndex

public IndexedFaceSet setCoordIndex(MFInt32 newValue)

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

Parameters:

newValue - is new value for the coordIndex field.

Returns:

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

setCoordIndex

public IndexedFaceSet setCoordIndex(ArrayList<Integer> newValue)

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

Parameters:

newValue - is new value for the coordIndex field.

Returns:

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

clearCoordIndex

public IndexedFaceSet clearCoordIndex()

Utility method to clear MFInt32 value of coordIndex field. This method does not initialize withCOORDINDEX_DEFAULT_VALUE.

Returns:

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

addCoordIndex

public IndexedFaceSet addCoordIndex(int newValue)

Add singleton int value to MFInt32 coordIndex field.

Parameters:

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

Returns:

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

addCoordIndex

public IndexedFaceSet addCoordIndex(SFInt32 newValue)

Add singleton SFInt32 value to MFInt32 coordIndex field.

Parameters:

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

Returns:

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

getCreaseAngle

public float getCreaseAngle()

Provide float value unit axis, angle (in radians) within allowed range of [0,infinity) from initializeOnly SFFloat field named creaseAngle.

Tooltip: [0,+infinity) creaseAngle defines angle (in radians) for determining whether adjacent polygons are drawn with sharp edges or smooth shading. If angle between normals of two adjacent polygons is less than creaseAngle, smooth shading is rendered across the shared line segment. Interchange profile

• Hint: only 0 and pi radians supported.
• Hint: creaseAngle=0 means render all edges sharply, creaseAngle=3.14159 means render all edges smoothly.
• Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian

Specified by:

getCreaseAngle in interface IndexedFaceSet

Returns:

value of creaseAngle field

setCreaseAngle

public IndexedFaceSet setCreaseAngle(float newValue)

Accessor method to assign float value unit axis, angle (in radians) to initializeOnly SFFloat field named creaseAngle.

Tooltip: [0,+infinity) creaseAngle defines angle (in radians) for determining whether adjacent polygons are drawn with sharp edges or smooth shading. If angle between normals of two adjacent polygons is less than creaseAngle, smooth shading is rendered across the shared line segment. Interchange profile

• Hint: only 0 and pi radians supported.
• Hint: creaseAngle=0 means render all edges sharply, creaseAngle=3.14159 means render all edges smoothly.
• Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian

Specified by:

setCreaseAngle in interface IndexedFaceSet

Parameters:

newValue - is new value for the creaseAngle field.

Returns:

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

setCreaseAngle

public IndexedFaceSet setCreaseAngle(SFFloat newValue)

Assign typed object value to SFFloat creaseAngle field, similar to setCreaseAngle(float).

Parameters:

newValue - is new value for the creaseAngle field.

Returns:

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

setCreaseAngle

public IndexedFaceSet setCreaseAngle(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setCreaseAngle(float).

Parameters:

newValue - is new value for field

Returns:

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

getFogCoord

public FogCoordinate getFogCoord()

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

Specified by:

getFogCoord in interface IndexedFaceSet

Specified by:

getFogCoord in interface X3DComposedGeometryNode

Returns:

value of fogCoord field

See Also:

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

setFogCoord

public IndexedFaceSet setFogCoord(FogCoordinate newValue)

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

Specified by:

setFogCoord in interface IndexedFaceSet

Specified by:

setFogCoord in interface X3DComposedGeometryNode

Parameters:

newValue - is new value for the fogCoord field.

Returns:

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

See Also:

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

clearFogCoord

public IndexedFaceSet clearFogCoord()

Utility method to clear SFNode value of fogCoord field.

Returns:

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

setFogCoord

public IndexedFaceSet setFogCoord(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the fogCoord field.

Returns:

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

See Also:

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

hasFogCoord

public boolean hasFogCoord()

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

Returns:

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

See Also:

• getFogCoord()
• getFogCoordProtoInstance()

getIS

public IS getIS()

Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.

Specified by:

getIS in class X3DConcreteNode

Returns:

value of IS field

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

setIS

public IndexedFaceSet setIS(IS newValue)

Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the IS field.

Returns:

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

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

clearIS

public IndexedFaceSet clearIS()

Utility method to clear SFNode value of IS field.

Returns:

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

hasIS

public boolean hasIS()

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

Returns:

whether a concrete statement or CommentsBlock is available.

See Also:

• getIS()

getMetadata

public X3DMetadataObject getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface IndexedFaceSet

Specified by:

getMetadata in interface X3DComposedGeometryNode

Specified by:

getMetadata in interface X3DGeometryNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public IndexedFaceSet setMetadata(X3DMetadataObject newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface IndexedFaceSet

Specified by:

setMetadata in interface X3DComposedGeometryNode

Specified by:

setMetadata in interface X3DGeometryNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public IndexedFaceSet clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

public IndexedFaceSet setMetadata(ProtoInstance newValue)

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

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

• setMetadata(org.web3d.x3d.sai.Core.X3DMetadataObject)

hasMetadata

public boolean hasMetadata()

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

Returns:

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

See Also:

• getMetadata()
• getMetadataProtoInstance()
• X3D Scene Authoring Hints: Metadata Nodes

getNormal

public X3DNormalNode getNormal()

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

Specified by:

getNormal in interface IndexedFaceSet

Specified by:

getNormal in interface X3DComposedGeometryNode

Returns:

value of normal field

See Also:

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

setNormal

public IndexedFaceSet setNormal(X3DNormalNode newValue)

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

Specified by:

setNormal in interface IndexedFaceSet

Specified by:

setNormal in interface X3DComposedGeometryNode

Parameters:

newValue - is new value for the normal field.

Returns:

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

See Also:

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

clearNormal

public IndexedFaceSet clearNormal()

Utility method to clear SFNode value of normal field.

Returns:

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

setNormal

public IndexedFaceSet setNormal(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the normal field.

Returns:

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

See Also:

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

hasNormal

public boolean hasNormal()

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

Returns:

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

See Also:

• getNormal()
• getNormalProtoInstance()

getNormalIndex

public int[] getNormalIndex()

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

Tooltip: [-1,+infinity) normalIndex values define the order in which normal vectors are applied to polygons (or vertices).

• Warning: if normalIndex array is not provided, then Normal values are indexed according to the coordIndex field.
• Hint: If normalPerVertex='false' then one index is provided for each polygon defined by the coordIndex array. No sentinel -1 values are included.
• Hint: If normalPerVertex='true' then a matching set of indices is provided, each separated by sentinel -1, that exactly corresponds to individual values in the coordIndex array polygon definitions.
• Hint: if no child Normal node is provided, the X3D browser shall automatically generate normals, using creaseAngle to determine smoothed shading across shared vertices. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.

Specified by:

getNormalIndex in interface IndexedFaceSet

Returns:

value of normalIndex field

getNormalIndexList

public ArrayList<Integer> getNormalIndexList()

Utility method to get ArrayList value of MFInt32 normalIndex field, similar to getNormalIndex().

Returns:

value of normalIndex field

getNormalIndexString

public String getNormalIndexString()

Utility method to get String value of MFInt32 normalIndex field, similar to getNormalIndex().

Returns:

value of normalIndex field

setNormalIndex

public IndexedFaceSet setNormalIndex(int[] newValue)

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

Tooltip: [-1,+infinity) normalIndex values define the order in which normal vectors are applied to polygons (or vertices).

• Warning: if normalIndex array is not provided, then Normal values are indexed according to the coordIndex field.
• Hint: If normalPerVertex='false' then one index is provided for each polygon defined by the coordIndex array. No sentinel -1 values are included.
• Hint: If normalPerVertex='true' then a matching set of indices is provided, each separated by sentinel -1, that exactly corresponds to individual values in the coordIndex array polygon definitions.
• Hint: if no child Normal node is provided, the X3D browser shall automatically generate normals, using creaseAngle to determine smoothed shading across shared vertices. Interchange profile
• Hint: this field may be ignored, applying the default value regardless.

Specified by:

setNormalIndex in interface IndexedFaceSet

Parameters:

newValue - is new value for the normalIndex field.

Returns:

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

setNormalIndex

public IndexedFaceSet setNormalIndex(MFInt32 newValue)

Assign typed object value to MFInt32 normalIndex field, similar to setNormalIndex(int[]).

Parameters:

newValue - is new value for the normalIndex field.

Returns:

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

setNormalIndex

public IndexedFaceSet setNormalIndex(ArrayList<Integer> newValue)

Assign ArrayList value of MFInt32 normalIndex field, similar to setNormalIndex(int[]).

Parameters:

newValue - is new value for the normalIndex field.

Returns:

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

clearNormalIndex

public IndexedFaceSet clearNormalIndex()

Utility method to clear MFInt32 value of normalIndex field. This method does not initialize withNORMALINDEX_DEFAULT_VALUE.

Returns:

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

addNormalIndex

public IndexedFaceSet addNormalIndex(int newValue)

Add singleton int value to MFInt32 normalIndex field.

Parameters:

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

Returns:

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

addNormalIndex

public IndexedFaceSet addNormalIndex(SFInt32 newValue)

Add singleton SFInt32 value to MFInt32 normalIndex field.

Parameters:

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

Returns:

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

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:

getNormalPerVertex in interface IndexedFaceSet

Specified by:

getNormalPerVertex in interface X3DComposedGeometryNode

Returns:

value of normalPerVertex field

setNormalPerVertex

public IndexedFaceSet setNormalPerVertex(boolean newValue)

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:

setNormalPerVertex in interface IndexedFaceSet

Specified by:

setNormalPerVertex in interface X3DComposedGeometryNode

Parameters:

newValue - is new value for the normalPerVertex field.

Returns:

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

setNormalPerVertex

public IndexedFaceSet setNormalPerVertex(SFBool newValue)

Assign typed object value to SFBool normalPerVertex field, similar to setNormalPerVertex(boolean).

Parameters:

newValue - is new value for the normalPerVertex field.

Returns:

IndexedFaceSet - 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.
• Hint: accessType relaxed to inputOutput in order to support animation and visualization.

Specified by:

getSolid in interface IndexedFaceSet

Specified by:

getSolid in interface X3DComposedGeometryNode

Returns:

value of solid field

setSolid

public IndexedFaceSet setSolid(boolean newValue)

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.
• Hint: accessType relaxed to inputOutput in order to support animation and visualization.

Specified by:

setSolid in interface IndexedFaceSet

Specified by:

setSolid in interface X3DComposedGeometryNode

Parameters:

newValue - is new value for the solid field.

Returns:

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

setSolid

public IndexedFaceSet setSolid(SFBool newValue)

Assign typed object value to SFBool solid field, similar to setSolid(boolean).

Parameters:

newValue - is new value for the solid field.

Returns:

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

getTexCoord

public X3DNode getTexCoord()

Provide org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) with acceptable node types limited to X3DSingleTextureCoordinateNode|MultiTextureCoordinate, from inputOutput SFNode field texCoord.

Specified by:

getTexCoord in interface IndexedFaceSet

Specified by:

getTexCoord in interface X3DComposedGeometryNode

Returns:

value of texCoord field

See Also:

• 
  
  Tooltip: [X3DTextureCoordinateNode] Single contained TextureCoordinate, TextureCoordinateGenerator or MultiTextureCoordinate node that can specify coordinates for texture mapping onto corresponding geometry. *
  

setTexCoord

public IndexedFaceSet setTexCoord(X3DNode newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DNode instance (using a properly typed node) to inputOutput SFNode field texCoord.

Specified by:

setTexCoord in interface IndexedFaceSet

Specified by:

setTexCoord in interface X3DComposedGeometryNode

Parameters:

newValue - is new value for the texCoord field.

Returns:

IndexedFaceSet - 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 can specify coordinates for texture mapping onto corresponding geometry. *
  

clearTexCoord

public IndexedFaceSet clearTexCoord()

Utility method to clear SFNode value of texCoord field.

Returns:

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

setTexCoord

public IndexedFaceSet setTexCoord(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the texCoord field.

Returns:

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

See Also:

• setTexCoord(org.web3d.x3d.sai.Core.X3DNode)

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

getTexCoordIndex

public int[] getTexCoordIndex()

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

Tooltip: [-1,+infinity) List of texture-coordinate indices mapping attached texture to corresponding coordinates.

• Hint: if texCoordIndex array is not provided, then TextureCoordinate values are indexed according to the coordIndex field.
• Hint: use a tool!.

Specified by:

getTexCoordIndex in interface IndexedFaceSet

Returns:

value of texCoordIndex field

getTexCoordIndexList

public ArrayList<Integer> getTexCoordIndexList()

Utility method to get ArrayList value of MFInt32 texCoordIndex field, similar to getTexCoordIndex().

Returns:

value of texCoordIndex field

getTexCoordIndexString

public String getTexCoordIndexString()

Utility method to get String value of MFInt32 texCoordIndex field, similar to getTexCoordIndex().

Returns:

value of texCoordIndex field

setTexCoordIndex

public IndexedFaceSet setTexCoordIndex(int[] newValue)

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

Tooltip: [-1,+infinity) List of texture-coordinate indices mapping attached texture to corresponding coordinates.

• Hint: if texCoordIndex array is not provided, then TextureCoordinate values are indexed according to the coordIndex field.
• Hint: use a tool!.

Specified by:

setTexCoordIndex in interface IndexedFaceSet

Parameters:

newValue - is new value for the texCoordIndex field.

Returns:

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

setTexCoordIndex

public IndexedFaceSet setTexCoordIndex(MFInt32 newValue)

Assign typed object value to MFInt32 texCoordIndex field, similar to setTexCoordIndex(int[]).

Parameters:

newValue - is new value for the texCoordIndex field.

Returns:

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

setTexCoordIndex

public IndexedFaceSet setTexCoordIndex(ArrayList<Integer> newValue)

Assign ArrayList value of MFInt32 texCoordIndex field, similar to setTexCoordIndex(int[]).

Parameters:

newValue - is new value for the texCoordIndex field.

Returns:

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

clearTexCoordIndex

public IndexedFaceSet clearTexCoordIndex()

Utility method to clear MFInt32 value of texCoordIndex field. This method does not initialize withTEXCOORDINDEX_DEFAULT_VALUE.

Returns:

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

addTexCoordIndex

public IndexedFaceSet addTexCoordIndex(int newValue)

Add singleton int value to MFInt32 texCoordIndex field.

Parameters:

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

Returns:

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

addTexCoordIndex

public IndexedFaceSet addTexCoordIndex(SFInt32 newValue)

Add singleton SFInt32 value to MFInt32 texCoordIndex field.

Parameters:

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

Returns:

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

getDEF

public String getDEF()

Provide String value from inputOutput SFString field named DEF.

Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

• Hint: descriptive DEF names improve clarity and help document a model.
• Hint: well-defined names can simplify design and debugging through improved author understanding.
• Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final IndexedFaceSet setDEF(String newValue)

Accessor method to assign String value to inputOutput SFString field named DEF.

Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

• Hint: descriptive DEF names improve clarity and help document a model.
• Hint: well-defined names can simplify design and debugging through improved author understanding.
• Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setDEF

public IndexedFaceSet setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Parameters:

newValue - is new value for the DEF field.

Returns:

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

getUSE

public String getUSE()

Provide String value from inputOutput SFString field named USE.

Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).

• Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
• Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
• Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.

Overrides:

getUSE in class X3DConcreteNode

Returns:

value of USE field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setUSE

public final IndexedFaceSet setUSE(String newValue)

Accessor method to assign String value to inputOutput SFString field named USE.

Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).

• Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
• Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
• Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.

Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.

Specified by:

setUSE in class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setUSE

public IndexedFaceSet setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Parameters:

newValue - is new value for the USE field.

Returns:

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

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final IndexedFaceSet setCssClass(String newValue)

Accessor method to assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public IndexedFaceSet setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

Parameters:

newValue - is new value for the class field.

Returns:

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

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final IndexedFaceSet setHtmlID(String newValue)

Accessor method to assign String value to inputOutput SFString field named id.

Specified by:

setHtmlID in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public IndexedFaceSet setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Parameters:

newValue - is new value for the id field.

Returns:

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

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final IndexedFaceSet setCssStyle(String newValue)

Accessor method to assign String value to inputOutput SFString field named style.

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public IndexedFaceSet setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

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

setUSE

public IndexedFaceSet setUSE(IndexedFaceSet DEFnode)

Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.

Parameters:

DEFnode - must have a DEF value defined

Returns:

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

addComments

public IndexedFaceSet addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public IndexedFaceSet addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public IndexedFaceSet addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

toStringX3D

public String toStringX3D(int indentLevel)

Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D.toStringXML()
• X3D.toFileXML(String)
• X3D.toFileX3D(String)
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

public String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

Specified by:

toStringClassicVRML in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

ClassicVRML string

See Also:

• X3D.FILE_EXTENSION_CLASSICVRML
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Extensible 3D (X3D) encodings Part 2: Classic VRML encoding
• Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

toStringVRML97

public String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

• X3D.FILE_EXTENSION_VRML97
• X3D Resources: Virtual Reality Modeling Language (VRML) 97
• Virtual Reality Modeling Language (VRML) 97 specification
• VRML 97 v2.1 Amendment

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found element, null otherwise

See Also:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue,
 String elementName)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

object reference to found element, null otherwise

See Also:

• findNodeByDEF(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasElementByNameValue

public boolean hasElementByNameValue(String nameValue,
 String elementName)

Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

whether node is found

See Also:

• findElementByNameValue(String, String)

findNodeByDEF

public X3DConcreteNode findNodeByDEF(String DEFvalue)

Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

Warning: more than one element may be found that has the same DEF, this method does not handle that case.

Specified by:

findNodeByDEF in class X3DConcreteElement

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found node, null otherwise

See Also:

• findElementByNameValue(String)
• X3DConcreteElement.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasNodeByDEF

public boolean hasNodeByDEF(String DEFvalue)

Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

whether node is found

See Also:

• findNodeByDEF(String)

validate

public String validate()

Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)

getCoordCount

public int getCoordCount()

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

Returns:

number of coordinate 3-tuple values

See Also:

• Coordinate
• CoordinateDouble
• ProtoInstance

getColorCount

public int getColorCount()

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

Returns:

number of color values

See Also:

• Color
• ColorRGBA
• ProtoInstance

getNormalCount

public int getNormalCount()

Utility method to get number of 3-tuple normal vectors in contained Normal or ProtoInstance node

Returns:

number of color values

See Also:

• Normal
• ProtoInstance

getTexCoordCount

public int getTexCoordCount()

Utility method to get number of 2-tuple texture coordinate values in contained TextureCoordinate or ProtoInstance node

Returns:

number of color values

See Also:

• TextureCoordinate
• MultiTextureCoordinate
• ProtoInstance