Package org.web3d.x3d.jsail.Core

Class component

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteStatement

org.web3d.x3d.jsail.Core.component

public class component
extends X3DConcreteStatement

Functional summary: each added component statement indicates needed scene functionality support above the given X3D profile. This concrete class represents an X3D component statement.

component statement tooltip: Each added component statement indicates needed scene functionality above the given X3D profile.

• Hint: component statements are optional secondary children of head statement (add a head statement first).
• Hint: X3D XML Encoding https://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/concepts.html#Header
• Warning: the COMPONENT statement is capitalized in the X3D Architecture specification and in the X3D ClassicVRML Encoding.
• Hint: X3D Architecture 7.2.5.4 COMPONENT statement https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#COMPONENTStatement

See Also:

• X3D Abstract Specification: component
• X3D Tooltips: component
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the component element: Core
static final int	LEVEL	Integer constant LEVEL provides default X3D Core component level for this element: 1
static final int	LEVEL_DEFAULT_VALUE	SFInt32 field named level has default value 1 (Java syntax) or 1 (XML syntax).
static final String	NAME	String constant NAME provides name of this element: component.
static final String	NAME_CADGEOMETRY	Tooltip: The CADGeometry component is provided for Computer-Aided Design (CAD) nodes.
static final String	NAME_CORE	Tooltip: The Core component supplies the base functionality for the X3D run-time system, including the abstract base node type, field types, the event model, and routing.
static final String	NAME_CUBEMAPTEXTURING	Tooltip: The Cube Map Environmental Texturing component describes how additional texturing effects are defined to produce environmental effects such as reflections from objects.
static final String	NAME_DEFAULT_VALUE	SFString field named name has default value equal to an empty string.
static final String	NAME_DIS	Tooltip: The Distributed Interactive Simulation (DIS) component provides networked interoperability with the IEEE DIS protocol for sharing state and conducting real-time platform-level simulations across multiple host computers.
static final String	NAME_ENVIRONMENTALEFFECTS	Tooltip: Nodes in the Environmental effects component support the creation of realistic environmental effects such as panoramic backgrounds and fog.
static final String	NAME_ENVIRONMENTALSENSOR	Tooltip: The Environment Sensor nodes emit events indicating activity in the scene environment, usually based on interactions between the viewer and the world.
static final String	NAME_EVENTUTILITIES	Tooltip: The Event Utility nodes provide the capability to filter, trigger, convert, or sequence numerous event-types for common interactive applications without the use of a Script node.
static final String	NAME_FOLLOWERS	Tooltip: The Follower nodes (Chasers and Dampers) support dynamic creation of smooth parameter transitions at run time.
static final String	NAME_GEOMETRY2D	Tooltip: The Geometry2D component defines how two-dimensional geometry is specified and what shapes are available.
static final String	NAME_GEOMETRY3D	Tooltip: The Geometry3D component describes how three-dimensional geometry is specified and defines ElevationGrid, Extrusion, IndexedFaceSet, and most primitive geometry nodes (Box, Cone, Cylinder, Sphere).
static final String	NAME_GEOSPATIAL	Tooltip: The Geospatial component defines how to associate real-world locations in an X3D scene and specifies nodes particularly tuned for geospatial applications.
static final String	NAME_GROUPING	Tooltip: The Grouping component describes how nodes are organized into groups to establish a transformation hierarchy for the X3D scene graph.
static final String	NAME_H_ANIM	Tooltip: Legacy enumeration H-Anim for X3D versions 3.0-3.3 provides backwards compatibility with Humanoid Animation (HAnim) version 1, preferred form of enumeration value is HAnim.
static final String	NAME_HANIM	Tooltip: The Humanoid Animation (HAnim) component for X3D defines node bindings and other details for implementing ISO/IEC 19774, the HAnim International Specification.
static final String	NAME_INTERPOLATION	Tooltip: Interpolator nodes provide keyframe-based animation capability.
static final String	NAME_KEYDEVICESENSOR	Tooltip: The Key Device Sensor defines how keyboard keystrokes are inserted into an X3D world.
static final String	NAME_LAYERING	Tooltip: The Layering component describes how to layer a set of subscene layers into a composite scene.
static final String	NAME_LAYOUT	Tooltip: The Layout component defines how to precisely position content in a scene in relation to the rendered results, especially for integrating 2D content with 3D content.
static final String	NAME_LIGHTING	Tooltip: The Lighting component specifies how light sources are defined and positioned, as well as how lights effect the rendered image.
static final String	NAME_NAVIGATION	Tooltip: The Navigation component specifies how a user can effectively and intuitively move through and around a 3D scene.
static final String	NAME_NETWORKING	Tooltip: The Networking component defines node types and other features used to access file-based and streaming resources on the World Wide Web.
static final String	NAME_NURBS	Tooltip: The NURBS component describes Non-uniform Rational B-Spline (NURBS) geometry and interpolation nodes.
static final String	NAME_PARTICLESYSTEMS	Tooltip: The Particle Systems component specifies how to model particles and their interactions through the application of basic physics principles to affect motion.
static final String	NAME_PICKING	Tooltip: The Picking component provides the ability to test for arbitrary object collision and provide basic capabilities to detecting object intersections and interactions.
static final String	NAME_POINTINGDEVICESENSOR	Tooltip: Pointing device sensor nodes detect pointing events from user-interface devices, defining activities such as a user selecting a piece of geometry.
static final String	NAME_RENDERING	Tooltip: The Rendering component includes fundamental rendering primitives such as TriangleSet and PointSet nodes, as well as geometric properties nodes that define how coordinate indices, colors, normals and texture coordinates are specified.
static final String	NAME_RIGIDBODYPHYSICS	Tooltip: The Rigid Body Physics component describes how to model rigid bodies and their interactions through the application of basic physics principles to effect motion.
static final String	NAME_SCRIPTING	Tooltip: The Scripting component describes how Script nodes are used to effect changes in X3D worlds.
static final String	NAME_SHADERS	Tooltip: The Programmable Shaders component describes how programmable shaders are specified and how they affect the visual appearance of geometry.
static final String	NAME_SHAPE	Tooltip: The Shape component defines nodes for associating geometry with their visible properties and the scene environment.
static final String	NAME_SOUND	Tooltip: The Sound component defines how sound is delivered to an X3D world as well as how sounds are accessed.
static final String	NAME_TEXT	Tooltip: The Text component defines how text strings are rendered in an X3D scene.
static final String	NAME_TEXTUREPROJECTION	Tooltip: TextureProjection nodes project texture images onto geometry in a scene.
static final String	NAME_TEXTURING	Tooltip: The Texturing component specifies how 2D texture images are defined and then positioned on associated geometry.
static final String	NAME_TEXTURING3D	Tooltip: The Texturing3D component specifies how 3D volumetric textures describe surface properties as data points in a volume of space, rather than a flat surface.
static final String	NAME_TIME	Tooltip: The Time component defines how time is sensed, computed and associated with events in an X3D scene.
static final String	NAME_VOLUMERENDERING	Tooltip: The Volume Rendering component provides the ability to specify and render volumetric data sets.

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

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
component()	Constructor for component to initialize member variables with default values.
component(String newName, int newLevel)	Utility constructor that assigns name and level attributes.

