/*
 * Copyright © 2016 <code@io7m.com> http://io7m.com
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package com.io7m.jcamera;

import com.io7m.jtensors.core.parameterized.matrices.PMatrix4x4D;
import com.io7m.jtensors.core.unparameterized.matrices.Matrix4x4D;
import com.io7m.jtensors.core.unparameterized.vectors.Vector3D;
import org.immutables.value.Value;

/**
 * An immutable snapshot of a camera.
 */

@JCameraImmutableStyleType
@Value.Immutable
public interface JCameraFPSStyleSnapshotType
  extends JCameraFPSStyleReadableType, JCameraReadableSnapshotType
{
  @Value.Parameter
  @Override
  double cameraGetAngleAroundHorizontal();

  @Value.Parameter
  @Override
  double cameraGetAngleAroundVertical();

  @Value.Parameter
  @Override
  Vector3D cameraGetRight();

  @Value.Parameter
  @Override
  Vector3D cameraGetUp();

  @Value.Parameter
  @Override
  Vector3D cameraGetForward();

  @Value.Parameter
  @Override
  Vector3D cameraGetPosition();

  @Override
  default Matrix4x4D cameraMakeViewMatrix()
  {
    return JCameraViewMatrix.makeViewMatrix(
      this.cameraGetPosition(),
      this.cameraGetRight(),
      this.cameraGetUp(),
      this.cameraGetForward());
  }

  @Override
  default <T0, T1> PMatrix4x4D<T0, T1> cameraMakeViewPMatrix()
  {
    return JCameraViewMatrix.makeViewPMatrix(
      this.cameraGetPosition(),
      this.cameraGetRight(),
      this.cameraGetUp(),
      this.cameraGetForward());
  }
}
