Package com.solibri.smc.api.communication

Interface Viewpoint

public interface Viewpoint
Viewpoint represents a point of view about a situation in a model. It relates to a single parent Slide.
Since:
9.10.8

  • Method Details

    • create

      static Viewpoint create()
      Creates an empty viewpoint.
      Returns:
      the new viewpoint
      Since:
      9.12.0

    • create

      static Viewpoint create​(UUID uuid)
      Creates an empty viewpoint with the specified UUID.
      Parameters:
      uuid - the UUID of the viewpoint
      Returns:
      the new viewpoint
      Since:
      9.12.0

    • getUniqueId

      String getUniqueId()
      Returns the unique ID of the viewpoint.
      Returns:
      the ID of the viewpoint
      Since:
      9.12.0

    • getComments

      List<Comment> getComments()
      Returns a list of the comments this Viewpoint has.
      Returns:
      the comments
      Since:
      9.10.8

    • addComment

      boolean addComment​(Comment comment)
      Adds the given comment to this viewpoint.
      Parameters:
      comment - the new comment
      Returns:
      true if the comment didn't already exist in this viewpoint, false otherwise
      Since:
      9.12.0

    • removeComment

      boolean removeComment​(Comment comment)
      Removes the given comment from this viewpoint.
      Parameters:
      comment - the comment to remove
      Returns:
      true if the comments was removed, false if it didn't exist in this viewpoint
      Since:
      9.12.0

    • getImage

      Optional<BufferedImage> getImage()
      Returns the optional image this viewpoint holds.
      Returns:
      the optional image
      Since:
      9.12.0

    • getImagePngBytes

      Optional<byte[]> getImagePngBytes()
      Returns the optional image in PNG (Portable Network Graphics) format as byte array.
      Returns:
      the optional PNG image bytes
      Since:
      9.12.0

    • setImage

      void setImage​(BufferedImage image)
      Sets the image to this viewpoint.
      Parameters:
      image - the image
      Since:
      9.12.0

    • setImagePngBytes

      void setImagePngBytes​(byte[] bytes)
      Sets the image from given bytes. The bytes must represent the image in PNG (Portable Network Graphics) format.
      Parameters:
      bytes - the image as PNG byte array
      Since:
      9.12.0

    • getVisualization

      Optional<Visualization> getVisualization()
      Returns optional Visualization of this viewpoint. The visualization defines visible 3D content like visible components and markups.
      Returns:
      the optional visualization.
      Since:
      9.12.0

    • setVisualization

      void setVisualization​(Visualization visualization)
      Sets the Visualization to this viewpoint. The visualization defines visible 3D content like visible components and markups. A null value undefines the current visualization.
      Parameters:
      visualization - the visualization
      Since:
      9.12.0

    • getCameraState

      Optional<CameraState> getCameraState()
      Returns optional CameraState of this viewpoint. The camera state defines where the 3D cameras location and positioning in this viewpoint.
      Returns:
      the camera state
      Since:
      9.12.0

    • setCameraState

      void setCameraState​(CameraState cameraState)
      Sets the camera state to this viewpoint. A null value undefines the current camera state.
      Parameters:
      cameraState - the camera state
      Since:
      9.12.0

    • addExternalID

      boolean addExternalID​(UUID uuid)
      Add an id this viewpoint has in some external system.
      Parameters:
      uuid - the external id
      Returns:
      true when the id didn't exist previously
      Since:
      9.12.0

    • removeExternalID

      boolean removeExternalID​(UUID uuid)
      Remove an id this viewpoint has in some external system.
      Parameters:
      uuid - the external id
      Returns:
      true when the id existed and was removed
      Since:
      9.12.0

    • getExternalIds

      Set<UUID> getExternalIds()
      Returns all the external IDs for this viewpoint.
      Returns:
      all the external IDs
      Since:
      9.12.0