Skip navigation links
com.supermap.data

Class Scenes

  • java.lang.Object
    • com.supermap.data.Scenes

  • public class Scenes
extends java.lang.Object
    The 3D scene class.

    • Constructor Summary

      Constructors 
      Constructor and Description
      Scenes() 

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int add(java.lang.String name, java.lang.String xml)
      Take the passed name by users to the scene name.
      void clear()
      Deletes all the saved scenes in the scene.
      java.lang.String get(int index)
      Returns the name of 3d scene at the specified index in the 3d scene set.
      java.lang.String getAvailableSceneName(java.lang.String name)
      Returns a name of the scene with the specified name which is not used in the Scene collection.
      int getCount()
      Returns the count of the Scenes objects in the specified Scenes collection.
      java.lang.String getSceneXML(int index)
      Get the content of the scene with the specified index.
      java.lang.String getSceneXML(java.lang.String name)
      Get the content of the scene with the specified name.
      int indexOf(java.lang.String name)
      Gets the index of 3d scene with the specified name.
      boolean insert(int index, java.lang.String name, java.lang.String xml)
      Take the passed name by users to the scene name.
      boolean remove(int index)
      Deletes a saved scene with the specified index in the workspace.
      boolean remove(java.lang.String name)
      Deletes a saved scene with the specified name in the workspace.
      boolean setSceneXML(int index, java.lang.String xml)
      Adds the scene inputted by user to the Scene collection.
      boolean setSceneXML(java.lang.String name, java.lang.String xml)
      Modify the content of the scene with the specified name, without any modification on the name of the scene.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Scenes

        public Scenes()

    • Method Detail

      • get

        public java.lang.String get(int index)
        Returns the name of 3d scene at the specified index in the 3d scene set.
        Parameters:
        index - index
        Returns:
        the name of 3d scene at the specified index in the 3d scene set.

      • getCount

        public int getCount()
        Returns the count of the Scenes objects in the specified Scenes collection.
        Returns:
        the count of the Scenes objects in the specified Scenes collection.

      • add

        public int add(java.lang.String name,
               java.lang.String xml)
        Take the passed name by users to the scene name.
        Parameters:
        name - The name of 3d scene.
        xml - The xml string used to create the scene.
        Returns:
        Returns the index of the newly added scene in this Scenes object.

      • insert

        public boolean insert(int index,
                      java.lang.String name,
                      java.lang.String xml)
        Take the passed name by users to the scene name.
        Parameters:
        index - The specified index.
        name - The name of 3d scene.
        xml - The xml string used to create the scene.
        Returns:
        Returns true if successful; otherwise false.

      • setSceneXML

        public boolean setSceneXML(int index,
                           java.lang.String xml)
        Adds the scene inputted by user to the Scene collection. The position of the new item is at the specified index of the collection.
        Parameters:
        index - The specified index.
        xml - The xml string used to create the scene.
        Returns:
        Returns true if successful; otherwise false.

      • setSceneXML

        public boolean setSceneXML(java.lang.String name,
                           java.lang.String xml)
        Modify the content of the scene with the specified name, without any modification on the name of the scene.
        Parameters:
        name - The name of 3d scene.
        xml - The xml string used to create the scene.
        Returns:
        Returns true if successful; otherwise false.

      • getSceneXML

        public java.lang.String getSceneXML(int index)
        Get the content of the scene with the specified index.
        Parameters:
        index - The specified index.
        Returns:
        Returns a XML string that represents the scene with the specified index.

      • getSceneXML

        public java.lang.String getSceneXML(java.lang.String name)
        Get the content of the scene with the specified name.
        Parameters:
        name - The name of the specified scene.
        Returns:
        Returns a XML string that represents the scene with the specified name.

      • remove

        public boolean remove(int index)
        Deletes a saved scene with the specified index in the workspace. This method will not change the datasource and dataset.
        Parameters:
        index - The specified index of the scene.
        Returns:
        If successful, this method will return true; otherwise it will return false.

      • remove

        public boolean remove(java.lang.String name)
        Deletes a saved scene with the specified name in the workspace. This method will not change the datasource and dataset.
        Parameters:
        name - The name of 3d scene.
        Returns:
        If successful, this method will return true; otherwise it will return false.

      • clear

        public void clear()
        Deletes all the saved scenes in the scene. This method will not change the datasource and dataset.

      • indexOf

        public int indexOf(java.lang.String name)
        Gets the index of 3d scene with the specified name.
        Parameters:
        name - The name of 3d scene.
        Returns:
        Returns the index of the 3d scene.

      • getAvailableSceneName

        public java.lang.String getAvailableSceneName(java.lang.String name)
        Returns a name of the scene with the specified name which is not used in the Scene collection.
        Parameters:
        name - The name of 3d scene.
        Returns:
        Returns the name of the scene new added.
Skip navigation links