Class CinemachineVirtualCamera
This is a deprecated component. Use CinemachineCamera instead.
Inheritance
Inherited Members
Namespace: Unity.Cinemachine
Assembly: solution.dll
Syntax
[Obsolete("CinemachineVirtualCamera is deprecated. Use CinemachineCamera instead.")]
[DisallowMultipleComponent]
[ExecuteAlways]
[ExcludeFromPreset]
[AddComponentMenu("")]
public class CinemachineVirtualCamera : CinemachineVirtualCameraBase, ICinemachineCamera, AxisState.IRequiresInputFields
| Name | Description |
|---|---|
| BlendHint | Hint for transitioning to and from this CinemachineCamera. Hints can be combined, although not all combinations make sense. In the case of conflicting hints, Cinemachine will make an arbitrary choice. |
| CreatePipelineOverride | Override component pipeline creation. This needs to be done by the editor to support Undo. The override must do exactly the same thing as the CreatePipeline method in this class. |
| DestroyPipelineOverride | Override component pipeline destruction. This needs to be done by the editor to support Undo. |
| m_Follow | The object that the camera wants to move with (the Body target). The Body component of the CinemachineComponent pipeline will refer to this target and position the vcam in accordance with rules and settings that are provided to it. If this is null, then the vcam's Transform position will be used. |
| m_Lens | Specifies the LensSettings of this Virtual Camera. These settings will be transferred to the Unity camera when the vcam is live. |
| m_LookAt | The object that the camera wants to look at (the Aim target). The Aim component of the CinemachineComponent pipeline will refer to this target and orient the vcam in accordance with rules and settings that are provided to it. If this is null, then the vcam's Transform orientation will be used. |
| m_OnCameraLiveEvent | This event fires when a transition occurs. |
Properties
| Name | Description |
|---|---|
| Follow | Get the Follow target for the Body component in the Cinemachine pipeline. If this vcam is a part of a meta-camera collection, then the owner's target will be used if the local target is null. |
| IsDprecated | Helper for upgrading from CM2 |
| LookAt | Get the LookAt target for the Aim component in the Cinemachine pipeline. If this vcam is a part of a meta-camera collection, then the owner's target will be used if the local target is null. |
| State | The CameraState object holds all of the information necessary to position the Unity camera. It is the output of this class. |
Methods
| Name | Description |
|---|---|
| AddCinemachineComponent<T>() | Add a component to the cinemachine pipeline. |
| DestroyCinemachineComponent<T>() | Remove a component from the cinemachine pipeline if it's present. |
| ForceCameraPosition(Vector3, Quaternion) | Force the virtual camera to assume a given position and orientation |
| GetCinemachineComponent(Stage) | Get the component set for a specific stage. |
| GetCinemachineComponent<T>() | Get an existing component of a specific type from the cinemachine pipeline. |
| GetComponentOwner() | Get the hidden CinemachinePipeline child object. |
| GetComponentPipeline() | Get the component pipeline owned by the hidden child pipline container. For most purposes, it is preferable to use the GetCinemachineComponent method. |
| GetMaxDampTime() | Query components and extensions for the maximum damping time. |
| InternalUpdateCameraState(Vector3, float) | Internal use only. Do not call this method. Called by CinemachineCore at the appropriate Update time so the vcam can position itself and track its targets. This class will invoke its pipeline and generate a CameraState for this frame. |
| InvalidateComponentPipeline() | Editor API: Call this when changing the pipeline from the editor. Will force a rebuild of the pipeline cache. |
| OnDestroy() | Calls the DestroyPipelineDelegate for destroying the hidden child object, to support undo. |
| OnEnable() | Make sure that the pipeline cache is up-to-date. |
| OnTargetObjectWarped(Transform, Vector3) | This is called to notify the vcam that a target got warped, so that the vcam can update its internal state to make the camera also warp seamlessly. |
| OnTransitionFromCamera(ICinemachineCamera, Vector3, float) | If we are transitioning from another vcam, grab the position from it. |
| OnValidate() | Enforce bounds for fields, when changed in inspector. |
| PerformLegacyUpgrade(int) | Override this to handle any upgrades necessitated by a streaming version change. Note that since this method is not called from the main thread, there are many things it cannot do, including checking a unity object for null. |