Package org.web3d.x3d.jsail.Text

Class Text

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Text.Text

All Implemented Interfaces:

X3DNode, X3DGeometryNode, Text

public class Text
extends X3DConcreteNode
implements Text

Text is a 2D (flat) geometry node that can contain multiple lines of string values.

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. Text node tooltip: [X3DGeometryNode] Text is a 2D (flat) geometry node that can contain multiple lines of string values. Layout and styling is controlled by a contained FontStyle node.

• Hint: String (computer science) https://en.wikipedia.org/wiki/String_(computer_science)
• Hint: full internationalization (i18n) and localization (l10n) features are available for any written language.
• Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n
• 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: Text node requires X3D profile='Immersive' or <component name='Text' level='1'/>

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: Text
• X3D Tooltips: Text
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the Text element: Text
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final X3DFontStyleNode	FONTSTYLE_DEFAULT_VALUE	SFNode field named fontStyle has default value null (Java syntax) or NULL (XML syntax).
static final String	fromField_FONTSTYLE	fromField ROUTE name for SFNode field named fontStyle.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_LENGTH	fromField ROUTE name for MFFloat field named length.
static final String	fromField_LINEBOUNDS	fromField ROUTE name for MFVec2f field named lineBounds.
static final String	fromField_MAXEXTENT	fromField ROUTE name for SFFloat field named maxExtent.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_ORIGIN	fromField ROUTE name for SFVec3f field named origin.
static final String	fromField_STRING	fromField ROUTE name for MFString field named string.
static final String	fromField_TEXTBOUNDS	fromField ROUTE name for SFVec2f field named textBounds.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final ArrayList<Float>	LENGTH_DEFAULT_VALUE	MFFloat field named length has default value equal to an empty list.
static final int	LEVEL	Integer constant LEVEL provides default X3D Text component level for this element: 1
static final float	MAXEXTENT_DEFAULT_VALUE	SFFloat field named maxExtent has default value 0.0f (Java syntax) or 0.0 (XML syntax).
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: Text.
static final boolean	SOLID_DEFAULT_VALUE	SFBool field named solid has default value false (Java syntax) or false (XML syntax).
static final ArrayList<String>	STRING_DEFAULT_VALUE	MFString field named string has default value equal to an empty list.
static final String	toField_FONTSTYLE	toField ROUTE name for SFNode field named fontStyle.
static final String	toField_LENGTH	toField ROUTE name for MFFloat field named length.
static final String	toField_MAXEXTENT	toField ROUTE name for SFFloat field named maxExtent.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_STRING	toField ROUTE name for MFString field named string.

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
Text()	Constructor for Text to initialize member variables with default values.
Text(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
Text	addComments(String newComment)	Add comment as String to contained commentsList.
Text	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
Text	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
Text	addLength(float newValue)	Add singleton float value to MFFloat length field.
Text	addLength(SFFloat newValue)	Add singleton SFFloat value to MFFloat length field.
Text	addString(String newValue)	Add singleton String value to MFString string field.
Text	addString(SFString newValue)	Add singleton SFString value to MFString string field.
Text	clearFontStyle()	Utility method to clear SFNode value of fontStyle field.
Text	clearIS()	Utility method to clear SFNode value of IS field.
Text	clearLength()	Utility method to clear MFFloat value of length field.
Text	clearMetadata()	Utility method to clear SFNode value of metadata field.
Text	clearString()	Utility method to clear MFString value of string 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.
final String	getComponent()	Defines X3D component for the Text element: Text
final int	getComponentLevel()	Provides default X3D component level for this element: 1
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
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: Text
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
X3DFontStyleNode	getFontStyle()	Provide org.web3d.x3d.sai.Text.X3DFontStyleNode instance (using a properly typed node) from inputOutput SFNode field fontStyle.
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.
float[]	getLength()	Provide array of Float results within allowed range of [0,infinity) from inputOutput MFFloat field named length.
ArrayList<Float>	getLengthList()	Utility method to get ArrayList value of MFFloat length field, similar to getLength().
String	getLengthString()	Utility method to get String value of MFFloat length field, similar to getLength().
float[]	getLineBounds()	Provide array of 2-tuple float results from outputOnly MFVec2f field named lineBounds.
float	getMaxExtent()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named maxExtent.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float[]	getOrigin()	Provide array of 3-tuple float results from outputOnly SFVec3f field named origin.
boolean	getSolid()	Provide boolean value from initializeOnly SFBool field named solid.
String[]	getString()	Provide array of String results from inputOutput MFString field named string.
ArrayList<String>	getStringList()	Utility method to get ArrayList value of MFString string field, similar to getString().
String	getStringString()	Utility method to get String value of MFString string field, similar to getString().
float[]	getTextBounds()	Provide array of 2-tuple float results from outputOnly SFVec2f field named textBounds.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
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	hasFontStyle()	Indicate whether an object is available for inputOutput SFNode field fontStyle.
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.
final void	initialize()	Initialize all member variables to default values.
final Text	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
Text	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final Text	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
Text	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final Text	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
Text	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
Text	setFontStyle(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field fontStyle.
Text	setFontStyle(X3DFontStyleNode newValue)	Accessor method to assign org.web3d.x3d.sai.Text.X3DFontStyleNode instance (using a properly typed node) to inputOutput SFNode field fontStyle.
final Text	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
Text	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
Text	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
Text	setLength(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setLength(float[]).
Text	setLength(float[] newValue)	Accessor method to assign Float array to inputOutput MFFloat field named length.
Text	setLength(int[] newValue)	Assign floating-point array value of MFFloat length field, similar to setLength(float[]).
Text	setLength(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat length field, similar to setLength(float[]).
Text	setLength(MFFloat newValue)	Assign typed object value to MFFloat length field, similar to setLength(float[]).
Text	setMaxExtent(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setMaxExtent(float).
Text	setMaxExtent(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named maxExtent.
Text	setMaxExtent(SFFloat newValue)	Assign typed object value to SFFloat maxExtent field, similar to setMaxExtent(float).
Text	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
Text	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Text	setSolid(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named solid.
Text	setSolid(SFBool newValue)	Assign typed object value to SFBool solid field, similar to setSolid(boolean).
Text	setString(String newValue)	Assign singleton String value to MFString string field, similar to setString(String[]).
Text	setString(String[] newValue)	Accessor method to assign String array to inputOutput MFString field named string.
Text	setString(ArrayList<String> newValue)	Assign ArrayList value of MFString string field, similar to setString(String[]).
Text	setString(MFString newValue)	Assign typed object value to MFString string field, similar to setString(String[]).
Text	setString(SFString newValue)	Assign single SFString object value to MFString string field, similar to setString(String[]).
final Text	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
Text	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
Text	setUSE(Text 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: Text.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the Text element: Text

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D Text component level for this element: 1

See Also:

• Constant Field Values

FONTSTYLE_DEFAULT_VALUE

public static final X3DFontStyleNode FONTSTYLE_DEFAULT_VALUE

SFNode field named fontStyle 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).

LENGTH_DEFAULT_VALUE

public static final ArrayList<Float> LENGTH_DEFAULT_VALUE

MFFloat field named length has default value equal to an empty list.

MAXEXTENT_DEFAULT_VALUE

public static final float MAXEXTENT_DEFAULT_VALUE

SFFloat field named maxExtent has default value 0.0f (Java syntax) or 0.0 (XML syntax).

See Also:

• Constant Field Values

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

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

SOLID_DEFAULT_VALUE

public static final boolean SOLID_DEFAULT_VALUE

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

See Also:

• Constant Field Values

STRING_DEFAULT_VALUE

public static final ArrayList<String> STRING_DEFAULT_VALUE

MFString field named string 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" }; 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_FONTSTYLE

public static final String fromField_FONTSTYLE

fromField ROUTE name for SFNode field named fontStyle.

See Also:

• Constant Field Values

toField_FONTSTYLE

public static final String toField_FONTSTYLE

toField ROUTE name for SFNode field named fontStyle.

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_LENGTH

public static final String fromField_LENGTH

fromField ROUTE name for MFFloat field named length.

See Also:

• Constant Field Values

toField_LENGTH

public static final String toField_LENGTH

toField ROUTE name for MFFloat field named length.

See Also:

• Constant Field Values

fromField_LINEBOUNDS

public static final String fromField_LINEBOUNDS

fromField ROUTE name for MFVec2f field named lineBounds.

See Also:

• Constant Field Values

fromField_MAXEXTENT

public static final String fromField_MAXEXTENT

fromField ROUTE name for SFFloat field named maxExtent.

See Also:

• Constant Field Values

toField_MAXEXTENT

public static final String toField_MAXEXTENT

toField ROUTE name for SFFloat field named maxExtent.

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_ORIGIN

public static final String fromField_ORIGIN

fromField ROUTE name for SFVec3f field named origin.

See Also:

• Constant Field Values

fromField_STRING

public static final String fromField_STRING

fromField ROUTE name for MFString field named string.

See Also:

• Constant Field Values

toField_STRING

public static final String toField_STRING

toField ROUTE name for MFString field named string.

See Also:

• Constant Field Values

fromField_TEXTBOUNDS

public static final String fromField_TEXTBOUNDS

fromField ROUTE name for SFVec2f field named textBounds.

See Also:

• Constant Field Values

Constructor Details

Text

public Text()

Constructor for Text to initialize member variables with default values.

Text

public Text(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: Text

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the Text element: Text

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

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

getFontStyle

public X3DFontStyleNode getFontStyle()

Provide org.web3d.x3d.sai.Text.X3DFontStyleNode instance (using a properly typed node) from inputOutput SFNode field fontStyle.

Specified by:

getFontStyle in interface Text

Returns:

value of fontStyle field

See Also:

• 
  
  Tooltip: [X3DFontStyleNode] The fontStyle field can contain a FontStyle or ScreenFontStyle node defining size, family, and style for presented text.
  • Hint: Wikipedia https://en.wikipedia.org/wiki/Font

setFontStyle

public Text setFontStyle(X3DFontStyleNode newValue)

Accessor method to assign org.web3d.x3d.sai.Text.X3DFontStyleNode instance (using a properly typed node) to inputOutput SFNode field fontStyle.

Specified by:

setFontStyle in interface Text

Parameters:

newValue - is new value for the fontStyle field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DFontStyleNode] The fontStyle field can contain a FontStyle or ScreenFontStyle node defining size, family, and style for presented text.
  • Hint: Wikipedia https://en.wikipedia.org/wiki/Font

clearFontStyle

public Text clearFontStyle()

Utility method to clear SFNode value of fontStyle field.

Returns:

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

setFontStyle

public Text setFontStyle(ProtoInstance newValue)

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

Parameters:

newValue - is new value for the fontStyle field.

Returns:

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

See Also:

• setFontStyle(org.web3d.x3d.sai.Text.X3DFontStyleNode)

hasFontStyle

public boolean hasFontStyle()

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

Returns:

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

See Also:

• getFontStyle()
• getFontStyleProtoInstance()

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

getLength

public float[] getLength()

Provide array of Float results within allowed range of [0,infinity) from inputOutput MFFloat field named length.

Tooltip: Array of length values for each text string in the local coordinate system. Each string is stretched or compressed to fit. *

Specified by:

getLength in interface Text

Returns:

value of length field

getLengthList

public ArrayList<Float> getLengthList()

Utility method to get ArrayList value of MFFloat length field, similar to getLength().

Returns:

value of length field

getLengthString

public String getLengthString()

Utility method to get String value of MFFloat length field, similar to getLength().

Returns:

value of length field

setLength

public Text setLength(float[] newValue)

Accessor method to assign Float array to inputOutput MFFloat field named length.

Tooltip: Array of length values for each text string in the local coordinate system. Each string is stretched or compressed to fit. *

Specified by:

setLength in interface Text

Parameters:

newValue - is new value for the length field.

Returns:

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

setLength

public Text setLength(MFFloat newValue)

Assign typed object value to MFFloat length field, similar to setLength(float[]).

Parameters:

newValue - is new value for the length field.

Returns:

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

setLength

public Text setLength(ArrayList<Float> newValue)

Assign ArrayList value of MFFloat length field, similar to setLength(float[]).

Parameters:

newValue - is new value for the length field.

Returns:

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

clearLength

public Text clearLength()

Utility method to clear MFFloat value of length field. This method does not initialize withLENGTH_DEFAULT_VALUE.

Returns:

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

setLength

public Text setLength(int[] newValue)

Assign floating-point array value of MFFloat length field, similar to setLength(float[]).

Parameters:

newValue - is new value for the length field.

Returns:

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

addLength

public Text addLength(float newValue)

Add singleton float value to MFFloat length field.

Parameters:

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

Returns:

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

addLength

public Text addLength(SFFloat newValue)

Add singleton SFFloat value to MFFloat length field.

Parameters:

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

Returns:

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

setLength

public Text setLength(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setLength(float[]).

Parameters:

newArray - is new value for field

Returns:

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

getLineBounds

public float[] getLineBounds()

Provide array of 2-tuple float results from outputOnly MFVec2f field named lineBounds.

Tooltip: Array of 2D bounding box values for each line of text in the local coordinate system.

• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

Specified by:

getLineBounds in interface Text

Returns:

value of lineBounds field

getMaxExtent

public float getMaxExtent()

Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named maxExtent.

Tooltip: Limits/compresses all text strings if max string length is longer than maxExtent, as measured in local coordinate system. *

Specified by:

getMaxExtent in interface Text

Returns:

value of maxExtent field

setMaxExtent

public Text setMaxExtent(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named maxExtent.

Tooltip: Limits/compresses all text strings if max string length is longer than maxExtent, as measured in local coordinate system. *

Specified by:

setMaxExtent in interface Text

Parameters:

newValue - is new value for the maxExtent field.

Returns:

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

setMaxExtent

public Text setMaxExtent(SFFloat newValue)

Assign typed object value to SFFloat maxExtent field, similar to setMaxExtent(float).

Parameters:

newValue - is new value for the maxExtent field.

Returns:

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

setMaxExtent

public Text setMaxExtent(double newValue)

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

Parameters:

newValue - is new value for field

Returns:

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

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 Text

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

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:

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

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getOrigin

public float[] getOrigin()

Provide array of 3-tuple float results from outputOnly SFVec3f field named origin.

Tooltip: origin of the text local coordinate system, in units of the coordinate system in which the Text node is embedded. The value of the origin field represents the upper left corner of the textBounds.

• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

Specified by:

getOrigin in interface Text

Returns:

value of origin field

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.
• Warning: solid false not supported in VRML97.
• Hint: accessType relaxed to inputOutput in order to support animation and visualization.

Specified by:

getSolid in interface Text

Returns:

value of solid field

setSolid

public Text 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.
• Warning: solid false not supported in VRML97.
• Hint: accessType relaxed to inputOutput in order to support animation and visualization.

Specified by:

setSolid in interface Text

Parameters:

newValue - is new value for the solid field.

Returns:

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

setSolid

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

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

getString

public String[] getString()

Provide array of String results from inputOutput MFString field named string.

Tooltip: Single or multiple string values to present as Text. Each value in the string array (including empty strings) gets displayed on a separate line.

• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks.
• Hint: Strings can contain quote marks by first escaping them with a backslash example: "say \"hello\" please"
• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
• Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n Example: https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter02-GeometryPrimitives/TextIndex.html Example: https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter02-GeometryPrimitives/TextSpecialCharactersIndex.html

Specified by:

getString in interface Text

Returns:

value of string field

getStringList

public ArrayList<String> getStringList()

Utility method to get ArrayList value of MFString string field, similar to getString().

Returns:

value of string field

getStringString

public String getStringString()

Utility method to get String value of MFString string field, similar to getString().

Returns:

value of string field

setString

public Text setString(String[] newValue)

Accessor method to assign String array to inputOutput MFString field named string.

Tooltip: Single or multiple string values to present as Text. Each value in the string array (including empty strings) gets displayed on a separate line.

• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks.
• Hint: Strings can contain quote marks by first escaping them with a backslash example: "say \"hello\" please"
• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
• Hint: relates to Internationalization (i18n) http://www.w3.org/standards/webdesign/i18n Example: https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter02-GeometryPrimitives/TextIndex.html Example: https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter02-GeometryPrimitives/TextSpecialCharactersIndex.html

Specified by:

setString in interface Text

Parameters:

newValue - is new value for the string field.

Returns:

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

setString

public Text setString(MFString newValue)

Assign typed object value to MFString string field, similar to setString(String[]).

Parameters:

newValue - is new value for the string field.

Returns:

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

setString

public Text setString(SFString newValue)

Assign single SFString object value to MFString string field, similar to setString(String[]).

Parameters:

newValue - is new value for the string field.

Returns:

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

setString

public Text setString(String newValue)

Assign singleton String value to MFString string field, similar to setString(String[]).

Parameters:

newValue - is new value for the string field.

Returns:

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

setString

public Text setString(ArrayList<String> newValue)

Assign ArrayList value of MFString string field, similar to setString(String[]).

Parameters:

newValue - is new value for the string field.

Returns:

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

clearString

public Text clearString()

Utility method to clear MFString value of string field. This method does not initialize withSTRING_DEFAULT_VALUE.

Returns:

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

addString

public Text addString(String newValue)

Add singleton String value to MFString string field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

addString

public Text addString(SFString newValue)

Add singleton SFString value to MFString string field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

getTextBounds

public float[] getTextBounds()

Provide array of 2-tuple float results from outputOnly SFVec2f field named textBounds.

Tooltip: 2D bounding box value for all lines of text in the local coordinate system.

• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

Specified by:

getTextBounds in interface Text

Returns:

value of textBounds field

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

public Text setUSE(Text 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:

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

addComments

public Text addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

Text - 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 Text addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public Text addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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