Package org.web3d.x3d.jsail.Core

Class componentObject

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteStatement
org.web3d.x3d.jsail.Core.componentObject
public class componentObject
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.

X3D statement tooltip: [X3D statement] Each added component statement indicates needed scene functionality above the given X3D profile.
See Also:
X3D Abstract Specification: component, X3D Tooltips: component, X3D Scene Authoring Hints

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static java.lang.String COMPONENT
    String constant COMPONENT defines X3D component for the component element: Core
    static int LEVEL
    Integer constant LEVEL provides default X3D Core component level for this element: 1
    static int LEVEL_DEFAULT_VALUE
    SFInt32 field named level has default value 1 (Java syntax) or 1 (XML syntax).
    static java.lang.String NAME
    String constant NAME provides name of this element: component.
    static java.lang.String NAME_CADGEOMETRY
    Tooltip: The CADGeometry component is provided for Computer-Aided Design (CAD) nodes.
    static java.lang.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 java.lang.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 java.lang.String NAME_DEFAULT_VALUE
    SFString field named name has default value equal to an empty string.
    static java.lang.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 java.lang.String NAME_ENVIRONMENTALEFFECTS
    Tooltip: Nodes in the Environmental effects component support the creation of realistic environmental effects such as panoramic backgrounds and fog.
    static java.lang.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 java.lang.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 java.lang.String NAME_FOLLOWERS
    Tooltip: The Follower nodes (Chasers and Dampers) support dynamic creation of smooth parameter transitions at run time.
    static java.lang.String NAME_GEOMETRY2D
    Tooltip: The Geometry2D component defines how two-dimensional geometry is specified and what shapes are available.
    static java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String NAME_INTERPOLATION
    Tooltip: Interpolator nodes provide keyframe-based animation capability.
    static java.lang.String NAME_KEYDEVICESENSOR
    Tooltip: The Key Device Sensor defines how keyboard keystrokes are inserted into an X3D world.
    static java.lang.String NAME_LAYERING
    Tooltip: The Layering component describes how to layer a set of subscene layers into a composite scene.
    static java.lang.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 java.lang.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 java.lang.String NAME_NAVIGATION
    Tooltip: The Navigation component specifies how a user can effectively and intuitively move through and around a 3D scene.
    static java.lang.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 java.lang.String NAME_NURBS
    Tooltip: The NURBS component describes Non-uniform Rational B-Spline (NURBS) geometry and interpolation nodes.
    static java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String NAME_SCRIPTING
    Tooltip: The Script component describes how Script nodes are used to effect changes in X3D worlds.
    static java.lang.String NAME_SHADERS
    Tooltip: The programmable shaders component describes how programmable shaders are specified and how they affect the visual appearance of geometry.
    static java.lang.String NAME_SHAPE
    Tooltip: The Shape component defines nodes for associating geometry with their visible properties and the scene environment.
    static java.lang.String NAME_SOUND
    Tooltip: The Sound component defines how sound is delivered to an X3D world as well as how sounds are accessed.
    static java.lang.String NAME_TEXT
    Tooltip: The Text component defines how text strings are rendered in an X3D scene.
    static java.lang.String NAME_TEXTURING
    Tooltip: The Texturing component specifies how 2D texture images are defined and then positioned on associated geometry.
    static java.lang.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 java.lang.String NAME_TIME
    Tooltip: The Time component defines how time is sensed, computed and associated with events in an X3D scene.
    static java.lang.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

    validationResult

  • Constructor Summary

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

  • Method Summary

    Modifier and Type Method Description
    componentObject addComments​(java.lang.String newComment)
    Add comment as String to contained commentsList.
    componentObject addComments​(java.lang.String[] newComments)
    Add comments as String[] array to contained commentsList.
    componentObject addComments​(CommentsBlock newCommentsBlock)
    Add CommentsBlock to contained commentsList.
    X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
    X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
    X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
    Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
    java.lang.String getAccessType​(java.lang.String fieldName)
    Indicate accessType corresponding to given fieldName.
    java.lang.String getComponent()
    Defines X3D component for the component element: Core
    int getComponentLevel()
    Provides default X3D component level for this element: 1
    java.lang.String getElementName()
    Provides name of this element: component
    java.lang.String getFieldType​(java.lang.String fieldName)
    Indicate type corresponding to given fieldName.
    int getLevel()
    Provide int value within allowed range of [1,5] from inputOutput SFInt32 field named level.
    java.lang.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" | "Rendering" | "RigidBodyPhysics" | "Scripting" | "Shaders" | "Shape" | "Sound" | "Text" | "Texturing" | "Texturing3D" | "Time" | "VolumeRendering"] from inputOutput SFString field named name.
    boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
    Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
    boolean hasNodeByDEF​(java.lang.String DEFvalue)
    Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
    void initialize()
    Initialize all member variables to default values.
    componentObject setLevel​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named level.
    componentObject setLevel​(SFInt32Object newValue)
    Assign typed object value to SFInt32 level field, similar to setLevel(int).
    componentObject setName​(java.lang.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" | "Rendering" | "RigidBodyPhysics" | "Scripting" | "Shaders" | "Shape" | "Sound" | "Text" | "Texturing" | "Texturing3D" | "Time" | "VolumeRendering") to inputOutput SFString field named name.
    componentObject setName​(SFStringObject newValue)
    Assign typed object value to SFString name field, similar to setName(String).
    java.lang.String toStringClassicVRML​(int indentLevel)
    Recursive method to provide ClassicVRML string serialization.
    java.lang.String toStringVRML97​(int indentLevel)
    Recursive method to provide VRML97 string serialization.
    java.lang.String toStringX3D​(int indentLevel)
    Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
    java.lang.String validate()
    Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

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

    isNode, isStatement

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

    clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

    Methods inherited from class java.lang.Object

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