Class CinemachineOrbitalFollow

This is a CinemachineComponent in the the Body section of the component pipeline. Its job is to position the camera somewhere on a spheroid centered at the Follow target.

The position on the sphere and the radius of the sphere can be controlled by user input.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

CinemachineComponentBase

CinemachineOrbitalFollow

Implements

IInputAxisOwner

IInputAxisResetSource

CinemachineFreeLookModifier.IModifierValueSource

CinemachineFreeLookModifier.IModifiablePositionDamping

CinemachineFreeLookModifier.IModifiableDistance

Inherited Members

CinemachineComponentBase.Epsilon

CinemachineComponentBase.VirtualCamera

CinemachineComponentBase.OnEnable()

CinemachineComponentBase.OnDisable()

CinemachineComponentBase.FollowTarget

CinemachineComponentBase.LookAtTarget

CinemachineComponentBase.FollowTargetAsGroup

CinemachineComponentBase.FollowTargetPosition

CinemachineComponentBase.FollowTargetRotation

CinemachineComponentBase.LookAtTargetAsGroup

CinemachineComponentBase.LookAtTargetPosition

CinemachineComponentBase.LookAtTargetRotation

CinemachineComponentBase.VcamState

CinemachineComponentBase.PrePipelineMutateCameraState(ref CameraState, float)

CinemachineComponentBase.BodyAppliesAfterAim

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

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, bool)

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, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Namespace: Unity.Cinemachine

Assembly: solution.dll

Syntax

[AddComponentMenu("Cinemachine/Procedural/Position Control/Cinemachine Orbital Follow")]
[DisallowMultipleComponent]
[CameraPipeline(CinemachineCore.Stage.Body)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.cinemachine@3.0/manual/CinemachineOrbitalFollow.html")]
public class CinemachineOrbitalFollow : CinemachineComponentBase, IInputAxisOwner, IInputAxisResetSource, CinemachineFreeLookModifier.IModifierValueSource, CinemachineFreeLookModifier.IModifiablePositionDamping, CinemachineFreeLookModifier.IModifiableDistance

Fields

Name	Description
HorizontalAxis	Axis representing the current horizontal rotation. Value is in degrees and represents a rotation about the up vector
OrbitStyle	How to construct the surface on which the camera will travel
Orbits	Defines a complex surface rig from 3 horizontal rings.
RadialAxis	Axis controlling the scale of the current distance. Value is a scalar multiplier and is applied to the specified camera distance
Radius	The camera will be placed at this distance from the Follow target
RecenteringTarget	Defines the reference frame for horizontal recentering. The axis center will be dynamically updated to be behind the selected object.
TargetOffset	Offset from the object's center in local space. Use this to fine-tune the orbit when the desired focus of the orbit is not the tracked object's center
TrackerSettings	Settings to control damping for target tracking.
VerticalAxis	Axis representing the current vertical rotation. Value is in degrees and represents a rotation about the right vector

Properties

Name	Description
IsValid	True if component is enabled and has a valid Follow target
Stage	Get the Cinemachine Pipeline stage that this component implements. Always returns the Body stage

Methods

Name	Description
ForceCameraPosition(Vector3, Quaternion)	Force the virtual camera to assume a given position and orientation
GetMaxDampTime()	Report maximum damping time needed for this component.
MutateCameraState(ref CameraState, float)	Positions the virtual camera according to the transposer rules.
OnTargetObjectWarped(Transform, Vector3)	This is called to notify the user that a target got warped, so that we can update its internal state to make the camera also warp seamlessly.
OnTransitionFromCamera(ICinemachineCamera, Vector3, float)	Notification that this virtual camera is going live. Base class implementation does nothing.