Method Summary

Modifier and Type	Method	Description
component	addComments(String newComment)	Add comment as String to contained commentsList.
component	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
component	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
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 component element: Core
final int	getComponentLevel()	Provides default X3D component level for this element: 1
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
final String	getElementName()	Provides name of this element: component
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
int	getLevel()	Provide int value within allowed range of [1,5] from inputOutput SFInt32 field named level.
String	getName()	Provide String enumeration value (baseType xs:NMTOKEN) ["Core" | "CADGeometry" | "CubeMapTexturing" | "DIS" | "EnvironmentalEffects" | "EnvironmentalSensor" | "EventUtilities" | "Followers" | "Geometry2D" | "Geometry3D" | "Geospatial" | "Grouping" | "HAnim" | "H-Anim" | "Interpolation" | "KeyDeviceSensor" | "Layering" | "Layout" | "Lighting" | "Navigation" | "Networking" | "NURBS" | "ParticleSystems" | "Picking" | "PointingDeviceSensor" | "TextureProjection" | "Rendering" | "RigidBodyPhysics" | "Scripting" | "Shaders" | "Shape" | "Sound" | "Text" | "Texturing" | "Texturing3D" | "Time" | "VolumeRendering"] from inputOutput SFString field named name.
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	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 component	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
component	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final component	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
component	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final component	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
component	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
component	setLevel(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named level.
component	setLevel(SFInt32 newValue)	Assign typed object value to SFInt32 level field, similar to setLevel(int).
final component	setName(String newValue)	Accessor method to assign String enumeration value ("Core" | "CADGeometry" | "CubeMapTexturing" | "DIS" | "EnvironmentalEffects" | "EnvironmentalSensor" | "EventUtilities" | "Followers" | "Geometry2D" | "Geometry3D" | "Geospatial" | "Grouping" | "HAnim" | "H-Anim" | "Interpolation" | "KeyDeviceSensor" | "Layering" | "Layout" | "Lighting" | "Navigation" | "Networking" | "NURBS" | "ParticleSystems" | "Picking" | "PointingDeviceSensor" | "TextureProjection" | "Rendering" | "RigidBodyPhysics" | "Scripting" | "Shaders" | "Shape" | "Sound" | "Text" | "Texturing" | "Texturing3D" | "Time" | "VolumeRendering") to inputOutput SFString field named name.
component	setName(SFString newValue)	Assign typed object value to SFString name field, similar to setName(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.X3DConcreteStatement

isNode, isStatement

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_CORE

public static final String NAME_CORE

Tooltip: The Core component supplies the base functionality for the X3D run-time system, including the abstract base node type, field types, the event model, and routing. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Core" (Java syntax) or Core (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html
• Constant Field Values

NAME_CADGEOMETRY

public static final String NAME_CADGEOMETRY

Tooltip: The CADGeometry component is provided for Computer-Aided Design (CAD) nodes. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "CADGeometry" (Java syntax) or CADGeometry (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/CADGeometry.html
• Constant Field Values

NAME_CUBEMAPTEXTURING

public static final String NAME_CUBEMAPTEXTURING

Tooltip: The Cube Map Environmental Texturing component describes how additional texturing effects are defined to produce environmental effects such as reflections from objects. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "CubeMapTexturing" (Java syntax) or CubeMapTexturing (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/environmentalTexturing
• Constant Field Values

NAME_DIS

public static final String NAME_DIS

Tooltip: The Distributed Interactive Simulation (DIS) component provides networked interoperability with the IEEE DIS protocol for sharing state and conducting real-time platform-level simulations across multiple host computers. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "DIS" (Java syntax) or DIS (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/dis.html
• Constant Field Values

NAME_ENVIRONMENTALEFFECTS

public static final String NAME_ENVIRONMENTALEFFECTS

Tooltip: Nodes in the Environmental effects component support the creation of realistic environmental effects such as panoramic backgrounds and fog. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "EnvironmentalEffects" (Java syntax) or EnvironmentalEffects (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/environmentalEffects.html
• Constant Field Values

NAME_ENVIRONMENTALSENSOR

public static final String NAME_ENVIRONMENTALSENSOR

Tooltip: The Environment Sensor nodes emit events indicating activity in the scene environment, usually based on interactions between the viewer and the world. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "EnvironmentalSensor" (Java syntax) or EnvironmentalSensor (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/environmentalSensor.html
• Constant Field Values

NAME_EVENTUTILITIES

public static final String NAME_EVENTUTILITIES

Tooltip: The Event Utility nodes provide the capability to filter, trigger, convert, or sequence numerous event-types for common interactive applications without the use of a Script node. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "EventUtilities" (Java syntax) or EventUtilities (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/eventUtilities.html
• Constant Field Values

NAME_FOLLOWERS

public static final String NAME_FOLLOWERS

Tooltip: The Follower nodes (Chasers and Dampers) support dynamic creation of smooth parameter transitions at run time. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Followers" (Java syntax) or Followers (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/followers.html
• Constant Field Values

NAME_GEOMETRY2D

public static final String NAME_GEOMETRY2D

Tooltip: The Geometry2D component defines how two-dimensional geometry is specified and what shapes are available. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Geometry2D" (Java syntax) or Geometry2D (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geometry2D.html
• Constant Field Values

NAME_GEOMETRY3D

public static final String NAME_GEOMETRY3D

Tooltip: The Geometry3D component describes how three-dimensional geometry is specified and defines ElevationGrid, Extrusion, IndexedFaceSet, and most primitive geometry nodes (Box, Cone, Cylinder, Sphere). SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Geometry3D" (Java syntax) or Geometry3D (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geometry3D.html
• Constant Field Values

NAME_GEOSPATIAL

public static final String NAME_GEOSPATIAL

Tooltip: The Geospatial component defines how to associate real-world locations in an X3D scene and specifies nodes particularly tuned for geospatial applications. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Geospatial" (Java syntax) or Geospatial (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html
• Constant Field Values

NAME_GROUPING

public static final String NAME_GROUPING

Tooltip: The Grouping component describes how nodes are organized into groups to establish a transformation hierarchy for the X3D scene graph. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Grouping" (Java syntax) or Grouping (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html
• Constant Field Values

NAME_HANIM

public static final String NAME_HANIM

Tooltip: The Humanoid Animation (HAnim) component for X3D defines node bindings and other details for implementing ISO/IEC 19774, the HAnim International Specification. Original name was H-Anim for X3D versions 3.0 through 3.3, both enumeration values HAnim and H-Anim are allowed to pass validation. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "HAnim" (Java syntax) or HAnim (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/hanim.html
• Constant Field Values

NAME_H_ANIM

public static final String NAME_H_ANIM

Tooltip: Legacy enumeration H-Anim for X3D versions 3.0-3.3 provides backwards compatibility with Humanoid Animation (HAnim) version 1, preferred form of enumeration value is HAnim. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "H-Anim" (Java syntax) or H-Anim (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/hanim.html
• Constant Field Values

NAME_INTERPOLATION

public static final String NAME_INTERPOLATION

Tooltip: Interpolator nodes provide keyframe-based animation capability. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Interpolation" (Java syntax) or Interpolation (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/interpolators.html
• Constant Field Values

NAME_KEYDEVICESENSOR

public static final String NAME_KEYDEVICESENSOR

Tooltip: The Key Device Sensor defines how keyboard keystrokes are inserted into an X3D world. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "KeyDeviceSensor" (Java syntax) or KeyDeviceSensor (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/keyDeviceSensor.html
• Constant Field Values

NAME_LAYERING

public static final String NAME_LAYERING

Tooltip: The Layering component describes how to layer a set of subscene layers into a composite scene. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Layering" (Java syntax) or Layering (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/layering.html
• Constant Field Values

NAME_LAYOUT

public static final String NAME_LAYOUT

Tooltip: The Layout component defines how to precisely position content in a scene in relation to the rendered results, especially for integrating 2D content with 3D content. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Layout" (Java syntax) or Layout (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/layout.html
• Constant Field Values

NAME_LIGHTING

public static final String NAME_LIGHTING

Tooltip: The Lighting component specifies how light sources are defined and positioned, as well as how lights effect the rendered image. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Lighting" (Java syntax) or Lighting (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/lighting.html
• Constant Field Values

NAME_NAVIGATION

public static final String NAME_NAVIGATION

Tooltip: The Navigation component specifies how a user can effectively and intuitively move through and around a 3D scene. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Navigation" (Java syntax) or Navigation (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/navigation.html
• Constant Field Values

NAME_NETWORKING

public static final String NAME_NETWORKING

Tooltip: The Networking component defines node types and other features used to access file-based and streaming resources on the World Wide Web. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Networking" (Java syntax) or Networking (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/networking.html
• Constant Field Values

NAME_NURBS

public static final String NAME_NURBS

Tooltip: The NURBS component describes Non-uniform Rational B-Spline (NURBS) geometry and interpolation nodes. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "NURBS" (Java syntax) or NURBS (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/nurbs.html
• Constant Field Values

NAME_PARTICLESYSTEMS

public static final String NAME_PARTICLESYSTEMS

Tooltip: The Particle Systems component specifies how to model particles and their interactions through the application of basic physics principles to affect motion. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "ParticleSystems" (Java syntax) or ParticleSystems (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/particleSystems.html
• Constant Field Values

NAME_PICKING

public static final String NAME_PICKING

Tooltip: The Picking component provides the ability to test for arbitrary object collision and provide basic capabilities to detecting object intersections and interactions. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Picking" (Java syntax) or Picking (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/picking.html
• Constant Field Values

NAME_POINTINGDEVICESENSOR

public static final String NAME_POINTINGDEVICESENSOR

Tooltip: Pointing device sensor nodes detect pointing events from user-interface devices, defining activities such as a user selecting a piece of geometry. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "PointingDeviceSensor" (Java syntax) or PointingDeviceSensor (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/pointingDeviceSensor.html
• Constant Field Values

NAME_TEXTUREPROJECTION

public static final String NAME_TEXTUREPROJECTION

Tooltip: TextureProjection nodes project texture images onto geometry in a scene. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "TextureProjection" (Java syntax) or TextureProjection (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/textureProjector.html
• Constant Field Values

NAME_RENDERING

public static final String NAME_RENDERING

Tooltip: The Rendering component includes fundamental rendering primitives such as TriangleSet and PointSet nodes, as well as geometric properties nodes that define how coordinate indices, colors, normals and texture coordinates are specified. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Rendering" (Java syntax) or Rendering (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/rendering.html
• Constant Field Values

NAME_RIGIDBODYPHYSICS

public static final String NAME_RIGIDBODYPHYSICS

Tooltip: The Rigid Body Physics component describes how to model rigid bodies and their interactions through the application of basic physics principles to effect motion. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "RigidBodyPhysics" (Java syntax) or RigidBodyPhysics (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/rigidBodyPhysics.html
• Constant Field Values

NAME_SCRIPTING

public static final String NAME_SCRIPTING

Tooltip: The Scripting component describes how Script nodes are used to effect changes in X3D worlds. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Scripting" (Java syntax) or Scripting (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/scripting.html
• Constant Field Values

NAME_SHADERS

public static final String NAME_SHADERS

Tooltip: The Programmable Shaders component describes how programmable shaders are specified and how they affect the visual appearance of geometry. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Shaders" (Java syntax) or Shaders (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shaders.html
• Constant Field Values

NAME_SHAPE

public static final String NAME_SHAPE

Tooltip: The Shape component defines nodes for associating geometry with their visible properties and the scene environment. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Shape" (Java syntax) or Shape (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/shape.html
• Constant Field Values

NAME_SOUND

public static final String NAME_SOUND

Tooltip: The Sound component defines how sound is delivered to an X3D world as well as how sounds are accessed. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Sound" (Java syntax) or Sound (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/sound.html
• Constant Field Values

NAME_TEXT

public static final String NAME_TEXT

Tooltip: The Text component defines how text strings are rendered in an X3D scene. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Text" (Java syntax) or Text (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/text.html
• Constant Field Values

NAME_TEXTURING

public static final String NAME_TEXTURING

Tooltip: The Texturing component specifies how 2D texture images are defined and then positioned on associated geometry. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Texturing" (Java syntax) or Texturing (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html
• Constant Field Values

NAME_TEXTURING3D

public static final String NAME_TEXTURING3D

Tooltip: The Texturing3D component specifies how 3D volumetric textures describe surface properties as data points in a volume of space, rather than a flat surface. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Texturing3D" (Java syntax) or Texturing3D (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texture3D.html
• Constant Field Values

NAME_TIME

public static final String NAME_TIME

Tooltip: The Time component defines how time is sensed, computed and associated with events in an X3D scene. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "Time" (Java syntax) or Time (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/time.html
• Constant Field Values

NAME_VOLUMERENDERING

public static final String NAME_VOLUMERENDERING

Tooltip: The Volume Rendering component provides the ability to specify and render volumetric data sets. SFString field named name with X3DUOM simpleType componentNameChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "VolumeRendering" (Java syntax) or VolumeRendering (XML syntax).

See Also:

• XML Schema: componentNameChoices
• https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/volume.html
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: component.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

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

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

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

See Also:

• Constant Field Values

LEVEL_DEFAULT_VALUE

public static final int LEVEL_DEFAULT_VALUE

SFInt32 field named level has default value 1 (Java syntax) or 1 (XML syntax).

See Also:

• Constant Field Values

NAME_DEFAULT_VALUE

public static final String NAME_DEFAULT_VALUE

SFString field named name has default value equal to an empty string.

See Also:

• Constant Field Values

Constructor Details

component

public component()

Constructor for component to initialize member variables with default values.

component

public component(String newName,
 int newLevel)

Utility constructor that assigns name and level attributes.

Parameters:

newName - name for this component

newLevel - level value for this component element

See Also:

• X3D Tooltips: component

Method Details

getElementName

public final String getElementName()

Provides name of this element: component

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the component element: Core

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 statement

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 statement

Returns:

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

See Also:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteStatement

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 component setCssClass(String newValue)

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

Parameters:

newValue - is new value for the class field.

Returns:

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

setCssClass

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

component - 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 component setHtmlID(String newValue)

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

Parameters:

newValue - is new value for the id field.

Returns:

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

setHtmlID

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

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

getLevel

public int getLevel()

Provide int value within allowed range of [1,5] from inputOutput SFInt32 field named level.

Tooltip: Necessary level of support for this scene, as defined in corresponding Support table for a given node's component.

• Hint: for example specification definitions, X3D Architecture Grouping component, 10.5 Support levels https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#SupportLevels

Returns:

value of level field

setLevel

public component setLevel(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named level.

Tooltip: Necessary level of support for this scene, as defined in corresponding Support table for a given node's component.

• Hint: for example specification definitions, X3D Architecture Grouping component, 10.5 Support levels https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#SupportLevels

Parameters:

newValue - is new value for the level field.

Returns:

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

setLevel

public component setLevel(SFInt32 newValue)

Assign typed object value to SFInt32 level field, similar to setLevel(int).

Parameters:

newValue - is new value for the level field.

Returns:

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

getName

public String getName()

Provide String enumeration value (baseType xs:NMTOKEN) ["Core" | "CADGeometry" | "CubeMapTexturing" | "DIS" | "EnvironmentalEffects" | "EnvironmentalSensor" | "EventUtilities" | "Followers" | "Geometry2D" | "Geometry3D" | "Geospatial" | "Grouping" | "HAnim" | "H-Anim" | "Interpolation" | "KeyDeviceSensor" | "Layering" | "Layout" | "Lighting" | "Navigation" | "Networking" | "NURBS" | "ParticleSystems" | "Picking" | "PointingDeviceSensor" | "TextureProjection" | "Rendering" | "RigidBodyPhysics" | "Scripting" | "Shaders" | "Shape" | "Sound" | "Text" | "Texturing" | "Texturing3D" | "Time" | "VolumeRendering"] from inputOutput SFString field named name.

Tooltip: Provides name of this component, as defined in corresponding X3D Specification component Introduction. Example: X3D Architecture 10.1.1 Name for Grouping component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#Name

• Hint: all nodes, components and levels are already supported in Full profile.
• 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

Available enumeration values for string comparison: CORE, CADGEOMETRY, CUBEMAPTEXTURING, DIS, ENVIRONMENTALEFFECTS, ENVIRONMENTALSENSOR, EVENTUTILITIES, FOLLOWERS, GEOMETRY2D, GEOMETRY3D, GEOSPATIAL, GROUPING, HANIM, H_ANIM, INTERPOLATION, KEYDEVICESENSOR, LAYERING, LAYOUT, LIGHTING, NAVIGATION, NETWORKING, NURBS, PARTICLESYSTEMS, PICKING, POINTINGDEVICESENSOR, TEXTUREPROJECTION, RENDERING, RIGIDBODYPHYSICS, SCRIPTING, SHADERS, SHAPE, SOUND, TEXT, TEXTURING, TEXTURING3D, TIME, VOLUMERENDERING.

Returns:

value of name field

setName

public final component setName(String newValue)

Accessor method to assign String enumeration value ("Core" | "CADGeometry" | "CubeMapTexturing" | "DIS" | "EnvironmentalEffects" | "EnvironmentalSensor" | "EventUtilities" | "Followers" | "Geometry2D" | "Geometry3D" | "Geospatial" | "Grouping" | "HAnim" | "H-Anim" | "Interpolation" | "KeyDeviceSensor" | "Layering" | "Layout" | "Lighting" | "Navigation" | "Networking" | "NURBS" | "ParticleSystems" | "Picking" | "PointingDeviceSensor" | "TextureProjection" | "Rendering" | "RigidBodyPhysics" | "Scripting" | "Shaders" | "Shape" | "Sound" | "Text" | "Texturing" | "Texturing3D" | "Time" | "VolumeRendering") to inputOutput SFString field named name.

Warning: authors can only choose from a strict list of enumeration values (CORE, CADGEOMETRY, CUBEMAPTEXTURING, DIS, ENVIRONMENTALEFFECTS, ENVIRONMENTALSENSOR, EVENTUTILITIES, FOLLOWERS, GEOMETRY2D, GEOMETRY3D, GEOSPATIAL, GROUPING, HANIM, H_ANIM, INTERPOLATION, KEYDEVICESENSOR, LAYERING, LAYOUT, LIGHTING, NAVIGATION, NETWORKING, NURBS, PARTICLESYSTEMS, PICKING, POINTINGDEVICESENSOR, TEXTUREPROJECTION, RENDERING, RIGIDBODYPHYSICS, SCRIPTING, SHADERS, SHAPE, SOUND, TEXT, TEXTURING, TEXTURING3D, TIME, VOLUMERENDERING).

Tooltip: Provides name of this component, as defined in corresponding X3D Specification component Introduction. Example: X3D Architecture 10.1.1 Name for Grouping component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#Name

• Hint: all nodes, components and levels are already supported in Full profile.
• 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

@see X3D Scene Authoring Hints: Naming Conventions

Parameters:

newValue - is new value for the name field.

Returns:

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

setName

public component setName(SFString newValue)

Assign typed object value to SFString name field, similar to setName(String).

Parameters:

newValue - is new value for the name field.

Returns:

component - 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 component setCssStyle(String newValue)

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

Parameters:

newValue - is new value for the style field.

Returns:

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

setCssStyle

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

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

addComments

public component addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public component addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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