CinemachineFramingTransposer Class

Cinemachine

CinemachineFramingTransposer Class

This is a Cinemachine Component in the Body section of the component pipeline. Its job is to position the camera in a fixed screen-space relationship to the vcam's Follow target object, with offsets and damping. The camera will be first moved along the camera Z axis until the Follow target is at the desired distance from the camera's X-Y plane. The camera will then be moved in its XY plane until the Follow target is at the desired point on the camera's screen. The FramingTansposer will only change the camera's position in space. It will not re-orient or otherwise aim the camera. For this component to work properly, the vcam's LookAt target must be null. The Follow target will define what the camera is looking at. If the Follow target is a CinemachineTargetGroup, then additional controls will be available to dynamically adjust the camera’s view in order to frame the entire group. Although this component was designed for orthographic cameras, it works equally well with persective cameras and can be used in 3D environments.
Inheritance Hierarchy
SystemObject  Object
    Component
      Behaviour
        MonoBehaviour
          CinemachineCinemachineComponentBase
            CinemachineCinemachineFramingTransposer

Namespace:  Cinemachine
Assembly:  Cinemachine (in Cinemachine.dll) Version: 2.0.0.0 (2.0.0.0)
Syntax
[DocumentationSortingAttribute(5.5f, DocumentationSortingAttributeLevel.UserRef)]
[ExecuteInEditMode]
[AddComponentMenu("")]
[RequireComponent(typeof(CinemachinePipeline))]
[SaveDuringPlayAttribute]
public class CinemachineFramingTransposer : CinemachineComponentBase
Cinemachine.CinemachineFramingTransposer = function();

Type.createClass(
	'Cinemachine.CinemachineFramingTransposer',
	Cinemachine.CinemachineComponentBase);

The CinemachineFramingTransposer type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyFollowTarget
Returns the owner vcam's Follow target.
(Inherited from CinemachineComponentBase.)
Public propertyHardGuideRect
Internal API for the inspector editor
Public propertyIsValid
True if component is enabled and has a valid Follow target
(Overrides CinemachineComponentBaseIsValid.)
Public propertyLookAtTarget
Returns the owner vcam's LookAt target.
(Inherited from CinemachineComponentBase.)
Public propertym_LastBounds
For editor visulaization of the calculated bounding box of the group
Public propertym_lastBoundsMatrix
For editor visualization of the calculated bounding box of the group
Public propertySoftGuideRect
Internal API for the inspector editor
Public propertyStage
Get the Cinemachine Pipeline stage that this component implements. Always returns the Body stage
(Overrides CinemachineComponentBaseStage.)
Public propertyTargetGroup
Get Follow target as CinemachineTargetGroup, or null if target is not a group
Public propertyVcamState
Returns the owner vcam's CameraState.
(Inherited from CinemachineComponentBase.)
Public propertyVirtualCamera
Get the associated CinemachineVirtualCameraBase
(Inherited from CinemachineComponentBase.)
Top
Methods
  NameDescription
Public methodMutateCameraState
Positions the virtual camera according to the transposer rules.
(Overrides CinemachineComponentBaseMutateCameraState(CameraState, Single).)
Public methodOnPositionDragged
API for the editor, to process a position drag from the user. Base class implementation does nothing.
(Inherited from CinemachineComponentBase.)
Top
Fields
  NameDescription
Public fieldm_AdjustmentMode
How to adjust the camera to get the desired framing
Public fieldm_BiasX
A non-zero bias will move the targt position away from the center of the soft zone
Public fieldm_BiasY
A non-zero bias will move the targt position away from the center of the soft zone
Public fieldm_CameraDistance
The distance along the camera axis that will be maintained from the Follow target
Public fieldm_DeadZoneDepth
The camera will not move along its z-axis if the Follow target is within this distance of the specified camera distance
Public fieldm_DeadZoneHeight
Camera will not move vertically if the target is within this range of the position
Public fieldm_DeadZoneWidth
Camera will not move horizontally if the target is within this range of the position
Public fieldm_GroupFramingMode
What screen dimensions to consider when framing
Public fieldm_GroupFramingSize
How much of the screen to fill with the bounding box of the targets.
Public fieldm_LookaheadSmoothing
Controls the smoothness of the lookahead algorithm. Larger values smooth out jittery predictions and also increase prediction lag
Public fieldm_LookaheadTime
This setting will instruct the composer to adjust its target offset based on the motion of the target. The composer will look at a point where it estimates the target will be this many seconds into the future. Note that this setting is sensitive to noisy animation, and can amplify the noise, resulting in undesirable camera jitter. If the camera jitters unacceptably when the target is in motion, turn down this setting, or animate the target more smoothly.
Public fieldm_MaxDollyIn
How much closer to the target can the camera go?
Public fieldm_MaxDollyOut
How much farther from the target can the camera go?
Public fieldm_MaximumDistance
Set this to limit how far from the taregt the camera can get
Public fieldm_MaximumFOV
If adjusting FOV, will not set the FOV higher than this
Public fieldm_MaximumOrthoSize
If adjusting Orthographic Size, will not set it higher than this
Public fieldm_MinimumDistance
Set this to limit how close to the target the camera can get
Public fieldm_MinimumFOV
If adjusting FOV, will not set the FOV lower than this
Public fieldm_MinimumOrthoSize
If adjusting Orthographic Size, will not set it lower than this
Public fieldm_ScreenX
Horizontal screen position for target. The camera will move to position the tracked object here
Public fieldm_ScreenY
Vertical screen position for target, The camera will move to to position the tracked object here
Public fieldm_SoftZoneHeight
When target is within this region, camera will gradually move to re-align towards the desired position, depending onm the damping speed
Public fieldm_SoftZoneWidth
When target is within this region, camera will gradually move to re-align towards the desired position, depending onm the damping speed
Public fieldm_UnlimitedSoftZone
Public fieldm_XDamping
How aggressively the camera tries to maintain the offset in the X-axis. Small numbers are more responsive, rapidly translating the camera to keep the target's x-axis offset. Larger numbers give a more heavy slowly responding camera. Using different settings per axis can yield a wide range of camera behaviors
Public fieldm_YDamping
How aggressively the camera tries to maintain the offset in the Y-axis. Small numbers are more responsive, rapidly translating the camera to keep the target's y-axis offset. Larger numbers give a more heavy slowly responding camera. Using different settings per axis can yield a wide range of camera behaviors
Public fieldm_ZDamping
How aggressively the camera tries to maintain the offset in the Z-axis. Small numbers are more responsive, rapidly translating the camera to keep the target's z-axis offset. Larger numbers give a more heavy slowly responding camera. Using different settings per axis can yield a wide range of camera behaviors
Public fieldOnGUICallback
Used by the Inspector Editor to display on-screen guides.
Top
See Also