Interface VRImage

All Known Implementing Classes:
VRImageView, VRMediaView

public interface VRImage
Pane which holds some type of visual media e.g. a video or photograph.
Author:
Jamie Macaulay
  • Method Summary Link icon

    Modifier and Type
    Method
    Description
    javafx.scene.layout.Region
    Get the control pane for the particular media type.
    javafx.scene.layout.Region
    Get the image edit pane.
    int
    Get the height of the current image
    int
    Get the width of the current image
    Get readable metadata for the image/media
    javafx.scene.Node
    The main node which holds the media.
    boolean
    setMedia(File currentFile)
    Set the current media.
  • Method Details Link icon

    • getControlPane Link icon

      javafx.scene.layout.Region getControlPane()
      Get the control pane for the particular media type. This sits at the bottom of the screen and allows users to manipulate the media e.g. might contain play and pause controls.
      Returns:
      the control pane
    • getImageEditPane Link icon

      javafx.scene.layout.Region getImageEditPane()
      Get the image edit pane. This contains image/media editing controls. E.g. brightness or contrast controls might go here.
      Returns:
      the image edit pane
    • setMedia Link icon

      boolean setMedia(File currentFile)
      Set the current media.
      Parameters:
      currentFile - - the current file for the media.
      Returns:
      - true if loaded properly, otherwise false.
    • getNode Link icon

      javafx.scene.Node getNode()
      The main node which holds the media.
      Returns:
      node which holds the media view.
    • getMetaData Link icon

      ArrayList<String> getMetaData()
      Get readable metadata for the image/media
      Returns:
      a list of human readable metadata strings.
    • getImageHeight Link icon

      int getImageHeight()
      Get the height of the current image
      Returns:
      the height of the current image
    • getImageWidth Link icon

      int getImageWidth()
      Get the width of the current image
      Returns:
      the width of the current image.