Package org.web3d.x3d.jsail.Core

Class ISObject

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteStatement
org.web3d.x3d.jsail.Core.ISObject
public class ISObject
extends X3DConcreteStatement
Functional summary: the IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields. IS/connect statements can be added if the parent node is within a ProtoBody and connect statements define correspondences between prototype fields and built-in node fields. This concrete class represents an X3D IS statement.

X3D statement tooltip: [X3D statement] The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields. To define each Prototype connection between a ProtoInterface field and a ProtoBody node field, add one or more connect statements within each IS statement.
See Also:
X3D Abstract Specification: IS, X3D Tooltips: IS, X3D Scene Authoring Hints, connectObject, ProtoDeclareObject, ProtoInterfaceObject, ProtoBodyObject, ProtoInstanceObject

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static java.lang.String COMPONENT
    String constant COMPONENT defines X3D component for the IS element: Core
    static int LEVEL
    Integer constant LEVEL provides default X3D Core component level for this element: 2
    static java.lang.String NAME
    String constant NAME provides name of this element: IS.

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

    validationResult

  • Constructor Summary

    Constructors 
    Constructor Description
    ISObject()
    Constructor for ISObject to initialize member variables with default values.

  • Method Summary

    Modifier and Type Method Description
    ISObject addComments​(java.lang.String newComment)
    Add comment as String to contained commentsList.
    ISObject addComments​(java.lang.String[] newComments)
    Add comments as String[] array to contained commentsList.
    ISObject addComments​(CommentsBlock newCommentsBlock)
    Add CommentsBlock to contained commentsList.
    ISObject addConnect​(connectObject newValue)
    Add array of child connect nodes to array of existing nodes (if any).
    ISObject clearConnect()
    Utility method to clear MFNode value of connectList field.
    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 IS element: Core
    int getComponentLevel()
    Provides default X3D component level for this element: 2
    java.util.ArrayList<connectObject> getConnectList()
    Provide array of connectObject results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field connect.
    java.lang.String getElementName()
    Provides name of this element: IS
    java.lang.String getFieldType​(java.lang.String fieldName)
    Indicate type corresponding to given fieldName.
    boolean hasConnect()
    Indicate whether an object is available for inputOutput MFNode field connectList.
    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.
    ISObject setConnect​(connectObject newValue)
    Set single child connect node, replacing prior array of existing nodes (if any).
    ISObject setConnectList​(java.util.ArrayList<connectObject> newValue)
    Accessor method to assign connectObject array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field connect.
    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