Struct CameraState

The output of the Cinemachine engine for a specific virtual camera. The information in this struct can be blended, and provides what is needed to calculate an appropriate camera position, orientation, and lens setting.

Raw values are what the Cinemachine behaviours generate. The correction channel holds perturbations to the raw values - e.g. noise or smoothing, or obstacle avoidance corrections. Coirrections are not considered when making time-based calculations such as damping.

The Final position and orientation is the comination of the raw values and their corrections.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace: Cinemachine

Assembly: solution.dll

Syntax

public struct CameraState

Fields

Name	Description
kNoPoint	This constant represents "no point in space" or "no direction".

Properties

Name	Description
BlendHint	These hints can be or'ed toether to influence how blending is done, and how state is applied to the camera
CorrectedOrientation	Orientation with correction applied.
CorrectedPosition	Position with correction applied.
Default	State with default values
FinalOrientation	Orientation with correction and dutch applied. This is what the final camera gets.
FinalPosition	Position with correction applied. This is what the final camera gets.
HasLookAt	Returns true if this state has a valid ReferenceLookAt value.
Lens	Camera Lens Settings.
NumCustomBlendables	The number of custom blendables that will be applied to the camera. The base system manages but otherwise ignores this data - it is intended for extension modules
OrientationCorrection	Orientation correction. This will be added to the raw orientation. This value doesn't get fed back into the system when calculating the next frame. Can be noise, or smoothing, or both, or something else.
PositionCorrection	Position correction. This will be added to the raw position. This value doesn't get fed back into the system when calculating the next frame. Can be noise, or smoothing, or both, or something else.
PositionDampingBypass	This is a way for the Body component to bypass aim damping, useful for when the body needs to rotate its point of view, but does not want interference from the aim damping. The value is the camera rotation, in Euler degrees.
RawOrientation	Raw (un-corrected) world space orientation of this camera
RawPosition	Raw (un-corrected) world space position of this camera
ReferenceLookAt	The world space focus point of the camera. What the camera wants to look at. There is a special constant define to represent "nothing". Be careful to check for that (or check the HasLookAt property).
ReferenceUp	Which way is up. World space unit vector. Must have a length of 1.
ShotQuality	Subjective estimation of how "good" the shot is. Larger values mean better quality. Default is 1.

Methods

Name	Description
AddCustomBlendable(CustomBlendable)	Add a custom blendable to the pot for eventual application to the camera. The base system manages but otherwise ignores this data - it is intended for extension modules
GetCustomBlendable(int)	Get a custom blendable that will be applied to the camera. The base system manages but otherwise ignores this data - it is intended for extension modules
Lerp(CameraState, CameraState, float)	Intelligently blend the contents of two states.