CinemachineExtension Class

previous page next page

Cinemachine

Base class for a Cinemachine Virtual Camera extension module. Hooks into the Cinemachine Pipeline.

Inheritance Hierarchy

SystemObject  Object
    Component
      Behaviour
        MonoBehaviour
          CinemachineCinemachineExtension
            CinemachineCinemachineCollider
            CinemachineCinemachineConfiner
            CinemachineCinemachineFollowZoom

Namespace: Cinemachine
Assembly: Cinemachine (in Cinemachine.dll) Version: 2.0.0.0 (2.0.0.0)

Syntax

[DocumentationSortingAttribute(23f, DocumentationSortingAttributeLevel.API)]
public abstract class CinemachineExtension : MonoBehaviour

Cinemachine.CinemachineExtension = function();

Type.createClass(
	'Cinemachine.CinemachineExtension',
	UnityEngine.MonoBehaviour);

The CinemachineExtension type exposes the following members.

Constructors

	Name	Description
	CinemachineExtension

Properties

	Name	Description
	VirtualCamera	Get the associated CinemachineVirtualCameraBase

Methods

	Name	Description
	Awake	Connect to virtual camera pipeline. Override implementations must call this base implementation
	GetAllExtraStatesT	Ineffeicient method to get all extra state infor for all vcams. Intended for Editor use only, not runtime!
	GetExtraStateT	Because extensions can be placed on manager cams and will in that case be called for all the vcam children, vcam-specific state information should be stored here. Just define a class to hold your state info and use it exclusively when calling this.
	OnDestroy	Disconnect from virtual camera pipeline. Override implementations must call this base implementation
	PostPipelineStageCallback	This callback will be called after the virtual camera has implemented each stage in the pipeline. This method may modify the referenced state. If deltaTime less than 0, reset all state info and perform no damping.

Fields

	Name	Description
	Epsilon	Useful constant for very small floats

previous page start next page