docs.unity3d.com
    Show / Hide Table of Contents

    Class CinemachineVirtualCameraBaseEditor<T>

    Base class for virtual camera editors. Handles drawing the header and the basic properties.

    Inheritance
    Object
    Object
    ScriptableObject
    Editor
    BaseEditor<T>
    CinemachineVirtualCameraBaseEditor<T>
    Inherited Members
    BaseEditor<T>.Target
    BaseEditor<T>.FindAndExcludeProperty<TValue>(Expression<Func<T, TValue>>)
    BaseEditor<T>.FindProperty<TValue>(Expression<Func<T, TValue>>)
    BaseEditor<T>.FieldPath<TValue>(Expression<Func<T, TValue>>)
    BaseEditor<T>.ExcludeProperty(String)
    BaseEditor<T>.IsPropertyExcluded(String)
    BaseEditor<T>.BeginInspector()
    BaseEditor<T>.DrawPropertyInInspector(SerializedProperty)
    BaseEditor<T>.DrawRemainingPropertiesInInspector()
    Editor.CreateEditorWithContext(Object[], Object, Type)
    Editor.CreateEditorWithContext(Object[], Object)
    Editor.CreateCachedEditorWithContext(Object, Object, Type, Editor)
    Editor.CreateCachedEditorWithContext(Object[], Object, Type, Editor)
    Editor.CreateCachedEditor(Object, Type, Editor)
    Editor.CreateCachedEditor(Object[], Type, Editor)
    Editor.CreateEditor(Object)
    Editor.CreateEditor(Object, Type)
    Editor.CreateEditor(Object[])
    Editor.CreateEditor(Object[], Type)
    Editor.DrawPropertiesExcluding(SerializedObject, String[])
    Editor.DrawDefaultInspector()
    Editor.Repaint()
    Editor.CreateInspectorGUI()
    Editor.RequiresConstantRepaint()
    Editor.DrawHeader()
    Editor.OnHeaderGUI()
    Editor.ShouldHideOpenButton()
    Editor.DrawFoldoutInspector(Object, Editor)
    Editor.HasPreviewGUI()
    Editor.GetPreviewTitle()
    Editor.RenderStaticPreview(String, Object[], Int32, Int32)
    Editor.OnPreviewGUI(Rect, GUIStyle)
    Editor.OnInteractivePreviewGUI(Rect, GUIStyle)
    Editor.OnPreviewSettings()
    Editor.GetInfoString()
    Editor.DrawPreview(Rect)
    Editor.ReloadPreviewInstances()
    Editor.UseDefaultMargins()
    Editor.Initialize(Object[])
    UnityEditor.Editor.MoveNextTarget()
    Editor.ResetTarget()
    Editor.target
    Editor.targets
    Editor.serializedObject
    Editor.finishedDefaultHeaderGUI
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(String)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectOfType<T>()
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.ToString()
    Object.name
    Object.hideFlags
    Namespace: Cinemachine.Editor
    Syntax
    public class CinemachineVirtualCameraBaseEditor<T> : BaseEditor<T>, IPreviewable, IToolModeOwner where T : CinemachineVirtualCameraBase
    Type Parameters
    Name Description
    T

    The type of CinemachineVirtualCameraBase being edited

    Methods

    DrawCameraStatusInInspector()

    Draw the Live status in the inspector, and the Solo button

    Declaration
    protected void DrawCameraStatusInInspector()

    DrawExtensionsWidgetInInspector()

    Draw the Extensions dropdown in the inspector

    Declaration
    protected void DrawExtensionsWidgetInInspector()

    DrawGlobalControlsInInspector()

    Draw the global settings controls in the inspector

    Declaration
    protected void DrawGlobalControlsInInspector()

    DrawHeaderInInspector()

    Draw the virtual camera header in the inspector.
    This includes Solo button, Live status, and global settings

    Declaration
    protected void DrawHeaderInInspector()

    DrawLensSettingsInInspector(SerializedProperty)

    Draw the Lens Settings controls in the inspector

    Declaration
    protected void DrawLensSettingsInInspector(SerializedProperty property)
    Parameters
    Type Name Description
    SerializedProperty property

    The SerializedProperty for the field of type LensSettings field

    DrawTargetsInInspector(SerializedProperty, SerializedProperty)

    Draw the LookAt and Follow targets in the inspector

    Declaration
    protected void DrawTargetsInInspector(SerializedProperty followTarget, SerializedProperty lookAtTarget)
    Parameters
    Type Name Description
    SerializedProperty followTarget

    Follow target SerializedProperty

    SerializedProperty lookAtTarget

    LookAt target SerializedProperty

    GetExcludedPropertiesInInspector()

    Obsolete, do not use. Use the overload, which is more performant

    Declaration
    protected override List<string> GetExcludedPropertiesInInspector()
    Returns
    Type Description
    List<String>

    List of property names to exclude

    Overrides
    Cinemachine.Editor.BaseEditor<T>.GetExcludedPropertiesInInspector()

    GetExcludedPropertiesInInspector(List<String>)

    Get the property names to exclude in the inspector.
    Implementation should call the base class implementation

    Declaration
    protected override void GetExcludedPropertiesInInspector(List<string> excluded)
    Parameters
    Type Name Description
    List<String> excluded

    Add the names to this list

    Overrides
    Cinemachine.Editor.BaseEditor<T>.GetExcludedPropertiesInInspector(System.Collections.Generic.List<System.String>)

    OnDisable()

    Inspector panel is being disabled. Implementation should call the base class implementation

    Declaration
    protected virtual void OnDisable()

    OnEnable()

    Inspector panel is being enabled.
    Implementation should call the base class implementation

    Declaration
    protected virtual void OnEnable()

    OnInspectorGUI()

    Create the contents of the inspector panel. This implementation draws header and Extensions widget, and uses default algorithms to draw the properties in the inspector

    Declaration
    public override void OnInspectorGUI()
    Overrides
    Cinemachine.Editor.BaseEditor<T>.OnInspectorGUI()
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023