This CinemachineExtension allows you to lock a Cinemachine on one or more axis More...

Inheritance diagram for MoreMountains.CorgiEngine.CinemachineAxisLocker:

Public Types
enum	Methods { Methods.ForcedPosition, Methods.InitialPosition, Methods.ColliderBoundsCenter, Methods.Collider2DBoundsCenter }
	the possible methods to lock axis on More...

Public Attributes
bool	LockXAxis = false
	whether or not axis should be locked on X More...

bool	LockYAxis = false
	whether or not axis should be locked on Y More...

bool	LockZAxis = false
	whether or not axis should be locked on Z More...

Methods	Method = Methods.InitialPosition
	the selected method to lock axis on More...

Vector3	ForcedPosition
	the position to lock axis based on More...

Collider	TargetCollider
	the collider to lock axis on More...

Collider2D	TargetCollider2D
	the 2D collider to lock axis on More...

Protected Member Functions
virtual void	Start ()
	On Start we initialize our forced position based on the selected choice More...

override void	PostPipelineStageCallback (CinemachineVirtualCameraBase vcam, CinemachineCore.Stage stage, ref CameraState state, float deltaTime)
	Locks position More...

Protected Attributes
Vector3	_forcedPosition

Detailed Description

This CinemachineExtension allows you to lock a Cinemachine on one or more axis

Member Enumeration Documentation

◆ Methods

enum MoreMountains.CorgiEngine.CinemachineAxisLocker.Methods

strong

the possible methods to lock axis on

Enumerator
ForcedPosition
InitialPosition
ColliderBoundsCenter
Collider2DBoundsCenter

Member Function Documentation

◆ PostPipelineStageCallback()

override void MoreMountains.CorgiEngine.CinemachineAxisLocker.PostPipelineStageCallback	(	CinemachineVirtualCameraBase	vcam,
		CinemachineCore.Stage	stage,
		ref CameraState	state,
		float	deltaTime
	)

protected

Locks position

Parameters

vcam
stage
state
deltaTime

◆ Start()

virtual void MoreMountains.CorgiEngine.CinemachineAxisLocker.Start ( )

protectedvirtual

On Start we initialize our forced position based on the selected choice

Member Data Documentation

◆ _forcedPosition

Vector3 MoreMountains.CorgiEngine.CinemachineAxisLocker._forcedPosition

protected

◆ ForcedPosition

Vector3 MoreMountains.CorgiEngine.CinemachineAxisLocker.ForcedPosition

the position to lock axis based on

◆ LockXAxis

bool MoreMountains.CorgiEngine.CinemachineAxisLocker.LockXAxis = false

whether or not axis should be locked on X

◆ LockYAxis

bool MoreMountains.CorgiEngine.CinemachineAxisLocker.LockYAxis = false

whether or not axis should be locked on Y

◆ LockZAxis

bool MoreMountains.CorgiEngine.CinemachineAxisLocker.LockZAxis = false

whether or not axis should be locked on Z

◆ Method

Methods MoreMountains.CorgiEngine.CinemachineAxisLocker.Method = Methods.InitialPosition

the selected method to lock axis on

◆ TargetCollider

Collider MoreMountains.CorgiEngine.CinemachineAxisLocker.TargetCollider

the collider to lock axis on

◆ TargetCollider2D

Collider2D MoreMountains.CorgiEngine.CinemachineAxisLocker.TargetCollider2D

the 2D collider to lock axis on

The documentation for this class was generated from the following file:

Assets/CorgiEngine/Common/ScriptsCinemachine/Camera/CinemachineAxisLocker.cs

Public Types

Public Attributes

Protected Member Functions

Protected Attributes