Namespace Cinemachine.Editor

Classes

BaseEditor<T>

A convenience base class for making inspector editors.

CinemachineBrainEditor

Inspector for CinemachineBrain

CinemachineImpulseChannels

This class contains setting for the Impulse system. Specifically, it holds the Impulse Channel definitions. These work like Unity Layers, you can define and name them, and create masks to filter only the layers you want.

CinemachineLensPresets

User-definable named presets for lenses. This is a Singleton asset, available in editor only

CinemachineScreenComposerGuides

Use an instance of this class to draw screen composer guides in the game view. This is an internal class, and is not meant to be called outside of Cinemachine.

CinemachineTool

This is a generic Tool class for Cinemachine tools. To create a new tool, inherit from CinemachineTool and implement GetIcon(). Your new tool will need to have the [EditorTool("tool-name", typeof(CinemachineVirtualCameraBase))] attribute.

A tool will be drawn iff it has been registered using CinemachineSceneToolUtility.RegisterTool. This is generally done in the OnEnable function of the editor script of the cinemachine component (CinemachineVirtualCamera, CinemachineComponentBase), for which the tool was meant. To unregister, call CinemachineSceneToolUtility.UnregisterTool in the same script's OnDisable function.

To draw the handles related to the tool, you need to implement your drawing function and call it in the editor script's OnSceneGUI function. An alternative for drawing handles is to override this function's OnToolGUI or OnDrawHandles functions (see EditorTool or IDrawSelectedHandles docs for more information).

To check, if a tool has been enabled/disabled in the editor script, use CinemachineSceneToolUtility.IsToolActive.

CinemachineVirtualCameraBaseEditor<T>

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

CinemachineVirtualCameraBaseEditor<T>.Styles

A collection of GUIContent for use in the inspector

InspectorUtility

Collection of tools and helpers for drawing inspectors

ScriptableObjectUtility

This is a collection of utilities surrounding ScriptableObjects

SerializedPropertyHelper

Helpers for the editor relating to SerializedPropertys

Structs

CinemachineLensPresets.PhysicalPreset

Physical Lens Preset

CinemachineLensPresets.Preset

Lens Preset

Delegates

CinemachineScreenComposerGuides.ObjectGetter

Delegate to get the current object whose guides are being drawn

CinemachineScreenComposerGuides.RectGetter

Delegate for getting the hard/soft guide rects

CinemachineScreenComposerGuides.RectSetter

Delegate for setting the hard/soft guide rects