Class SceneObject


  • public class SceneObject
    extends X3DConcreteStatement
    Scene is the implicit root node of the X3D scene graph. This concrete class represents an X3D Scene statement.

    X3D statement tooltip: [X3D statement] Scene is the root element that contains an X3D scene graph. Add nodes and children to build an X3D model. Only one Scene root element is allowed per X3D file.
    • Hint: Scene can contain regular children nodes, Metadata* nodes and LayerSet as top-level root nodes.
    • Hint: Scene is implicit, and not explicitly defined, in VRML97 and ClassicVRML encodings.
    • Hint: Scene nodes within Inline models report identical values as top-most root Scene node.
    • Warning: player support for attribute fields in this node is not defined.
    • Warning: Scene is a child of X3D statement, and must follow the (optional) head statement.
    See Also:
    X3D Abstract Specification: Scene, X3D Tooltips: Scene, 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 Scene element: Core
      static int LEVEL
      Integer constant LEVEL provides default X3D Core component level for this element: 1
      static java.lang.String NAME
      String constant NAME provides name of this element: Scene.
    • Constructor Summary

      Constructors 
      Constructor Description
      SceneObject()
      Constructor for SceneObject to initialize member variables with default values.
    • Method Summary

      Modifier and Type Method Description
      SceneObject addChild​(X3DChildNode newValue)
      Utility method to add single child element to contained list of existing children nodes (if any).
      SceneObject addChildren​(ProtoInstanceObject newValue)
      Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for children field.
      void addChildren​(X3DNode newValue)
      Add single node to existing array of children nodes (if any).
      void addChildren​(X3DNode[] newValue)
      Add array of children nodes to array of existing nodes (if any).
      SceneObject addComments​(java.lang.String newComment)
      Add comment as CommentsBlock to children field
      SceneObject addComments​(java.lang.String[] newComments)
      Add comments as String[] array to children field
      SceneObject addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to children field
      SceneObject addLayerSet​(LayerSetObject newValue)
      Utility method to add single LayerSetObject to contained list of existing Scene root nodes (if any).
      SceneObject addMetadata​(X3DMetadataObject newValue)
      Utility method to add single X3DMetadataNode to contained list of existing Scene root nodes (if any).
      SceneObject clearChildren()
      Utility method to clear MFNode value of children 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.util.ArrayList<X3DNode> getChildren()
      Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DChildNode|X3DMetadataObject|LayerSet, from inputOutput MFNode field children.
      java.lang.String getComponent()
      Defines X3D component for the Scene element: Core
      int getComponentLevel()
      Provides default X3D component level for this element: 1
      java.lang.String getElementName()
      Provides name of this element: Scene
      java.lang.String getFieldType​(java.lang.String fieldName)
      Indicate type corresponding to given fieldName.
      boolean hasChildren()
      Indicate whether an object is available for inputOutput MFNode field children.
      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.
      SceneObject setChildren​(java.util.ArrayList<X3DNode> newValue)
      Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (newValue instanceof org.web3d.x3d.jsail.Core.CommentsBlock) || (newValue instanceof org.web3d.x3d.jsail.Core.ROUTEObject) || (newValue instanceof org.web3d.x3d.jsail.Networking.IMPORTObject) || (newValue instanceof org.web3d.x3d.jsail.Networking.EXPORTObject) || (newValue instanceof org.web3d.x3d.jsail.Core.ProtoDeclareObject) || (newValue instanceof org.web3d.x3d.jsail.Core.ExternProtoDeclareObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Core.X3DChildNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Core.X3DMetadataObject) || (newValue instanceof org.web3d.x3d.jsail.Layering.LayerSetObject); if (!
      void setChildren​(X3DNode newValue)
      Set single children node, replacing prior array of existing nodes (if any).
      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 java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: Scene.
        See Also:
        Constant Field Values
      • COMPONENT

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the Scene 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
    • Constructor Detail

      • SceneObject

        public SceneObject()
        Constructor for SceneObject to initialize member variables with default values.
    • Method Detail

      • getElementName

        public final java.lang.String getElementName()
        Provides name of this element: Scene
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.String getComponent()
        Defines X3D component for the Scene 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 java.lang.String getFieldType​(java.lang.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 java.lang.String getAccessType​(java.lang.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
      • getChildren

        public java.util.ArrayList<X3DNode> getChildren()
        Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to X3DChildNode|X3DMetadataObject|LayerSet, from inputOutput MFNode field children.

        Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode|X3DMetadataObject|LayerSet.
        Returns:
        value of children field
        See Also:
        X3DChildNode, X3DMetadataObject, LayerSetObject
      • setChildren

        public SceneObject setChildren​(java.util.ArrayList<X3DNode> newValue)
        Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (newValue instanceof org.web3d.x3d.jsail.Core.CommentsBlock) || (newValue instanceof org.web3d.x3d.jsail.Core.ROUTEObject) || (newValue instanceof org.web3d.x3d.jsail.Networking.IMPORTObject) || (newValue instanceof org.web3d.x3d.jsail.Networking.EXPORTObject) || (newValue instanceof org.web3d.x3d.jsail.Core.ProtoDeclareObject) || (newValue instanceof org.web3d.x3d.jsail.Core.ExternProtoDeclareObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Core.X3DChildNode) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.sai.Core.X3DMetadataObject) || (newValue instanceof org.web3d.x3d.jsail.Layering.LayerSetObject); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes X3DChildNode|X3DMetadataObject|LayerSet; newValue=" + newValue); }

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode|X3DMetadataObject|LayerSet.
        Parameters:
        newValue - is new value for the children field.
        Returns:
        SceneObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addChildren

        public void addChildren​(X3DNode newValue)
        Add single node to existing array of children nodes (if any).

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode|X3DMetadataObject|LayerSet and ProtoInstance.
        Parameters:
        newValue - is new value to be appended the children field.
      • addChildren

        public SceneObject addChildren​(ProtoInstanceObject newValue)
        Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for children field.

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.
        Parameters:
        newValue - is new value to be appended the parts field.
        Returns:
        SceneObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addChild

        public SceneObject addChild​(X3DChildNode newValue)
        Utility method to add single child element to contained list of existing children nodes (if any).
        Parameters:
        newValue - is new node value to be appended the children field.
        Returns:
        SceneObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addChildren

        public void addChildren​(X3DNode[] newValue)
        Add array of children nodes to array of existing nodes (if any).

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode|X3DMetadataObject|LayerSet.
        Parameters:
        newValue - is new value array to be appended the children field.
      • setChildren

        public void setChildren​(X3DNode newValue)
        Set single children node, replacing prior array of existing nodes (if any).

        Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to X3DChildNode|X3DMetadataObject|LayerSet.
        Parameters:
        newValue - is new node for the children field (restricted to X3DChildNode|X3DMetadataObject|LayerSet)
      • clearChildren

        public SceneObject clearChildren()
        Utility method to clear MFNode value of children field.
        Returns:
        SceneObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasChildren

        public boolean hasChildren()
        Indicate whether an object is available for inputOutput MFNode field children.
        Returns:
        whether a properly typed node or ProtoInstance array or CommentsBlock is available.
        See Also:
        getChildren()
      • addComments

        public SceneObject addComments​(java.lang.String newComment)
        Add comment as CommentsBlock to children field
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newComment - initial value
        Returns:
        SceneObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addComments

        public SceneObject addComments​(java.lang.String[] newComments)
        Add comments as String[] array to children field
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newComments - array of comments
        Returns:
        SceneObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addComments

        public SceneObject addComments​(CommentsBlock newCommentsBlock)
        Add CommentsBlock to children field
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newCommentsBlock - block of comments to add
        Returns:
        SceneObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • findElementByNameValue

        public 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. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

        Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
      • findElementByNameValue

        public 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. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

        Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
      • hasElementByNameValue

        public 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.
        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)
      • hasNodeByDEF

        public 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.
        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 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.
        Specified by:
        validate in class X3DConcreteElement
        Returns:
        validation results (if any)
      • addMetadata

        public SceneObject addMetadata​(X3DMetadataObject newValue)
        Utility method to add single X3DMetadataNode to contained list of existing Scene root nodes (if any). WARNING: Scene is a statement that is implicit in several encodings and has no metadata field, so top-level metadata nodes are typically kept together within other top-level root nodes as Scene children.
        Parameters:
        newValue - is new node value to be appended the children field.
        Returns:
        SceneObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • addLayerSet

        public SceneObject addLayerSet​(LayerSetObject newValue)
        Utility method to add single LayerSetObject to contained list of existing Scene root nodes (if any).
        Parameters:
        newValue - is new node value to be appended the children field.
        Returns:
        SceneObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).