Viewpoint<T0>

Description

Defines a Viewpoint that can be selected from the Cameras overlay.

Use this base class with ICameraLensData to define a Viewpoint and expose a component in the Cameras overlay. If you expose a component in the Cameras overlay, you can use the Cameras overlay to look through that component in the Scene view.

To use this class, you must have a custom representation of your camera lens in a MonoBehaviour.

When detected, the Cameras overlay creates an instance of the Viewpoint class for each component that is type T0 in the scene.

The Cameras overlay uses the icon that is attached to the component in the UI.

using UnityEngine;

public class MyVirtualCamera : MonoBehaviour
{
    public float fov;
    public float nearPlane;
    public float farPlane;

    public bool physicalProps;
    public float focalLength;
    public Vector2 sensor;
    public Vector2 lensShift;
    public Camera.GateFitMode gateFit;
}

using UnityEngine;
using UnityEditor;

class VirtualCameraViewpoint : Viewpoint<MyVirtualCamera>, ICameraLensData
{
    public VirtualCameraViewpoint(MyVirtualCamera target) : base(target) { }

    public float NearClipPlane => Target.nearPlane;

    public float FarClipPlane => Target.farPlane;

    // If you are not using physical properties, FieldOfView can change from the SceneView with the scrollwheel action while looking through a camera.
    public float FieldOfView { get => Target.fov; set => Target.fov = value; }

    public bool UsePhysicalProperties => Target.physicalProps;

    // If you are using physical properties, FocalLength can change from the SceneView with the scrollwheel action while looking through a camera.
    public float FocalLength { get => Target.focalLength; set => Target.focalLength = value; }

    public Vector2 SensorSize => Target.sensor;

    public Vector2 LensShift => Target.lensShift;

    public Camera.GateFitMode GateFit => Target.gateFit;

    // The SceneView sets orthographic to true when: 
    // - the 2DMode button is toggled on.
    // - orthographic view is set from the Orientation gizmo.
    //
    // In this example, our representation doesn't consider orthographic view.
    public bool Orthographic { get => false; set { } }
    public float OrthographicSize { get => 0; set { } }
}

Properties

Constructors

Public Methods