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 { } } }
Position | The world position. |
Rotation | The world rotation. |
Target | Returns the component the Viewpoint is attached to cast as T. |
TargetObject | A reference to the Component of type T this Viewpoint is attached to. |
Viewpoint_1 | Constructor. |
CreateVisualElement | CreateVisualElement is called when a Viewpoint is selected in the Cameras Overlay. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.