2D Implementation of the CinemachineZone abstract class More...

Inheritance diagram for MoreMountains.Tools.MMCinemachineZone2D:

Protected Member Functions
override void	InitializeCollider ()
	Gets and sets up the colliders More...

override void	SetupConfiner ()
	Creates and sets up the camera's confiner More...

virtual void	CopyCollider ()
	Copies the initial collider to the composite More...

virtual void	OnTriggerEnter2D (Collider2D collider)
	On enter, enables the camera and triggers the enter event More...

virtual void	OnTriggerExit2D (Collider2D collider)
	On exit, disables the camera and invokes the exit event More...

Protected Member Functions inherited from MoreMountains.Tools.MMCinemachineZone
virtual void	Awake ()
	On Awake we proceed to init if app is playing More...

virtual void	AlwaysInitialization ()
	On Awake we initialize our collider More...

virtual void	Initialization ()
	On init we grab our virtual camera More...

virtual void	Start ()
	On Start we setup the confiner More...

virtual void	ManualSetupConfiner ()
	A method used to manually create a confiner More...

virtual void	SetupConfinerGameObject ()
	Creates an object to host the confiner More...

virtual IEnumerator	EnableCamera (bool state, int frames)
	Enables the camera, either via enabled state or priority More...

virtual void	Reset ()
	On Reset we initialize our gizmo color More...

Protected Attributes
Collider2D	_collider2D

Collider2D	_confinerCollider2D

Rigidbody2D	_confinerRigidbody2D

CompositeCollider2D	_confinerCompositeCollider2D

CinemachineConfiner	_cinemachineConfiner

BoxCollider2D	_boxCollider2D

CircleCollider2D	_circleCollider2D

PolygonCollider2D	_polygonCollider2D

Protected Attributes inherited from MoreMountains.Tools.MMCinemachineZone
GameObject	_confinerGameObject

Vector3	_gizmoSize

Additional Inherited Members
Public Types inherited from MoreMountains.Tools.MMCinemachineZone
enum	Modes { Enable , Priority }

Public Attributes inherited from MoreMountains.Tools.MMCinemachineZone
CinemachineVirtualCamera	VirtualCamera
	the virtual camera associated to this zone (will try to grab one in children if none is set) More...

Modes	Mode = Modes.Enable
	whether to enable/disable virtual cameras, or to play on their priority for transitions More...

bool	CameraStartsActive = false
	whether or not the camera in this zone should start active More...

int	EnabledPriority = 10
	when in priority mode, the priority this camera should have when the zone is active More...

int	DisabledPriority = 0
	when in priority mode, the priority this camera should have when the zone is inactive More...

LayerMask	TriggerMask
	a layermask containing all the layers that should activate this zone More...

bool	SetupConfinerOnStart = false
	whether or not the zone should auto setup its camera's confiner on start - alternative is to manually click the ManualSetupConfiner, or do your own setup More...

bool	GenerateConfinerSetup
	a debug button used to setup the confiner on click More...

UnityEvent	OnEnterZoneEvent
	a UnityEvent to trigger when entering the zone More...

UnityEvent	OnExitZoneEvent
	a UnityEvent to trigger when exiting the zone More...

bool	DrawGizmos = true
	whether or not to draw shape gizmos to help visualize the zone's bounds More...

Color	GizmosColor
	the color of the gizmos to draw in edit mode More...

Detailed Description

2D Implementation of the CinemachineZone abstract class

Member Function Documentation

◆ CopyCollider()

virtual void MoreMountains.Tools.MMCinemachineZone2D.CopyCollider ( )

protectedvirtual

Copies the initial collider to the composite

◆ InitializeCollider()

override void MoreMountains.Tools.MMCinemachineZone2D.InitializeCollider ( )

protectedvirtual

Gets and sets up the colliders

Implements MoreMountains.Tools.MMCinemachineZone.

◆ OnTriggerEnter2D()

virtual void MoreMountains.Tools.MMCinemachineZone2D.OnTriggerEnter2D ( Collider2D collider )

protectedvirtual

On enter, enables the camera and triggers the enter event

Parameters

collider

◆ OnTriggerExit2D()

virtual void MoreMountains.Tools.MMCinemachineZone2D.OnTriggerExit2D ( Collider2D collider )

protectedvirtual

On exit, disables the camera and invokes the exit event

Parameters

collider

◆ SetupConfiner()

override void MoreMountains.Tools.MMCinemachineZone2D.SetupConfiner ( )

protectedvirtual

Creates and sets up the camera's confiner

Implements MoreMountains.Tools.MMCinemachineZone.

Member Data Documentation

◆ _boxCollider2D

BoxCollider2D MoreMountains.Tools.MMCinemachineZone2D._boxCollider2D

protected

◆ _cinemachineConfiner

CinemachineConfiner MoreMountains.Tools.MMCinemachineZone2D._cinemachineConfiner

protected

◆ _circleCollider2D

CircleCollider2D MoreMountains.Tools.MMCinemachineZone2D._circleCollider2D

protected

◆ _collider2D

Collider2D MoreMountains.Tools.MMCinemachineZone2D._collider2D

protected

◆ _confinerCollider2D

Collider2D MoreMountains.Tools.MMCinemachineZone2D._confinerCollider2D

protected

◆ _confinerCompositeCollider2D

CompositeCollider2D MoreMountains.Tools.MMCinemachineZone2D._confinerCompositeCollider2D

protected

◆ _confinerRigidbody2D

Rigidbody2D MoreMountains.Tools.MMCinemachineZone2D._confinerRigidbody2D

protected

◆ _polygonCollider2D

PolygonCollider2D MoreMountains.Tools.MMCinemachineZone2D._polygonCollider2D

protected

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

E:/Github/Store/HighroadEngine/Assets/HighroadEngine/MMTools/ToolsForCinemachine/MMCinemachineZone/MMCinemachineZone2D.cs

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CopyCollider()

◆ InitializeCollider()

◆ OnTriggerEnter2D()

◆ OnTriggerExit2D()

◆ SetupConfiner()

Member Data Documentation

◆ _boxCollider2D

◆ _cinemachineConfiner

◆ _circleCollider2D

◆ _collider2D

◆ _confinerCollider2D

◆ _confinerCompositeCollider2D

◆ _confinerRigidbody2D

◆ _polygonCollider2D