Interface BundleCameraState

All Known Implementing Classes:
BundleZoomState

public interface BundleCameraState

Interface for an object which describes the camera's state. It provides functions for serializing and deserializing so that the state can be saved to disk. The camera model will typecast this to the appropriate class internally.

Typically the camera state will be used to store parameters such as the current focal length or similar.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Returns true if the provided camera state is identical to this camera state.
    Set's the classes state to the value contained in this map
    Convert's the values into a map format where each class's field has a corresponding key with the same name and primitive value or primitive array.
  • Method Details

    • setTo

      Set's the classes state to the value contained in this map
    • toMap

      Map<String,Object> toMap()
      Convert's the values into a map format where each class's field has a corresponding key with the same name and primitive value or primitive array. This is used for serialization to YAML.
    • isIdentical

      boolean isIdentical(BundleCameraState b)
      Returns true if the provided camera state is identical to this camera state. If they are different types then it should return false.