Class Scene

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteStatement
org.web3d.x3d.jsail.Core.Scene
public class Scene extends X3DConcreteStatement
Scene is the implicit root node of the X3D scene graph. This concrete class represents an X3D Scene statement.

Scene statement tooltip: Scene is the root element that contains an X3D scene graph, appearing after the head of an X3D model. Add nodes, statements and comments 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: the Scene statement cannot have a DEF since it is not a node, cannot be re-USEd, and cannot receive or send events.
  • Hint: Scene nodes for Inline models report identical values as top-most root of the contained model.
  • 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:

  • Field Details

    • NAME

      public static final String NAME
      String constant NAME provides name of this element: Scene.
      See Also:

    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the Scene element: Core
      See Also:

    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D Core component level for this element: 1
      See Also:

  • Constructor Details

    • Scene

      public Scene()
      Constructor for Scene to initialize member variables with default values.

  • Method Details

    • getElementName

      public final String getElementName()
      Provides name of this element: Scene
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element

    • getComponent

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

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

    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteStatement

    • getChildren

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

      Tooltip: [X3DNode] Scene can contain nodes, statements and comments. *


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

    • setChildren

      public Scene setChildren(ArrayList<X3DNode> newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.

      Tooltip: [X3DNode] Scene can contain nodes, statements and comments. *


      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:
      Scene - 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 Scene addChildren(ProtoInstance newValue)
      Add single ProtoInstance (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:
      Scene - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addChild

      public Scene 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:
      Scene - 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 Scene clearChildren()
      Utility method to clear MFNode value of children field. This method does not initialize withCHILDREN_DEFAULT_VALUE.
      Returns:
      Scene - 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:

    • addComments

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

    • addComments

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

    • addComments

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

    • getCssClass

      public String getCssClass()
      Provide String value from inputOutput SFString field named class.
      Overrides:
      getCssClass in class X3DConcreteElement
      Returns:
      value of class field
      See Also:

    • setCssClass

      public final Scene 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:
      Scene - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCssClass

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

    • setHtmlID

      public final Scene 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:
      Scene - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setHtmlID

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

    • setCssStyle

      public final Scene 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:
      Scene - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setCssStyle

      public Scene 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:
      Scene - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

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

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

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

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

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

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

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

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

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

    • addMetadata

      public Scene 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:
      Scene - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addLayerSet

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