Cinemachine
CinemachineExternalCamera Class |
This component will expose a non-cinemachine camera to the cinemachine system,
allowing it to participate in blends.
Just add it as a component alongside an existing Unity Camera component.
Inheritance Hierarchy
SystemObject Object
Component
Behaviour
MonoBehaviour
CinemachineCinemachineVirtualCameraBase
CinemachineCinemachineExternalCamera
Component
Behaviour
MonoBehaviour
CinemachineCinemachineVirtualCameraBase
CinemachineCinemachineExternalCamera
Namespace: Cinemachine
Assembly: Cinemachine (in Cinemachine.dll) Version: 2.0.0.0 (2.0.0.0)
Syntax
[DocumentationSortingAttribute(14f, DocumentationSortingAttributeLevel.UserRef)] [RequireComponent(typeof(Camera))] [DisallowMultipleComponent] [ExecuteInEditMode] [AddComponentMenu("Cinemachine/CinemachineExternalCamera")] public class CinemachineExternalCamera : CinemachineVirtualCameraBase
Cinemachine.CinemachineExternalCamera = function(); Type.createClass( 'Cinemachine.CinemachineExternalCamera', Cinemachine.CinemachineVirtualCameraBase);
The CinemachineExternalCamera type exposes the following members.
Constructors
Name | Description | |
---|---|---|
CinemachineExternalCamera |
Properties
Name | Description | |
---|---|---|
Description | Gets a brief debug description of this virtual camera, for use when displayiong debug info (Inherited from CinemachineVirtualCameraBase.) | |
Follow | This vcam defines no targets (Overrides CinemachineVirtualCameraBaseFollow.) | |
LiveChildOrSelf | Just returns self. (Inherited from CinemachineVirtualCameraBase.) | |
LookAt | The object that the camera is looking at (Overrides CinemachineVirtualCameraBaseLookAt.) | |
Name | Get the name of the Virtual Camera. Base implementation
returns the owner GameObject's name. (Inherited from CinemachineVirtualCameraBase.) | |
ParentCamera | Support for meta-virtual-cameras. This is the situation where a
virtual camera is in fact the public face of a private army of virtual cameras, which
it manages on its own. This method gets the VirtualCamera owner, if any.
Private armies are implemented as Transform children of the parent vcam. (Inherited from CinemachineVirtualCameraBase.) | |
PreviousStateIsValid | Set this to force the next update to ignore deltaTime and reset itself (Inherited from CinemachineVirtualCameraBase.) | |
Priority | Get the Priority of the virtual camera. This determines its placement
in the CinemachineCore's queue of eligible shots. (Inherited from CinemachineVirtualCameraBase.) | |
State | Get the CameraState, as we are able to construct one from the Unity Camera (Overrides CinemachineVirtualCameraBaseState.) | |
ValidatingStreamVersion | Version that was last streamed, for upgrading legacy (Inherited from CinemachineVirtualCameraBase.) | |
VirtualCameraGameObject | The GameObject owner of the Virtual Camera behaviour. (Inherited from CinemachineVirtualCameraBase.) |
Methods
Name | Description | |
---|---|---|
AddPostPipelineStageHook |
A delegate to hook into the state calculation pipeline.
This will be called after each pipeline stage, to allow others to hook into the pipeline.
See CinemachineCore.Stage.
(Inherited from CinemachineVirtualCameraBase.) | |
InvokePostPipelineStageCallback |
Invokes the PostPipelineStageDelegate for this camera, and up the hierarchy for all
parent cameras (if any).
(Inherited from CinemachineVirtualCameraBase.) | |
IsLiveChild | Check whether the vcam a live child of this camera.
This base class implementation always returns false. (Inherited from CinemachineVirtualCameraBase.) | |
MoveToTopOfPrioritySubqueue | When multiple virtual cameras have the highest priority, there is
sometimes the need to push one to the top, making it the current Live camera if
it shares the highest priority in the queue with its peers.
This happens automatically when a
new vcam is enabled: the most recent one goes to the top of the priority subqueue.
Use this method to push a vcam to the top of its priority peers.
If it and its peers share the highest priority, then this vcam will become Live. (Inherited from CinemachineVirtualCameraBase.) | |
OnDestroy | Base class implementation removes the virtual camera from the priority queue. (Inherited from CinemachineVirtualCameraBase.) | |
OnDisable | Base class implementation makes sure the priority queue remains up-to-date. (Inherited from CinemachineVirtualCameraBase.) | |
OnEnable | Base class implementation adds the virtual camera from the priority queue. (Inherited from CinemachineVirtualCameraBase.) | |
OnTransformParentChanged | Base class implementation makes sure the priority queue remains up-to-date. (Inherited from CinemachineVirtualCameraBase.) | |
OnTransitionFromCamera | Notification that this virtual camera is going live.
Base class implementationmust be called by any overridden method. (Inherited from CinemachineVirtualCameraBase.) | |
OnValidate | Enforce bounds for fields, when changed in inspector.
Call base class implementation at the beginning of overridden method.
After base method is called, ValidatingStreamVersion will be valid. (Inherited from CinemachineVirtualCameraBase.) | |
PreUpdateChildCameras |
This is called prior to the updating of the vcam's child cameras,
in order to allow the parent to prepare its children.
If the children are updating on FixedUpdate, then this will not necessarily be called
prior to every FixedUpdate, but it might be called on LateUpdate instead.
Base class implementation does nothing.
(Inherited from CinemachineVirtualCameraBase.) | |
RemovePostPipelineStageHook | Remove a Pipeline stage hook callback. (Inherited from CinemachineVirtualCameraBase.) | |
ResolveFollow | Returns this vcam's Follow target, or if that is null, will retrun
the parent vcam's Follow target. (Inherited from CinemachineVirtualCameraBase.) | |
ResolveLookAt | Returns this vcam's LookAt target, or if that is null, will retrun
the parent vcam's LookAt target. (Inherited from CinemachineVirtualCameraBase.) | |
Start | Base class implementation does nothing. (Inherited from CinemachineVirtualCameraBase.) | |
Update | Base class implementation makes sure the priority queue remains up-to-date. (Inherited from CinemachineVirtualCameraBase.) | |
UpdateCameraState | Construct a CameraState object from the Unity Camera (Overrides CinemachineVirtualCameraBaseUpdateCameraState(Vector3, Single).) |
Fields
Name | Description | |
---|---|---|
CinemachineGUIDebuggerCallback | This is deprecated. It is here to support the soon-to-be-removed
Cinemachine Debugger in the Editor. (Inherited from CinemachineVirtualCameraBase.) | |
m_ExcludedPropertiesInInspector | Inspector control - Use for hiding sections of the Inspector UI. (Inherited from CinemachineVirtualCameraBase.) | |
m_LockStageInInspector | Inspector control - Use for enabling sections of the Inspector UI. (Inherited from CinemachineVirtualCameraBase.) | |
m_LookAt | The object that the camera is looking at. | |
m_Priority | The priority will determine which camera becomes active based on the
state of other cameras and this camera. Higher numbers have greater priority.
(Inherited from CinemachineVirtualCameraBase.) | |
OnPostPipelineStage |
A delegate to hook into the state calculation pipeline.
Implementaion must be sure to call this after each pipeline stage, to allow
other services to hook into the pipeline.
See CinemachineCore.Stage.
(Inherited from CinemachineVirtualCameraBase.) |
See Also