cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman....

Cinemachine

WelcometoCinemachine

Cinemachineisasuiteof‘smart’proceduralcameramoduleswhichallowyoutodefinetheshotandthey’lldynamicallyfollowyourdirection.

Setupshotswhichtrackandcomposemotioninrealtime,likeAIcameraoperators.Theproceduralnaturemakesthembug-resistantastheyalwaysworktomaketheshotbasedonyourdirection.That’sgreatforgameplay,butthey’realsoamazinglyfastforcutscenes.Changeananimation,avehiclespeed,groundterrain-whatever-andCinemachinewilldynamicallymaketheshot.Youcanusereallytelephotolensesandnothavetoupdatethecutsceneifthingschange.

TheBrainTheideaistotelltheUnitycamerawheretogoandwhattodoinresponsetogameplayandsceneevolution.Todothis,thefirststepistogivetheUnityCameraaCinemachineBrainbehaviour.Thinkofthatasthemoviedirector,whochoosesamongtheavailablecamerashotsfortheonethattellsthebeststoryatanygivenmoment.

ThenextstepistopopulateyourscenewithintelligentCinemachineVirtualCameraobjects.Thesecanbethoughtofasskilledcameramenwhoaregiveninstructionsaboutwhatgameobjectstotarget,andhowtofollowthem.Itisthebrain'sjobtomonitortheseandchoosethemostappropriateonetotrackatanygivenframe.

VirtualCamerasAvirtualcameraisnotacamera.Instead,itcanbethoughtofasacameracontroller,notunlikeacameraman.ItcandrivetheUnityCameraandcontrolitsposition,orientation,lenssettings,andPostProcessingeffects.EachVirtualCameraownsitsownCinemachineComponentPipeline,throughwhichyouprovidetheinstructionsfordynamicallytrackingspecificgameobjects.

Avirtualcameraisverylightweight,anddoesnorenderingofitsown.ItmerelytracksinterestingGameObjects,andpositionsitselfaccordingly.Atypicalgamecanhavedozensofvirtualcameras,

eachsetuptofollowaparticularcharacterorcaptureaparticularevent.

AVirtualCameracanbeinanyofthreestates:

Live:ThevirtualcameraisactivelycontrollingtheUnityCamera.Thevirtualcameraistrackingitstargetsandbeingupdatedeveryframe.Standby:Thevirtualcameraistrackingitstargetsandbeingupdatedeveryframe,butnoUnityCameraisactivelybeingcontrolledbyit.ThisisthestateofavirtualcamerathatisenabledinthescenebutperhapsatalowerprioritythantheLivevirtualcamera.Disabled:Thevirtualcameraispresentbutdisabledinthescene.Itisnotactivelytrackingitstargetsandsoconsumesnoprocessingpower.However,thevirtualcameracanbemadelivefromtheTimeline.

TheUnityCameracanbedrivenbyanyvirtualcamerainthescene.Thegamelogiccanchoosethevirtualcameratomakelivebymanipulatingthevirtualcameras'enabledflagsandtheirpriorities,basedongamelogic.

Inordertobedrivenbyavirtualcamera,theUnityCameramusthaveaCinemachineBrainbehaviour,whichwillselectthemosteligiblevirtualcamerabasedonitspriorityoronothercriteria,andwillmanageblending.

BlendingCameraBlendingisaconceptthatbringstheVirtualCamerasbeyondtheanalogyofacameraman.Itisessentiallyaninterpolationovertimeofonevirtualcamerapositionandstatetoanother.Ifyouthinkofvirtualcamerasascameramen,thenblendingisalittlelikeonecameramansmoothlypassingthecameratoanothercameraman.Youcanspecifythetimeoverwhichtoblend,aswellastheblendcurveshape.Notethatacameracutisjustazero-timeblend.

TheCinemachineBrainbehaviourholdstheinstructionsforblending.Thereyoucanspecifythedefaultblend(howvirtualcamerastranstionfromonebeinglivetoanother),andalsospecificoverridestothedefaultblendintheformofaninstructionlist:"whenthisvcamgoeslive,blendlikethis",or"whenbendingfromthisvcamtothatone,doitlikethat",andsoon.

GettingStartedThefirstthingtolookatistheCinemachineVirtualCamerabehaviour.ThatshouldleadyoutothepipelineofICinemachineComponentswhichserveasinstructionsforcontrollingthePosition,Orientation,andLensofthecamera.CreatesomeVirtualCamerasinyourscene,settheirtargets,andplaywiththeirsettingstoseewhattheydo.Alsohavealookatsomeoftheexamplescenesincludedwiththepackage.

TheAPIgenerallyreflectswhatyouseeintheinspectorforthebehavioursofthedifferentsortsofVirtualCamerasandtheircomponents.Havealookatthecorrespondingclasses,beginningwith:

CinemachineVirtualCamera

CinemachineBrain

CinemachineClearShot

CinemachineFreeLook

CinemachineCollider

CinemachineTransposer

CinemachineComposer

SeeAlsoOtherResourcesVersionHistory

VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service

https://forum.unity3d.com/forums/timeline-cinemachine.127/

https://unity3d.com/legal/terms-of-service

Cinemachine

VersionHistory

Thetopicsinthissectiondescribethevariouschangesmadetothe[TODO:ProjectTitle]overthelifeoftheproject.

VersionHistorySelectaversionbelowtoseeadescriptionofitschanges.

Version2.0

Version2.1

SeeAlsoOtherResourcesWelcometoCinemachine




Cinemachine

Version2.0

Version2.0wasreleasedonJuly23,2017.

ChangesinThisReleaseThisisacompleteoverhaulofCinemachine1.0,andcontainsmanynewfeaturesandimplementations.

Unfortunatelyitwasnotpossibletomaintainback-compatibilitywithCinemachine1,andsoanyCinemachinecontentcreatedwithearlierversionswillhavetobere-createdusingthisversion.

PleaseseetheCinemachineForumforacompletelistofchangesinthisrelease.





Cinemachine

Version2.1

Version2.1wasreleasedonNov11,2017.

ChangesinThisReleasePostProcessingV2isnowsupported.

NewColliderimplementation.Curbfeelersaregone,replacedbyaclevercamera-repositioningalgorithmthatwilltrytopreservecameraheightordistancefromtarget(strategyisuser-selectable).

NewCinemachineConfiner:confineavirtualcameratoasimpleboundingvolumeorPolygonCollider2D.

NewFramingTransposer.Thisisaspecialtransposerthatwillrespectcompositionandframingrulesbymovingthecamerawithoutrotatingit.TakesonlyaFollowTarget(noLookAt-thisisimportant).DesignedforOrthographiccameras,butwillalsoworkforPerspectivecameras.IfFollowtargetisaCinemachineTargetGroup,thenwillalsoprovideGroupFramingoptions.

NewCinemachinePOVAimcomponent.Cameraaimisentirelycontrolledbyuser,using2inputaxes.

NewCinemachineMixingCamera.Driveacontinuousblendofupto8virtualcamerasfromtimelineorgamelogic.Createcomplexrigswithcustomblendsandexposethemasordinaryvcams.

NewCinemachineBlendListCamera.AminivcamsequencerthatprovidesaquickandeasywaytodoABcameramovesonthefly.

NewCinemachineDollyCartbehaviour,formovinganythingalongapath.Noneedtocreatedummyvcamsjustforthat.

NewCinemachineSmoothPathcomponent.YoucanuseitinsteadoftheoldCinemachinePath.ThedifferenceisthattheSmoothPathguaranteessecond-ordercontinuity,whichmeans

thattherewillneverbeanysuddencamerarotationchangesbakedintothepathtangents.Easiertouse,too:notangentstomessaroundwith(theygetautomaticallysetforsmoothness).

PathnowsupportsDistanceUnitsinadditiontoPathunits,makingiteasytocreatesteadymotion.

TrackedDolly:addedabilitytouseDistanceorPathunitsforpathposition.

TransposerandTrackedDolly:addedtargetangulardampingon3axes.

OrbitalTransposerandFreeLook:addedangulardampingandbindingmode,sameasTransposer.

OrbitalTransopserandfreelook:addedcheckboxtoinvertinputaxis.

Transposer,OrbitalTransposer,andFreeLook:addednewSimpleFollowbindingmode,whichwillfollowthetargetusingrotationasmuchaspossible,changingpositionaslittleaspossible.Likealazycameraman.

AddedIgnoreTimeScaleoptiontoBrain.Usefulforsnappycameraseveninslo-mo.

AddedLookaheadTimetocomposer.Composerwilllookatthepointwhereitestimatesthetargetwillbeatsometimeinthenearfuture.Thisgivesmuchmorenaturalframingofamovingtarget.

SmartUpdateissmarter:addedsupportforInterpolationwhentargetisanimatedbyphysicssystem.

Addedoff-buttonforSaveDuringPlay.

NoSaveDuringPlayforvcampriority,LookAtandFollowtargets,GroupTargetmembers.

AddedIsBlendingAPImethodtoStateDrivenCameraandClearShot.

TargetGroupnowhasauser-selectableupdatemethod.

TargetGroupnowrespectstheweightwhencomputingboundingbox,soit'spossibletograduallyaddorremovemembersbymanipulatingtheweight.

Clearshot:ifrandomize,thenre-randomizewheneveritbecomesactive.

ClearShot:defaultblendiscut.

ClearShotcreatemenu:addaColliderbydefault.

FollowZoom:min/maxFOVdefaultschangedto3/60.

Composerdampingrangeisnow0-20insteadof0-100.

OrbitalandFreeLook:HeadingBiascannowbeanimatedonthetimeline.

OrbitalandFreeLook:dampingnolongerinterfereswithcameraresponsetouserinput.Axismovementbypassesalldamping.

TrackedDolly:addedpathpositionoffsettoAuto-Dolly.Staysonthepath(unlikepathoffset,whichisbasedonthepathtangentandsocangooffthepath)

NoisecomponentinspectornowhasadropdownforProfilepresets,insteadofdirectlyallowingeditingoftheProfileasset.

AddedconceptofCinemachineExtension.Collider,confiner,PostProcessing,etcarenowExtensions.Theyareavailableviaadropdownatthebottomoftheinspectionforvirtualcameras.TheywillnolongerappearinthestandardComponentsmenu.

Time.timeScale=0isnowsupported.Pausingthegamewillalsopausethevirtualcameras.

HardConstrainthasbeensplitintotwosettings:DoNothingandHardLookAt/Follow.DoNothingwillleavethecamera'stransformalone,ignoringanytargetthatmayhavebeenset.

CinemachineBrainnolongerrequiresaCameracomponent.CanbeusedwithanyGameObject,makingitpossibletouseCinemachinetocontrolthetransformsofarbitraryobjects.

ImprovedlogicforAxisStateaccel/decel.Morerealisticbehaviour.

SaveDuringPlayobsoleteAPIfixfor2017.2.

FixedbuilderrorswhenbuildingforUWP.

ClearshotandSDC:don'tresetstateifdeactivated.

FreeLookdestroy-nomoreorphanrigs.

FixedstrangebuilderrorthatonlyshowedupinMonoDevelop.

FreeLookwasnotrespectingX-axisaccelanddecel.Headingspeedhadtobecrazyhigh.NowsameasOrbital(warning:mayhavetore-tunesettingsonexistingFreeLooks).

Recentertotargetheadingwasnotmovingsmoothlyinsomecircumstances.

Colliderraycastsnolongerhittriggers.

Noise:handlevariabledeltaTimegracefully.

State-Driven-Camera:don'tgenerateerrorswhenanimatedtargetisinactive.

Severaljitterandjudderissuesresolved.





Cinemachine

Namespaces

NamespacesNamespace Description

Cinemachine ThisnamespaceholdstheCoreCinemachinecode.

Cinemachine.Utility Cinemachinenon-domainutilitiesandUnityextensionsandhelpers




Cinemachine

CinemachineNamespace

ThisnamespaceholdstheCoreCinemachinecode.

Classes Class Description

CinemachineBasicMultiChannelPerlin AsapartoftheCinemachinePipelineimplementingtheNoisestage,thiscomponentaddsPerlinNoisetotheCamerastate,intheCorrectionoftheCameraState.iscreatedbyusingapredefinednoiseprofileasset.theshapeofthenoiseovertime.Youcanscalethisinamplitudeorintime,toproducefamilyofdifferentnoisesusingthesameprofile.

CinemachineBlend Describesablendbetween2CinemachineVirtualCameras,andholdsthetheblend.

CinemachineBlendDefinitionPropertyAttribute PropertyappliedtoCinemachineBlendDefinition.Usedforcustomdrawingintheinspector.

CinemachineBlenderSettings AssetthatdefinestherulesforblendingbetweenVirtualCameras.

CinemachineBlendListCamera Thisisavirtualcamera"manager"thatownsandmanagesacollectionVirtualCameras.cameragoeslive,thesechildvcamsareenabled,oneafteranother,holdingeachcameraforadesignatedtime.betweencamerasarespecified.Thelastcameraisheldindefinitely.

CinemachineBrain CinemachineBrainisthelinkbetweentheUnityCameraandtheCinemachineVirtualCamerasinthescene.monitorstheprioritystacktochoosethecurrentCamera,andblendwithanotherifnecessary.importantly,CamerastatetotheattachedUnityCamera.CinemachineBrainisalsotheplacewhererulesforblendingbetweenvirtualcamerasdefined.Camerablendingisaninterpolationovertimeofonevirtualcameratoanother.Ifyouthinkofvirtualcamerasascameramen,thenblendingisalittlelikeonecameramansmoothlypassingthecameratoanothercameraman.timeoverwhichtoblend,aswellastheblendcurveshape.thatacameracutisjustazero-timeblend.

CinemachineBrainBrainEvent EventwithaCinemachineBrainparameter

CinemachineBrainVcamEvent EventwithaICinemachineCameraparameter

CinemachineClearShot CinemachineClearShotisa"managercamera"thatownsandmanagesasetofCameragameObjectchildren.WhenLive,theClearShotwillcheckthechildren,andchoosetheonewiththebestqualityshotandmakeitLive.beaverypowerfultool.childcamerashaveCinemachineColliderextensions,theywillanalyzethescenefortargetobstructions,optimaltargetotheritems,andreporttheirassessmentofshotqualitybacktotheClearShotparent,whowillthenchoosethebestone.canusethistosetmulti-cameracoverageofascene,andbeassuredthataclearshotofalwaysbeavailable.childcamerashavethesameshotquality,theonewiththehighestprioritywillbechosen.YoucanalsodefinecustomblendsbetweentheClearShotchildren.

CinemachineCollider Anadd-onmoduleforCinemachineVirtualCamera

thatpost-processespositionofthevirtualcamera.Basedonthesuppliedsettings,theColliderwillattempttopreservethelineofsighttheLookAttargetofthevirtualcamerabymovingobjectsthatwillobstructtheview.Additionally,theCollidercanbeusedtoassesstheshotqualityandreportthisasafieldinthecameraState.

CinemachineComponentBase AnabstractrepresentationofamutatoractingonaCinemachineVirtualCamera

CinemachineComposer ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.Itsjobistoaimthecameraatthevcam'sLookAttargetobject,withoffsets,damping,andcompositionrules.composerdoesnotchangethecamera'sposition.panandtilttheis,inordertogetthedesiredframing.Tomovethecamera,youhavetousethevirtualcamera'sBodysection.

CinemachineConfiner Anadd-onmoduleforCinemachineVirtualCamerathatpost-processespositionofthevirtualcamera.Itwillconfinethevirtualpositiontothevolumespecified

intheBoundingVolumefield.

CinemachineCore AsingletonthatmanagescompletelistsofCinemachineBrainand,CinemachineVirtualCameras,andthepriorityqueue.servicestokeepingtrackofwhetherCinemachineVirtualCamerashaveeachframe.

CinemachineDollyCart ThisisaverysimplebehaviourthatconstrainsitstransformtoaCinemachinePath.usedtoanimateanyobjectsalongapath,orasaFollowtargetforCinemachineVirtualCameras.

CinemachineExtension BaseclassforaCinemachineVirtualCameraextensionmodule.HooksintotheCinemachinePipeline.

CinemachineExternalCamera Thiscomponentwillexposeanon-cinemachinecameratothecinemachinesystem,toparticipateinblends.itasacomponentalongsideanexistingUnityCameracomponent.

CinemachineFollowZoom Anadd-onmoduleforCinemachineVirtualCamerathatadjuststokeepthetargetobjectataconstantsizeonthescreen,regardlessofcameraandtarget

position.

CinemachineFramingTransposer ThisisaCinemachineComponentintheBodysectionofthecomponentpipeline.jobistopositionthecamerainafixedscreen-spacerelationshiptothevcam'sFollowtargetobject,withoffsetsanddamping.ThecamerawillbefirstmovedalongthecameraZaxisuntiltheFollowtargetthedesireddistancefromthecamera'sX-Yplane.camerawillthenXYplaneuntiltheFollowtargetisatthedesiredpointoncamera'sscreen.FramingTansposerwillonlychangethecamera'spositioninspace.Itwillnototherwiseaimthecamera.thiscomponenttoworkproperly,thevcam'sLookAttargetmustbenull.TheFollowtargetwilldefinewhatthecameraislookingat.IftheFollowtargetisaCinemachineTargetGroup,thenadditionalcontrolswillavailabletodynamicallyadjustthecamera’sviewinordertoframetheentiregroup.thiscomponentwasdesignedfororthographiccameras,itworksequallypersectivecamerasandcanbeusedin3Denvironments.

CinemachineFreeLook ACinemachineCamerageared

towardsa3rdpersoncameraexperience.arounditssubjectwiththreeseparatecamerarigsdefiningringsaroundthetarget.Eachrighasitsownradius,heightoffset,composer,andlenssettings.Dependingonthecamera'spositionalongthesplineconnectingthesethreerigs,thesesettingsareinterpolatedtogivethefinalcamerapositionandstate.

CinemachineGroupComposer ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.Itsjobistoaimthecameraatatargetobject,withconfigurableoffsets,damping,andcompositionrules.addition,ifthetargetisaCinemachineTargetGroup,thebehaviourwilladjusttheFOVandthecameradistancetoensurethattheentiregroupoftargetsisframedproperly.

CinemachineHardLockToTarget ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.ItsjobistoplacethecameraontheFollowTarget.

CinemachineHardLookAt ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.ItsjobistoaimthecamerahardattheLookAt

target.

CinemachineMixingCamera CinemachineMixingCameraisa"managercamera"thattakesonthestateoftheweightedaverageofthestatesofitschildvirtualcameras.ofslotsaremadeavailableforcameras,ratherthanadynamicarray.WedoitthiswayinordertosupportweightanimationfromtheTimeline.animatearrayelements.

CinemachineOrbitalTransposer ThisisaCinemachineComponentinthetheBodysectionofthecomponentpipeline.positionthecamerainavariablerelationshiptoathevcam'sFollowtargetobject,withoffsetsanddamping.typicallyusedtoimplementacamerathatfollowsitstarget.canacceptplayerinputfromaninputdevice,whichallowstheplayertodynamicallycontroltherelationshipbetweenthecameraandthetarget,ajoystick.TheOrbitalTransposerintroducestheconceptof__Heading__,whichisthedirectionthetargetismoving,andtheOrbitalTransposerwillattempttopositionthecamerainrelationshiptotheheading,whichisbydefaultdirectlybehindthetarget.

controlthedefaultrelationshipbyadjustingtheHeadingBiassetting.IfyouattachaninputcontrollertotheOrbitalTransposer,thentheplayercanalsothecamerapositionsitselfinrelationtothetargetheading.Thisallowsthecameratomovetoanyspotonanorbitaroundthetarget.

CinemachinePath Definesaworld-spacepath,consistingofanarrayofwaypoints,eachofwhichhasposition,tangent,androllsettings.Bezierinterpolationperformedbetweenthewaypoints,togetasmoothandcontinuouspath.

CinemachinePathBase Abstractbaseclassforaworld-spacepath,cameradollytrack.

CinemachinePathBaseAppearance Thisclassholdsthesettingsthatcontrolhowthepathintheeditorsceneview.pathisnotvisibleinthegameview

CinemachinePipeline InternalcontainerforCinemachineComponentBase.Doesnothingbutcontain.

CinemachinePOV ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.Itsjobistoaimthe

camerainresponsetotheuser'smouseorjoystickinput.composerdoesnotchangethecamera'sposition.panandtilttheis,inordertogetthedesiredframing.Tomovethecamera,youhavetousethevirtualcamera'sBodysection.

CinemachineSmoothPath Definesaworld-spacepath,consistingofanarrayofwaypoints,eachofwhichhaspositionandrollsettings.interpolationbetweenthewaypoints,togetasmoothandcontinuouspath.Thepathwillpassthroughallwaypoints,and(unlikeCinemachinePath)firstsecondordercontinuityisguaranteed

CinemachineStateDrivenCamera Thisisavirtualcamera"manager"thatownsandmanagesacollectionVirtualCameras.vcamsaremappedtoindividualstatesinananimationstatemachine,allowingyoutoassociatespecificvcamstospecificanimationstates.thatstateisactiveinthestatemachine,thenthecamerawillbeactivated.candefinecustomblendsandtransitionsbetweenchildcameras.Inordertousethisbehaviour,youmusthavean

animatedtarget(i.e.anobjectanimatedwithastatemachine)todrivethebehaviour.

CinemachineTargetGroup Definesagroupoftargetobjects,eachwitharadiusandaweight.Theweightisusedwhencalculatingtheaveragepositionofthetargetgroup.Higher-weightedmembersofthegroupwillcountmore.boundingboxiscalculatedbytakingthememberpositions,weight,andradiiintoaccount.

CinemachineTrackedDolly ACinemachineVirtualCameraBodycomponentthatconstrainscameramotionCinemachinePath.canmovealongthepath.behaviourcanoperateintwomodes:manualpositioning,andAuto-Dollypositioning.Manualmode,thecamera'spositionisspecifiedbyanimatingthePathPositionfield.InAuto-Dollymode,thePathPositionfieldisanimatedautomaticallyeveryframebyfindingthepositiononthepaththat'sclosesttothevirtualcamera'sFollowtarget.

CinemachineTransposer ThisisaCinemachineComponentintheBodysectionofthecomponentpipeline.Itsjobistopositionthecamerainafixedrelationshiptothevcam'sFollow

withoffsetsanddamping.Tansposerwillonlychangethecamera'spositioninspace.willnotre-orientorotherwiseaimthecamera.needtoinstructAimsectionofitspipeline.

CinemachineVirtualCamera ThisbehaviourisintendedtobeattachedtoanemptyTransformGameObject,VirtualCamerawithintheUnityscene.TheVirtualCamerawillanimateitsTransformaccordingtotherulescontainedCinemachineComponentpipeline(Aim,Body,andNoise).WhenthevirtualtheUnitycamerawillassumethepositionandorientationthevirtualcamera.cameraisnotacamera.Instead,itcanbethoughtofasacameracontroller,cameraman.ItcandrivetheUnityCameraandcontrolitsposition,orientation,lenssettings,andPostProcessingeffects.EachVirtualCameraownsitsownCinemachineComponentPipeline,throughwhichyouprovidetheinstructionstrackingspecificgameobjects.virtualcameraisverylightweight,anddoesnorenderingofitsown.ItmerelytracksinterestingGameObjects,andpositionsitselfaccordingly.

Atypicalgameofvirtualcameras,eachsetuptofollowaparticularcharactercaptureaparticularevent.VirtualCameracanbeinanyofthreestates:virtualcameraisactivelycontrollingtheUnityCamera.Thevirtualcameraistrackingitstargetsandbeingupdatedeveryframe.***Standby**:ThevirtualcameraistrackingitstargetsandbeingupdatedbutnoUnityCameraisactivelybeingcontrolledbyit.ThisisstateofavirtualcamerathatisenabledinthescenebutperhapsatatheLivevirtualcamera.**Disabled**:Thevirtualcameraispresentbutdisabledinthescene.Itisnotactivelytrackingitstargetsandsoconsumesnoprocessingpower.However,virtualcameracanbemadelivefromtheTimeline.Cameracanbedrivenbyanyvirtualcamerainthescene.Thegamelogiccanchoosethevirtualcameratomakelivebymanipulatingthevirtualcameras'enabledflagsandtheirpriorities,basedongamelogic.Inordertobedrivenbyavirtualcamera,theUnityCameramusthaveaCinemachineBrainbehaviour,whichwillselectthemosteligiblevirtualcamerabasedonitspriority

criteria,andwillmanageblending.

CinemachineVirtualCameraBase BaseclassforaMonobehaviourthatrepresentsaVirtualCamerawithintheUnityscene.intendedtobeattachedtoanemptyTransformGameObject.InheritedclassescanbeeitherstandalonevirtualcamerassuchasCinemachineVirtualCamera,ormeta-camerassuchasCinemachineClearShotorCinemachineFreeLook.CinemachineVirtualCameraBaseexposesaPriorityproperty.Whenthebehaviourisinthegame,theVirtualCameraisautomaticallyplacedinaqueuemaintainedbythestaticCinemachineCoresingleton.Thequeueissortedbypriority.WhenaUnitycameraisequippedwithaCinemachineBrainbehaviour,thebrainwillchoosethecameraattheheadofthequeue.havemultipleUnitycameraswithCinemachineBrainbehaviours(sayinasplit-screencontext),thenyoucanfilterthequeuebysettingthecullingflagsonthevirtualcameras.cullingmaskoftheCamerawillthenactasafilterforthebrain.thereisnothingthatpreventsavirtualcamerafromcontrollingmultipleUnitycameras

simultaneously.

DocumentationSortingAttribute Atrtributetocontroltheautomaticgenerationofdocumentation.

LensSettingsPropertyAttribute PropertyappliedtoLensSettings.drawingintheinspector.

NoiseSettings Thisisanassetthatdefinesanoiseprofile.theshapeofthenoiseasafunctionoftime.arbitrarilycomplexshapesbycombiningdifferentbaseperlinnoisefrequenciesatdifferentamplitudes.amplitudesshouldbechosenwithcare,toensureaninterestingnoisequalitythatisnotobviouslyrepetitive.mathematicalside-note,anyarbitraryperiodiccurvecanbebrokendownintoafixed-amplitudesine-wavesaddedtogether.fourierdecomposition,basisofmuchsignalprocessing.Itdoesn'treallyhavemuchtodowiththisasset,butit'ssuperinteresting!

NoSaveDuringPlayAttribute Suppressesplay-mode-saveforafield.Useitifthecalseehas[SaveDuringPlay]therearefieldsintheclassthatshouldn'tbesaved.

SaveDuringPlayAttribute Invokeplay-mode-saveforaclass.Thisclass'sfieldswillbescanneduponexitingplaymode,anditspropertyvalueswillbeappliedtothesceneobject.ThisisastopgapmeasurethatwillbecomeobsoleteonceUnityimplementsplay-mode-saveinamoregeneralway.

Structures Structure Description

AxisState Axisstatefordefiningtoreacttoplayerinput.Thesettingsherecontroltheresponsivenessoftheaxistoplayerinput.

CameraState TheoutputoftheCinemachineengineforaspecificvirtualcamera.informationinthisstructcanbeblended,andprovideswhatisneededtocalculateanappropriatecameraposition,orientation,andlenssetting.RawvaluesarewhattheCinemachine

behavioursgenerate.Thecorrectionchannelholdsperturbationstotherawvalues-e.g.noiseorsmoothing,orobstacleavoidancecorrections.Coirrectionsarenotconsideredwhenmakingtime-basedcalculationssuchasdamping.TheFinalpositionandorientationisthecominationoftherawvaluesandcorrections.

CameraStateCustomBlendable Opaquestructurerepresentextrablendablestuffanditsweight.Thebasesystemignoresthisdata-itisintendedforextensionmodules

CinemachineBlendDefinition DefinitionofaCamerablend.structholdstheinformationnecessarytogenerateasuitableAnimationCurveforaCinemachineBlend.

CinemachineBlenderSettingsCustomBlend ContainerspecifyinghowtwospecificCinemachineVirtualCamerasblendtogether.

CinemachineBlendListCameraInstruction ThisrepresentsasingleentryintheinstrunctionlistoftheBlendListCamera.

CinemachineFreeLookOrbit DefinestheheightandradiusoftheRigorbit

CinemachineOrbitalTransposerHeading Howthe"forward"directionisdefined.Orbitaloffsetisinrelationtotheforwarddirection.

CinemachineOrbitalTransposerRecentering Controlshowautomaticorbitrecenteringoccurs

CinemachinePathWaypoint Awaypointalongthepath

CinemachineSmoothPathWaypoint Awaypointalongthepath

CinemachineStateDrivenCameraInstruction ThisrepresentsasingleinstrunctiontotheStateDrivenCamera.Itassociatesanstatefromthestatemachinewithachild

VirtualCamera,andalsoholdsactivationtuningparameters.

CinemachineTargetGroupTarget Holdstheinformationthatrepresentsamemberofthegroup

CinemachineTrackedDollyAutoDolly Controlshowautomaticdollyingoccurs

LensSettings DescribestheFOVandclipplanesforacamera.ThisgenerallymirrorstheUnityCamera'slenssettings,andwillbeusedtodrivetheUnitycamerawhenthevcamisactive.

NoiseSettingsNoiseParams Describesthebehaviourforachannelofnoise

NoiseSettingsTransformNoiseParams Containsthebehaviourofnoiseforthenoisemoduleforall3cardinalaxesofthecamera

Interfaces Interface Description

ICinemachineCamera AnabstractrepresentationofavirtualcamerawhichliveswithintheUnityscene

Delegates Delegate

CinemachineCoreAxisInputDelegate

CinemachineFreeLookCreateRigDelegate

CinemachineFreeLookDestroyRigDelegate

CinemachineVirtualCameraCreatePipelineDelegate

CinemachineVirtualCameraDestroyPipelineDelegate

CinemachineVirtualCameraBaseOnPostPipelineStageDelegate

Enumerations Enumeration

CinemachineBlendDefinitionStyle

CinemachineBrainUpdateMethod

CinemachineColliderResolutionStrategy

CinemachineConfinerMode

CinemachineCoreStage

CinemachineCoreUpdateFilter

CinemachineDollyCartUpdateMethod

CinemachineFramingTransposerAdjustmentMode

CinemachineFramingTransposerFramingMode

CinemachineGroupComposerAdjustmentMode

CinemachineGroupComposerFramingMode

CinemachineOrbitalTransposerHeadingHeadingDefinition

CinemachinePathBasePositionUnits

CinemachineTargetGroupPositionMode

CinemachineTargetGroupRotationMode

CinemachineTargetGroupUpdateMethod

CinemachineTrackedDollyCameraUpMode

CinemachineTransposerBindingMode

DocumentationSortingAttributeLevel




Cinemachine

AxisStateStructure

Axisstatefordefiningtoreacttoplayerinput.Thesettingsherecontroltheresponsivenessoftheaxistoplayerinput.

Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)

Syntax

TheAxisStatetypeexposesthefollowingmembers.

Constructors Name Description

AxisState Constructorwithspecificvalues

Top

Methods Name Description

SetThresholds Setstheconstraintsbywhichthisaxiswilloperateon

Update Updatesthestateofthisaxis

[SerializableAttribute]

[DocumentationSortingAttribute(6.4f,DocumentationSortingAttribute

publicstructAxisState

CopyC# JavaScript

basedontheaxisdefinedbyAxisState.m_AxisName

Validate CallfromOnValidate:Makesurethefieldsaresensible

Top

Fields Name Description

m_AccelTime TheamountoftimeinsecondsittakestoacceleratetoMaxSpeedwiththesuppliedAxisatitsmaximumvalue

m_DecelTime Theamountoftimeinsecondsittakestodeceleratetheaxistozeroifthesuppliedaxisisinaneutralposition

m_InputAxisName ThenameofthisaxisasspecifiedinUnityInputmanager.Settingtoanemptystringwilldisabletheautomaticupdatingofthisaxis

m_InputAxisValue Thevalueoftheinputaxis.Avalueof0meansnoinputYoucandrivethisdirectlyfromacustominputsystem,oryoucansettheAxisNameandhavethevaluedrivenbytheinternalInputManager

m_InvertAxis Ifchecked,thentherawvalue

oftheinputaxiswillbeinvertedbeforeitisused.

m_MaxSpeed Howfasttheaxisvaluecantravel.Increasingthisnumbermakesthebehaviourmoreresponsivetojoystickinput

Value Thecurrentvalueoftheaxis

Top

SeeAlsoReferenceCinemachineNamespace




Cinemachine

AxisStateConstructor

Constructorwithspecificvalues


Syntax

Parameters

maxSpeedType:SystemSingle[Missing<paramname="maxSpeed"/>documentationfor"M:Cinemachine.AxisState.#ctor(System.Single,System.Single,System.Single,System.Single,System.String,System.Boolean)"]

accelTimeType:SystemSingle[Missing<paramname="accelTime"/>documentationfor"M:Cinemachine.AxisState.#ctor(System.Single,System.Single,System.Single,System.Single,System.String,System.Boolean)"]

decelTimeType:SystemSingle[Missing<paramname="decelTime"/>documentationfor"M:Cinemachine.AxisState.#ctor(System.Single,System.Single,System.Single,System.Single,System.String,System.Boolean)"]

val

publicAxisState(

floatmaxSpeed,

floataccelTime,

floatdecelTime,

floatval,

stringname,

boolinvert

)

CopyC# JavaScript

http://msdn2.microsoft.com/en-us/library/3www918f



Type:SystemSingle[Missing<paramname="val"/>documentationfor"M:Cinemachine.AxisState.#ctor(System.Single,System.Single,System.Single,System.Single,System.String,System.Boolean)"]

nameType:SystemString[Missing<paramname="name"/>documentationfor"M:Cinemachine.AxisState.#ctor(System.Single,System.Single,System.Single,System.Single,System.String,System.Boolean)"]

invertType:SystemBoolean[Missing<paramname="invert"/>documentationfor"M:Cinemachine.AxisState.#ctor(System.Single,System.Single,System.Single,System.Single,System.String,System.Boolean)"]

SeeAlsoReferenceAxisStateStructureCinemachineNamespace



http://msdn2.microsoft.com/en-us/library/s1wwdcbf

http://msdn2.microsoft.com/en-us/library/a28wyd50



Cinemachine

AxisStateMethods



SetThresholds Setstheconstraintsbywhichthisaxiswilloperateon

Update UpdatesthestateofthisaxisbasedontheaxisdefinedbyAxisState.m_AxisName

Validate CallfromOnValidate:Makesurethefieldsaresensible

Top





Cinemachine

AxisStateSetThresholdsMethod

Setstheconstraintsbywhichthisaxiswilloperateon


Syntax

Parameters

minValueType:SystemSingleThelowestvaluethisaxiscanachieve

maxValueType:SystemSingleThehighestvaluethisaxiscanachieve

wrapAroundType:SystemBooleanIftrue,valuescommandedgreaterthanmMaxValueorlessthanmMinValuewillwraparound.Iffalse,thevaluewillbeclampedwithintherange.

SeeAlsoReferenceAxisStateStructure

publicvoidSetThresholds(

floatminValue,

floatmaxValue,

boolwrapAround

)

CopyC# JavaScript




Cinemachine

AxisStateUpdateMethod

UpdatesthestateofthisaxisbasedontheaxisdefinedbyAxisState.m_AxisName


Syntax

Parameters

deltaTimeType:SystemSingleDeltatimeinseconds

ReturnValueType:BooleanReturnstrueifthisaxis'inputwasnon-zerothisUpdate,flaseotherwise



publicboolUpdate(

floatdeltaTime

)

CopyC# JavaScript





Cinemachine

AxisStateValidateMethod

CallfromOnValidate:Makesurethefieldsaresensible


Syntax



publicvoidValidate()

CopyC# JavaScript



Cinemachine

AxisStateFields



m_AccelTime TheamountoftimeinsecondsittakestoacceleratetoMaxSpeedwiththesuppliedAxisatitsmaximumvalue

m_DecelTime Theamountoftimeinsecondsittakestodeceleratetheaxistozeroifthesuppliedaxisisinaneutralposition

m_InputAxisName ThenameofthisaxisasspecifiedinUnityInputmanager.Settingtoanemptystringwilldisabletheautomaticupdatingofthisaxis

m_InputAxisValue Thevalueoftheinputaxis.Avalueof0meansnoinputYoucandrivethisdirectlyfromacustominputsystem,oryoucansettheAxisNameandhavethevaluedrivenbytheinternalInputManager

m_InvertAxis Ifchecked,thentherawvalueoftheinputaxiswillbe

invertedbeforeitisused.

m_MaxSpeed Howfasttheaxisvaluecantravel.Increasingthisnumbermakesthebehaviourmoreresponsivetojoystickinput

Value Thecurrentvalueoftheaxis

Top





Cinemachine

AxisStatem_AccelTimeField

TheamountoftimeinsecondsittakestoacceleratetoMaxSpeedwiththesuppliedAxisatitsmaximumvalue


Syntax

FieldValueType:Single



[TooltipAttribute("TheamountoftimeinsecondsittakestoacceleratetoMaxSpeedwiththesuppliedAxisatitsmaximumvalue")]

publicfloatm_AccelTime

CopyC# JavaScript




Cinemachine

AxisStatem_DecelTimeField

Theamountoftimeinsecondsittakestodeceleratetheaxistozeroifthesuppliedaxisisinaneutralposition


Syntax




[TooltipAttribute("Theamountoftimeinsecondsittakestodeceleratetheaxistozeroifthesuppliedaxisisinaneutralposition")]

publicfloatm_DecelTime

CopyC# JavaScript




Cinemachine

AxisStatem_InputAxisNameField

ThenameofthisaxisasspecifiedinUnityInputmanager.Settingtoanemptystringwilldisabletheautomaticupdatingofthisaxis


Syntax

FieldValueType:String



[FormerlySerializedAsAttribute("m_AxisName")]

[TooltipAttribute("ThenameofthisaxisasspecifiedinUnityInputmanager.Settingtoanemptystringwilldisabletheautomaticupdatingofthisaxis")]

publicstringm_InputAxisName

CopyC# JavaScript




Cinemachine

AxisStatem_InputAxisValueField

Thevalueoftheinputaxis.Avalueof0meansnoinputYoucandrivethisdirectlyfromacustominputsystem,oryoucansettheAxisNameandhavethevaluedrivenbytheinternalInputManager


Syntax




[NoSaveDuringPlayAttribute]

[TooltipAttribute("Thevalueoftheinputaxis.Avalueof0meansnoinput.Youcandrivethisdirectlyfromacustominputsystem,oryoucansettheAxisNameandhavethevaluedrivenbytheinternalInputManager")]

publicfloatm_InputAxisValue

CopyC# JavaScript




Cinemachine

AxisStatem_InvertAxisField

Ifchecked,thentherawvalueoftheinputaxiswillbeinvertedbeforeitisused.


Syntax

FieldValueType:Boolean




[TooltipAttribute("Ifchecked,thentherawvalueoftheinputaxiswillbeinvertedbeforeitisused")]

publicboolm_InvertAxis

CopyC# JavaScript




Cinemachine

AxisStatem_MaxSpeedField

Howfasttheaxisvaluecantravel.Increasingthisnumbermakesthebehaviourmoreresponsivetojoystickinput


Syntax




[TooltipAttribute("Themaximumspeedofthisaxisinunits/second")]

publicfloatm_MaxSpeed

CopyC# JavaScript




Cinemachine

AxisStateValueField

Thecurrentvalueoftheaxis


Syntax





[TooltipAttribute("Thecurrentvalueoftheaxis.")]

publicfloatValue

CopyC# JavaScript




Cinemachine

CameraStateStructure

TheoutputoftheCinemachineengineforaspecificvirtualcamera.Theinformationinthisstructcanbeblended,andprovideswhatisneededtocalculateanappropriatecameraposition,orientation,andlenssetting.RawvaluesarewhattheCinemachinebehavioursgenerate.Thecorrectionchannelholdsperturbationstotherawvalues-e.g.noiseorsmoothing,orobstacleavoidancecorrections.Coirrectionsarenotconsideredwhenmakingtime-basedcalculationssuchasdamping.TheFinalpositionandorientationisthecominationoftherawvaluesandtheircorrections.


Syntax

TheCameraStatetypeexposesthefollowingmembers.

Properties Name Description

CorrectedOrientation Orientationwithcorrectionapplied.

CorrectedPosition Positionwithcorrectionapplied.

Default Statewithdefaultvalues

publicstructCameraState

CopyC# JavaScript

FinalOrientation Orientationwithcorrectionanddutchapplied.Thisiswhatthefinalcameragets.

FinalPosition Positionwithcorrectionapplied.Thisiswhatthefinalcameragets.

HasLookAt ReturnstrueifthisstatehasavalidReferenceLookAtvalue.

Lens CameraLensSettings.

NumCustomBlendables Thenumberofcustomblendablesthatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules

OrientationCorrection Orientationcorrection.Thiswillbeaddedtotheraworientation.Thisvaluedoesn'tgetfedbackintothesystemwhencalculatingthenextframe.Canbenoise,orsmoothing,orboth,orsomethingelse.

PositionCorrection Positioncorrection.Thiswillbeaddedtotherawposition.Thisvaluedoesn'tgetfedbackintothesystemwhen

calculatingthenextframe.Canbenoise,orsmoothing,orboth,orsomethingelse.

RawOrientation Raw(un-corrected)worldspaceorientationofthiscamera

RawPosition Raw(un-corrected)worldspacepositionofthiscamera

ReferenceLookAt Theworldspacefocuspointofthecamera.Whatthecamerawantstolookat.Thereisaspecialconstantdefinetorepresent"nothing".Becarefultocheckforthat(orchecktheHasLookAtproperty).

ReferenceUp Whichwayisup.Worldspaceunitvector.

ShotQuality Subjectiveestimationofhow"good"theshotis.Largervaluesmeanbetterquality.Defaultis1.

Top


AddCustomBlendable Addacustomblendable

tothepotforeventualapplicationtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules

GetCustomBlendable Getacustomblendablethatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules

Lerp Intelligentlyblendthecontentsoftwostates.

Top


kNoPoint Thisconstantrepresents"nopointinspace"or"nodirection".

Top





Cinemachine

CameraStateProperties



CorrectedOrientation Orientationwithcorrectionapplied.

CorrectedPosition Positionwithcorrectionapplied.

Default Statewithdefaultvalues

FinalOrientation Orientationwithcorrectionanddutchapplied.Thisiswhatthefinalcameragets.

FinalPosition Positionwithcorrectionapplied.Thisiswhatthefinalcameragets.

HasLookAt ReturnstrueifthisstatehasavalidReferenceLookAtvalue.

Lens CameraLensSettings.

NumCustomBlendables Thenumberofcustomblendablesthatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwise

ignoresthisdata-itisintendedforextensionmodules

OrientationCorrection Orientationcorrection.Thiswillbeaddedtotheraworientation.Thisvaluedoesn'tgetfedbackintothesystemwhencalculatingthenextframe.Canbenoise,orsmoothing,orboth,orsomethingelse.

PositionCorrection Positioncorrection.Thiswillbeaddedtotherawposition.Thisvaluedoesn'tgetfedbackintothesystemwhencalculatingthenextframe.Canbenoise,orsmoothing,orboth,orsomethingelse.

RawOrientation Raw(un-corrected)worldspaceorientationofthiscamera

RawPosition Raw(un-corrected)worldspacepositionofthiscamera

ReferenceLookAt Theworldspacefocuspointofthecamera.Whatthecamerawantstolookat.Thereisaspecialconstantdefinetorepresent"nothing".Becarefultocheckfor

that(orchecktheHasLookAtproperty).

ReferenceUp Whichwayisup.Worldspaceunitvector.

ShotQuality Subjectiveestimationofhow"good"theshotis.Largervaluesmeanbetterquality.Defaultis1.

Top

SeeAlsoReferenceCameraStateStructureCinemachineNamespace




Cinemachine

CameraStateCorrectedOrientationProperty

Orientationwithcorrectionapplied.


Syntax

PropertyValueType:Quaternion



publicQuaternionCorrectedOrientation{get;}

CopyC# JavaScript



Cinemachine

CameraStateCorrectedPositionProperty

Positionwithcorrectionapplied.


Syntax

PropertyValueType:Vector3



publicVector3CorrectedPosition{get;}

CopyC# JavaScript



Cinemachine

CameraStateDefaultProperty

Statewithdefaultvalues


Syntax

PropertyValueType:CameraState



publicstaticCameraStateDefault{get;}

CopyC# JavaScript



Cinemachine

CameraStateFinalOrientationProperty

Orientationwithcorrectionanddutchapplied.Thisiswhatthefinalcameragets.


Syntax




publicQuaternionFinalOrientation{get;}

CopyC# JavaScript



Cinemachine

CameraStateFinalPositionProperty

Positionwithcorrectionapplied.Thisiswhatthefinalcameragets.


Syntax




publicVector3FinalPosition{get;}

CopyC# JavaScript



Cinemachine

CameraStateHasLookAtProperty

ReturnstrueifthisstatehasavalidReferenceLookAtvalue.


Syntax

PropertyValueType:Boolean



publicboolHasLookAt{get;}

CopyC# JavaScript




Cinemachine

CameraStateLensProperty

CameraLensSettings.


Syntax

PropertyValueType:LensSettings



publicLensSettingsLens{get;set;}

CopyC# JavaScript



Cinemachine

CameraStateNumCustomBlendablesProperty

Thenumberofcustomblendablesthatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules


Syntax

PropertyValueType:Int32



publicintNumCustomBlendables{get;}

CopyC# JavaScript

http://msdn2.microsoft.com/en-us/library/td2s409d



Cinemachine

CameraStateOrientationCorrectionProperty

Orientationcorrection.Thiswillbeaddedtotheraworientation.Thisvaluedoesn'tgetfedbackintothesystemwhencalculatingthenextframe.Canbenoise,orsmoothing,orboth,orsomethingelse.


Syntax




publicQuaternionOrientationCorrection{get;set;}

CopyC# JavaScript



Cinemachine

CameraStatePositionCorrectionProperty

Positioncorrection.Thiswillbeaddedtotherawposition.Thisvaluedoesn'tgetfedbackintothesystemwhencalculatingthenextframe.Canbenoise,orsmoothing,orboth,orsomethingelse.


Syntax




publicVector3PositionCorrection{get;set;}

CopyC# JavaScript



Cinemachine

CameraStateRawOrientationProperty

Raw(un-corrected)worldspaceorientationofthiscamera


Syntax




publicQuaternionRawOrientation{get;set;}

CopyC# JavaScript



Cinemachine

CameraStateRawPositionProperty

Raw(un-corrected)worldspacepositionofthiscamera


Syntax




publicVector3RawPosition{get;set;}

CopyC# JavaScript



Cinemachine

CameraStateReferenceLookAtProperty

Theworldspacefocuspointofthecamera.Whatthecamerawantstolookat.Thereisaspecialconstantdefinetorepresent"nothing".Becarefultocheckforthat(orchecktheHasLookAtproperty).


Syntax




publicVector3ReferenceLookAt{get;set;}

CopyC# JavaScript



Cinemachine

CameraStateReferenceUpProperty

Whichwayisup.Worldspaceunitvector.


Syntax




publicVector3ReferenceUp{get;set;}

CopyC# JavaScript



Cinemachine

CameraStateShotQualityProperty

Subjectiveestimationofhow"good"theshotis.Largervaluesmeanbetterquality.Defaultis1.


Syntax

PropertyValueType:Single



publicfloatShotQuality{get;set;}

CopyC# JavaScript




Cinemachine

CameraStateMethods



AddCustomBlendable Addacustomblendabletothepotforeventualapplicationtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules

GetCustomBlendable Getacustomblendablethatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules

Lerp Intelligentlyblendthecontentsoftwostates.

Top


Cinemachine

CameraStateAddCustomBlendableMethod

Addacustomblendabletothepotforeventualapplicationtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules


Syntax

Parameters

bType:CinemachineCameraStateCustomBlendableThecustomblendabletoadd.Ifb.m_Customisthesameasanalready-addedcustomblendable,thentheywillbemergedandtheweightscombined.



publicvoidAddCustomBlendable(

CameraStateCustomBlendableb

)

CopyC# JavaScript



Cinemachine

CameraStateGetCustomBlendableMethod

Getacustomblendablethatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules


Syntax

Parameters

indexType:SystemInt32Whichonetoget.Mustbeinrange[0...NumCustomBlendables)

ReturnValueType:CameraStateCustomBlendableThecustomblendableatthespecifiedindex.


publicCameraStateCustomBlendableGetCustomBlendable

intindex

)

CopyC# JavaScript


Cinemachine

CameraStateLerpMethod

Intelligentlyblendthecontentsoftwostates.


Syntax

Parameters

stateAType:CinemachineCameraStateThefirststate,correspondingtot=0

stateBType:CinemachineCameraStateThesecondstate,correspondingtot=1

tType:SystemSingleHowmuchtointerpolate.Internallyclampedto0..1

ReturnValueType:CameraStateLinearlyinterpolatedCameraState

SeeAlso

publicstaticCameraStateLerp(

CameraStatestateA,

CameraStatestateB,

floatt

)

CopyC# JavaScript


ReferenceCameraStateStructureCinemachineNamespace




Cinemachine

CameraStateFields



kNoPoint Thisconstantrepresents"nopointinspace"or"nodirection".

Top





Cinemachine

CameraStatekNoPointField

Thisconstantrepresents"nopointinspace"or"nodirection".


Syntax

FieldValueType:Vector3



publicstaticVector3kNoPoint

CopyC# JavaScript



Cinemachine

CameraStateCustomBlendableStructure

Opaquestructurerepresentextrablendablestuffanditsweight.Thebasesystemignoresthisdata-itisintendedforextensionmodules


Syntax

TheCameraStateCustomBlendabletypeexposesthefollowingmembers.


CameraStateCustomBlendable Constructorwithspecificvalues

Top


m_Custom Thecustomstuffthattheextentionmodulewillconsider

publicstructCustomBlendable

CopyC# JavaScript

m_Weight Theweightofthecustomstuff.Mustbe0...1

Top





Cinemachine

CameraStateCustomBlendableConstructor



Syntax

Parameters

customType:ObjectThecustomstuffthattheextentionmodulewillconsider

weightType:SystemSingleTheweightofthecustomstuff.Mustbe0...1

SeeAlsoReferenceCameraStateCustomBlendableStructureCinemachineNamespace


publicCustomBlendable(

Objectcustom,

floatweight

)

CopyC# JavaScript




Cinemachine

CustomBlendableFields

TheCameraStateCustomBlendabletypeexposesthefollowingmembers.


m_Custom Thecustomstuffthattheextentionmodulewillconsider

m_Weight Theweightofthecustomstuff.Mustbe0...1

Top





Cinemachine

CameraStateCustomBlendablem_CustomField

Thecustomstuffthattheextentionmodulewillconsider


Syntax

FieldValueType:Object



publicObjectm_Custom

CopyC# JavaScript



Cinemachine

CameraStateCustomBlendablem_WeightField

Theweightofthecustomstuff.Mustbe0...1


Syntax




publicfloatm_Weight

CopyC# JavaScript




Cinemachine

CinemachineBasicMultiChannelPerlinClass

AsapartoftheCinemachinePipelineimplementingtheNoisestage,thiscomponentaddsPerlinNoisetotheCamerastate,intheCorrectionchanneloftheCameraState.Thenoiseiscreatedbyusingapredefinednoiseprofileasset.Thisdefinestheshapeofthenoiseovertime.Youcanscalethisinamplitudeorintime,toproducealargefamilyofdifferentnoisesusingthesameprofile.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineBasicMultiChannelPerlin


Syntax

TheCinemachineBasicMultiChannelPerlintypeexposesthefollowingmembers.

[DocumentationSortingAttribute(8f,DocumentationSortingAttribute

[AddComponentMenu("")]

[RequireComponent(typeof(CinemachinePipeline))]

[SaveDuringPlayAttribute]

publicclassCinemachineBasicMultiChannelPerlin:CinemachineComponentBase

CopyC# JavaScript

http://msdn2.microsoft.com/en-us/library/e5kfa45b


FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)

IsValid Trueifthecomponentisvalid,i.e.ithasanoisedefinitionandisenabled.(OverridesCinemachineComponentBaseIsValid.)

LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)

Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheNoisestage(OverridesCinemachineComponentBaseStage.)

VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)

VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)

Top


MutateCameraState AppliesnoisetotheCorrectionchanneloftheCameraStateifthedeltatimeisgreaterthan0.Otherwise,doesnothing.(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)

OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.classimplementationdoesnothing.(InheritedfromCinemachineComponentBase

Top


m_AmplitudeGain Gaintoapplytotheamplitudesdefinedinthesettingsasset.

m_FrequencyGain Scalefactortoapplytothefrequenciesdefinedinthesettingsasset.

m_NoiseProfile SerializedpropertyforreferencingaNoiseSettingsasset

Top

SeeAlsoReference

CinemachineNamespaceCinemachineNoiseSettings




Cinemachine

CinemachineBasicMultiChannelPerlinProperties




IsValid Trueifthecomponentisvalid,i.e.ithasanoisedefinitionandisenabled.(OverridesCinemachineComponentBaseIsValid.)


Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheNoisestage(OverridesCinemachineComponentBaseStage.)



Top

SeeAlsoReferenceCinemachineBasicMultiChannelPerlinClassCinemachineNamespace




Cinemachine

CinemachineBasicMultiChannelPerlinProperty

Trueifthecomponentisvalid,i.e.ithasanoisedefinitionandisenabled.


Syntax




publicoverrideboolIsValid{get;}

CopyC# JavaScript




Cinemachine

CinemachineBasicMultiChannelPerlinProperty

GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheNoisestage


Syntax

PropertyValueType:CinemachineCoreStage



publicoverrideCinemachineCoreStageStage{get;}

CopyC# JavaScript



Cinemachine

CinemachineBasicMultiChannelPerlinMethods



MutateCameraState AppliesnoisetotheCorrectionchanneloftheCameraStateifthedeltatimeisgreaterthan0.Otherwise,doesnothing.(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)


Top





Cinemachine

CinemachineBasicMultiChannelPerlinMethod

AppliesnoisetotheCorrectionchanneloftheCameraStateifthedeltatimeisgreaterthan0.Otherwise,doesnothing.


Syntax

Parameters

curStateType:CinemachineCameraStateThecurrentcamerastate

deltaTimeType:SystemSingleHowmuchtoadvancetheperlinnoisegenerator.Noiseisonlyappliedifthisvalueisgreaterthanorequalto0


publicoverridevoidMutateCameraState(

refCameraStatecurState,

floatdeltaTime

)

CopyC# JavaScript


Cinemachine

CinemachineBasicMultiChannelPerlinFields



m_AmplitudeGain Gaintoapplytotheamplitudesdefinedinthesettingsasset.

m_FrequencyGain Scalefactortoapplytothefrequenciesdefinedinthesettingsasset.

m_NoiseProfile SerializedpropertyforreferencingaNoiseSettingsasset

Top





Cinemachine

CinemachineBasicMultiChannelPerlinField

Gaintoapplytotheamplitudesdefinedinthesettingsasset.


Syntax




[TooltipAttribute("GaintoapplytotheamplitudesdefinedintheNoiseSettingsasset.1isnormal.Settingthisto0completelymutesthenoise.")]

publicfloatm_AmplitudeGain

CopyC# JavaScript




Cinemachine


Scalefactortoapplytothefrequenciesdefinedinthesettingsasset.


Syntax




[TooltipAttribute("ScalefactortoapplytothefrequenciesdefinedintheNoiseSettingsasset.1isnormal.Largermagnitudeswillmakethenoiseshakemorerapidly.")]

publicfloatm_FrequencyGain

CopyC# JavaScript




Cinemachine


SerializedpropertyforreferencingaNoiseSettingsasset


Syntax

FieldValueType:NoiseSettings



[HideInInspector]

[TooltipAttribute("TheassetcontainingtheNoiseProfile.Definethefrequenciesandamplitudestheretomakeacharacteristicnoiseprofile.Makeyourownorjustuseoneofthemanypresets.")]

[FormerlySerializedAsAttribute("m_Definition")]

publicNoiseSettingsm_NoiseProfile

CopyC# JavaScript



Cinemachine

CinemachineBlendClass

Describesablendbetween2CinemachineVirtualCameras,andholdsthecurrentstateoftheblend.

InheritanceHierarchySystemObjectCinemachineCinemachineBlend


Syntax

TheCinemachineBlendtypeexposesthefollowingmembers.


CinemachineBlend Constructablend

Top


BlendCurve Thecurvethatdescribesthewaytheblendtransitionsovertimefromthefirstcameratothesecond.X-

publicclassCinemachineBlend

CopyC# JavaScript


axisistimeinsecondsoverwhichtheblendtakesplaceandYaxisisblendweight(0..1)

BlendWeight Thecurrentweightoftheblend.ThisisanevaluationoftheBlendCurveatthecurrenttimerelativetothestartoftheblend.0meanscamA,1meanscamB.

CamA Firstcameraintheblend

CamB Secondcameraintheblend

Description Textdescriptionoftheblend,fordebugging

Duration Durationinsecondsoftheblend.ThisisgivenreadfromtheBlendCurve.

IsComplete Trueifthetimerelativetothestartoftheblendisgreaterthanorequaltotheblendduration

IsValid Validitytestfortheblend.Trueifbothcamerasaredefined.

State ComputetheblendedCameraStateforthecurrenttimeintheblend.

TimeInBlend Thecurrenttimerelativetothestartoftheblend

Top


UpdateCameraState Makesurethesourcecamerasgetupdated.

Uses DoestheblenduseaspecificCinemachineVirtualCamera?

Top





Cinemachine

CinemachineBlendConstructor

Constructablend


Syntax

Parameters

aType:CinemachineICinemachineCameraFirstcamera

bType:CinemachineICinemachineCameraSecondcamera

curveType:AnimationCurveBlendcurve

durationType:SystemSingle[Missing<paramname="duration"/>documentationfor"M:Cinemachine.CinemachineBlend.#ctor(Cinemachine.ICinemachineCamera,Cinemachine.ICinemachineCamera,UnityEngine.AnimationCurve,System.Single,System.Single)"]

t

publicCinemachineBlend(

ICinemachineCameraa,

ICinemachineCamerab,

AnimationCurvecurve,

floatduration,

floatt

)

CopyC# JavaScript


Type:SystemSingleCurrenttimeinblend,relativetothestartoftheblend

SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace





Cinemachine

CinemachineBlendProperties



BlendCurve Thecurvethatdescribesthewaytheblendtransitionsovertimefromthefirstcameratothesecond.X-axisistimeinsecondsoverwhichtheblendtakesplaceandYaxisisblendweight(0..1)

BlendWeight Thecurrentweightoftheblend.ThisisanevaluationoftheBlendCurveatthecurrenttimerelativetothestartoftheblend.0meanscamA,1meanscamB.

CamA Firstcameraintheblend

CamB Secondcameraintheblend

Description Textdescriptionoftheblend,fordebugging

Duration Durationinsecondsoftheblend.ThisisgivenreadfromtheBlendCurve.

IsComplete Trueifthetimerelativetothestartoftheblendisgreaterthanorequaltotheblendduration

IsValid Validitytestfortheblend.Trueifbothcamerasaredefined.

State ComputetheblendedCameraStateforthecurrenttimeintheblend.

TimeInBlend Thecurrenttimerelativetothestartoftheblend

Top





Cinemachine

CinemachineBlendBlendCurveProperty

Thecurvethatdescribesthewaytheblendtransitionsovertimefromthefirstcameratothesecond.X-axisistimeinsecondsoverwhichtheblendtakesplaceandYaxisisblendweight(0..1)


Syntax

PropertyValueType:AnimationCurve



publicAnimationCurveBlendCurve{get;set;}

CopyC# JavaScript



Cinemachine

CinemachineBlendBlendWeightProperty

Thecurrentweightoftheblend.ThisisanevaluationoftheBlendCurveatthecurrenttimerelativetothestartoftheblend.0meanscamA,1meanscamB.


Syntax




publicfloatBlendWeight{get;}

CopyC# JavaScript




Cinemachine

CinemachineBlendCamAProperty

Firstcameraintheblend


Syntax

PropertyValueType:ICinemachineCamera



publicICinemachineCameraCamA{get;set;}

CopyC# JavaScript



Cinemachine

CinemachineBlendCamBProperty

Secondcameraintheblend


Syntax




publicICinemachineCameraCamB{get;set;}

CopyC# JavaScript



Cinemachine

CinemachineBlendDescriptionProperty

Textdescriptionoftheblend,fordebugging


Syntax

PropertyValueType:String



publicstringDescription{get;}

CopyC# JavaScript




Cinemachine

CinemachineBlendDurationProperty

Durationinsecondsoftheblend.ThisisgivenreadfromtheBlendCurve.


Syntax




publicfloatDuration{get;set;}

CopyC# JavaScript




Cinemachine

CinemachineBlendIsCompleteProperty

Trueifthetimerelativetothestartoftheblendisgreaterthanorequaltotheblendduration


Syntax




publicboolIsComplete{get;}

CopyC# JavaScript




Cinemachine

CinemachineBlendIsValidProperty

Validitytestfortheblend.Trueifbothcamerasaredefined.


Syntax




publicboolIsValid{get;}

CopyC# JavaScript




Cinemachine

CinemachineBlendStateProperty

ComputetheblendedCameraStateforthecurrenttimeintheblend.


Syntax




publicCameraStateState{get;}

CopyC# JavaScript



Cinemachine

CinemachineBlendTimeInBlendProperty

Thecurrenttimerelativetothestartoftheblend


Syntax




publicfloatTimeInBlend{get;set;}

CopyC# JavaScript




Cinemachine

CinemachineBlendMethods



UpdateCameraState Makesurethesourcecamerasgetupdated.

Uses DoestheblenduseaspecificCinemachineVirtualCamera?

Top





Cinemachine

CinemachineBlendUpdateCameraStateMethod

Makesurethesourcecamerasgetupdated.


Syntax

Parameters

worldUpType:Vector3Defaultworldup.Individualvcamsmaymodifythis

deltaTimeType:SystemSingleTimeincrementusedforcalculatingtime-basedbehaviours(e.g.damping)


VisittheCinemachineForum

publicvoidUpdateCameraState(

Vector3worldUp,

floatdeltaTime

)

CopyC# JavaScript



Cinemachine

CinemachineBlendUsesMethod

DoestheblenduseaspecificCinemachineVirtualCamera?


Syntax

Parameters

camType:CinemachineICinemachineCameraThecameratotest

ReturnValueType:BooleanTrueifthecameraisinvolvedintheblend



publicboolUses(

ICinemachineCameracam

)

CopyC# JavaScript




Cinemachine

CinemachineBlendDefinitionStructure

DefinitionofaCamerablend.ThisstructholdstheinformationnecessarytogenerateasuitableAnimationCurveforaCinemachineBlend.


Syntax

TheCinemachineBlendDefinitiontypeexposesthefollowingmembers.


CinemachineBlendDefinition Constructor

Top


BlendCurve AnAnimationCurvespecifyingthe



publicstructCinemachineBlendDefinition

CopyC# JavaScript

interpolationdurationandvalueforthiscamerablend.Thetimeofthelastkeyframeisassumedtothebethedurationoftheblend.Y-axisvaluesmustbeinrange[0,1](internallyclampedwithinBlender)andtimemustbeinrangeof[0,+infinity)

Top


m_Style Theshapeoftheblendcurve.

m_Time Theduration(inseconds)oftheblend

Top





Cinemachine

CinemachineBlendDefinitionConstructor

Constructor


Syntax

Parameters

styleType:CinemachineCinemachineBlendDefinitionStyleTheshapeoftheblendcurve.

timeType:SystemSingleTheduration(inseconds)oftheblend

SeeAlsoReferenceCinemachineBlendDefinitionStructureCinemachineNamespace


publicCinemachineBlendDefinition(

CinemachineBlendDefinitionStylestyle,

floattime

)

CopyC# JavaScript




Cinemachine

CinemachineBlendDefinitionProperties



BlendCurve AnAnimationCurvespecifyingtheinterpolationdurationandvalueforthiscamerablend.Thetimeofthelastkeyframeisassumedtothebethedurationoftheblend.Y-axisvaluesmustbeinrange[0,1](internallyclampedwithinBlender)andtimemustbeinrangeof[0,+infinity)

Top





Cinemachine

CinemachineBlendDefinitionBlendCurveProperty

AnAnimationCurvespecifyingtheinterpolationdurationandvalueforthiscamerablend.Thetimeofthelastkeyframeisassumedtothebethedurationoftheblend.Y-axisvaluesmustbeinrange[0,1](internallyclampedwithinBlender)andtimemustbeinrangeof[0,+infinity)


Syntax

PropertyValueType:AnimationCurve



publicAnimationCurveBlendCurve{get;}

CopyC# JavaScript



Cinemachine

CinemachineBlendDefinitionFields



m_Style Theshapeoftheblendcurve.

m_Time Theduration(inseconds)oftheblend

Top





Cinemachine

CinemachineBlendDefinitionm_StyleField

Theshapeoftheblendcurve.


Syntax

FieldValueType:CinemachineBlendDefinitionStyle



[TooltipAttribute("Shapeoftheblendcurve")]

publicCinemachineBlendDefinitionStylem_Style

CopyC# JavaScript



Cinemachine

CinemachineBlendDefinitionm_TimeField

Theduration(inseconds)oftheblend


Syntax




[TooltipAttribute("Durationoftheblend,inseconds")]

publicfloatm_Time

CopyC# JavaScript




Cinemachine

CinemachineBlendDefinitionStyleEnumeration

Supportedpredefinedshapesfortheblendcurve.


Syntax

Members

Membername Value Description

Cut 0 Zero-lengthblend

EaseInOut 1 S-shapedcurve,givingagentleandsmoothtransition

EaseIn 2 Linearoutoftheoutgoingshot,andeasyintotheincoming

EaseOut 3 Easyoutoftheoutgoingshot,andlinearintotheincoming


publicenumStyle

CopyC# JavaScript

HardIn 4 Easyoutoftheoutgoing,andhardintotheincoming

HardOut 5 Hardoutoftheoutgoing,andeasyintotheincoming

Linear 6 Linearblend.Mechanical-looking.





Cinemachine

CinemachineBlendDefinitionPropertyAttributeClass

PropertyappliedtoCinemachineBlendDefinition.Usedforcustomdrawingintheinspector.

InheritanceHierarchySystemObjectSystemAttributePropertyAttributeCinemachineCinemachineBlendDefinitionPropertyAttribute


Syntax

TheCinemachineBlendDefinitionPropertyAttributetypeexposesthefollowingmembers.


CinemachineBlendDefinitionPropertyAttribute

Top

SeeAlso

publicsealedclassCinemachineBlendDefinitionPropertyAttribute

CopyC# JavaScript


http://msdn2.microsoft.com/en-us/library/e8kc3626

ReferenceCinemachineNamespace




Cinemachine

CinemachineBlendDefinitionPropertyAttributeConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineBlendDefinitionPropertyAttribute.#ctor"]


Syntax

SeeAlsoReferenceCinemachineBlendDefinitionPropertyAttributeClassCinemachineNamespace


publicCinemachineBlendDefinitionPropertyAttribute()

CopyC# JavaScript



Cinemachine

CinemachineBlenderSettingsClass

AssetthatdefinestherulesforblendingbetweenVirtualCameras.

InheritanceHierarchySystemObjectObjectScriptableObjectCinemachineCinemachineBlenderSettings


Syntax

TheCinemachineBlenderSettingstypeexposesthefollowingmembers.


CinemachineBlenderSettings

Top



publicsealedclassCinemachineBlenderSettings:ScriptableObject

CopyC# JavaScript



GetBlendCurveForVirtualCameras Attemptstofindablendcurvewhichmatchesthetoandfromcamerasasspecified.Ifnomatchisfound,thefunctionreturnseitherthedefaultblendforthisBlenderorNULLdependingonthestatereturnDefaultOnNoMatch

Top


kBlendFromAnyCameraLabel InternalAPIfortheinspectoreditopr:alabeltorepresentanycamera

m_CustomBlends ThearraycontainingexplicitlydefinedblendsbetweentwoVirtualCameras

Top

SeeAlso

Cinemachine

CinemachineBlenderSettingsConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineBlenderSettings.#ctor"]


Syntax

SeeAlsoReferenceCinemachineBlenderSettingsClassCinemachineNamespace


publicCinemachineBlenderSettings()

CopyC# JavaScript



Cinemachine

CinemachineBlenderSettingsMethods



GetBlendCurveForVirtualCameras Attemptstofindablendcurvewhichmatchesthetoandfromcamerasasspecified.Ifnomatchisfound,thefunctionreturnseitherthedefaultblendforthisBlenderorNULLdependingonthestatereturnDefaultOnNoMatch

Top





Cinemachine

CinemachineBlenderSettingsGetBlendCurveForVirtualCamerasMethod

Attemptstofindablendcurvewhichmatchesthetoandfromcamerasasspecified.Ifnomatchisfound,thefunctionreturnseitherthedefaultblendforthisBlenderorNULLdependingonthestateofreturnDefaultOnNoMatch.


Syntax

Parameters

fromCameraNameType:SystemStringThegameobjectnameofthefromcamera

toCameraNameType:SystemStringThegameobjectnameofthetocamera

defaultCurveType:AnimationCurveCurvetoreturnifnocurvefound.CanbeNULL.

publicAnimationCurveGetBlendCurveForVirtualCameras

stringfromCameraName,

stringtoCameraName,

AnimationCurvedefaultCurve

)

CopyC# JavaScript



ReturnValueType:AnimationCurve[Missing<returns>documentationfor"M:Cinemachine.CinemachineBlenderSettings.GetBlendCurveForVirtualCameras(System.String,System.String,UnityEngine.AnimationCurve)"]





Cinemachine

CinemachineBlenderSettingsFields



kBlendFromAnyCameraLabel InternalAPIfortheinspectoreditopr:alabeltorepresentanycamera

m_CustomBlends ThearraycontainingexplicitlydefinedblendsbetweentwoVirtualCameras

Top





Cinemachine

CinemachineBlenderSettingskBlendFromAnyCameraLabelField

InternalAPIfortheinspectoreditopr:alabeltorepresentanycamera


Syntax




publicconststringkBlendFromAnyCameraLabel="**ANYCAMERA**"

CopyC# JavaScript




Cinemachine

CinemachineBlenderSettingsm_CustomBlendsField

ThearraycontainingexplicitlydefinedblendsbetweentwoVirtualCameras


Syntax

FieldValueType:CinemachineBlenderSettingsCustomBlend



[TooltipAttribute("ThearraycontainingexplicitlydefinedblendsbetweentwoVirtualCameras")]

publicCinemachineBlenderSettingsCustomBlend[]m_CustomBlends

CopyC# JavaScript



Cinemachine

CinemachineBlenderSettingsCustomBlendStructure

ContainerspecifyinghowtwospecificCinemachineVirtualCamerasblendtogether.


Syntax

TheCinemachineBlenderSettingsCustomBlendtypeexposesthefollowingmembers.


m_Blend

m_From

m_To

Top

SeeAlso



publicstructCustomBlend

CopyC# JavaScript

Cinemachine

CustomBlendFields

TheCinemachineBlenderSettingsCustomBlendtypeexposesthefollowingmembers.


m_Blend

m_From

m_To

Top

SeeAlsoReferenceCinemachineBlenderSettingsCustomBlendStructureCinemachineNamespace




Cinemachine

CinemachineBlenderSettingsCustomBlendField

[Missing<summary>documentationfor"F:Cinemachine.CinemachineBlenderSettings.CustomBlend.m_Blend"]


Syntax

FieldValueType:CinemachineBlendDefinition



[TooltipAttribute("Blendcurvedefinition")]

publicCinemachineBlendDefinitionm_Blend

CopyC# JavaScript



Cinemachine


[Missing<summary>documentationfor"F:Cinemachine.CinemachineBlenderSettings.CustomBlend.m_From"]


Syntax




[TooltipAttribute("Whenblendingfromthiscamera")]

publicstringm_From

CopyC# JavaScript




Cinemachine


[Missing<summary>documentationfor"F:Cinemachine.CinemachineBlenderSettings.CustomBlend.m_To"]


Syntax




[TooltipAttribute("Whenblendingtothiscamera")]

publicstringm_To

CopyC# JavaScript




Cinemachine

CinemachineBlendListCameraClass

Thisisavirtualcamera"manager"thatownsandmanagesacollectionofchildVirtualCameras.Whenthecameragoeslive,thesechildvcamsareenabled,oneafteranother,holdingeachcameraforadesignatedtime.Blendsbetweencamerasarespecified.Thelastcameraisheldindefinitely.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineBlendListCamera


Syntax

TheCinemachineBlendListCameratypeexposesthefollowingmembers.


[ExecuteInEditMode]

[DisallowMultipleComponent]

[AddComponentMenu("Cinemachine/CinemachineBlendListCamera")]

publicclassCinemachineBlendListCamera:CinemachineVirtualCameraBase

CopyC# JavaScript



CinemachineBlendListCamera

Top


ChildCameras Thelistofchildcameras.Thesearejusttheimmediatechildreninthehierarchy.

Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo(OverridesCinemachineVirtualCameraBase

Follow GetthecurrentFollowtarget.Returnsparent'sFollowifparentisnon-nullandnospecificFollowdefinedforthiscamera(OverridesCinemachineVirtualCameraBase

IsBlending Isthereablendinprogress?

LiveChild Getthecurrent"best"childvirtualcamera,thatwouldbechoseniftheStateDrivenCamerawereactive.

LiveChildOrSelf Returnthelivechild.(OverridesCinemachineVirtualCameraBase

LookAt GetthecurrentLookAttarget.LookAtifparentisnon-nullandnospecific

LookAtdefinedforthiscamera(OverridesCinemachineVirtualCameraBase

Name GetthenameoftheVirtualCamera.implementationreturnstheownerGameObject'sname.(InheritedfromCinemachineVirtualCameraBase

ParentCamera Supportformeta-virtual-cameras.situationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.areimplementedasTransformchildrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase

PreviousStateIsValid SetthistoforcethenextupdatetoignoredeltaTimeandresetitself(InheritedfromCinemachineVirtualCameraBase

Priority GetthePriorityofthevirtualcamera.determinesitsplacementintheCinemachineCore'squeueofeligibleshots.(InheritedfromCinemachineVirtualCameraBase

State TheStateofthecurrentlivechild(OverridesCinemachineVirtualCameraBase

ValidatingStreamVersion Versionthatwaslaststreamed,forupgradinglegacy(InheritedfromCinemachineVirtualCameraBase

VirtualCameraGameObject TheGameObjectowneroftheVirtualCamerabehaviour.(InheritedfromCinemachineVirtualCameraBase

Top


AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.pipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase

InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforall(InheritedfromCinemachineVirtualCameraBase

IsLiveChild Checkwhetherthevcamalivechildofthiscamera.(OverridesCinemachineVirtualCameraBase

MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereisLivecameraifitsharesthehighestpriorityinthequeuewithitspeers.themostrecentonegoestothetopoftheprioritysubqueue.anditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.(InheritedfromCinemachineVirtualCameraBase

OnDestroy Baseclassimplementationremovesthevirtualcamerafromthepriorityqueue.(InheritedfromCinemachineVirtualCameraBase

OnDisable Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase

OnEnable Makessuretheinternalchildcacheisuptodate(OverridesCinemachineVirtualCameraBase

OnTransformChildrenChanged Makessuretheinternalchildcacheisuptodate

OnTransformParentChanged Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase

OnTransitionFromCamera (OverridesCinemachineVirtualCameraBase

OnValidate Enforceboundsforfields,whenchangedininspector.basemethodiscalled,ValidatingStreamVersionwillbevalid.

(InheritedfromCinemachineVirtualCameraBase

PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,areupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledLateUpdateinstead.Baseclassimplementationdoesnothing.(InheritedfromCinemachineVirtualCameraBase

RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.(OverridesCinemachineVirtualCameraBase

ResolveFollow Returnsthisvcam'sFollowtarget,orifthatisnull,willretrun(InheritedfromCinemachineVirtualCameraBase

ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretrun(InheritedfromCinemachineVirtualCameraBase

Start Baseclassimplementationdoesnothing.(InheritedfromCinemachineVirtualCameraBase

Update Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase

UpdateCameraState CalledbyCinemachineCoreatdesignatedupdatetimeupdatesallthechildren,choosesthebestone,andimplementsanyrequiredblending.(OverridesCinemachineVirtualCameraBase

ValidateInstructions InternalAPIfortheinspectoreditor.

Top


CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.


m_ChildCameras InternalAPIfortheeditor.usethisfield

m_EnableAllChildCameras Forceallchildcamerastobeenabled.ThisisusefulifanimatingtheminTimeline,butconsumesextraresources.

m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase

m_Follow Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildrig.Maybeempty

m_Instructions Thesetofinstructionsassociatingvirtualcameraswithstates.setofinstructionsforenablingchildcameras

m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase

m_LookAt Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildrig.Maybeempty

m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedon

thestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase

m_ShowDebugText Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging

OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase

Top





Cinemachine

CinemachineBlendListCameraConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineBlendListCamera.#ctor"]


Syntax

SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace


publicCinemachineBlendListCamera()

CopyC# JavaScript



Cinemachine

CinemachineBlendListCameraProperties









LookAt GetthecurrentLookAttarget.

LookAtifparentisnon-nullandnospecificLookAtdefinedforthiscamera(OverridesCinemachineVirtualCameraBase








Top





Cinemachine

CinemachineBlendListCameraChildCamerasProperty

Thelistofchildcameras.Thesearejusttheimmediatechildreninthehierarchy.


Syntax

PropertyValueType:CinemachineVirtualCameraBase



publicCinemachineVirtualCameraBase[]ChildCameras{

CopyC# JavaScript



Cinemachine

CinemachineBlendListCameraDescriptionProperty

Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo


Syntax

PropertyValueType:StringImplementsICinemachineCameraDescription



publicoverridestringDescription{get;}

CopyC# JavaScript




Cinemachine

CinemachineBlendListCameraFollowProperty

GetthecurrentFollowtarget.Returnsparent'sFollowifparentisnon-nullandnospecificFollowdefinedforthiscamera


Syntax

PropertyValueType:TransformImplementsICinemachineCameraFollow



publicoverrideTransformFollow{get;set;}

CopyC# JavaScript



Cinemachine

CinemachineBlendListCameraIsBlendingProperty

Isthereablendinprogress?


Syntax




publicboolIsBlending{get;}

CopyC# JavaScript




Cinemachine

CinemachineBlendListCameraLiveChildProperty

Getthecurrent"best"childvirtualcamera,thatwouldbechoseniftheStateDrivenCamerawereactive.


Syntax




publicICinemachineCameraLiveChild{get;set;}

CopyC# JavaScript



Cinemachine

CinemachineBlendListCameraLiveChildOrSelfProperty

Returnthelivechild.


Syntax

PropertyValueType:ICinemachineCameraImplementsICinemachineCameraLiveChildOrSelf



publicoverrideICinemachineCameraLiveChildOrSelf{

CopyC# JavaScript



Cinemachine

CinemachineBlendListCameraLookAtProperty

GetthecurrentLookAttarget.Returnsparent'sLookAtifparentisnon-nullandnospecificLookAtdefinedforthiscamera


Syntax

PropertyValueType:TransformImplementsICinemachineCameraLookAt



publicoverrideTransformLookAt{get;set;}

CopyC# JavaScript



Cinemachine

CinemachineBlendListCameraStateProperty

TheStateofthecurrentlivechild


Syntax

PropertyValueType:CameraStateImplementsICinemachineCameraState



publicoverrideCameraStateState{get;}

CopyC# JavaScript



Cinemachine

CinemachineBlendListCameraMethods












OnTransitionFromCamera (OverridesCinemachineVirtualCameraBase

OnValidate Enforceboundsforfields,whenchangedininspector.basemethodiscalled,ValidatingStreamVersionwillbevalid.(InheritedfromCinemachineVirtualCameraBase









Top

Cinemachine

CinemachineBlendListCameraIsLiveChildMethod

Checkwhetherthevcamalivechildofthiscamera.


Syntax

Parameters

vcamType:CinemachineICinemachineCameraTheVirtualCameratocheck

ReturnValueType:BooleanTrueifthevcamiscurrentlyactivelyinfluencingthestateofthisvcamImplementsICinemachineCameraIsLiveChild(ICinemachineCamera)


publicoverrideboolIsLiveChild(

ICinemachineCameravcam

)

CopyC# JavaScript


Cinemachine

CinemachineBlendListCameraOnEnableMethod

Makessuretheinternalchildcacheisuptodate


Syntax



protectedoverridevoidOnEnable()

CopyC# JavaScript



Cinemachine

CinemachineBlendListCameraOnTransformChildrenChangedMethod



Syntax



publicvoidOnTransformChildrenChanged()

CopyC# JavaScript



Cinemachine

CinemachineBlendListCameraOnTransitionFromCameraMethod

[Missing<summary>documentationfor"M:Cinemachine.CinemachineBlendListCamera.OnTransitionFromCamera(Cinemachine.ICinemachineCamera)"]


Syntax

Parameters

fromCamType:CinemachineICinemachineCamera[Missing<paramname="fromCam"/>documentationfor"M:Cinemachine.CinemachineBlendListCamera.OnTransitionFromCamera(Cinemachine.ICinemachineCamera)"]

ImplementsICinemachineCameraOnTransitionFromCamera(ICinemachineCamera)


publicoverridevoidOnTransitionFromCamera(

ICinemachineCamerafromCam

)

CopyC# JavaScript

Cinemachine

CinemachineBlendListCameraRemovePostPipelineStageHookMethod

RemoveaPipelinestagehookcallback.Makesureitisremovedfromallthechildren.


Syntax

Parameters

dType:CinemachineCinemachineVirtualCameraBaseOnPostPipelineStageDelegateThedelegatetoremove.



publicoverridevoidRemovePostPipelineStageHook(


)

CopyC# JavaScript



Cinemachine

CinemachineBlendListCameraUpdateCameraStateMethod

CalledbyCinemachineCoreatdesignatedupdatetimesothevcamcanpositionitselfandtrackitstargets.Thisimplementationupdatesallthechildren,choosesthebestone,andimplementsanyrequiredblending.


Syntax

Parameters

worldUpType:Vector3DefaultworldUp,setbytheCinemachineBrain

deltaTimeType:SystemSingleDeltatimefortime-basedeffects(ignoreiflessthanorequalto0)

ImplementsICinemachineCameraUpdateCameraState(Vector3,Single)

SeeAlso

publicoverridevoidUpdateCameraState(

Vector3worldUp,

floatdeltaTime

)

CopyC# JavaScript


ReferenceCinemachineBlendListCameraClassCinemachineNamespace




Cinemachine

CinemachineBlendListCameraValidateInstructionsMethod

InternalAPIfortheinspectoreditor.


Syntax



publicvoidValidateInstructions()

CopyC# JavaScript



Cinemachine

CinemachineBlendListCameraFields



CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.(InheritedfromCinemachineVirtualCameraBase

m_ChildCameras InternalAPIfortheeditor.usethisfield




m_Instructions Thesetofinstructionsassociatingvirtualcameraswithstates.setofinstructionsforenablingchildcameras



m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase



Top





Cinemachine

CinemachineBlendListCameram_ChildCamerasField

InternalAPIfortheeditor.Donotusethisfield


Syntax

FieldValueType:CinemachineVirtualCameraBase



[SerializeField]

[HideInInspector]


publicCinemachineVirtualCameraBase[]m_ChildCameras

CopyC# JavaScript



Cinemachine

CinemachineBlendListCameram_EnableAllChildCamerasField

Forceallchildcamerastobeenabled.ThisisusefulifanimatingtheminTimeline,butconsumesextraresources.


Syntax




[TooltipAttribute("Forceallchildcamerastobeenabled.ThisisusefulifanimatingtheminTimeline,butconsumesextraresources")]

publicboolm_EnableAllChildCameras

CopyC# JavaScript




Cinemachine

CinemachineBlendListCameram_FollowField

Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildrig.Maybeempty


Syntax

FieldValueType:Transform



[TooltipAttribute("Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildcamera.Maybeemptyifallofthechildrendefinetargetsoftheirown.")]


publicTransformm_Follow

CopyC# JavaScript



Cinemachine

CinemachineBlendListCameram_InstructionsField

Thesetofinstructionsassociatingvirtualcameraswithstates.Thesetofinstructionsforenablingchildcameras


Syntax

FieldValueType:CinemachineBlendListCameraInstruction



[TooltipAttribute("Thesetofinstructionsforenablingchildcameras.")]

publicCinemachineBlendListCameraInstruction[]m_Instructions

CopyC# JavaScript



Cinemachine

CinemachineBlendListCameram_LookAtField

Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildrig.Maybeempty


Syntax




[TooltipAttribute("Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildcamera.Maybeemptyifallofthechildrendefinetargetsoftheirown.")]


publicTransformm_LookAt

CopyC# JavaScript



Cinemachine

CinemachineBlendListCameram_ShowDebugTextField

Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging


Syntax




[TooltipAttribute("Whenenabled,thecurrentchildcameraandblendwillbeindicatedinthegamewindow,fordebugging")]

publicboolm_ShowDebugText

CopyC# JavaScript




Cinemachine

CinemachineBlendListCameraInstructionStructure

ThisrepresentsasingleentryintheinstrunctionlistoftheBlendListCamera.


Syntax

TheCinemachineBlendListCameraInstructiontypeexposesthefollowingmembers.


m_Blend Howtoblendtothenextvirtualcamerainthelist(ifany)

m_Hold Howlongtowait(inseconds)beforeactivatingthenextvirtualcamerainthelist(ifany)

m_VirtualCamera Thevirtualcameratoactivatewhenthisinstructionbecomes


publicstructInstruction

CopyC# JavaScript

active

Top





Cinemachine

InstructionFields

TheCinemachineBlendListCameraInstructiontypeexposesthefollowingmembers.


m_Blend Howtoblendtothenextvirtualcamerainthelist(ifany)

m_Hold Howlongtowait(inseconds)beforeactivatingthenextvirtualcamerainthelist(ifany)

m_VirtualCamera Thevirtualcameratoactivatewhenthisinstructionbecomesactive

Top

SeeAlsoReferenceCinemachineBlendListCameraInstructionStructureCinemachineNamespace




Cinemachine

CinemachineBlendListCameraInstructionField

Howtoblendtothenextvirtualcamerainthelist(ifany)


Syntax




[CinemachineBlendDefinitionPropertyAttribute]

[TooltipAttribute("Howtoblendtothenextvirtualcamerainthelist(ifany)")]

publicCinemachineBlendDefinitionm_Blend

CopyC# JavaScript



Cinemachine


Howlongtowait(inseconds)beforeactivatingthenextvirtualcamerainthelist(ifany)


Syntax




[TooltipAttribute("Howlongtowait(inseconds)beforeactivatingthenextvirtualcamerainthelist(ifany)")]

publicfloatm_Hold

CopyC# JavaScript




Cinemachine


Thevirtualcameratoactivatewhenthisinstructionbecomesactive


Syntax




[TooltipAttribute("Thevirtualcameratoactivatewhenthisinstructionbecomesactive")]

publicCinemachineVirtualCameraBasem_VirtualCamera

CopyC# JavaScript



Cinemachine

CinemachineBrainClass

CinemachineBrainisthelinkbetweentheUnityCameraandtheCinemachineVirtualCamerasinthescene.ItmonitorstheprioritystacktochoosethecurrentVirtualCamera,andblendwithanotherifnecessary.Finallyandmostimportantly,itappliestheVirtualCamerastatetotheattachedUnityCamera.TheCinemachineBrainisalsotheplacewhererulesforblendingbetweenvirtualcamerasaredefined.Camerablendingisaninterpolationovertimeofonevirtualcamerapositionandstatetoanother.Ifyouthinkofvirtualcamerasascameramen,thenblendingisalittlelikeonecameramansmoothlypassingthecameratoanothercameraman.Youcanspecifythetimeoverwhichtoblend,aswellastheblendcurveshape.Notethatacameracutisjustazero-timeblend.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineBrain


Syntax


[ExecuteInEditMode]


[AddComponentMenu("Cinemachine/CinemachineBrain")]


publicclassCinemachineBrain:MonoBehaviour

CopyC# JavaScript


TheCinemachineBraintypeexposesthefollowingmembers.


CinemachineBrain

Top


ActiveBlend Getthecurrentblendinprogress.Returnsnullifnone.

ActiveVirtualCamera Getthecurrentactivevirtualcamera.

CurrentCameraState Thecurrentstateappliedtotheunitycamera(maybetheresultofablend)

DefaultWorldUp Getthedefaultworldupforthevirtualcameras.


OutputCamera GettheUnityCamerathatisattachedtothisGameObject.Thisisthecamerathatwillbecontrolledbythebrain.

SoloCamera APIfortheUnityEditor.Showthiscameranomatterwhat.Thisisstatic,andsoaffectsallCinemachinebrains.

Top


GetSoloGUIColor APIfortheUnityEditor.

IsLive TrueiftheICinemachineCamerathecurrentactivecamera,orpartofacurrentblend,eitherdirectlyorindirectlybecauseitsparentsarelive.

Top


m_CameraActivatedEvent Thiseventwillfirewheneveravirtualcameragoeslive.Ifablendisinvolved,thentheeventwillfireonthefirstframeoftheblend

m_CameraCutEvent Thiseventwillfirewheneveravirtualcameragoesliveandthereisnoblend

m_CustomBlends Thisistheassetwhichcontainscustomsettingsforspecificblends.

m_DefaultBlend Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras.

m_IgnoreTimeScale Whenenabled,thecameraswillalwaysrespondinreal-timetouserinputanddamping,evenifthegameisrunninginslowmotion

m_ShowCameraFrustum Whenenabled,showsthecamera'sfrustuminthesceneview.

m_ShowDebugText Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging.

m_UpdateMethod Dependingonhowthetargetobjectsareanimated,adjusttheupdatemethodtominimizethepotentialjitter.UseFixedUpdateifallyourtargetsareanimatedwithfor

RigidBodyanimation.SmartUpdatewillchoosethebestmethodforeachvirtualcamera,dependingonhowthetargetisanimated.

m_WorldUpOverride Ifset,thisobject'sYaxiswilldefinetheworldspaceUpvectorforallthevirtualcameras.Thisisusefulintop-downgameenvironments.Ifnotset,UpisworldspaceY.

Top





Cinemachine

CinemachineBrainConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineBrain.#ctor"]


Syntax

SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace


publicCinemachineBrain()

CopyC# JavaScript



Cinemachine

CinemachineBrainProperties



ActiveBlend Getthecurrentblendinprogress.Returnsnullifnone.

ActiveVirtualCamera Getthecurrentactivevirtualcamera.

CurrentCameraState Thecurrentstateappliedtotheunitycamera(maybetheresultofablend)

DefaultWorldUp Getthedefaultworldupforthevirtualcameras.


OutputCamera GettheUnityCamerathatisattachedtothisGameObject.Thisisthecamerathatwillbecontrolledbythebrain.

SoloCamera APIfortheUnityEditor.Showthiscameranomatterwhat.Thisisstatic,andsoaffectsallCinemachinebrains.

Top





Cinemachine

CinemachineBrainActiveBlendProperty

Getthecurrentblendinprogress.Returnsnullifnone.


Syntax

PropertyValueType:CinemachineBlend



publicCinemachineBlendActiveBlend{get;}

CopyC# JavaScript



Cinemachine

CinemachineBrainActiveVirtualCameraProperty

Getthecurrentactivevirtualcamera.


Syntax




publicICinemachineCameraActiveVirtualCamera{get

CopyC# JavaScript



Cinemachine

CinemachineBrainCurrentCameraStateProperty

Thecurrentstateappliedtotheunitycamera(maybetheresultofablend)


Syntax




publicCameraStateCurrentCameraState{get;}

CopyC# JavaScript



Cinemachine

CinemachineBrainDefaultWorldUpProperty

Getthedefaultworldupforthevirtualcameras.


Syntax




publicVector3DefaultWorldUp{get;}

CopyC# JavaScript



Cinemachine

CinemachineBrainIsBlendingProperty



Syntax





CopyC# JavaScript




Cinemachine

CinemachineBrainOutputCameraProperty

GettheUnityCamerathatisattachedtothisGameObject.Thisisthecamerathatwillbecontrolledbythebrain.


Syntax

PropertyValueType:Camera



publicCameraOutputCamera{get;}

CopyC# JavaScript



Cinemachine

CinemachineBrainSoloCameraProperty

APIfortheUnityEditor.Showthiscameranomatterwhat.Thisisstatic,andsoaffectsallCinemachinebrains.


Syntax




publicstaticICinemachineCameraSoloCamera{get;

CopyC# JavaScript



Cinemachine

CinemachineBrainMethods



GetSoloGUIColor APIfortheUnityEditor.

IsLive TrueiftheICinemachineCamerathecurrentactivecamera,orpartofacurrentblend,eitherdirectlyorindirectlybecauseitsparentsarelive.

Top





Cinemachine

CinemachineBrainGetSoloGUIColorMethod

APIfortheUnityEditor.


Syntax

ReturnValueType:ColorColorusedtoindicatethatacameraisinSolomode.



publicstaticColorGetSoloGUIColor()

CopyC# JavaScript



Cinemachine

CinemachineBrainIsLiveMethod

TrueiftheICinemachineCamerathecurrentactivecamera,orpartofacurrentblend,eitherdirectlyorindirectlybecauseitsparentsarelive.


Syntax

Parameters

vcamType:CinemachineICinemachineCameraThecameratotestwhetheritislive

ReturnValueType:BooleanTrueifthecameraislive(directlyorindirectly)orpartofablendinprogress.



publicboolIsLive(


)

CopyC# JavaScript




Cinemachine

CinemachineBrainFields



m_CameraActivatedEvent Thiseventwillfirewheneveravirtualcameragoeslive.Ifablendisinvolved,thentheeventwillfireonthefirstframeoftheblend

m_CameraCutEvent Thiseventwillfirewheneveravirtualcameragoesliveandthereisnoblend

m_CustomBlends Thisistheassetwhichcontainscustomsettingsforspecificblends.

m_DefaultBlend Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras.

m_IgnoreTimeScale Whenenabled,thecameraswillalwaysrespondinreal-timetouserinputand

damping,evenifthegameisrunninginslowmotion

m_ShowCameraFrustum Whenenabled,showsthecamera'sfrustuminthesceneview.

m_ShowDebugText Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging.

m_UpdateMethod Dependingonhowthetargetobjectsareanimated,adjusttheupdatemethodtominimizethepotentialjitter.UseFixedUpdateifallyourtargetsareanimatedwithforRigidBodyanimation.SmartUpdatewillchoosethebestmethodforeachvirtualcamera,dependingonhowthetargetisanimated.

m_WorldUpOverride Ifset,thisobject'sYaxiswilldefinetheworldspaceUpvectorforallthevirtualcameras.Thisisusefulintop-downgameenvironments.Ifnotset,Upis

worldspaceY.

Top





Cinemachine

CinemachineBrainm_CameraActivatedEventField

Thiseventwillfirewheneveravirtualcameragoeslive.Ifablendisinvolved,thentheeventwillfireonthefirstframeoftheblend


Syntax

FieldValueType:CinemachineBrainVcamEvent



[TooltipAttribute("Thiseventwillfirewheneveravirtualcameragoeslive.Ifablendisinvolved,thentheeventwillfireonthefirstframeoftheblend.")]

publicCinemachineBrainVcamEventm_CameraActivatedEvent

CopyC# JavaScript



Cinemachine

CinemachineBrainm_CameraCutEventField

Thiseventwillfirewheneveravirtualcameragoesliveandthereisnoblend


Syntax

FieldValueType:CinemachineBrainBrainEvent



[TooltipAttribute("Thiseventwillfirewheneveravirtualcameragoesliveandthereisnoblend")]

publicCinemachineBrainBrainEventm_CameraCutEvent

CopyC# JavaScript



Cinemachine

CinemachineBrainm_CustomBlendsField

Thisistheassetwhichcontainscustomsettingsforspecificblends.


Syntax

FieldValueType:CinemachineBlenderSettings



[TooltipAttribute("Thisistheassetthatcontainscustomsettingsforblendsbetweenspecificvirtualcamerasinyourscene")]

publicCinemachineBlenderSettingsm_CustomBlends

CopyC# JavaScript



Cinemachine

CinemachineBrainm_DefaultBlendField

Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras.


Syntax





[TooltipAttribute("Theblendthatisusedincaseswhereyouhaven'texplicitlydefinedablendbetweentwoVirtualCameras")]

publicCinemachineBlendDefinitionm_DefaultBlend

CopyC# JavaScript



Cinemachine

CinemachineBrainm_IgnoreTimeScaleField

Whenenabled,thecameraswillalwaysrespondinreal-timetouserinputanddamping,evenifthegameisrunninginslowmotion


Syntax




[TooltipAttribute("Whenenabled,thecameraswillalwaysrespondinreal-timetouserinputanddamping,evenifthegameisrunninginslowmotion")]

publicboolm_IgnoreTimeScale

CopyC# JavaScript




Cinemachine

CinemachineBrainm_ShowCameraFrustumField

Whenenabled,showsthecamera'sfrustuminthesceneview.


Syntax




[TooltipAttribute("Whenenabled,thecamera'sfrustumwillbeshownatalltimesinthesceneview")]

publicboolm_ShowCameraFrustum

CopyC# JavaScript




Cinemachine

CinemachineBrainm_ShowDebugTextField

Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging.


Syntax




[TooltipAttribute("Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging")]


CopyC# JavaScript




Cinemachine

CinemachineBrainm_UpdateMethodField

Dependingonhowthetargetobjectsareanimated,adjusttheupdatemethodtominimizethepotentialjitter.UseFixedUpdateifallyourtargetsareanimatedwithforRigidBodyanimation.SmartUpdatewillchoosethebestmethodforeachvirtualcamera,dependingonhowthetargetisanimated.


Syntax

FieldValueType:CinemachineBrainUpdateMethod



[TooltipAttribute("UseFixedUpdateifallyourtargetsareanimatedduringFixedUpdate(e.g.RigidBodies),LateUpdateifallyourtargetsareanimatedduringthenormalUpdateloop,andSmartUpdateifyouwantCinemachinetodotheappropriatethingonaper-targetbasis.SmartUpdateistherecommendedsetting")]

publicCinemachineBrainUpdateMethodm_UpdateMethod

CopyC# JavaScript



Cinemachine

CinemachineBrainm_WorldUpOverrideField

Ifset,thisobject'sYaxiswilldefinetheworldspaceUpvectorforallthevirtualcameras.Thisisusefulintop-downgameenvironments.Ifnotset,UpisworldspaceY.


Syntax




[TooltipAttribute("Ifset,thisobject'sYaxiswilldefinetheworldspaceUpvectorforallthevirtualcameras.Thisisusefulforinstanceintop-downgameenvironments.Ifnotset,UpisworldspaceY.Settingthisappropriatelyisimportant,becauseVirtualCamerasdon'tlikelookingstraightuporstraightdown.")]

publicTransformm_WorldUpOverride

CopyC# JavaScript



Cinemachine

CinemachineBrainBrainEventClass

EventwithaCinemachineBrainparameter

InheritanceHierarchySystemObjectUnityEventBaseUnityEventCinemachineBrainCinemachineCinemachineBrainBrainEvent


Syntax

TheCinemachineBrainBrainEventtypeexposesthefollowingmembers.


CinemachineBrainBrainEvent

Top

Methods


publicclassBrainEvent:UnityEvent<CinemachineBrain

CopyC# JavaScript


Name Description

AddListener(UnityActionUTP) (InheritedfromUnityEventCinemachineBrain

AddListener(Object,MethodInfo) (InheritedfromUnityEventBase.)

FindMethod_Impl (InheritedfromUnityEventCinemachineBrain

GetPersistentEventCount (InheritedfromUnityEventBase.)

GetPersistentMethodName (InheritedfromUnityEventBase.)

GetPersistentTarget (InheritedfromUnityEventBase.)

Invoke(Object) (InheritedfromUnityEventBase.)

Invoke(UTP) (InheritedfromUnityEventCinemachineBrain

RegisterPersistentListener (InheritedfromUnityEventBase.)

RemoveAllListeners (InheritedfromUnityEventBase.)

RemoveListener(UnityActionUTP) (InheritedfromUnityEventCinemachineBrain

RemoveListener(Object,MethodInfo)

(InheritedfromUnityEventBase.)

SetPersistentListenerState (InheritedfromUnityEventBase.)

ToString (InheritedfromUnityEventBase.)

ValidateRegistration(MethodInfo,Object,PersistentListenerMode)


ValidateRegistration(MethodInfo,Object,PersistentListenerMode,Type)


Top

ExplicitInterfaceImplementations Name

UnityEngine#ISerializationCallbackReceiver#OnAfterDeserialize

UnityEngine#ISerializationCallbackReceiver#OnBeforeSerialize

Top





Cinemachine

CinemachineBrainBrainEventConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineBrain.BrainEvent.#ctor"]


Syntax

SeeAlsoReferenceCinemachineBrainBrainEventClassCinemachineNamespace


publicBrainEvent()

CopyC# JavaScript



Cinemachine

BrainEventMethods

TheCinemachineBrainBrainEventtypeexposesthefollowingmembers.


AddListener(UnityActionUTP) (InheritedfromUnityEventCinemachineBrain

AddListener(Object,MethodInfo) (InheritedfromUnityEventBase.)

FindMethod_Impl (InheritedfromUnityEventCinemachineBrain

GetPersistentEventCount (InheritedfromUnityEventBase.)

GetPersistentMethodName (InheritedfromUnityEventBase.)

GetPersistentTarget (InheritedfromUnityEventBase.)

Invoke(Object) (InheritedfromUnityEventBase.)

Invoke(UTP) (InheritedfromUnityEventCinemachineBrain

RegisterPersistentListener (InheritedfromUnityEventBase.)

RemoveAllListeners (Inheritedfrom

UnityEventBase.)

RemoveListener(UnityActionUTP) (InheritedfromUnityEventCinemachineBrain



SetPersistentListenerState (InheritedfromUnityEventBase.)

ToString (InheritedfromUnityEventBase.)





Top




Top

SeeAlsoReferenceCinemachineBrainBrainEventClass

Cinemachine

CinemachineBrainUpdateMethodEnumeration

Thisenumdefinestheoptionsavailablefortheupdatemethod.


Syntax

Members


FixedUpdate 0 VirtualcamerasareupdatedinsyncwiththePhysicsmodule,inFixedUpdate

LateUpdate 1 VirtualcamerasareupdatedinMonoBehaviourLateUpdate.

SmartUpdate 2 Virtualcamerasareupdatedaccordingtohowthetargetis


publicenumUpdateMethod

CopyC# JavaScript

updated.





Cinemachine

CinemachineBrainVcamEventClass

EventwithaICinemachineCameraparameter

InheritanceHierarchySystemObjectUnityEventBaseUnityEventICinemachineCameraCinemachineCinemachineBrainVcamEvent


Syntax

TheCinemachineBrainVcamEventtypeexposesthefollowingmembers.


CinemachineBrainVcamEvent

Top

Methods


publicclassVcamEvent:UnityEvent<ICinemachineCamera

CopyC# JavaScript


Name Description

AddListener(UnityActionUTP) (InheritedfromUnityEventICinemachineCamera

AddListener(Object,MethodInfo) (InheritedfromUnityEventBase

FindMethod_Impl (InheritedfromUnityEventICinemachineCamera

GetPersistentEventCount (InheritedfromUnityEventBase

GetPersistentMethodName (InheritedfromUnityEventBase

GetPersistentTarget (InheritedfromUnityEventBase

Invoke(Object) (InheritedfromUnityEventBase

Invoke(UTP) (InheritedfromUnityEventICinemachineCamera

RegisterPersistentListener (InheritedfromUnityEventBase

RemoveAllListeners (InheritedfromUnityEventBase

RemoveListener(UnityActionUTP) (InheritedfromUnityEventICinemachineCamera


(InheritedfromUnityEventBase

SetPersistentListenerState (InheritedfromUnityEventBase

ToString (InheritedfromUnityEventBase



ValidateRegistration(MethodInfo,Object,PersistentListenerMode,


Type)

Top




Top





Cinemachine

CinemachineBrainVcamEventConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineBrain.VcamEvent.#ctor"]


Syntax

SeeAlsoReferenceCinemachineBrainVcamEventClassCinemachineNamespace


publicVcamEvent()

CopyC# JavaScript



Cinemachine

VcamEventMethods

TheCinemachineBrainVcamEventtypeexposesthefollowingmembers.


AddListener(UnityActionUTP) (InheritedfromUnityEventICinemachineCamera

AddListener(Object,MethodInfo) (InheritedfromUnityEventBase

FindMethod_Impl (InheritedfromUnityEventICinemachineCamera

GetPersistentEventCount (InheritedfromUnityEventBase

GetPersistentMethodName (InheritedfromUnityEventBase

GetPersistentTarget (InheritedfromUnityEventBase

Invoke(Object) (InheritedfromUnityEventBase

Invoke(UTP) (InheritedfromUnityEventICinemachineCamera

RegisterPersistentListener (InheritedfromUnityEventBase

RemoveAllListeners (InheritedfromUnityEventBase

RemoveListener(UnityActionUTP) (InheritedfromUnityEventICinemachineCamera



SetPersistentListenerState (InheritedfromUnityEventBase

ToString (InheritedfromUnityEventBase





Top




Top

SeeAlsoReferenceCinemachineBrainVcamEventClassCinemachineNamespace




Cinemachine

CinemachineClearShotClass

CinemachineClearShotisa"managercamera"thatownsandmanagesasetofVirtualCameragameObjectchildren.WhenLive,theClearShotwillcheckthechildren,andchoosetheonewiththebestqualityshotandmakeitLive.Thiscanbeaverypowerfultool.IfthechildcamerashaveCinemachineColliderextensions,theywillanalyzethescenefortargetobstructions,optimaltargetdistance,andotheritems,andreporttheirassessmentofshotqualitybacktotheClearShotparent,whowillthenchoosethebestone.Youcanusethistosetupcomplexmulti-cameracoverageofascene,andbeassuredthataclearshotofthetargetwillalwaysbeavailable.Ifmultiplechildcamerashavethesameshotquality,theonewiththehighestprioritywillbechosen.YoucanalsodefinecustomblendsbetweentheClearShotchildren.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineClearShot


Syntax


[ExecuteInEditMode]


[AddComponentMenu("Cinemachine/CinemachineClearShot")]

CopyC# JavaScript


TheCinemachineClearShottypeexposesthefollowingmembers.


CinemachineClearShot

Top






LiveChild Getthecurrent"best"childvirtualcamera,thatwouldbechoseniftheClearShotcamerawereactive.

LiveChildOrSelf Returnthelivechild.(Overrides

publicclassCinemachineClearShot:CinemachineVirtualCameraBase

CinemachineVirtualCameraBase

LookAt GetthecurrentLookAttarget.LookAtifparentisnon-nullandnospecificLookAtdefinedforthiscamera(OverridesCinemachineVirtualCameraBase





State TheCameraStateofthecurrentlylivechild(OverridesCinemachineVirtualCameraBase



Top











OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.(OverridesCinemachineVirtualCameraBase




ResetRandomization IfRandomizeChoiceisenabled,callthistore-randomizethechildrennextframe.






Top



m_ActivateAfter Waitthismanysecondsbeforeactivatinganewchildcamera

m_ChildCameras InternalAPIfortheeditor.usethisfiled.

m_CustomBlends Thisistheassetwhichcontainscustomsettingsforspecificblends

m_DefaultBlend Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras


m_Follow Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildcamera.Maybeempty.


m_LookAt Defaultobjectforthecamerachildrentolookat(theaim

target),ifnotspecifiedinachildcamera.Maybeempty.

m_MinDuration Anactivecameramustbeactiveforatleastthismanyseconds,unlessahigher-prioritycamerawantstoactivate


m_RandomizeChoice Ifchecked,camerachoicewillberandomizedifmultiplecamerasareequallydesirable.childlistorderwillbeused



Top

Cinemachine

CinemachineClearShotConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineClearShot.#ctor"]


Syntax

SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace


publicCinemachineClearShot()

CopyC# JavaScript



Cinemachine

CinemachineClearShotProperties







LiveChild Getthecurrent"best"childvirtualcamera,thatwouldbechoseniftheClearShotcamerawereactive.


LookAt GetthecurrentLookAttarget.LookAtifparentisnon-nullandnospecific

LookAtdefinedforthiscamera(OverridesCinemachineVirtualCameraBase





State TheCameraStateofthecurrentlylivechild(OverridesCinemachineVirtualCameraBase



Top





Cinemachine

CinemachineClearShotChildCamerasProperty



Syntax





CopyC# JavaScript



Cinemachine

CinemachineClearShotDescriptionProperty



Syntax





CopyC# JavaScript




Cinemachine

CinemachineClearShotFollowProperty



Syntax





CopyC# JavaScript



Cinemachine

CinemachineClearShotIsBlendingProperty



Syntax





CopyC# JavaScript




Cinemachine

CinemachineClearShotLiveChildProperty

Getthecurrent"best"childvirtualcamera,thatwouldbechoseniftheClearShotcamerawereactive.


Syntax





CopyC# JavaScript



Cinemachine

CinemachineClearShotLiveChildOrSelfProperty

Returnthelivechild.


Syntax





CopyC# JavaScript



Cinemachine

CinemachineClearShotLookAtProperty



Syntax





CopyC# JavaScript



Cinemachine

CinemachineClearShotStateProperty

TheCameraStateofthecurrentlylivechild


Syntax





CopyC# JavaScript



Cinemachine

CinemachineClearShotMethods











OnTransformParentChanged Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.


OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.(OverridesCinemachineVirtualCameraBase




ResetRandomization IfRandomizeChoiceisenabled,callthistore-randomizethechildrennextframe.






Top

SeeAlso

ReferenceCinemachineClearShotClassCinemachineNamespace




Cinemachine

CinemachineClearShotIsLiveChildMethod



Syntax

Parameters






)

CopyC# JavaScript


Cinemachine

CinemachineClearShotOnEnableMethod



Syntax




CopyC# JavaScript



Cinemachine

CinemachineClearShotOnTransformChildrenChangedMethod



Syntax




CopyC# JavaScript



Cinemachine

CinemachineClearShotOnTransitionFromCameraMethod

Notificationthatthisvirtualcameraisgoinglive.Thisimplementationresetsthechildrandomization.


Syntax

Parameters

fromCamType:CinemachineICinemachineCameraThecamerabeingdeactivated.Maybenull.






)

CopyC# JavaScript



Cinemachine

CinemachineClearShotRemovePostPipelineStageHookMethod



Syntax

Parameters






)

CopyC# JavaScript



Cinemachine

CinemachineClearShotResetRandomizationMethod

IfRandomizeChoiceisenabled,callthistore-randomizethechildrennextframe.Thisisusefulifyouwanttofreshenuptheshot.


Syntax



publicvoidResetRandomization()

CopyC# JavaScript



Cinemachine

CinemachineClearShotUpdateCameraStateMethod



Syntax

Parameters


deltaTimeType:SystemSingleDeltatimefortime-basedeffects(ignoreiflessthan0)


SeeAlso


Vector3worldUp,

floatdeltaTime

)

CopyC# JavaScript


ReferenceCinemachineClearShotClassCinemachineNamespace




Cinemachine

CinemachineClearShotFields




m_ActivateAfter Waitthismanysecondsbeforeactivatinganewchildcamera

m_ChildCameras InternalAPIfortheeditor.usethisfiled.

m_CustomBlends Thisistheassetwhichcontainscustomsettingsforspecificblends

m_DefaultBlend Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras


m_Follow Defaultobjectforthecamerachildrenwantstomovewith(the

bodytarget),ifnotspecifiedinachildcamera.Maybeempty.


m_LookAt Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildcamera.Maybeempty.

m_MinDuration Anactivecameramustbeactiveforatleastthismanyseconds,unlessahigher-prioritycamerawantstoactivate


m_RandomizeChoice Ifchecked,camerachoicewillberandomizedifmultiplecamerasareequallydesirable.childlistorderwillbeused


OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.

Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase

Top





Cinemachine

CinemachineClearShotm_ActivateAfterField

Waitthismanysecondsbeforeactivatinganewchildcamera


Syntax




[TooltipAttribute("Waitthismanysecondsbeforeactivatinganewchildcamera")]

publicfloatm_ActivateAfter

CopyC# JavaScript




Cinemachine

CinemachineClearShotm_ChildCamerasField

InternalAPIfortheeditor.Donotusethisfiled.


Syntax




[SerializeField]

[HideInInspector]


publicCinemachineVirtualCameraBase[]m_ChildCameras

CopyC# JavaScript



Cinemachine

CinemachineClearShotm_CustomBlendsField

Thisistheassetwhichcontainscustomsettingsforspecificblends


Syntax




[HideInInspector]


CopyC# JavaScript



Cinemachine

CinemachineClearShotm_DefaultBlendField

Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras


Syntax





[TooltipAttribute("Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras")]


CopyC# JavaScript



Cinemachine

CinemachineClearShotm_FollowField

Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildcamera.Maybeempty.


Syntax




[TooltipAttribute("Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildcamera.Maybeemptyifallchildrenspecifytargetsoftheirown.")]



CopyC# JavaScript



Cinemachine

CinemachineClearShotm_LookAtField

Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildcamera.Maybeempty.


Syntax




[TooltipAttribute("Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildcamera.Maybeemptyifallchildrenspecifytargetsoftheirown.")]



CopyC# JavaScript



Cinemachine

CinemachineClearShotm_MinDurationField

Anactivecameramustbeactiveforatleastthismanyseconds,unlessahigher-prioritycamerawantstoactivate


Syntax




[TooltipAttribute("Anactivecameramustbeactiveforatleastthismanyseconds,unlessahigher-prioritycamerawantstoactivate")]

publicfloatm_MinDuration

CopyC# JavaScript




Cinemachine

CinemachineClearShotm_RandomizeChoiceField

Ifchecked,camerachoicewillberandomizedifmultiplecamerasareequallydesirable.Otherwise,childlistorderwillbeused


Syntax




[TooltipAttribute("Ifchecked,camerachoicewillberandomizedifmultiplecamerasareequallydesirable.Otherwise,childlistorderandchildcameraprioritywillbeused.")]

publicboolm_RandomizeChoice

CopyC# JavaScript




Cinemachine

CinemachineClearShotm_ShowDebugTextField



Syntax







CopyC# JavaScript




Cinemachine

CinemachineColliderClass

Anadd-onmoduleforCinemachineVirtualCamerathatpost-processesthefinalpositionofthevirtualcamera.Basedonthesuppliedsettings,theColliderwillattempttopreservethelineofsightwiththeLookAttargetofthevirtualcamerabymovingawayfromobjectsthatwillobstructtheview.Additionally,theCollidercanbeusedtoassesstheshotqualityandreportthisasafieldinthecameraState.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineExtensionCinemachineCinemachineCollider


Syntax

TheCinemachineCollidertypeexposesthefollowingmembers.

Properties


[ExecuteInEditMode]



publicclassCinemachineCollider:CinemachineExtension

CopyC# JavaScript


Name Description

DebugPaths InspectorAPIfordebuggingcollisionresolutionpath

VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineExtension.)

Top


Awake Connecttovirtualcamerapipeline.implementation(InheritedfromCinemachineExtension

CameraWasDisplaced Seewhetherthevirtualcamerahasbeenmovednbythecollider

GetAllExtraStatesT Ineffeicientmethodtogetallextrastateinforforallvcams.only,notruntime!(InheritedfromCinemachineExtension

GetExtraStateT Becauseextensionscanbeplacedonmanagercamsandwillinthatforallthevcamchildren,vcam-specificstateinformationdefineaclasstoholdyourstateinfo(InheritedfromCinemachineExtension

IsTargetObscured Seewheteranobjectisblockingthecamera'sviewofthetarget

OnDestroy Cleanup(OverridesCinemachineExtension

PostPipelineStageCallback Callcacktotothecollisionresolutionandshotevaluation(OverridesCinemachineExtensionPostPipelineStageCallback(CinemachineVirtualCameraBase,

CinemachineCoreStage,CameraState

Top


m_AvoidObstacles Whenenabled,willattempttoresolvesituationswherethelineofsighttothetargetisblockedbyanobstacle

m_CameraRadius Camerawilltrytomaintainthisdistancefromanyobstacle.IncreasethisvalueifyouareseeinginsideobstaclesduetoalargeFOVonthecamera.

m_CollideAgainst TheUnitylayermaskagainstwhichthecolliderwillraycast.

m_Damping Thegradualnessofcollisionresolution.

Highernumberswillmovethecameramoregraduallyawayfromobstructions.

m_DistanceLimit Theraycastdistancetotestforwhencheckingifthelineofsighttothiscamera'stargetisclear.

m_MaximumEffort Upperlimitonhowmanyobstaclehitstoprocess.Highernumbersmayimpactperformance.Inmostenvironments,4isenough.

m_MinimumDistanceFromTarget Obstaclesclosertothetargetthanthiswillnotbeseen

m_OptimalTargetDistance Ifgreaterthanzero,ahigherscorewillbegiventoshotswhenthetargetisclosertothisdistance.Set

thistozerotodisablethisfeature

m_Strategy ThewayinwhichtheColliderwillattempttopreservesightofthetarget.

Top





Cinemachine

CinemachineColliderProperties



DebugPaths InspectorAPIfordebuggingcollisionresolutionpath


Top

SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace




Cinemachine

CinemachineColliderDebugPathsProperty

InspectorAPIfordebuggingcollisionresolutionpath


Syntax

PropertyValueType:ListListVector3



publicList<List<Vector3>>DebugPaths{get;}

CopyC# JavaScript

http://msdn2.microsoft.com/en-us/library/6sh2ey19




Cinemachine

CinemachineColliderMethods




CameraWasDisplaced Seewhetherthevirtualcamerahasbeenmovednbythecollider



IsTargetObscured Seewheteranobjectisblockingthecamera'sviewofthetarget

OnDestroy Cleanup(OverridesCinemachineExtension

PostPipelineStageCallback Callcacktotothecollisionresolutionandshotevaluation(OverridesCinemachineExtensionPostPipelineStageCallback(CinemachineVirtualCameraBase,CinemachineCoreStage,CameraState

Top

Cinemachine

CinemachineColliderCameraWasDisplacedMethod

Seewhetherthevirtualcamerahasbeenmovednbythecollider


Syntax

Parameters

vcamType:CinemachineCinemachineVirtualCameraBaseThevirtualcamerainquestion.Thismightbedifferentfromthevirtualcamerathatownsthecollider,intheeventthatthecamerahaschildren

ReturnValueType:BooleanTrueifthevirtualcamerahasbeendisplacedduetocollisionortargetobstruction


publicboolCameraWasDisplaced(

CinemachineVirtualCameraBasevcam

)

CopyC# JavaScript


Cinemachine

CinemachineColliderIsTargetObscuredMethod

Seewheteranobjectisblockingthecamera'sviewofthetarget


Syntax

Parameters

vcamType:CinemachineICinemachineCameraThevirtualcamerainquestion.Thismightbedifferentfromthevirtualcamerathatownsthecollider,intheeventthatthecamerahaschildren

ReturnValueType:BooleanTrueifsomethingisblockingtheview


publicboolIsTargetObscured(


)

CopyC# JavaScript


Cinemachine

CinemachineColliderOnDestroyMethod

Cleanup


Syntax



protectedoverridevoidOnDestroy()

CopyC# JavaScript



Cinemachine

CinemachineColliderPostPipelineStageCallbackMethod

Callcacktotothecollisionresolutionandshotevaluation


Syntax

Parameters

vcamType:CinemachineCinemachineVirtualCameraBase[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineCollider.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

stageType:CinemachineCinemachineCoreStage[Missing<paramname="stage"/>documentationfor"M:Cinemachine.CinemachineCollider.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

stateType:CinemachineCameraState[Missing<paramname="state"/>documentationfor"M:Cinemachine.CinemachineCollider.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

protectedoverridevoidPostPipelineStageCallback(

CinemachineVirtualCameraBasevcam,

CinemachineCoreStagestage,

refCameraStatestate,

floatdeltaTime

)

CopyC# JavaScript

deltaTimeType:SystemSingle[Missing<paramname="deltaTime"/>documentationfor"M:Cinemachine.CinemachineCollider.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]






Cinemachine

CinemachineColliderFields



m_AvoidObstacles Whenenabled,willattempttoresolvesituationswherethelineofsighttothetargetisblockedbyanobstacle

m_CameraRadius Camerawilltrytomaintainthisdistancefromanyobstacle.IncreasethisvalueifyouareseeinginsideobstaclesduetoalargeFOVonthecamera.

m_CollideAgainst TheUnitylayermaskagainstwhichthecolliderwillraycast.

m_Damping The

gradualnessofcollisionresolution.Highernumberswillmovethecameramoregraduallyawayfromobstructions.

m_DistanceLimit Theraycastdistancetotestforwhencheckingifthelineofsighttothiscamera'stargetisclear.

m_MaximumEffort Upperlimitonhowmanyobstaclehitstoprocess.Highernumbersmayimpactperformance.Inmostenvironments,4isenough.

m_MinimumDistanceFromTarget Obstaclesclosertothetargetthanthiswillnotbeseen

m_OptimalTargetDistance Ifgreaterthanzero,ahigherscorewillbegiventoshots

whenthetargetisclosertothisdistance.Setthistozerotodisablethisfeature

m_Strategy ThewayinwhichtheColliderwillattempttopreservesightofthetarget.

Top





Cinemachine

CinemachineColliderm_AvoidObstaclesField

Whenenabled,willattempttoresolvesituationswherethelineofsighttothetargetisblockedbyanobstacle


Syntax




[SpaceAttribute]

[TooltipAttribute("Whenenabled,willattempttoresolvesituationswherethelineofsighttothetargetisblockedbyanobstacle")]

[FormerlySerializedAsAttribute("m_PreserveLineOfSight")]

publicboolm_AvoidObstacles

CopyC# JavaScript




Cinemachine

CinemachineColliderm_CameraRadiusField

Camerawilltrytomaintainthisdistancefromanyobstacle.IncreasethisvalueifyouareseeinginsideobstaclesduetoalargeFOVonthecamera.


Syntax




[TooltipAttribute("Camerawilltrytomaintainthisdistancefromanyobstacle.Trytokeepthisvaluesmall.IncreaseitifyouareseeinginsideobstaclesduetoalargeFOVonthecamera.")]

publicfloatm_CameraRadius

CopyC# JavaScript




Cinemachine

CinemachineColliderm_CollideAgainstField

TheUnitylayermaskagainstwhichthecolliderwillraycast.


Syntax

FieldValueType:LayerMask



[HeaderAttribute("ObstacleDetection")]

[TooltipAttribute("TheUnitylayermaskagainstwhichthecolliderwillraycast")]

publicLayerMaskm_CollideAgainst

CopyC# JavaScript



Cinemachine

CinemachineColliderm_DampingField

Thegradualnessofcollisionresolution.Highernumberswillmovethecameramoregraduallyawayfromobstructions.


Syntax




[RangeAttribute(0f,10f)]

[TooltipAttribute("Thegradualnessofcollisionresolution.Highernumberswillmovethecameramoregraduallyawayfromobstructions.")]

[FormerlySerializedAsAttribute("m_Smoothing")]

publicfloatm_Damping

CopyC# JavaScript




Cinemachine

CinemachineColliderm_DistanceLimitField

Theraycastdistancetotestforwhencheckingifthelineofsighttothiscamera'stargetisclear.


Syntax




[TooltipAttribute("Themaximumraycastdistancewhencheckingifthelineofsighttothiscamera'stargetisclear.Ifthesettingis0orless,thecurrentactualdistancetotargetwillbeused.")]

[FormerlySerializedAsAttribute("m_LineOfSightFeelerDistance")]

publicfloatm_DistanceLimit

CopyC# JavaScript




Cinemachine

CinemachineColliderm_MaximumEffortField

Upperlimitonhowmanyobstaclehitstoprocess.Highernumbersmayimpactperformance.Inmostenvironments,4isenough.


Syntax

FieldValueType:Int32




[TooltipAttribute("Upperlimitonhowmanyobstaclehitstoprocess.Highernumbersmayimpactperformance.Inmostenvironments,4isenough.")]

publicintm_MaximumEffort

CopyC# JavaScript




Cinemachine

CinemachineColliderm_MinimumDistanceFromTargetField

Obstaclesclosertothetargetthanthiswillnotbeseen


Syntax




[TooltipAttribute("Obstaclesclosertothetargetthanthiswillnotbeseen")]

publicfloatm_MinimumDistanceFromTarget

CopyC# JavaScript




Cinemachine

CinemachineColliderm_OptimalTargetDistanceField

Ifgreaterthanzero,ahigherscorewillbegiventoshotswhenthetargetisclosertothisdistance.Setthistozerotodisablethisfeature


Syntax




[HeaderAttribute("ShotEvaluation")]

[TooltipAttribute("Ifgreaterthanzero,ahigherscorewillbegiventoshotswhenthetargetisclosertothisdistance.Setthistozerotodisablethisfeature.")]

publicfloatm_OptimalTargetDistance

CopyC# JavaScript




Cinemachine

CinemachineColliderm_StrategyField

ThewayinwhichtheColliderwillattempttopreservesightofthetarget.


Syntax

FieldValueType:CinemachineColliderResolutionStrategy



[TooltipAttribute("ThewayinwhichtheColliderwillattempttopreservesightofthetarget.")]

publicCinemachineColliderResolutionStrategym_Strategy

CopyC# JavaScript



Cinemachine

CinemachineColliderResolutionStrategyEnumeration

ThewayinwhichtheColliderwillattempttopreservesightofthetarget.


Syntax

Members Membername Value Description

PullCameraForward 0 CamerawillbepulledforwardalongitsZaxisuntilitisinfrontofthenearestobstacle

PreserveCameraHeight 1 Inadditiontopullingthecameraforward,aneffortwillbemadeto

publicenumResolutionStrategy

CopyC# JavaScript

returnthecameratoitsoriginalheight

PreserveCameraDistance 2 Inadditiontopullingthecameraforward,aneffortwillbemadetoreturnthecameratoitsoriginaldistancefromthetarget





Cinemachine

CinemachineComponentBaseClass

AnabstractrepresentationofamutatoractingonaCinemachineVirtualCamera

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseMore...


Syntax

TheCinemachineComponentBasetypeexposesthefollowingmembers.


CinemachineComponentBase


publicabstractclassCinemachineComponentBase:MonoBehaviour

CopyC# JavaScript


Top


FollowTarget Returnstheownervcam'sFollowtarget.

IsValid Returnstrueifthisobjectisenabledandsetuptoproduceresults.

LookAtTarget Returnstheownervcam'sLookAttarget.

Stage Whatpartofthepipelinethisfitsinto

VcamState Returnstheownervcam'sCameraState.

VirtualCamera GettheassociatedCinemachineVirtualCameraBase

Top


MutateCameraState Mutatesthecamerastate.Thisstatewilllaterbeappliedtothecamera.

OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.Baseclassimplementationdoes

nothing.

Top


Epsilon Usefulconstantforverysmallfloats

Top


InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineBasicMultiChannelPerlinCinemachineCinemachineComposerCinemachineCinemachineFramingTransposerCinemachineCinemachineHardLockToTargetCinemachineCinemachineHardLookAtCinemachineCinemachinePOVCinemachineCinemachineTrackedDollyCinemachineCinemachineTransposer





Cinemachine

CinemachineComponentBaseConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineComponentBase.#ctor"]


Syntax

SeeAlsoReferenceCinemachineComponentBaseClassCinemachineNamespace


protectedCinemachineComponentBase()

CopyC# JavaScript



Cinemachine

CinemachineComponentBaseProperties



FollowTarget Returnstheownervcam'sFollowtarget.

IsValid Returnstrueifthisobjectisenabledandsetuptoproduceresults.

LookAtTarget Returnstheownervcam'sLookAttarget.

Stage Whatpartofthepipelinethisfitsinto

VcamState Returnstheownervcam'sCameraState.


Top

SeeAlsoReferenceCinemachineComponentBaseClass

Cinemachine

CinemachineComponentBaseFollowTargetProperty

Returnstheownervcam'sFollowtarget.


Syntax

PropertyValueType:Transform



publicTransformFollowTarget{get;}

CopyC# JavaScript



Cinemachine

CinemachineComponentBaseIsValidProperty

Returnstrueifthisobjectisenabledandsetuptoproduceresults.


Syntax




publicabstractboolIsValid{get;}

CopyC# JavaScript




Cinemachine

CinemachineComponentBaseLookAtTargetProperty

Returnstheownervcam'sLookAttarget.


Syntax




publicTransformLookAtTarget{get;}

CopyC# JavaScript



Cinemachine

CinemachineComponentBaseStageProperty

Whatpartofthepipelinethisfitsinto


Syntax




publicabstractCinemachineCoreStageStage{get;}

CopyC# JavaScript



Cinemachine

CinemachineComponentBaseVcamStateProperty

Returnstheownervcam'sCameraState.


Syntax




publicCameraStateVcamState{get;}

CopyC# JavaScript



Cinemachine

CinemachineComponentBaseVirtualCameraProperty

GettheassociatedCinemachineVirtualCameraBase


Syntax




publicCinemachineVirtualCameraBaseVirtualCamera{

CopyC# JavaScript



Cinemachine

CinemachineComponentBaseMethods



MutateCameraState Mutatesthecamerastate.Thisstatewilllaterbeappliedtothecamera.

OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.Baseclassimplementationdoesnothing.

Top





Cinemachine

CinemachineComponentBaseMutateCameraStateMethod

Mutatesthecamerastate.Thisstatewilllaterbeappliedtothecamera.


Syntax

Parameters

curStateType:CinemachineCameraStateInputstatethatmustbemutated




publicabstractvoidMutateCameraState(


floatdeltaTime

)

CopyC# JavaScript



Cinemachine

CinemachineComponentBaseOnPositionDraggedMethod

APIfortheeditor,toprocessapositiondragfromtheuser.Baseclassimplementationdoesnothing.


Syntax

Parameters

deltaType:Vector3Theamountdraggedthisframe



publicvirtualvoidOnPositionDragged(

Vector3delta

)

CopyC# JavaScript



Cinemachine

CinemachineComponentBaseFields




Top





Cinemachine

CinemachineComponentBaseEpsilonField

Usefulconstantforverysmallfloats


Syntax




protectedconstfloatEpsilon=0.0001f

CopyC# JavaScript




Cinemachine

CinemachineComposerClass

ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.Itsjobistoaimthecameraatthevcam'sLookAttargetobject,withconfigurableoffsets,damping,andcompositionrules.Thecomposerdoesnotchangethecamera'sposition.Itwillonlypanandtiltthecamerawhereitis,inordertogetthedesiredframing.Tomovethecamera,youhavetousethevirtualcamera'sBodysection.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineComposerCinemachineCinemachineGroupComposer


Syntax

TheCinemachineComposertypeexposesthefollowingmembers.


[ExecuteInEditMode]




publicclassCinemachineComposer:CinemachineComponentBase

CopyC# JavaScript




HardGuideRect InternalAPIfortheinspectoreditor

IsValid TrueifcomponentisenabledandhasaLookAtdefined(OverridesCinemachineComponentBaseIsValid.)


SoftGuideRect InternalAPIfortheinspectoreditor

Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage(OverridesCinemachineComponentBaseStage.)



Top


GetTrackedPoint Applythetargetoffsetstothetargetlocation.

MutateCameraState Appliesthecomposerrulesandorientsthecameraaccordingly(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)


Top


m_BiasX Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone

m_BiasY Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone

m_DeadZoneHeight Camerawillnotrotateverticallyifthetargetiswithinthisrangeoftheposition

m_DeadZoneWidth Camerawillnotrotate

horizontallyifthetargetiswithinthisrangeoftheposition

m_HorizontalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-horizontaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.

m_LookaheadSmoothing Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag

m_LookaheadTime Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothe

future.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.

m_ScreenX Horizontalscreenpositionfortarget.Thecamerawillrotatetothepositionthetrackedobjecthere

m_ScreenY Verticalscreenpositionfortarget,Thecamerawillrotatetotopositionthetrackedobjecthere

m_SoftZoneHeight Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed

m_SoftZoneWidth Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed

m_TrackedObjectOffset Targetoffsetfromtheobject'scenterinLOCALspacewhichtheComposertracks.Usethistofine-tunethetrackingtargetpositionwhenthedesiredareaisnotinthetrackedobject'scenter

m_VerticalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-verticaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.

OnGUICallback UsedbytheInspectorEditortodisplayon-screenguides.

Top

SeeAlsoReference

Cinemachine

CinemachineComposerProperties









VcamState Returnstheownervcam's

CameraState.(InheritedfromCinemachineComponentBase.)


Top

SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace




Cinemachine

CinemachineComposerHardGuideRectProperty

InternalAPIfortheinspectoreditor


Syntax

PropertyValueType:Rect



publicRectHardGuideRect{get;set;}

CopyC# JavaScript



Cinemachine

CinemachineComposerIsValidProperty

TrueifcomponentisenabledandhasaLookAtdefined


Syntax





CopyC# JavaScript




Cinemachine

CinemachineComposerSoftGuideRectProperty



Syntax




publicRectSoftGuideRect{get;set;}

CopyC# JavaScript



Cinemachine

CinemachineComposerStageProperty

GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage


Syntax





CopyC# JavaScript



Cinemachine

CinemachineComposerMethods



GetTrackedPoint Applythetargetoffsetstothetargetlocation.



Top





Cinemachine

CinemachineComposerGetTrackedPointMethod

Applythetargetoffsetstothetargetlocation.


Syntax

Parameters

lookAtType:Vector3TheunoffsetLookAtpoint

ReturnValueType:Vector3TheLookAtpointwiththeoffsetapplied



protectedvirtualVector3GetTrackedPoint(

Vector3lookAt

)

CopyC# JavaScript



Cinemachine

CinemachineComposerMutateCameraStateMethod

Appliesthecomposerrulesandorientsthecameraaccordingly


Syntax

Parameters


deltaTimeType:SystemSingleUsedforcalculatingdamping.Iflessthanzero,thentargetwillsnaptothecenterofthedeadzone.





floatdeltaTime

)

CopyC# JavaScript



Cinemachine

CinemachineComposerFields





m_DeadZoneHeight Camerawillnotrotateverticallyifthetargetiswithinthisrangeoftheposition

m_DeadZoneWidth Camerawillnotrotatehorizontallyifthetargetiswithinthisrangeoftheposition

m_HorizontalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-horizontaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecamerato

keepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.


m_LookaheadTime Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.

m_ScreenX Horizontalscreenpositionfortarget.Thecamerawillrotatetothepositionthetrackedobjecthere

m_ScreenY Verticalscreenpositionfortarget,Thecamerawillrotatetotopositionthetrackedobjecthere



m_TrackedObjectOffset Targetoffsetfromtheobject'scenterinLOCALspacewhichtheComposertracks.Usethistofine-tunethetrackingtargetpositionwhenthedesiredareaisnotinthetrackedobject'scenter

m_VerticalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-verticaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.


Top





Cinemachine

CinemachineComposerm_BiasXField

Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone


Syntax




[RangeAttribute(-0.5f,0.5f)]

[TooltipAttribute("Anon-zerobiaswillmovethetargetpositionhorizontallyawayfromthecenterofthesoftzone.")]

publicfloatm_BiasX

CopyC# JavaScript




Cinemachine

CinemachineComposerm_BiasYField



Syntax





[TooltipAttribute("Anon-zerobiaswillmovethetargetpositionverticallyawayfromthecenterofthesoftzone.")]

publicfloatm_BiasY

CopyC# JavaScript




Cinemachine

CinemachineComposerm_DeadZoneHeightField

Camerawillnotrotateverticallyifthetargetiswithinthisrangeoftheposition


Syntax





[TooltipAttribute("Camerawillnotrotateverticallyifthetargetiswithinthisrangeoftheposition.")]

publicfloatm_DeadZoneHeight

CopyC# JavaScript




Cinemachine

CinemachineComposerm_DeadZoneWidthField

Camerawillnotrotatehorizontallyifthetargetiswithinthisrangeoftheposition


Syntax





[TooltipAttribute("Camerawillnotrotatehorizontallyifthetargetiswithinthisrangeoftheposition.")]

publicfloatm_DeadZoneWidth

CopyC# JavaScript




Cinemachine

CinemachineComposerm_HorizontalDampingField

Howaggressivelythecameratriestofollowthetargetinthescreen-horizontaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.


Syntax




[SpaceAttribute]


[TooltipAttribute("Howaggressivelythecameratriestofollowthetargetinthescreen-horizontaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.")]

publicfloatm_HorizontalDamping

CopyC# JavaScript




Cinemachine

CinemachineComposerm_LookaheadSmoothingField

Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag


Syntax




[TooltipAttribute("Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag")]


publicfloatm_LookaheadSmoothing

CopyC# JavaScript




Cinemachine

CinemachineComposerm_LookaheadTimeField

Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.


Syntax




[TooltipAttribute("Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.")]


publicfloatm_LookaheadTime

CopyC# JavaScript




Cinemachine

CinemachineComposerm_ScreenXField

Horizontalscreenpositionfortarget.Thecamerawillrotatetothepositionthetrackedobjecthere


Syntax




[SpaceAttribute]


[TooltipAttribute("Horizontalscreenpositionfortarget.Thecamerawillrotatetopositionthetrackedobjecthere.")]

publicfloatm_ScreenX

CopyC# JavaScript




Cinemachine

CinemachineComposerm_ScreenYField

Verticalscreenpositionfortarget,Thecamerawillrotatetotopositionthetrackedobjecthere


Syntax





[TooltipAttribute("Verticalscreenpositionfortarget,Thecamerawillrotatetopositionthetrackedobjecthere.")]

publicfloatm_ScreenY

CopyC# JavaScript




Cinemachine

CinemachineComposerm_SoftZoneHeightField

Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed


Syntax





[TooltipAttribute("Whentargetiswithinthisregion,camerawillgraduallyrotateverticallytore-aligntowardsthedesiredposition,dependingonthedampingspeed.")]

publicfloatm_SoftZoneHeight

CopyC# JavaScript




Cinemachine

CinemachineComposerm_SoftZoneWidthField



Syntax





[TooltipAttribute("Whentargetiswithinthisregion,camerawillgraduallyrotatehorizontallytore-aligntowardsthedesiredposition,dependingonthedampingspeed.")]

publicfloatm_SoftZoneWidth

CopyC# JavaScript




Cinemachine

CinemachineComposerm_TrackedObjectOffsetField

Targetoffsetfromtheobject'scenterinLOCALspacewhichtheComposertracks.Usethistofine-tunethetrackingtargetpositionwhenthedesiredareaisnotinthetrackedobject'scenter


Syntax




[TooltipAttribute("Targetoffsetfromthetargetobject'scenterintarget-localspace.Usethistofine-tunethetrackingtargetpositionwhenthedesiredareaisnotthetrackedobject'scenter.")]

publicVector3m_TrackedObjectOffset

CopyC# JavaScript



Cinemachine

CinemachineComposerm_VerticalDampingField

Howaggressivelythecameratriestofollowthetargetinthescreen-verticaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.


Syntax





[TooltipAttribute("Howaggressivelythecameratriestofollowthetargetinthescreen-verticaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.")]

publicfloatm_VerticalDamping

CopyC# JavaScript




Cinemachine

CinemachineComposerOnGUICallbackField

UsedbytheInspectorEditortodisplayon-screenguides.


Syntax

FieldValueType:Action




[HideInInspector]

publicActionOnGUICallback

CopyC# JavaScript

http://msdn2.microsoft.com/en-us/library/bb534741



Cinemachine

CinemachineConfinerClass

Anadd-onmoduleforCinemachineVirtualCamerathatpost-processesthefinalpositionofthevirtualcamera.Itwillconfinethevirtualcamera'spositiontothevolumespecifiedintheBoundingVolumefield.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineExtensionCinemachineCinemachineConfiner


Syntax

TheCinemachineConfinertypeexposesthefollowingmembers.



[ExecuteInEditMode]



publicclassCinemachineConfiner:CinemachineExtension

CopyC# JavaScript


CinemachineConfiner

Top


IsValid Checkiftheboundingvolumeisdefined


Top



CameraWasDisplaced Seewhetherthevirtualcamerahasbeenmovedbytheconfiner



InvalidatePathCache Callthisiftheboundingshape'spointschangeatruntime

OnDestroy Disconnectfromvirtualcamerapipeline.baseimplementation(InheritedfromCinemachineExtension

PostPipelineStageCallback Callbacktotothecameraconfining(OverridesCinemachineExtensionPostPipelineStageCallback(CinemachineVirtualCameraBase,CinemachineCoreStage,CameraState

Top


m_BoundingShape2D The2Dshapewithinwhichthecameraistobecontained.

m_BoundingVolume Thevolumewithinwhichthecameraistobecontained.

m_ConfineMode Theconfinercanoperateusinga2Dboundingshapeora3Dboundingvolume

m_ConfineScreenEdges Ifcameraisorthographic,screenedgeswillbeconfinedtothevolume.

m_Damping Howgraduallytoreturnthecameratotheboundingvolumeifitgoesbeyondtheborders

Top





Cinemachine

CinemachineConfinerConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineConfiner.#ctor"]


Syntax

SeeAlsoReferenceCinemachineConfinerClassCinemachineNamespace


publicCinemachineConfiner()

CopyC# JavaScript



Cinemachine

CinemachineConfinerProperties



IsValid Checkiftheboundingvolumeisdefined


Top





Cinemachine

CinemachineConfinerIsValidProperty

Checkiftheboundingvolumeisdefined


Syntax




publicboolIsValid{get;}

CopyC# JavaScript




Cinemachine

CinemachineConfinerMethods




CameraWasDisplaced Seewhetherthevirtualcamerahasbeenmovedbytheconfiner



InvalidatePathCache Callthisiftheboundingshape'spointschangeatruntime


PostPipelineStageCallback Callbacktotothecameraconfining(OverridesCinemachineExtensionPostPipelineStageCallback(CinemachineVirtualCameraBase,CinemachineCoreStage,CameraState

Top

Cinemachine

CinemachineConfinerCameraWasDisplacedMethod

Seewhetherthevirtualcamerahasbeenmovedbytheconfiner


Syntax

Parameters

vcamType:CinemachineCinemachineVirtualCameraBaseThevirtualcamerainquestion.Thismightbedifferentfromthevirtualcamerathatownstheconfiner,intheeventthatthecamerahaschildren

ReturnValueType:BooleanTrueifthevirtualcamerahasbeenrepositioned


publicboolCameraWasDisplaced(


)

CopyC# JavaScript


Cinemachine

CinemachineConfinerInvalidatePathCacheMethod

Callthisiftheboundingshape'spointschangeatruntime


Syntax



publicvoidInvalidatePathCache()

CopyC# JavaScript



Cinemachine

CinemachineConfinerPostPipelineStageCallbackMethod

Callbacktotothecameraconfining


Syntax

Parameters

vcamType:CinemachineCinemachineVirtualCameraBase[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineConfiner.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

stageType:CinemachineCinemachineCoreStage[Missing<paramname="stage"/>documentationfor"M:Cinemachine.CinemachineConfiner.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

stateType:CinemachineCameraState[Missing<paramname="state"/>documentationfor"M:Cinemachine.CinemachineConfiner.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]





floatdeltaTime

)

CopyC# JavaScript

deltaTimeType:SystemSingle[Missing<paramname="deltaTime"/>documentationfor"M:Cinemachine.CinemachineConfiner.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]






Cinemachine

CinemachineConfinerFields



m_BoundingShape2D The2Dshapewithinwhichthecameraistobecontained.

m_BoundingVolume Thevolumewithinwhichthecameraistobecontained.

m_ConfineMode Theconfinercanoperateusinga2Dboundingshapeora3Dboundingvolume

m_ConfineScreenEdges Ifcameraisorthographic,screenedgeswillbeconfinedtothevolume.

m_Damping Howgraduallytoreturnthecameratotheboundingvolumeifitgoesbeyondtheborders

Top

SeeAlso

ReferenceCinemachineConfinerClassCinemachineNamespace




Cinemachine

CinemachineConfinerm_BoundingShape2DField

The2Dshapewithinwhichthecameraistobecontained.


Syntax

FieldValueType:Collider2D



[TooltipAttribute("The2Dshapewithinwhichthecameraistobecontained")]

publicCollider2Dm_BoundingShape2D

CopyC# JavaScript



Cinemachine

CinemachineConfinerm_BoundingVolumeField

Thevolumewithinwhichthecameraistobecontained.


Syntax

FieldValueType:Collider



[TooltipAttribute("Thevolumewithinwhichthecameraistobecontained")]

publicColliderm_BoundingVolume

CopyC# JavaScript



Cinemachine

CinemachineConfinerm_ConfineModeField

Theconfinercanoperateusinga2Dboundingshapeora3Dboundingvolume


Syntax

FieldValueType:CinemachineConfinerMode



[TooltipAttribute("Theconfinercanoperateusinga2Dboundingshapeora3Dboundingvolume")]

publicCinemachineConfinerModem_ConfineMode

CopyC# JavaScript



Cinemachine

CinemachineConfinerm_ConfineScreenEdgesField

Ifcameraisorthographic,screenedgeswillbeconfinedtothevolume.


Syntax




[TooltipAttribute("Ifcameraisorthographic,screenedgeswillbeconfinedtothevolume.Ifnotchecked,thenonlythecameracenterwillbeconfined")]

publicboolm_ConfineScreenEdges

CopyC# JavaScript




Cinemachine

CinemachineConfinerm_DampingField

Howgraduallytoreturnthecameratotheboundingvolumeifitgoesbeyondtheborders


Syntax




[TooltipAttribute("Howgraduallytoreturnthecameratotheboundingvolumeifitgoesbeyondtheborders.Highernumbersaremoregradual.")]



CopyC# JavaScript




Cinemachine

CinemachineConfinerModeEnumeration

Theconfinercanoperateusinga2Dboundingshapeora3Dboundingvolume


Syntax


Confine2D 0

Confine3D 1



publicenumMode

CopyC# JavaScript



Cinemachine

CinemachineCoreClass

AsingletonthatmanagescompletelistsofCinemachineBrainand,CinemachineVirtualCameras,andthepriorityqueue.ProvidesservicestokeepingtrackofwhetherCinemachineVirtualCamerashavebeenupdatedeachframe.

InheritanceHierarchySystemObjectCinemachineCinemachineCore


Syntax

TheCinemachineCoretypeexposesthefollowingmembers.


CinemachineCore

Top


BrainCount Accessthearrayofactive

publicsealedclassCinemachineCore

CopyC# JavaScript


CinemachineBrainsinthescene

Instance Getthesingletoninstance

VirtualCameraCount ListofallactiveCinemachineVirtualCamerasforallbrains.Thislistiskeptsortedbypriority.

Top


FindPotentialTargetBrain TrytofindaCinemachineBraintoassociatewithaCinemachineVirtualCamera.ThefirstCinemachineBraininwhichthisCinemachineVirtualCameraislivewillbeused.Ifnone,thenthefirstactiveCinemachineBrainwillbeused.BrainswithOutputCamera==nullwillnotbereturned.Finalresultmaybenull.

GenerateCameraActivationEvent Signalthatthevirtualhasbeenactivated.Ifthecameraislive,thenallCinemachineBrains

thatareshowingitwillsendanactivationevent.

GenerateCameraCutEvent Signalthatthevirtualcamera'scontentisdiscontinuousWRTthepreviousframe.Ifthecameraislive,thenallCinemachineBrainsthatareshowingitwillsendacutevent.

GetActiveBrain AccessthearrayofactiveCinemachineBrainsinthescenewithoutgebneratinggarbage

GetVcamUpdateStatus Internaluseonly

GetVirtualCamera AccessthearrayofactiveICinemachineCamerainthescenewithoutgebneratinggarbage

IsLive IsthisvirtualcameracurrentlyactivelycontrollinganyCamera?

Top


GetInputAxis DelegateforoverridingUnity'sdefaultinputsystem.Ifyousetthis,thenyourdelegatewillbecalledinsteadofSystem.Input.GetAxis(axisName)wheneverin-gameuserinputisneeded.

kStreamingVersion Dataversionstring.Usedtoupgradefromlegacyprojects

kVersionString Human-readableCinemachineVersion

sShowHiddenObjects Iftrue,showhiddenCinemachineobjects,tomakemanualscriptmappingpossible.

Top





Cinemachine

CinemachineCoreConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineCore.#ctor"]


Syntax

SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace


publicCinemachineCore()

CopyC# JavaScript



Cinemachine

CinemachineCoreProperties



BrainCount AccessthearrayofactiveCinemachineBrainsinthescene

Instance Getthesingletoninstance

VirtualCameraCount ListofallactiveCinemachineVirtualCamerasforallbrains.Thislistiskeptsortedbypriority.

Top





Cinemachine

CinemachineCoreBrainCountProperty

AccessthearrayofactiveCinemachineBrainsinthescene


Syntax




publicintBrainCount{get;}

CopyC# JavaScript




Cinemachine

CinemachineCoreInstanceProperty

Getthesingletoninstance


Syntax

PropertyValueType:CinemachineCore



publicstaticCinemachineCoreInstance{get;}

CopyC# JavaScript



Cinemachine

CinemachineCoreVirtualCameraCountProperty

ListofallactiveCinemachineVirtualCamerasforallbrains.Thislistiskeptsortedbypriority.


Syntax




publicintVirtualCameraCount{get;}

CopyC# JavaScript




Cinemachine

CinemachineCoreMethods



FindPotentialTargetBrain TrytofindaCinemachineBraintoassociatewithaCinemachineVirtualCamera.ThefirstCinemachineBraininwhichthisCinemachineVirtualCameraislivewillbeused.Ifnone,thenthefirstactiveCinemachineBrainwillbeused.BrainswithOutputCamera==nullwillnotbereturned.Finalresultmaybenull.

GenerateCameraActivationEvent Signalthatthevirtualhasbeenactivated.Ifthecameraislive,thenallCinemachineBrainsthatareshowingitwillsendanactivationevent.

GenerateCameraCutEvent Signalthatthevirtual

camera'scontentisdiscontinuousWRTthepreviousframe.Ifthecameraislive,thenallCinemachineBrainsthatareshowingitwillsendacutevent.

GetActiveBrain AccessthearrayofactiveCinemachineBrainsinthescenewithoutgebneratinggarbage

GetVcamUpdateStatus Internaluseonly

GetVirtualCamera AccessthearrayofactiveICinemachineCamerainthescenewithoutgebneratinggarbage

IsLive IsthisvirtualcameracurrentlyactivelycontrollinganyCamera?

Top





Cinemachine

CinemachineCoreFindPotentialTargetBrainMethod

TrytofindaCinemachineBraintoassociatewithaCinemachineVirtualCamera.ThefirstCinemachineBraininwhichthisCinemachineVirtualCameraislivewillbeused.Ifnone,thenthefirstactiveCinemachineBrainwillbeused.BrainswithOutputCamera==nullwillnotbereturned.Finalresultmaybenull.


Syntax

Parameters

vcamType:CinemachineICinemachineCameraVirtualcamerawhosepotentialbrainweneed.

ReturnValueType:CinemachineBrainFirstCinemachineBrainfoundthatmightbeappropriateforthisvcam,ornull

SeeAlso

publicCinemachineBrainFindPotentialTargetBrain(


)

CopyC# JavaScript

ReferenceCinemachineCoreClassCinemachineNamespace




Cinemachine

CinemachineCoreGenerateCameraActivationEventMethod

Signalthatthevirtualhasbeenactivated.Ifthecameraislive,thenallCinemachineBrainsthatareshowingitwillsendanactivationevent.


Syntax

Parameters

vcamType:CinemachineICinemachineCamera[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineCore.GenerateCameraActivationEvent(Cinemachine.ICinemachineCamera)"]



publicvoidGenerateCameraActivationEvent(


)

CopyC# JavaScript



Cinemachine

CinemachineCoreGenerateCameraCutEventMethod

Signalthatthevirtualcamera'scontentisdiscontinuousWRTthepreviousframe.Ifthecameraislive,thenallCinemachineBrainsthatareshowingitwillsendacutevent.


Syntax

Parameters

vcamType:CinemachineICinemachineCamera[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineCore.GenerateCameraCutEvent(Cinemachine.ICinemachineCamera)"]



publicvoidGenerateCameraCutEvent(


)

CopyC# JavaScript



Cinemachine

CinemachineCoreGetActiveBrainMethod

AccessthearrayofactiveCinemachineBrainsinthescenewithoutgebneratinggarbage


Syntax

Parameters

indexType:SystemInt32Indexofthebraintoaccess,range0-BrainCount

ReturnValueType:CinemachineBrainThebrainatthespecifiedindex



publicCinemachineBrainGetActiveBrain(

intindex

)

CopyC# JavaScript



Cinemachine

CinemachineCoreGetVcamUpdateStatusMethod

Internaluseonly


Syntax

Parameters

vcamType:CinemachineICinemachineCamera[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineCore.GetVcamUpdateStatus(Cinemachine.ICinemachineCamera)"]

ReturnValueType:CinemachineCoreUpdateFilter[Missing<returns>documentationfor"M:Cinemachine.CinemachineCore.GetVcamUpdateStatus(Cinemachine.ICinemachineCamera)"]


publicCinemachineCoreUpdateFilterGetVcamUpdateStatus


)

CopyC# JavaScript

Cinemachine

CinemachineCoreGetVirtualCameraMethod

AccessthearrayofactiveICinemachineCamerainthescenewithoutgebneratinggarbage


Syntax

Parameters

indexType:SystemInt32Indexofthecameratoaccess,range0-VirtualCameraCount

ReturnValueType:ICinemachineCameraThevirtualcameraatthespecifiedindex



publicICinemachineCameraGetVirtualCamera(

intindex

)

CopyC# JavaScript



Cinemachine

CinemachineCoreIsLiveMethod

IsthisvirtualcameracurrentlyactivelycontrollinganyCamera?


Syntax

Parameters

vcamType:CinemachineICinemachineCamera[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineCore.IsLive(Cinemachine.ICinemachineCamera)"]

ReturnValueType:Boolean[Missing<returns>documentationfor"M:Cinemachine.CinemachineCore.IsLive(Cinemachine.ICinemachineCamera)"]



publicboolIsLive(


)

CopyC# JavaScript




Cinemachine

CinemachineCoreFields



GetInputAxis DelegateforoverridingUnity'sdefaultinputsystem.Ifyousetthis,thenyourdelegatewillbecalledinsteadofSystem.Input.GetAxis(axisName)wheneverin-gameuserinputisneeded.

kStreamingVersion Dataversionstring.Usedtoupgradefromlegacyprojects

kVersionString Human-readableCinemachineVersion

sShowHiddenObjects Iftrue,showhiddenCinemachineobjects,tomakemanualscriptmappingpossible.

Top




Cinemachine

CinemachineCoreGetInputAxisField

DelegateforoverridingUnity'sdefaultinputsystem.Ifyousetthis,thenyourdelegatewillbecalledinsteadofSystem.Input.GetAxis(axisName)wheneverin-gameuserinputisneeded.


Syntax

FieldValueType:CinemachineCoreAxisInputDelegate



publicstaticCinemachineCoreAxisInputDelegateGetInputAxis

CopyC# JavaScript



Cinemachine

CinemachineCorekStreamingVersionField

Dataversionstring.Usedtoupgradefromlegacyprojects


Syntax




publicstaticreadonlyintkStreamingVersion

CopyC# JavaScript




Cinemachine

CinemachineCorekVersionStringField

Human-readableCinemachineVersion


Syntax




publicstaticreadonlystringkVersionString

CopyC# JavaScript




Cinemachine

CinemachineCoresShowHiddenObjectsField

Iftrue,showhiddenCinemachineobjects,tomakemanualscriptmappingpossible.


Syntax




publicstaticboolsShowHiddenObjects

CopyC# JavaScript




Cinemachine

CinemachineCoreAxisInputDelegateDelegate

DelegateforoverridingUnity'sdefaultinputsystem.Returnsthevalueofthenamedaxis.


Syntax

Parameters

axisNameType:SystemString

ReturnValueType:Single



publicdelegatefloatAxisInputDelegate(

stringaxisName

)

CopyC# JavaScript





Cinemachine

CinemachineCoreStageEnumeration

StagesintheCinemachineComponentpipeline,usedforUIorganization>.Thisenumdefinesthepipelineorder.


Syntax

Members


Body 0 Secondstage:positionthecamerainspace

Aim 1 Thirdstage:orientthecameratopointatthetarget

Noise 2 Finalstage:applynoise(thisisdoneseparately,intheCorrectionchanneloftheCameraState)

SeeAlso

publicenumStage

CopyC# JavaScript

Cinemachine

CinemachineCoreUpdateFilterEnumeration

Internaluseonly


Syntax


Fixed 0

Late 1

Any 2



publicenumUpdateFilter

CopyC# JavaScript



Cinemachine

CinemachineDollyCartClass

ThisisaverysimplebehaviourthatconstrainsitstransformtoaCinemachinePath.Itcanbeusedtoanimateanyobjectsalongapath,orasaFollowtargetforCinemachineVirtualCameras.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineDollyCart


Syntax

TheCinemachineDollyCarttypeexposesthefollowingmembers.


CinemachineDollyCart

Top


[ExecuteInEditMode]

publicclassCinemachineDollyCart:MonoBehaviour

CopyC# JavaScript



m_Path Thepathtofollow

m_Position Thecart'scurrentpositiononthepath,indistanceunits

m_PositionUnits HowtointerpretthePathPosition

m_Speed Movethecartwiththisspeed

m_UpdateMethod Whentomovethecart,ifVelocityisnon-zero

Top





Cinemachine

CinemachineDollyCartConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineDollyCart.#ctor"]


Syntax

SeeAlsoReferenceCinemachineDollyCartClassCinemachineNamespace


publicCinemachineDollyCart()

CopyC# JavaScript



Cinemachine

CinemachineDollyCartFields

TheCinemachineDollyCarttypeexposesthefollowingmembers.


m_Path Thepathtofollow

m_Position Thecart'scurrentpositiononthepath,indistanceunits


m_Speed Movethecartwiththisspeed

m_UpdateMethod Whentomovethecart,ifVelocityisnon-zero

Top





Cinemachine

CinemachineDollyCartm_PathField

Thepathtofollow


Syntax

FieldValueType:CinemachinePathBase



[TooltipAttribute("Thepathtofollow")]

publicCinemachinePathBasem_Path

CopyC# JavaScript



Cinemachine

CinemachineDollyCartm_PositionField

Thecart'scurrentpositiononthepath,indistanceunits


Syntax




[TooltipAttribute("Thepositionalongthepathatwhichthecartwillbeplaced.Thiscanbeanimateddirectlyor,ifthevelocityisnon-zero,willbeupdatedautomatically.ThevalueisinterpretedaccordingtothePositionUnitssetting.")]

[FormerlySerializedAsAttribute("m_CurrentDistance")]

publicfloatm_Position

CopyC# JavaScript




Cinemachine

CinemachineDollyCartm_PositionUnitsField

HowtointerpretthePathPosition


Syntax

FieldValueType:CinemachinePathBasePositionUnits



[TooltipAttribute("HowtointerpretthePathPosition.IfsettoPathUnits,valuesareasfollows:0representsthefirstwaypointonthepath,1isthesecond,andsoon.Valuesin-betweenarepointsonthepathinbetweenthewaypoints.IfsettoDistance,thenPathPositionrepresentsdistancealongthepath.")]

publicCinemachinePathBasePositionUnitsm_PositionUnits

CopyC# JavaScript



Cinemachine

CinemachineDollyCartm_SpeedField

Movethecartwiththisspeed


Syntax




[TooltipAttribute("Movethecartwiththisspeedalongthepath.ThevalueisinterpretedaccordingtothePositionUnitssetting.")]

[FormerlySerializedAsAttribute("m_Velocity")]

publicfloatm_Speed

CopyC# JavaScript




Cinemachine

CinemachineDollyCartm_UpdateMethodField

Whentomovethecart,ifVelocityisnon-zero


Syntax

FieldValueType:CinemachineDollyCartUpdateMethod



[TooltipAttribute("Whentomovethecart,ifVelocityisnon-zero")]

publicCinemachineDollyCartUpdateMethodm_UpdateMethod

CopyC# JavaScript



Cinemachine

CinemachineDollyCartUpdateMethodEnumeration



Syntax

Members


Update 0 UpdatedinnormalMonoBehaviourUpdate.

FixedUpdate 1 UpdatedinsyncwiththePhysicsmodule,inFixedUpdate




CopyC# JavaScript



Cinemachine

CinemachineExtensionClass

BaseclassforaCinemachineVirtualCameraextensionmodule.HooksintotheCinemachinePipeline.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineExtensionCinemachineCinemachineColliderCinemachineCinemachineConfinerCinemachineCinemachineFollowZoom


Syntax

TheCinemachineExtensiontypeexposesthefollowingmembers.


CinemachineExtension


publicabstractclassCinemachineExtension:MonoBehaviour

CopyC# JavaScript


Top



Top


Awake Connecttovirtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation

GetAllExtraStatesT Ineffeicientmethodtogetallextrastateinforforallvcams.IntendedforEditoruseonly,notruntime!

GetExtraStateT Becauseextensionscanbeplacedonmanagercamsandwillinthatcasebecalledforallthevcamchildren,vcam-specificstateinformationshouldbestoredhere.Justdefineaclasstoholdyourstateinfoand

useitexclusivelywhencallingthis.

OnDestroy Disconnectfromvirtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation

PostPipelineStageCallback Thiscallbackwillbecalledafterthevirtualcamerahasimplementedeachstageinthepipeline.Thismethodmaymodifythereferencedstate.IfdeltaTimelessthan0,resetallstateinfoandperformnodamping.

Top



Top


Cinemachine

CinemachineExtensionConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineExtension.#ctor"]


Syntax

SeeAlsoReferenceCinemachineExtensionClassCinemachineNamespace


protectedCinemachineExtension()

CopyC# JavaScript



Cinemachine

CinemachineExtensionProperties




Top





Cinemachine

CinemachineExtensionVirtualCameraProperty

GettheassociatedCinemachineVirtualCameraBase


Syntax




publicCinemachineVirtualCameraBaseVirtualCamera{

CopyC# JavaScript



Cinemachine

CinemachineExtensionMethods



Awake Connecttovirtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation

GetAllExtraStatesT Ineffeicientmethodtogetallextrastateinforforallvcams.IntendedforEditoruseonly,notruntime!

GetExtraStateT Becauseextensionscanbeplacedonmanagercamsandwillinthatcasebecalledforallthevcamchildren,vcam-specificstateinformationshouldbestoredhere.Justdefineaclasstoholdyourstateinfoanduseitexclusivelywhencallingthis.

OnDestroy Disconnectfrom

virtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation

PostPipelineStageCallback Thiscallbackwillbecalledafterthevirtualcamerahasimplementedeachstageinthepipeline.Thismethodmaymodifythereferencedstate.IfdeltaTimelessthan0,resetallstateinfoandperformnodamping.

Top





Cinemachine

CinemachineExtensionAwakeMethod

Connecttovirtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation


Syntax



protectedvirtualvoidAwake()

CopyC# JavaScript



Cinemachine

CinemachineExtensionGetAllExtraStatesMethod

Ineffeicientmethodtogetallextrastateinforforallvcams.IntendedforEditoruseonly,notruntime!


Syntax

TypeParameters

T

ReturnValueType:ListT[Missing<returns>documentationfor"M:Cinemachine.CinemachineExtension.GetAllExtraStates``1"]



protectedList<T>GetAllExtraStates<T>()

whereT:class,new()

CopyC# JavaScript




Cinemachine

CinemachineExtensionGetExtraStateMethod

Becauseextensionscanbeplacedonmanagercamsandwillinthatcasebecalledforallthevcamchildren,vcam-specificstateinformationshouldbestoredhere.Justdefineaclasstoholdyourstateinfoanduseitexclusivelywhencallingthis.


Syntax

Parameters

vcamType:CinemachineICinemachineCamera[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineExtension.GetExtraState``1(Cinemachine.ICinemachineCamera)"]

TypeParameters

T

ReturnValueType:T[Missing<returns>documentationfor

protectedTGetExtraState<T>(


)

whereT:class,new()

CopyC# JavaScript

"M:Cinemachine.CinemachineExtension.GetExtraState``1(Cinemachine.ICinemachineCamera)"]





Cinemachine

CinemachineExtensionOnDestroyMethod

Disconnectfromvirtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation


Syntax



protectedvirtualvoidOnDestroy()

CopyC# JavaScript



Cinemachine

CinemachineExtensionPostPipelineStageCallbackMethod

Thiscallbackwillbecalledafterthevirtualcamerahasimplementedeachstageinthepipeline.Thismethodmaymodifythereferencedstate.IfdeltaTimelessthan0,resetallstateinfoandperformnodamping.


Syntax

Parameters

vcamType:CinemachineCinemachineVirtualCameraBase[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineExtension.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

stageType:CinemachineCinemachineCoreStage[Missing<paramname="stage"/>documentationfor"M:Cinemachine.CinemachineExtension.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

state

protectedabstractvoidPostPipelineStageCallback(




floatdeltaTime

)

CopyC# JavaScript

Type:CinemachineCameraState[Missing<paramname="state"/>documentationfor"M:Cinemachine.CinemachineExtension.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

deltaTimeType:SystemSingle[Missing<paramname="deltaTime"/>documentationfor"M:Cinemachine.CinemachineExtension.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]






Cinemachine

CinemachineExtensionFields




Top





Cinemachine

CinemachineExtensionEpsilonField

Usefulconstantforverysmallfloats


Syntax




protectedconstfloatEpsilon=0.0001f

CopyC# JavaScript




Cinemachine

CinemachineExternalCameraClass

Thiscomponentwillexposeanon-cinemachinecameratothecinemachinesystem,allowingittoparticipateinblends.JustadditasacomponentalongsideanexistingUnityCameracomponent.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineExternalCamera


Syntax

TheCinemachineExternalCameratypeexposesthefollowingmembers.


[RequireComponent(typeof(Camera))]


[ExecuteInEditMode]

[AddComponentMenu("Cinemachine/CinemachineExternalCamera")]

publicclassCinemachineExternalCamera:CinemachineVirtualCameraBase

CopyC# JavaScript



CinemachineExternalCamera

Top


Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo(InheritedfromCinemachineVirtualCameraBase

Follow Thisvcamdefinesnotargets(OverridesCinemachineVirtualCameraBase

LiveChildOrSelf Justreturnsself.(InheritedfromCinemachineVirtualCameraBase

LookAt Theobjectthatthecameraislookingat(OverridesCinemachineVirtualCameraBase

Name GetthenameoftheVirtualCamera.BaseimplementationreturnstheownerGameObject'sname.(InheritedfromCinemachineVirtualCameraBase

ParentCamera Supportformeta-virtual-cameras.thesituationwhereavirtualcameraisin

factthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.PrivatearmiesareimplementedasTransformchildrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase


Priority GetthePriorityofthevirtualcamera.ThisdeterminesitsplacementCinemachineCore'squeueofeligibleshots.(InheritedfromCinemachineVirtualCameraBase

State GettheCameraState,asweareabletoconstructonefromtheUnityCamera(OverridesCinemachineVirtualCameraBase



Top


AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.becalledaftereachpipelinestage,toallowotherstohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase

InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforallparentcameras(ifany).(InheritedfromCinemachineVirtualCameraBase

IsLiveChild Checkwhetherthevcamalivechildofthiscamera.classimplementationalwaysreturnsfalse.(InheritedfromCinemachineVirtualCameraBase

MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereissometimestheneedtopushonetothetop,makingitthecurrentLivecameraifitsharesthehighestpriorityinthequeuewithitspeers.Thishappensautomaticallywhenavcamisenabled:themostrecentonegoestothetopoftheprioritysubqueue.Usethismethodtopushavcamtothetopofitsprioritypeers.Ifitanditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.(InheritedfromCinemachineVirtualCameraBase



OnEnable Baseclassimplementationaddsthevirtualcamerafromthepriorityqueue.(InheritedfromCinemachineVirtualCameraBase


OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.implementationmustbecalledbyanyoverriddenmethod.(InheritedfromCinemachineVirtualCameraBase

OnValidate Enforceboundsforfields,whenchangedininspector.baseclassimplementationatthebeginningofoverriddenmethod.Afterbasemethodiscalled,ValidatingStreamVersionwillbevalid.(InheritedfromCinemachineVirtualCameraBase

PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,inordertoallowtheparenttoprepareitschildren.thechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledpriortoeveryFixedUpdate,butitmightbecalledonLateUpdateinstead.doesnothing.(InheritedfromCinemachineVirtualCameraBase

RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.(InheritedfromCinemachineVirtualCameraBase

ResolveFollow Returnsthisvcam'sFollowtarget,orifthatisnull,willretruntheparentvcam'sFollowtarget.(InheritedfromCinemachineVirtualCameraBase

ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretruntheparentvcam'sLookAttarget.(InheritedfromCinemachineVirtualCameraBase



UpdateCameraState ConstructaCameraStateobjectfromtheUnityCamera(OverridesCinemachineVirtualCameraBaseSingle).)

Top





m_LookAt Theobjectthatthecameraislookingat.



Top





Cinemachine

CinemachineExternalCameraConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineExternalCamera.#ctor"]


Syntax

SeeAlsoReferenceCinemachineExternalCameraClassCinemachineNamespace


publicCinemachineExternalCamera()

CopyC# JavaScript



Cinemachine

CinemachineExternalCameraProperties




Follow Thisvcamdefinesnotargets(OverridesCinemachineVirtualCameraBase


LookAt Theobjectthatthecameraislookingat(OverridesCinemachineVirtualCameraBase


ParentCamera Supportformeta-virtual-cameras.

thesituationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.PrivatearmiesareimplementedasTransformchildrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase



State GettheCameraState,asweareabletoconstructonefromtheUnityCamera(OverridesCinemachineVirtualCameraBase



Top

Cinemachine

CinemachineExternalCameraFollowProperty

Thisvcamdefinesnotargets


Syntax





CopyC# JavaScript



Cinemachine

CinemachineExternalCameraLookAtProperty

Theobjectthatthecameraislookingat


Syntax





CopyC# JavaScript



Cinemachine

CinemachineExternalCameraStateProperty

GettheCameraState,asweareabletoconstructonefromtheUnityCamera


Syntax





CopyC# JavaScript



Cinemachine

CinemachineExternalCameraMethods



AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.becalledaftereachpipelinestage,toallowotherstohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase

InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforallparentcameras(ifany).(InheritedfromCinemachineVirtualCameraBase

IsLiveChild Checkwhetherthevcamalivechildofthiscamera.classimplementationalwaysreturnsfalse.(InheritedfromCinemachineVirtualCameraBase

MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereissometimestheneedtopushonetothetop,makingitthecurrentLivecameraifitsharesthehighestpriorityinthequeuewithitspeers.Thishappensautomaticallywhenavcamisenabled:themostrecentonegoestothetopoftheprioritysubqueue.Usethismethodtopushavcamtothetopofitsprioritypeers.Ifitanditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.(InheritedfromCinemachineVirtualCameraBase

OnDestroy Baseclassimplementationremovesthevirtualcamerafromthepriorityqueue.



OnEnable Baseclassimplementationaddsthevirtualcamerafromthepriorityqueue.(InheritedfromCinemachineVirtualCameraBase


OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.implementationmustbecalledbyanyoverriddenmethod.(InheritedfromCinemachineVirtualCameraBase

OnValidate Enforceboundsforfields,whenchangedininspector.baseclassimplementationatthebeginningofoverriddenmethod.Afterbasemethodiscalled,ValidatingStreamVersionwillbevalid.(InheritedfromCinemachineVirtualCameraBase

PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,inordertoallowtheparenttoprepareitschildren.thechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledpriortoeveryFixedUpdate,butitmightbecalledonLateUpdateinstead.doesnothing.(InheritedfromCinemachineVirtualCameraBase

RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.(InheritedfromCinemachineVirtualCameraBase

ResolveFollow Returnsthisvcam'sFollowtarget,orifthatisnull,willretruntheparentvcam'sFollowtarget.(InheritedfromCinemachineVirtualCameraBase

ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretruntheparentvcam'sLookAttarget.(InheritedfromCinemachineVirtualCameraBase



UpdateCameraState ConstructaCameraStateobjectfromtheUnityCamera(OverridesCinemachineVirtualCameraBaseSingle).)

Top





Cinemachine

CinemachineExternalCameraUpdateCameraStateMethod

ConstructaCameraStateobjectfromtheUnityCamera


Syntax

Parameters

worldUpType:Vector3[Missing<paramname="worldUp"/>documentationfor"M:Cinemachine.CinemachineExternalCamera.UpdateCameraState(UnityEngine.Vector3,System.Single)"]

deltaTimeType:SystemSingle[Missing<paramname="deltaTime"/>documentationfor"M:Cinemachine.CinemachineExternalCamera.UpdateCameraState(UnityEngine.Vector3,System.Single)"]


SeeAlsoReference


Vector3worldUp,

floatdeltaTime

)

CopyC# JavaScript


CinemachineExternalCameraClassCinemachineNamespace




Cinemachine

CinemachineExternalCameraFields






m_LookAt Theobjectthatthecameraislookingat.

m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbers

havegreaterpriority.(InheritedfromCinemachineVirtualCameraBase


Top





Cinemachine

CinemachineExternalCameram_LookAtField

Theobjectthatthecameraislookingat.


Syntax




[TooltipAttribute("Theobjectthatthecameraislookingat.Settingthiswillimprovethequalityoftheblendstoandfromthiscamera")]



CopyC# JavaScript



Cinemachine

CinemachineFollowZoomClass

Anadd-onmoduleforCinemachineVirtualCamerathatadjuststheFOVofthelenstokeepthetargetobjectataconstantsizeonthescreen,regardlessofcameraandtargetposition.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineExtensionCinemachineCinemachineFollowZoom


Syntax

TheCinemachineFollowZoomtypeexposesthefollowingmembers.



[ExecuteInEditMode]



publicclassCinemachineFollowZoom:CinemachineExtension

CopyC# JavaScript


CinemachineFollowZoom

Top



Top






PostPipelineStageCallback Callbacktopreformthezoomadjustment(OverridesCinemachineExtensionPostPipelineStageCallback(CinemachineVirtualCameraBase,

CinemachineCoreStage,CameraState

Top


m_Damping Increasethisvaluetosoftentheaggressivenessofthefollow-zoom.Smallnumbersaremoreresponsive,largernumbersgiveamoreheavyslowlyrespondingcamera.

m_MaxFOV WillnotgenerateanFOVlargetthanthis.

m_MinFOV WillnotgenerateanFOVsmallerthanthis.

m_Width Theshotwidthtomaintain,inworldunits,attargetdistance.FOVwillbeadustedasfaraspossibletomaintainthiswidthatthetargetdistancefromthecamera.

Top





Cinemachine

CinemachineFollowZoomConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineFollowZoom.#ctor"]


Syntax

SeeAlsoReferenceCinemachineFollowZoomClassCinemachineNamespace


publicCinemachineFollowZoom()

CopyC# JavaScript



Cinemachine

CinemachineFollowZoomProperties




Top





Cinemachine

CinemachineFollowZoomMethods







PostPipelineStageCallback Callbacktopreformthezoomadjustment(OverridesCinemachineExtensionPostPipelineStageCallback(CinemachineVirtualCameraBase,CinemachineCoreStage,CameraState

Top

SeeAlso

ReferenceCinemachineFollowZoomClassCinemachineNamespace




Cinemachine

CinemachineFollowZoomPostPipelineStageCallbackMethod

Callbacktopreformthezoomadjustment


Syntax

Parameters

vcamType:CinemachineCinemachineVirtualCameraBase[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineFollowZoom.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

stageType:CinemachineCinemachineCoreStage[Missing<paramname="stage"/>documentationfor"M:Cinemachine.CinemachineFollowZoom.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

stateType:CinemachineCameraState[Missing<paramname="state"/>documentationfor"M:Cinemachine.CinemachineFollowZoom.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]





floatdeltaTime

)

CopyC# JavaScript

deltaTimeType:SystemSingle[Missing<paramname="deltaTime"/>documentationfor"M:Cinemachine.CinemachineFollowZoom.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]






Cinemachine

CinemachineFollowZoomFields



m_Damping Increasethisvaluetosoftentheaggressivenessofthefollow-zoom.Smallnumbersaremoreresponsive,largernumbersgiveamoreheavyslowlyrespondingcamera.

m_MaxFOV WillnotgenerateanFOVlargetthanthis.

m_MinFOV WillnotgenerateanFOVsmallerthanthis.

m_Width Theshotwidthtomaintain,inworldunits,attargetdistance.FOVwillbeadustedasfaraspossibletomaintainthiswidthatthetargetdistancefromthecamera.

Top


Cinemachine

CinemachineFollowZoomm_DampingField

Increasethisvaluetosoftentheaggressivenessofthefollow-zoom.Smallnumbersaremoreresponsive,largernumbersgiveamoreheavyslowlyrespondingcamera.


Syntax





[TooltipAttribute("Increasethisvaluetosoftentheaggressivenessofthefollow-zoom.Smallnumbersaremoreresponsive,largernumbersgiveamoreheavyslowlyrespondingcamera.")]


CopyC# JavaScript




Cinemachine

CinemachineFollowZoomm_MaxFOVField

WillnotgenerateanFOVlargetthanthis.


Syntax





[TooltipAttribute("UpperlimitfortheFOVthatthisbehaviourwillgenerate.")]

publicfloatm_MaxFOV

CopyC# JavaScript




Cinemachine

CinemachineFollowZoomm_MinFOVField

WillnotgenerateanFOVsmallerthanthis.


Syntax





[TooltipAttribute("LowerlimitfortheFOVthatthisbehaviourwillgenerate.")]

publicfloatm_MinFOV

CopyC# JavaScript




Cinemachine

CinemachineFollowZoomm_WidthField

Theshotwidthtomaintain,inworldunits,attargetdistance.FOVwillbeadustedasfaraspossibletomaintainthiswidthatthetargetdistancefromthecamera.


Syntax




[TooltipAttribute("Theshotwidthtomaintain,inworldunits,attargetdistance.")]

publicfloatm_Width

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerClass

ThisisaCinemachineComponentintheBodysectionofthecomponentpipeline.Itsjobistopositionthecamerainafixedscreen-spacerelationshiptothevcam'sFollowtargetobject,withoffsetsanddamping.ThecamerawillbefirstmovedalongthecameraZaxisuntiltheFollowtargetisatthedesireddistancefromthecamera'sX-Yplane.ThecamerawillthenbemovedinitsXYplaneuntiltheFollowtargetisatthedesiredpointonthecamera'sscreen.TheFramingTansposerwillonlychangethecamera'spositioninspace.Itwillnotre-orientorotherwiseaimthecamera.Forthiscomponenttoworkproperly,thevcam'sLookAttargetmustbenull.TheFollowtargetwilldefinewhatthecameraislookingat.IftheFollowtargetisaCinemachineTargetGroup,thenadditionalcontrolswillbeavailabletodynamicallyadjustthecamera’sviewinordertoframetheentiregroup.Althoughthiscomponentwasdesignedfororthographiccameras,itworksequallywellwithpersectivecamerasandcanbeusedin3Denvironments.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineFramingTransposer


SyntaxCopy


TheCinemachineFramingTransposertypeexposesthefollowingmembers.


CinemachineFramingTransposer

Top




IsValid TrueifcomponentisenabledandhasavalidFollowtarget(OverridesCinemachineComponentBaseIsValid.)

LookAtTarget Returnstheownervcam'sLookAttarget.(Inheritedfrom


[ExecuteInEditMode]


[RequireComponent(typeof(CinemachinePipeline


publicclassCinemachineFramingTransposer

CopyC# JavaScript

CinemachineComponentBase.)

m_LastBounds Foreditorvisulaizationofthecalculatedboundingboxofthegroup

m_lastBoundsMatrix Foreditorvisualizationofthecalculatedboundingboxofthegroup


Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage(OverridesCinemachineComponentBaseStage.)

TargetGroup GetFollowtargetasCinemachineTargetGroup,ornulliftargetisnotagroup



Top


MutateCameraState Positionsthevirtualcameraaccordingtothetransposerrules.(OverridesCinemachineComponentBaseMutateCameraState(CameraState

Single).)


Top


m_AdjustmentMode Howtoadjustthecameratogetthedesiredframing



m_CameraDistance ThedistancealongthecameraaxisthatwillbemaintainedfromtheFollowtarget

m_DeadZoneDepth Thecamerawillnotmovealongitsz-axisiftheFollowtargetiswithinthisdistanceofthespecifiedcameradistance

m_DeadZoneHeight Camerawillnotmove

verticallyifthetargetiswithinthisrangeoftheposition

m_DeadZoneWidth Camerawillnotmovehorizontallyifthetargetiswithinthisrangeoftheposition

m_GroupFramingMode Whatscreendimensionstoconsiderwhenframing

m_GroupFramingSize Howmuchofthescreentofillwiththeboundingboxofthetargets.


m_LookaheadTime Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,

resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.

m_MaxDollyIn Howmuchclosertothetargetcanthecamerago?

m_MaxDollyOut Howmuchfartherfromthetargetcanthecamerago?

m_MaximumDistance Setthistolimithowfarfromthetaregtthecameracanget

m_MaximumFOV IfadjustingFOV,willnotsettheFOVhigherthanthis

m_MaximumOrthoSize IfadjustingOrthographicSize,willnotsetithigherthanthis

m_MinimumDistance Setthistolimithowclosetothetargetthecameracanget

m_MinimumFOV IfadjustingFOV,willnotsettheFOVlowerthanthis

m_MinimumOrthoSize IfadjustingOrthographicSize,willnotsetitlowerthanthis

m_ScreenX Horizontalscreenpositionfortarget.Thecamerawillmovetopositionthetrackedobjecthere

m_ScreenY Verticalscreenpositionfortarget,Thecamerawillmovetotopositionthetrackedobjecthere



m_UnlimitedSoftZone

m_XDamping HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersaremore

responsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors

m_YDamping HowaggressivelythecameratriestomaintaintheoffsetintheY-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors

m_ZDamping HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamore

heavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors


Top





Cinemachine

CinemachineFramingTransposerConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineFramingTransposer.#ctor"]


Syntax

SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace


publicCinemachineFramingTransposer()

CopyC# JavaScript



Cinemachine

CinemachineFramingTransposerProperties











TargetGroup GetFollowtargetasCinemachineTargetGroup,ornulliftargetisnotagroup



Top





Cinemachine

CinemachineFramingTransposerHardGuideRectProperty



Syntax




publicRectHardGuideRect{get;set;}

CopyC# JavaScript



Cinemachine

CinemachineFramingTransposerIsValidProperty

TrueifcomponentisenabledandhasavalidFollowtarget


Syntax





CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_LastBoundsProperty

Foreditorvisulaizationofthecalculatedboundingboxofthegroup


Syntax

PropertyValueType:Bounds



publicBoundsm_LastBounds{get;}

CopyC# JavaScript



Cinemachine

CinemachineFramingTransposerm_lastBoundsMatrixProperty

Foreditorvisualizationofthecalculatedboundingboxofthegroup


Syntax

PropertyValueType:Matrix4x4



publicMatrix4x4m_lastBoundsMatrix{get;}

CopyC# JavaScript



Cinemachine

CinemachineFramingTransposerSoftGuideRectProperty



Syntax




publicRectSoftGuideRect{get;set;}

CopyC# JavaScript



Cinemachine

CinemachineFramingTransposerStageProperty

GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage


Syntax





CopyC# JavaScript



Cinemachine

CinemachineFramingTransposerTargetGroupProperty

GetFollowtargetasCinemachineTargetGroup,ornulliftargetisnotagroup


Syntax

PropertyValueType:CinemachineTargetGroup



publicCinemachineTargetGroupTargetGroup{get;}

CopyC# JavaScript



Cinemachine

CinemachineFramingTransposerMethods



MutateCameraState Positionsthevirtualcameraaccordingtothetransposerrules.(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)


Top





Cinemachine

CinemachineFramingTransposerMutateCameraStateMethod

Positionsthevirtualcameraaccordingtothetransposerrules.


Syntax

Parameters


deltaTimeType:SystemSingleUsedfordamping.Iflessthan0,nodampingisdone.





floatdeltaTime

)

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerFields






m_CameraDistance ThedistancealongthecameraaxisthatwillbemaintainedfromtheFollowtarget

m_DeadZoneDepth Thecamerawillnotmovealongitsz-axisiftheFollowtargetiswithinthisdistanceofthespecifiedcameradistance

m_DeadZoneHeight Camerawillnotmoveverticallyifthetargetiswithinthisrangeoftheposition

m_DeadZoneWidth Camerawillnotmovehorizontallyifthetargetiswithinthisrangeoftheposition

m_GroupFramingMode Whatscreendimensionstoconsiderwhenframing



m_LookaheadTime Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitiveto

noisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.









m_ScreenX Horizontalscreenpositionfortarget.Thecamerawillmovetopositionthetrackedobjecthere

m_ScreenY Verticalscreenpositionfortarget,Thecamerawillmovetotopositionthetrackedobjecthere



m_UnlimitedSoftZone

m_XDamping HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersaremore

responsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors


m_ZDamping HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamore

heavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors


Top





Cinemachine

CinemachineFramingTransposerm_AdjustmentModeField

Howtoadjustthecameratogetthedesiredframing


Syntax

FieldValueType:CinemachineFramingTransposerAdjustmentMode



[TooltipAttribute("Howtoadjustthecameratogetthedesiredframing.Youcanzoom,dollyin/out,ordoboth.")]

publicCinemachineFramingTransposerAdjustmentModem_AdjustmentMode

CopyC# JavaScript



Cinemachine

CinemachineFramingTransposerm_BiasXField



Syntax





[TooltipAttribute("Anon-zerobiaswillmovethetargetpositionhorizontallyawayfromthecenterofthesoftzone.")]

publicfloatm_BiasX

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_BiasYField



Syntax





[TooltipAttribute("Anon-zerobiaswillmovethetargetpositionverticallyawayfromthecenterofthesoftzone.")]

publicfloatm_BiasY

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_CameraDistanceField

ThedistancealongthecameraaxisthatwillbemaintainedfromtheFollowtarget


Syntax




[TooltipAttribute("ThedistancealongthecameraaxisthatwillbemaintainedfromtheFollowtarget")]

publicfloatm_CameraDistance

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_DeadZoneDepthField

Thecamerawillnotmovealongitsz-axisiftheFollowtargetiswithinthisdistanceofthespecifiedcameradistance


Syntax




[TooltipAttribute("Thecamerawillnotmovealongitsz-axisiftheFollowtargetiswithinthisdistanceofthespecifiedcameradistance")]

[FormerlySerializedAsAttribute("m_DistanceDeadZoneSize")]

publicfloatm_DeadZoneDepth

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_DeadZoneHeightField

Camerawillnotmoveverticallyifthetargetiswithinthisrangeoftheposition


Syntax





[TooltipAttribute("Camerawillnotmoveverticallyifthetargetiswithinthisrangeoftheposition.")]

publicfloatm_DeadZoneHeight

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_DeadZoneWidthField

Camerawillnotmovehorizontallyifthetargetiswithinthisrangeoftheposition


Syntax




[SpaceAttribute]


[TooltipAttribute("Camerawillnotmovehorizontallyifthetargetiswithinthisrangeoftheposition.")]

publicfloatm_DeadZoneWidth

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_GroupFramingModeField

Whatscreendimensionstoconsiderwhenframing


Syntax

FieldValueType:CinemachineFramingTransposerFramingMode



[SpaceAttribute]

[TooltipAttribute("Whatscreendimensionstoconsiderwhenframing.CanbeHorizontal,Vertical,orboth")]

[FormerlySerializedAsAttribute("m_FramingMode")]

publicCinemachineFramingTransposerFramingModem_GroupFramingMode

CopyC# JavaScript



Cinemachine

CinemachineFramingTransposerm_GroupFramingSizeField

Howmuchofthescreentofillwiththeboundingboxofthetargets.


Syntax




[TooltipAttribute("Theboundingboxofthetargetsshouldoccupythisamountofthescreenspace.1meansfillthewholescreen.0.5meansfillhalfthescreen,etc.")]

publicfloatm_GroupFramingSize

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_LookaheadSmoothingField

Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag


Syntax




[TooltipAttribute("Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag")]


publicfloatm_LookaheadSmoothing

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_LookaheadTimeField

Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.


Syntax




[TooltipAttribute("Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.")]


publicfloatm_LookaheadTime

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_MaxDollyInField

Howmuchclosertothetargetcanthecamerago?


Syntax




[TooltipAttribute("Themaximumdistancetowardthetargetthatthisbehaviourisallowedtomovethecamera.")]

publicfloatm_MaxDollyIn

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_MaxDollyOutField

Howmuchfartherfromthetargetcanthecamerago?


Syntax




[TooltipAttribute("Themaximumdistanceawaythetargetthatthisbehaviourisallowedtomovethecamera.")]

publicfloatm_MaxDollyOut

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_MaximumDistanceField

Setthistolimithowfarfromthetaregtthecameracanget


Syntax




[TooltipAttribute("Setthistolimithowfarfromthetargetthecameracanget.")]

publicfloatm_MaximumDistance

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_MaximumFOVField

IfadjustingFOV,willnotsettheFOVhigherthanthis


Syntax





[TooltipAttribute("IfadjustingFOV,willnotsettheFOVhigherthanthis.")]

publicfloatm_MaximumFOV

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_MaximumOrthoSizeField

IfadjustingOrthographicSize,willnotsetithigherthanthis


Syntax




[TooltipAttribute("IfadjustingOrthographicSize,willnotsetithigherthanthis.")]

publicfloatm_MaximumOrthoSize

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_MinimumDistanceField

Setthistolimithowclosetothetargetthecameracanget


Syntax




[TooltipAttribute("Setthistolimithowclosetothetargetthecameracanget.")]

publicfloatm_MinimumDistance

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_MinimumFOVField

IfadjustingFOV,willnotsettheFOVlowerthanthis


Syntax





[TooltipAttribute("IfadjustingFOV,willnotsettheFOVlowerthanthis.")]

publicfloatm_MinimumFOV

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_MinimumOrthoSizeField

IfadjustingOrthographicSize,willnotsetitlowerthanthis


Syntax




[TooltipAttribute("IfadjustingOrthographicSize,willnotsetitlowerthanthis.")]

publicfloatm_MinimumOrthoSize

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_ScreenXField

Horizontalscreenpositionfortarget.Thecamerawillmovetopositionthetrackedobjecthere


Syntax




[SpaceAttribute]


[TooltipAttribute("Horizontalscreenpositionfortarget.Thecamerawillmovetopositionthetrackedobjecthere.")]

publicfloatm_ScreenX

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_ScreenYField

Verticalscreenpositionfortarget,Thecamerawillmovetotopositionthetrackedobjecthere


Syntax





[TooltipAttribute("Verticalscreenpositionfortarget,Thecamerawillmovetopositionthetrackedobjecthere.")]

publicfloatm_ScreenY

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_SoftZoneHeightField



Syntax





[TooltipAttribute("Whentargetiswithinthisregion,camerawillgraduallymoveverticallytore-aligntowardsthedesiredposition,dependingonthedampingspeed.")]

publicfloatm_SoftZoneHeight

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_SoftZoneWidthField



Syntax





[TooltipAttribute("Whentargetiswithinthisregion,camerawillgraduallymovehorizontallytore-aligntowardsthedesiredposition,dependingonthedampingspeed.")]

publicfloatm_SoftZoneWidth

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_UnlimitedSoftZoneField

[Missing<summary>documentationfor"F:Cinemachine.CinemachineFramingTransposer.m_UnlimitedSoftZone"]


Syntax




[SpaceAttribute]

[TooltipAttribute("Ifchecked,thenthensoftzonewillbeunlimitedinsize.")]

publicboolm_UnlimitedSoftZone

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_XDampingField

HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors


Syntax





[TooltipAttribute("HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]

publicfloatm_XDamping

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_YDampingField

HowaggressivelythecameratriestomaintaintheoffsetintheY-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors


Syntax





[TooltipAttribute("HowaggressivelythecameratriestomaintaintheoffsetintheY-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]

publicfloatm_YDamping

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerm_ZDampingField

HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors


Syntax





[TooltipAttribute("HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]

publicfloatm_ZDamping

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerOnGUICallbackField

UsedbytheInspectorEditortodisplayon-screenguides.


Syntax





[HideInInspector]

publicActionOnGUICallback

CopyC# JavaScript




Cinemachine

CinemachineFramingTransposerAdjustmentModeEnumeration



Syntax


ZoomOnly 0 Donotmovethecamera,onlyadjusttheFOV.

DollyOnly 1 Justmovethecamera,don'tchangetheFOV.

DollyThenZoom 2 Movethecameraasmuchaspermittedbytheranges,thenadjusttheFOVifnecessarytomaketheshot.

publicenumAdjustmentMode

CopyC# JavaScript

Cinemachine

CinemachineFramingTransposerFramingModeEnumeration



Syntax


Horizontal 0 Consideronlythehorizontaldimension.Verticalframingisignored.

Vertical 1 Consideronlytheverticaldimension.Horizontalframingisignored.

HorizontalAndVertical 2 Thelargerofthe


publicenumFramingMode

CopyC# JavaScript

horizontalandverticaldimensionswilldominate,togetthebestfit.

None 3 Don'tdoanyframingadjustment





Cinemachine

CinemachineFreeLookClass

ACinemachineCameragearedtowardsa3rdpersoncameraexperience.Thecameraorbitsarounditssubjectwiththreeseparatecamerarigsdefiningringsaroundthetarget.Eachrighasitsownradius,heightoffset,composer,andlenssettings.Dependingonthecamera'spositionalongthesplineconnectingthesethreerigs,thesesettingsareinterpolatedtogivethefinalcamerapositionandstate.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineFreeLook


Syntax

TheCinemachineFreeLooktypeexposesthefollowingmembers.

Constructors


[ExecuteInEditMode]


[AddComponentMenu("Cinemachine/CinemachineFreeLook")]

publicclassCinemachineFreeLook:CinemachineVirtualCameraBase

CopyC# JavaScript


Name Description

CinemachineFreeLook

Top




LiveChildOrSelf Returnstherigwiththegreatestweight(OverridesCinemachineVirtualCameraBase



ParentCamera Supportformeta-virtual-cameras.situationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.Thismethodgets

theVirtualCameraowner,ifany.areimplementedasTransformchildrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase



RigNames Namesofthe3childrigs

State Thecacmerastate,whichwillbeablendofthechildrigstates(OverridesCinemachineVirtualCameraBase



Top



GetLocalPositionForCameraFromInput Returnsthelocalpositionofthecameraalongthesplineusedtoconnectthecurrentheadingofthe

GetRig Getachildrig




OnDestroy Makessurethatthechildrigsgetdestroyedinanundo-firndlymanner.(OverridesCinemachineVirtualCameraBase


OnEnable Updatesthechildrigcache(OverridesCinemachineVirtualCameraBase


OnTransitionFromCamera IfwearetransitioningfromanotherFreeLook,grabtheaxisvaluesfromit.(OverridesCinemachineVirtualCameraBase

OnValidate Enforceboundsforfields,whenchangedininspector.(OverridesCinemachineVirtualCameraBase

PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,areupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledLateUpdate.Thisimplementationpushestheaxisvaluestotherigs.(OverridesCinemachineVirtualCameraBase






UpdateCameraState CalledbyCinemachineCoreatdesignatedupdatetimeupdated,andablendcalculated,dependingonthevalueoftheYaxis.(OverridesCinemachineVirtualCameraBase

Top



CreateRigOverride Overridecomponentpipelinecreation.ThisneedstobedonebytheeditortosupportUndo.TheoverridemustdoexactlythesamethingastheCreatePipelinemethodinthisclass.

DestroyRigOverride Overridecomponentpipelinedestruction.ThisneedstobedonebytheeditortosupportUndo.

m_BindingMode Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget

m_CommonLens Ifenabled,thislenssettingwillapplytoallthreechildrigs,otherwisethechildriglenssettingswillbeused


m_Follow Objectforthecamerachildrenwantstomovewith(thebodytarget)

m_Heading ThedefinitionofForward.Camerawillfollowbehind

m_Lens SpecifiesthelenspropertiesofthisVirtualCamera.ThisgenerallymirrorstheUnityCamera'slenssettings,andwillbeusedtodrivetheUnitycamerawhenthevcamisactive


m_LookAt Objectforthecamerachildrentolookat(theaimtarget)

m_Orbits Theradiusandheightofthethreeorbitingrigs


m_RecenterToTargetHeading ControlshowautomaticrecenteringoftheXaxisisaccomplished

m_SplineCurvature

m_XAxis TheHorizontalaxis.Valueis0..359.Thisispassedontotherigs'OrbitalTransposercomponent

m_YAxis TheVerticalaxis.Valueis0..1.Chooseshowtoblendthechildrigs


Top





Cinemachine

CinemachineFreeLookConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineFreeLook.#ctor"]


Syntax

SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace


publicCinemachineFreeLook()

CopyC# JavaScript



Cinemachine

CinemachineFreeLookProperties





LiveChildOrSelf Returnstherigwiththegreatestweight(OverridesCinemachineVirtualCameraBase



ParentCamera Supportformeta-virtual-cameras.

situationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.areimplementedasTransformchildrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase



RigNames Namesofthe3childrigs

State Thecacmerastate,whichwillbeablendofthechildrigstates(OverridesCinemachineVirtualCameraBase



Top


Cinemachine

CinemachineFreeLookFollowProperty



Syntax





CopyC# JavaScript



Cinemachine

CinemachineFreeLookLiveChildOrSelfProperty

Returnstherigwiththegreatestweight


Syntax





CopyC# JavaScript



Cinemachine

CinemachineFreeLookLookAtProperty



Syntax





CopyC# JavaScript



Cinemachine

CinemachineFreeLookRigNamesProperty

Namesofthe3childrigs


Syntax




publicstaticstring[]RigNames{get;}

CopyC# JavaScript




Cinemachine

CinemachineFreeLookStateProperty

Thecacmerastate,whichwillbeablendofthechildrigstates


Syntax





CopyC# JavaScript



Cinemachine

CinemachineFreeLookMethods




GetLocalPositionForCameraFromInput Returnsthelocalpositionofthecameraalongthesplineusedtoconnectthecurrentheadingofthe

GetRig Getachildrig




OnDestroy Makessurethatthechildrigsgetdestroyedinanundo-firndlymanner.(OverridesCinemachineVirtualCameraBase


OnEnable Updatesthechildrigcache

(OverridesCinemachineVirtualCameraBase


OnTransitionFromCamera IfwearetransitioningfromanotherFreeLook,grabtheaxisvaluesfromit.(OverridesCinemachineVirtualCameraBase

OnValidate Enforceboundsforfields,whenchangedininspector.(OverridesCinemachineVirtualCameraBase

PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,areupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledLateUpdate.Thisimplementationpushestheaxisvaluestotherigs.(OverridesCinemachineVirtualCameraBase






UpdateCameraState CalledbyCinemachineCoreatdesignatedupdatetimeupdated,andablendcalculated,dependingonthevalueoftheYaxis.(OverridesCinemachineVirtualCameraBase

Top

SeeAlso

ReferenceCinemachineFreeLookClassCinemachineNamespace




Cinemachine

CinemachineFreeLookGetLocalPositionForCameraFromInputMethod

Returnsthelocalpositionofthecameraalongthesplineusedtoconnectthethreecamerarigs.Doesnottakeintoaccountthecurrentheadingofthecamera(oritstarget)


Syntax

Parameters

tType:SystemSingleThet-valueforthecameraonitsspline.Internallyclampedtothevalue[0,1]

ReturnValueType:Vector3Thelocaloffset(back+up)ofthecameraWRTitstargetbasedonthesuppliedt-value

SeeAlsoReference

publicVector3GetLocalPositionForCameraFromInput(

floatt

)

CopyC# JavaScript


CinemachineFreeLookClassCinemachineNamespace




Cinemachine

CinemachineFreeLookGetRigMethod

Getachildrig


Syntax

Parameters

iType:SystemInt32Rigindex.Canbe0,1,or2

ReturnValueType:CinemachineVirtualCameraTherig,ornullifindexisbad.



publicCinemachineVirtualCameraGetRig(

inti

)

CopyC# JavaScript




Cinemachine

CinemachineFreeLookIsLiveChildMethod

Checkwhetherthevcamalivechildofthiscamera.Returnstrueifthechildiscurrentlycontributingactivelytothecamerastate.


Syntax

Parameters



SeeAlsoReferenceCinemachineFreeLookClass



)

CopyC# JavaScript


Cinemachine

CinemachineFreeLookOnDestroyMethod

Makessurethatthechildrigsgetdestroyedinanundo-firndlymanner.Invalidatestherigcache.


Syntax




CopyC# JavaScript



Cinemachine

CinemachineFreeLookOnEnableMethod

Updatesthechildrigcache


Syntax




CopyC# JavaScript



Cinemachine

CinemachineFreeLookOnTransitionFromCameraMethod

IfwearetransitioningfromanotherFreeLook,grabtheaxisvaluesfromit.


Syntax

Parameters







)

CopyC# JavaScript



Cinemachine

CinemachineFreeLookOnValidateMethod

Enforceboundsforfields,whenchangedininspector.


Syntax



protectedoverridevoidOnValidate()

CopyC# JavaScript



Cinemachine

CinemachineFreeLookPreUpdateChildCamerasMethod

Thisiscalledpriortotheupdatingofthevcam'schildcameras,inordertoallowtheparenttoprepareitschildren.IfthechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledpriortoeveryFixedUpdate,butmightbecalledonLateUpdate.Thisimplementationpushestheaxisvaluestotherigs.


Syntax

Parameters



ImplementsICinemachineCameraPreUpdateChildCameras(Vector3,Single)

SeeAlso

publicoverridevoidPreUpdateChildCameras(

Vector3worldUp,

floatdeltaTime

)

CopyC# JavaScript


ReferenceCinemachineFreeLookClassCinemachineNamespace




Cinemachine

CinemachineFreeLookRemovePostPipelineStageHookMethod



Syntax

Parameters






)

CopyC# JavaScript



Cinemachine

CinemachineFreeLookUpdateCameraStateMethod

CalledbyCinemachineCoreatdesignatedupdatetimesothevcamcanpositionitselfandtrackitstargets.All3childrigsareupdated,andablendcalculated,dependingonthevalueoftheYaxis.


Syntax

Parameters




SeeAlsoReference


Vector3worldUp,

floatdeltaTime

)

CopyC# JavaScript


CinemachineFreeLookClassCinemachineNamespace




Cinemachine

CinemachineFreeLookFields




CreateRigOverride Overridecomponentpipelinecreation.ThisneedstobedonebytheeditortosupportUndo.TheoverridemustdoexactlythesamethingastheCreatePipelinemethodinthisclass.

DestroyRigOverride Overridecomponentpipelinedestruction.ThisneedstobedonebytheeditortosupportUndo.


m_CommonLens Ifenabled,thislenssettingwillapplytoallthreechildrigs,otherwisethechildriglenssettingswillbeused


m_Follow Objectforthecamerachildrenwantstomovewith(thebodytarget)

m_Heading ThedefinitionofForward.Camerawillfollowbehind

m_Lens SpecifiesthelenspropertiesofthisVirtualCamera.ThisgenerallymirrorstheUnityCamera'slenssettings,andwillbeusedtodrivetheUnitycamerawhenthevcamisactive


m_LookAt Objectforthecamerachildrentolookat(theaimtarget)

m_Orbits Theradiusandheightofthethreeorbitingrigs


m_RecenterToTargetHeading ControlshowautomaticrecenteringoftheXaxisisaccomplished

m_SplineCurvature

m_XAxis TheHorizontalaxis.Valueis0..359.Thisispassedontotherigs'OrbitalTransposercomponent

m_YAxis TheVerticalaxis.Valueis0..1.Chooseshowtoblendthechildrigs


Top





Cinemachine

CinemachineFreeLookCreateRigOverrideField

Overridecomponentpipelinecreation.ThisneedstobedonebytheeditortosupportUndo.TheoverridemustdoexactlythesamethingastheCreatePipelinemethodinthisclass.


Syntax

FieldValueType:CinemachineFreeLookCreateRigDelegate



publicstaticCinemachineFreeLookCreateRigDelegate

CopyC# JavaScript



Cinemachine

CinemachineFreeLookDestroyRigOverrideField

Overridecomponentpipelinedestruction.ThisneedstobedonebytheeditortosupportUndo.


Syntax

FieldValueType:CinemachineFreeLookDestroyRigDelegate



publicstaticCinemachineFreeLookDestroyRigDelegate

CopyC# JavaScript



Cinemachine

CinemachineFreeLookm_BindingModeField

Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget


Syntax

FieldValueType:CinemachineTransposerBindingMode



[HeaderAttribute("Orbits")]

[TooltipAttribute("Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget.Thisisalsousedtosetthecamera'sUpvector,whichwillbemaintainedwhenaimingthecamera.")]

publicCinemachineTransposerBindingModem_BindingMode

CopyC# JavaScript



Cinemachine

CinemachineFreeLookm_CommonLensField

Ifenabled,thislenssettingwillapplytoallthreechildrigs,otherwisethechildriglenssettingswillbeused


Syntax




[TooltipAttribute("Ifenabled,thislenssettingwillapplytoallthreechildrigs,otherwisethechildriglenssettingswillbeused")]

[FormerlySerializedAsAttribute("m_UseCommonLensSetting")]

publicboolm_CommonLens

CopyC# JavaScript




Cinemachine

CinemachineFreeLookm_FollowField

Objectforthecamerachildrenwantstomovewith(thebodytarget)


Syntax




[TooltipAttribute("Objectforthecamerachildrenwantstomovewith(thebodytarget).")]



CopyC# JavaScript



Cinemachine

CinemachineFreeLookm_HeadingField

ThedefinitionofForward.Camerawillfollowbehind


Syntax

FieldValueType:CinemachineOrbitalTransposerHeading



[TooltipAttribute("ThedefinitionofForward.Camerawillfollowbehind.")]

publicCinemachineOrbitalTransposerHeadingm_Heading

CopyC# JavaScript



Cinemachine

CinemachineFreeLookm_LensField

SpecifiesthelenspropertiesofthisVirtualCamera.ThisgenerallymirrorstheUnityCamera'slenssettings,andwillbeusedtodrivetheUnitycamerawhenthevcamisactive


Syntax

FieldValueType:LensSettings



[FormerlySerializedAsAttribute("m_LensAttributes")]

[TooltipAttribute("SpecifiesthelenspropertiesofthisVirtualCamera.ThisgenerallymirrorstheUnityCamera'slenssettings,andwillbeusedtodrivetheUnitycamerawhenthevcamisactive")]

[LensSettingsPropertyAttribute]

publicLensSettingsm_Lens

CopyC# JavaScript



Cinemachine

CinemachineFreeLookm_LookAtField

Objectforthecamerachildrentolookat(theaimtarget)


Syntax




[TooltipAttribute("Objectforthecamerachildrentolookat(theaimtarget).")]



CopyC# JavaScript



Cinemachine

CinemachineFreeLookm_OrbitsField

Theradiusandheightofthethreeorbitingrigs


Syntax

FieldValueType:CinemachineFreeLookOrbit



[TooltipAttribute("Theradiusandheightofthethreeorbitingrigs.")]

publicCinemachineFreeLookOrbit[]m_Orbits

CopyC# JavaScript



Cinemachine

CinemachineFreeLookm_RecenterToTargetHeadingField

ControlshowautomaticrecenteringoftheXaxisisaccomplished


Syntax

FieldValueType:CinemachineOrbitalTransposerRecentering



[TooltipAttribute("ControlshowautomaticrecenteringoftheXaxisisaccomplished")]

publicCinemachineOrbitalTransposerRecenteringm_RecenterToTargetHeading

CopyC# JavaScript



Cinemachine

CinemachineFreeLookm_SplineCurvatureField

[Missing<summary>documentationfor"F:Cinemachine.CinemachineFreeLook.m_SplineCurvature"]


Syntax




[TooltipAttribute("Controlshowtautisthelinethatconnectstherigs'orbits,whichdeterminesfinalplacementontheYaxis")]


[FormerlySerializedAsAttribute("m_SplineTension")]

publicfloatm_SplineCurvature

CopyC# JavaScript




Cinemachine

CinemachineFreeLookm_XAxisField

TheHorizontalaxis.Valueis0..359.Thisispassedontotherigs'OrbitalTransposercomponent


Syntax

FieldValueType:AxisState



[TooltipAttribute("TheHorizontalaxis.Valueis0..359.Thisispassedontotherigs'OrbitalTransposercomponent")]

publicAxisStatem_XAxis

CopyC# JavaScript



Cinemachine

CinemachineFreeLookm_YAxisField

TheVerticalaxis.Valueis0..1.Chooseshowtoblendthechildrigs


Syntax




[HeaderAttribute("AxisControl")]

[TooltipAttribute("TheVerticalaxis.Valueis0..1.Chooseshowtoblendthechildrigs")]

publicAxisStatem_YAxis

CopyC# JavaScript



Cinemachine

CinemachineFreeLookCreateRigDelegateDelegate



Syntax

Parameters

vcamType:CinemachineCinemachineFreeLook

nameType:SystemString

copyFromType:CinemachineCinemachineVirtualCamera

ReturnValueType:CinemachineVirtualCamera

SeeAlso

publicdelegateCinemachineVirtualCameraCreateRigDelegate

CinemachineFreeLookvcam,

stringname,

CinemachineVirtualCameracopyFrom

)

CopyC# JavaScript


Cinemachine

CinemachineFreeLookDestroyRigDelegateDelegate



Syntax

Parameters

rigType:GameObject



publicdelegatevoidDestroyRigDelegate(

GameObjectrig

)

CopyC# JavaScript



Cinemachine

CinemachineFreeLookOrbitStructure

DefinestheheightandradiusoftheRigorbit


Syntax

TheCinemachineFreeLookOrbittypeexposesthefollowingmembers.


CinemachineFreeLookOrbit Constructorwithspecificvalues

Top


m_Height Heightrelativetotarget

m_Radius Radiusoforbit


publicstructOrbit

CopyC# JavaScript

Top





Cinemachine

CinemachineFreeLookOrbitConstructor



Syntax

Parameters

hType:SystemSingle[Missing<paramname="h"/>documentationfor"M:Cinemachine.CinemachineFreeLook.Orbit.#ctor(System.Single,System.Single)"]

rType:SystemSingle[Missing<paramname="r"/>documentationfor"M:Cinemachine.CinemachineFreeLook.Orbit.#ctor(System.Single,System.Single)"]

SeeAlsoReferenceCinemachineFreeLookOrbitStructureCinemachineNamespace

publicOrbit(

floath,

floatr

)

CopyC# JavaScript



Cinemachine

OrbitFields

TheCinemachineFreeLookOrbittypeexposesthefollowingmembers.


m_Height Heightrelativetotarget

m_Radius Radiusoforbit

Top





Cinemachine

CinemachineFreeLookOrbitm_HeightField

Heightrelativetotarget


Syntax




publicfloatm_Height

CopyC# JavaScript




Cinemachine

CinemachineFreeLookOrbitm_RadiusField

Radiusoforbit


Syntax




publicfloatm_Radius

CopyC# JavaScript




Cinemachine

CinemachineGroupComposerClass

ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.Itsjobistoaimthecameraatatargetobject,withconfigurableoffsets,damping,andcompositionrules.Inaddition,ifthetargetisaCinemachineTargetGroup,thebehaviourwilladjusttheFOVandthecameradistancetoensurethattheentiregroupoftargetsisframedproperly.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineComposerCinemachineCinemachineGroupComposer


Syntax


[ExecuteInEditMode]




publicclassCinemachineGroupComposer:CinemachineComposer

CopyC# JavaScript


TheCinemachineGroupComposertypeexposesthefollowingmembers.


CinemachineGroupComposer

Top



HardGuideRect InternalAPIfortheinspectoreditor(InheritedfromCinemachineComposer.)

IsValid TrueifcomponentisenabledandhasaLookAtdefined(InheritedfromCinemachineComposer.)




SoftGuideRect InternalAPIfortheinspectoreditor(InheritedfromCinemachineComposer.)

Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage(InheritedfromCinemachineComposer.)

TargetGroup GetLookAttargetasCinemachineTargetGroup,ornulliftargetisnotagroup



Top


GetTrackedPoint Applythetargetoffsetstothetargetlocation.(InheritedfromCinemachineComposer

MutateCameraState Appliesthecomposerrulesandorientsthecameraaccordingly(OverridesCinemachineComposerMutateCameraState(CameraStateSingle).)

OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.Baseclassimplementationdoesnothing.(InheritedfromCinemachineComponentBase

Top



m_BiasX Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone(InheritedfromCinemachineComposer.)

m_BiasY Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone(InheritedfromCinemachineComposer.)

m_DeadZoneHeight Camerawillnotrotateverticallyifthetargetiswithinthisrangeoftheposition(Inheritedfrom

CinemachineComposer.)

m_DeadZoneWidth Camerawillnotrotatehorizontallyifthetargetiswithinthisrangeoftheposition(InheritedfromCinemachineComposer.)

m_FrameDamping Howaggressivelythecameratriestoframethegroup.Smallnumbersaremoreresponsive

m_FramingMode Whatscreendimensionstoconsiderwhenframing


m_HorizontalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-horizontaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.

(InheritedfromCinemachineComposer.)

m_LookaheadSmoothing Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag(InheritedfromCinemachineComposer.)

m_LookaheadTime Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.(InheritedfromCinemachineComposer.)









m_ScreenX Horizontalscreenpositionfortarget.Thecamerawillrotatetothepositionthetrackedobjecthere(InheritedfromCinemachineComposer.)

m_ScreenY Verticalscreenpositionfortarget,Thecamerawillrotatetotoposition

thetrackedobjecthere(InheritedfromCinemachineComposer.)

m_SoftZoneHeight Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed(InheritedfromCinemachineComposer.)

m_SoftZoneWidth Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed(InheritedfromCinemachineComposer.)

m_TrackedObjectOffset Targetoffsetfromtheobject'scenterinLOCALspacewhichtheComposertracks.Usethistofine-tunethetrackingtargetpositionwhenthedesiredareaisnotinthetrackedobject'scenter(InheritedfromCinemachineComposer.)

m_VerticalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-

verticaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.(InheritedfromCinemachineComposer.)

OnGUICallback UsedbytheInspectorEditortodisplayon-screenguides.(InheritedfromCinemachineComposer.)

Top





Cinemachine

CinemachineGroupComposerConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineGroupComposer.#ctor"]


Syntax

SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace


publicCinemachineGroupComposer()

CopyC# JavaScript



Cinemachine

CinemachineGroupComposerProperties




HardGuideRect InternalAPIfortheinspectoreditor(InheritedfromCinemachineComposer.)

IsValid TrueifcomponentisenabledandhasaLookAtdefined(InheritedfromCinemachineComposer.)



m_lastBoundsMatrix Foreditorvisualizationofthe

calculatedboundingboxofthegroup

SoftGuideRect InternalAPIfortheinspectoreditor(InheritedfromCinemachineComposer.)

Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage(InheritedfromCinemachineComposer.)

TargetGroup GetLookAttargetasCinemachineTargetGroup,ornulliftargetisnotagroup



Top





Cinemachine

CinemachineGroupComposerm_LastBoundsProperty

Foreditorvisulaizationofthecalculatedboundingboxofthegroup


Syntax




publicBoundsm_LastBounds{get;}

CopyC# JavaScript



Cinemachine

CinemachineGroupComposerm_lastBoundsMatrixProperty

Foreditorvisualizationofthecalculatedboundingboxofthegroup


Syntax

PropertyValueType:Matrix4x4



publicMatrix4x4m_lastBoundsMatrix{get;}

CopyC# JavaScript



Cinemachine

CinemachineGroupComposerTargetGroupProperty

GetLookAttargetasCinemachineTargetGroup,ornulliftargetisnotagroup


Syntax

PropertyValueType:CinemachineTargetGroup



publicCinemachineTargetGroupTargetGroup{get;}

CopyC# JavaScript



Cinemachine

CinemachineGroupComposerMethods



GetTrackedPoint Applythetargetoffsetstothetargetlocation.(InheritedfromCinemachineComposer

MutateCameraState Appliesthecomposerrulesandorientsthecameraaccordingly(OverridesCinemachineComposerMutateCameraState(CameraStateSingle).)

OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.Baseclassimplementationdoesnothing.(InheritedfromCinemachineComponentBase

Top





Cinemachine

CinemachineGroupComposerMutateCameraStateMethod



Syntax

Parameters

curStateType:CinemachineCameraState[Missing<paramname="curState"/>documentationfor"M:Cinemachine.CinemachineGroupComposer.MutateCameraState(Cinemachine.CameraState@,System.Single)"]





floatdeltaTime

)

CopyC# JavaScript


Cinemachine

CinemachineGroupComposerFields




m_BiasX Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone(InheritedfromCinemachineComposer.)

m_BiasY Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone(InheritedfromCinemachineComposer.)

m_DeadZoneHeight Camerawillnotrotateverticallyifthetargetiswithinthisrangeoftheposition(InheritedfromCinemachineComposer.)

m_DeadZoneWidth Camerawillnotrotatehorizontallyifthetargetiswithinthisrangeoftheposition(InheritedfromCinemachineComposer.)

m_FrameDamping Howaggressivelythecameratriestoframethegroup.Smallnumbersaremoreresponsive

m_FramingMode Whatscreendimensionstoconsiderwhenframing


m_HorizontalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-horizontaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.(InheritedfromCinemachineComposer.)

m_LookaheadSmoothing Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag(InheritedfromCinemachineComposer.)

m_LookaheadTime Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.(InheritedfromCinemachineComposer.)


m_MaxDollyOut Howmuchfartherfromthetargetcanthe

camerago?







m_ScreenX Horizontalscreenpositionfortarget.Thecamerawillrotatetothepositionthetrackedobjecthere(InheritedfromCinemachineComposer.)

m_ScreenY Verticalscreenpositionfortarget,Thecamerawillrotatetotopositionthetrackedobjecthere(Inheritedfrom

CinemachineComposer.)

m_SoftZoneHeight Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed(InheritedfromCinemachineComposer.)

m_SoftZoneWidth Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed(InheritedfromCinemachineComposer.)

m_TrackedObjectOffset Targetoffsetfromtheobject'scenterinLOCALspacewhichtheComposertracks.Usethistofine-tunethetrackingtargetpositionwhenthedesiredareaisnotinthetrackedobject'scenter(InheritedfromCinemachineComposer.)

m_VerticalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-verticaldirection.Smallnumbersaremore

responsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.(InheritedfromCinemachineComposer.)

OnGUICallback UsedbytheInspectorEditortodisplayon-screenguides.(InheritedfromCinemachineComposer.)

Top





Cinemachine

CinemachineGroupComposerm_AdjustmentModeField



Syntax

FieldValueType:CinemachineGroupComposerAdjustmentMode



[TooltipAttribute("Howtoadjustthecameratogetthedesiredframing.Youcanzoom,dollyin/out,ordoboth.")]

publicCinemachineGroupComposerAdjustmentModem_AdjustmentMode

CopyC# JavaScript



Cinemachine

CinemachineGroupComposerm_FrameDampingField

Howaggressivelythecameratriestoframethegroup.Smallnumbersaremoreresponsive


Syntax





[TooltipAttribute("Howaggressivelythecameratriestoframethegroup.Smallnumbersaremoreresponsive,rapidlyadjustingthecameratokeepthegroupintheframe.Largernumbersgiveamoreheavyslowlyrespondingcamera.")]

publicfloatm_FrameDamping

CopyC# JavaScript




Cinemachine

CinemachineGroupComposerm_FramingModeField



Syntax

FieldValueType:CinemachineGroupComposerFramingMode



[TooltipAttribute("Whatscreendimensionstoconsiderwhenframing.CanbeHorizontal,Vertical,orboth")]

publicCinemachineGroupComposerFramingModem_FramingMode

CopyC# JavaScript



Cinemachine

CinemachineGroupComposerm_GroupFramingSizeField

Howmuchofthescreentofillwiththeboundingboxofthetargets.


Syntax




[SpaceAttribute]

[TooltipAttribute("Theboundingboxofthetargetsshouldoccupythisamountofthescreenspace.1meansfillthewholescreen.0.5meansfillhalfthescreen,etc.")]

publicfloatm_GroupFramingSize

CopyC# JavaScript




Cinemachine

CinemachineGroupComposerm_MaxDollyInField

Howmuchclosertothetargetcanthecamerago?


Syntax




[TooltipAttribute("Themaximumdistancetowardthetargetthatthisbehaviourisallowedtomovethecamera.")]

publicfloatm_MaxDollyIn

CopyC# JavaScript




Cinemachine

CinemachineGroupComposerm_MaxDollyOutField

Howmuchfartherfromthetargetcanthecamerago?


Syntax




[TooltipAttribute("Themaximumdistanceawaythetargetthatthisbehaviourisallowedtomovethecamera.")]

publicfloatm_MaxDollyOut

CopyC# JavaScript




Cinemachine

CinemachineGroupComposerm_MaximumDistanceField

Setthistolimithowfarfromthetaregtthecameracanget


Syntax




[TooltipAttribute("Setthistolimithowfarfromthetargetthecameracanget.")]

publicfloatm_MaximumDistance

CopyC# JavaScript




Cinemachine

CinemachineGroupComposerm_MaximumFOVField

IfadjustingFOV,willnotsettheFOVhigherthanthis


Syntax





[TooltipAttribute("IfadjustingFOV,willnotsettheFOVhigherthanthis.")]

publicfloatm_MaximumFOV

CopyC# JavaScript




Cinemachine

CinemachineGroupComposerm_MaximumOrthoSizeField

IfadjustingOrthographicSize,willnotsetithigherthanthis


Syntax




[TooltipAttribute("IfadjustingOrthographicSize,willnotsetithigherthanthis.")]

publicfloatm_MaximumOrthoSize

CopyC# JavaScript




Cinemachine

CinemachineGroupComposerm_MinimumDistanceField

Setthistolimithowclosetothetargetthecameracanget


Syntax




[TooltipAttribute("Setthistolimithowclosetothetargetthecameracanget.")]

publicfloatm_MinimumDistance

CopyC# JavaScript




Cinemachine

CinemachineGroupComposerm_MinimumFOVField

IfadjustingFOV,willnotsettheFOVlowerthanthis


Syntax





[TooltipAttribute("IfadjustingFOV,willnotsettheFOVlowerthanthis.")]

publicfloatm_MinimumFOV

CopyC# JavaScript




Cinemachine

CinemachineGroupComposerm_MinimumOrthoSizeField

IfadjustingOrthographicSize,willnotsetitlowerthanthis


Syntax




[TooltipAttribute("IfadjustingOrthographicSize,willnotsetitlowerthanthis.")]

publicfloatm_MinimumOrthoSize

CopyC# JavaScript




Cinemachine

CinemachineGroupComposerAdjustmentModeEnumeration



Syntax


ZoomOnly 0 Donotmovethecamera,onlyadjusttheFOV.

DollyOnly 1 Justmovethecamera,don'tchangetheFOV.

DollyThenZoom 2 Movethecameraasmuchaspermittedbytheranges,thenadjusttheFOVifnecessarytomaketheshot.

publicenumAdjustmentMode

CopyC# JavaScript

Cinemachine

CinemachineGroupComposerFramingModeEnumeration



Syntax


Horizontal 0 Consideronlythehorizontaldimension.Verticalframingisignored.

Vertical 1 Consideronlytheverticaldimension.Horizontalframingisignored.

HorizontalAndVertical 2 Thelargerofthe


publicenumFramingMode

CopyC# JavaScript

horizontalandverticaldimensionswilldominate,togetthebestfit.





Cinemachine

CinemachineHardLockToTargetClass

ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.ItsjobistoplacethecameraontheFollowTarget.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineHardLockToTarget


Syntax

TheCinemachineHardLockToTargettypeexposesthefollowingmembers.

Constructors





publicclassCinemachineHardLockToTarget:CinemachineComponentBase

CopyC# JavaScript


Name Description

CinemachineHardLockToTarget

Top







VirtualCamera GettheassociatedCinemachineVirtualCameraBase(Inheritedfrom


Top




Top





Cinemachine

CinemachineHardLockToTargetConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineHardLockToTarget.#ctor"]


Syntax

SeeAlsoReferenceCinemachineHardLockToTargetClassCinemachineNamespace


publicCinemachineHardLockToTarget()

CopyC# JavaScript



Cinemachine

CinemachineHardLockToTargetProperties









Top





Cinemachine

CinemachineHardLockToTargetIsValidProperty



Syntax





CopyC# JavaScript




Cinemachine

CinemachineHardLockToTargetStageProperty



Syntax





CopyC# JavaScript



Cinemachine

CinemachineHardLockToTargetMethods





Top





Cinemachine

CinemachineHardLockToTargetMutateCameraStateMethod



Syntax

Parameters







floatdeltaTime

)

CopyC# JavaScript



Cinemachine

CinemachineHardLookAtClass

ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.ItsjobistoaimthecamerahardattheLookAttarget.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineHardLookAt


Syntax

TheCinemachineHardLookAttypeexposesthefollowingmembers.


CinemachineHardLookAt





publicclassCinemachineHardLookAt:CinemachineComponentBase

CopyC# JavaScript


Top








Top




Top





Cinemachine

CinemachineHardLookAtConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineHardLookAt.#ctor"]


Syntax

SeeAlsoReferenceCinemachineHardLookAtClassCinemachineNamespace


publicCinemachineHardLookAt()

CopyC# JavaScript



Cinemachine

CinemachineHardLookAtProperties









Top





Cinemachine

CinemachineHardLookAtIsValidProperty



Syntax





CopyC# JavaScript




Cinemachine

CinemachineHardLookAtStageProperty



Syntax





CopyC# JavaScript



Cinemachine

CinemachineHardLookAtMethods





Top





Cinemachine

CinemachineHardLookAtMutateCameraStateMethod



Syntax

Parameters







floatdeltaTime

)

CopyC# JavaScript



Cinemachine

CinemachineMixingCameraClass

CinemachineMixingCameraisa"managercamera"thattakesonthestateoftheweightedaverageofthestatesofitschildvirtualcameras.Afixednumberofslotsaremadeavailableforcameras,ratherthanadynamicarray.WedoitthiswayinordertosupportweightanimationfromtheTimeline.Timelinecannotanimatearrayelements.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineMixingCamera


Syntax

TheCinemachineMixingCameratypeexposesthefollowingmembers.


[ExecuteInEditMode]


[AddComponentMenu("Cinemachine/CinemachineMixingCamera")]

publicclassCinemachineMixingCamera:CinemachineVirtualCameraBase

CopyC# JavaScript



CinemachineMixingCamera

Top


ChildCameras Getthecachedlistofchildcameras.justtheimmediatechildreninthehierarchy.onlythefirstentriesofthislistparticipateinthefinalblend,uptoMaxCameras


Follow Notused(OverridesCinemachineVirtualCameraBase


LookAt Notused(OverridesCinemachineVirtualCameraBase





State TheblendedCameraState(OverridesCinemachineVirtualCameraBase



Top


AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.pipeline.SeeCinemachineCore.Stage.(Inheritedfrom

GetWeight(Int32) Gettheweightofthechildatanindex.

GetWeight(CinemachineVirtualCameraBase) GettheweightofthechildCinemachineVirtualCameraBase.

InvalidateListOfChildren Invalidatethecachedlistofchildcameras.

InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforall(Inheritedfrom


MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereisLivecameraifthemostrecentonegoestothetopoftheprioritysubqueue.anditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.(Inheritedfrom

OnDestroy Baseclassimplementationremovesthevirtualcamerafromthepriorityqueue.(Inheritedfrom

OnDisable Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(Inheritedfrom



OnTransformParentChanged Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(Inheritedfrom

OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.(Inheritedfrom

OnValidate Makessuretheweightsarenon-negative(OverridesCinemachineVirtualCameraBase

PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,

areupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledLateUpdateinstead.(Inheritedfrom


ResolveFollow Returnsthisvcam'sFollowtarget,orifthatisnull,willretrun(Inheritedfrom

ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretrun(Inheritedfrom

SetWeight(Int32,Single) Settheweightofthechildatanindex.

SetWeight(CinemachineVirtualCameraBase,Single)

SettheweightofthechildCinemachineVirtualCameraBase.

Start Baseclassimplementationdoesnothing.(Inheritedfrom

Update Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(Inheritedfrom

UpdateCameraState CalledbyCinemachineCoreatdesignatedupdatetimecomputesandcachestheweightedblendofthetrackedcameras.(OverridesCinemachineVirtualCameraBase

ValidateListOfChildren Rebuildthecachedlistofchildcameras.

Top


CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removed

CinemachineDebuggerintheEditor.(InheritedfromCinemachineVirtualCameraBase




m_Weight0 Weightofthefirsttrackedcamera

m_Weight1 Weightofthesecondtrackedcamera

m_Weight2 Weightofthethirdtrackedcamera

m_Weight3 Weightofthefourthtrackedcamera

m_Weight4 Weightofthefifthtrackedcamera

m_Weight5 Weightofthesixthtrackedcamera

m_Weight6 Weightoftheseventhtrackedcamera

m_Weight7 Weightoftheeighthtrackedcamera

MaxCameras Themaximumnumberoftrackedcameras.Ifyouwanttoaddcameras,doithereinthesourcecode,andbesuretoaddtheextramembervariablesandtomaketheappropriatechangesinGetWeight()andSetWeight().Theinspectorwillfigureitselfoutbasedonthisvalue.


Top





Cinemachine

CinemachineMixingCameraConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineMixingCamera.#ctor"]


Syntax

SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace


publicCinemachineMixingCamera()

CopyC# JavaScript



Cinemachine

CinemachineMixingCameraProperties



ChildCameras Getthecachedlistofchildcameras.justtheimmediatechildreninthehierarchy.onlythefirstentriesofthislistparticipateinthefinalblend,uptoMaxCameras


Follow Notused(OverridesCinemachineVirtualCameraBase


LookAt Notused(OverridesCinemachineVirtualCameraBase





State TheblendedCameraState(OverridesCinemachineVirtualCameraBase



Top




Cinemachine

CinemachineMixingCameraChildCamerasProperty

Getthecachedlistofchildcameras.Thesearejusttheimmediatechildreninthehierarchy.Note:onlythefirstentriesofthislistparticipateinthefinalblend,uptoMaxCameras


Syntax





CopyC# JavaScript



Cinemachine

CinemachineMixingCameraFollowProperty

Notused


Syntax





CopyC# JavaScript



Cinemachine

CinemachineMixingCameraLiveChildOrSelfProperty

Returnthelivechild.


Syntax





CopyC# JavaScript



Cinemachine

CinemachineMixingCameraLookAtProperty

Notused


Syntax





CopyC# JavaScript



Cinemachine

CinemachineMixingCameraStateProperty

TheblendedCameraState


Syntax





CopyC# JavaScript



Cinemachine

CinemachineMixingCameraMethods



AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.pipeline.SeeCinemachineCore.Stage.(Inheritedfrom



InvalidateListOfChildren Invalidatethecachedlistofchildcameras.



MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereisLivecameraifthemostrecentonegoestothetopoftheprioritysubqueue.anditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.(Inheritedfrom

OnDestroy Baseclassimplementationremovesthevirtualcamerafromthepriorityqueue.(Inheritedfrom

OnDisable Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.

(Inheritedfrom




OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.(Inheritedfrom

OnValidate Makessuretheweightsarenon-negative(OverridesCinemachineVirtualCameraBase

PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,areupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledLateUpdateinstead.(Inheritedfrom


ResolveFollow Returnsthisvcam'sFollowtarget,orifthatisnull,willretrun(Inheritedfrom

ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretrun(Inheritedfrom





Update Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.

(Inheritedfrom

UpdateCameraState CalledbyCinemachineCoreatdesignatedupdatetimecomputesandcachestheweightedblendofthetrackedcameras.(OverridesCinemachineVirtualCameraBase

ValidateListOfChildren Rebuildthecachedlistofchildcameras.

Top





Cinemachine

CinemachineMixingCameraGetWeightMethod

OverloadList Name Description



Top





Cinemachine

CinemachineMixingCameraGetWeightMethod(Int32)

Gettheweightofthechildatanindex.


Syntax

Parameters

indexType:SystemInt32Thechildindex.OnlyimmediateCinemachineVirtualCameraBasechildrenarecounted.

ReturnValueType:SingleTheweightofthecamera.Validonlyifcameraisactiveandenabled.

SeeAlsoReferenceCinemachineMixingCameraClassGetWeightOverloadCinemachineNamespace

publicfloatGetWeight(

intindex

)

CopyC# JavaScript



Cinemachine

CinemachineMixingCameraGetWeightMethod(CinemachineVirtualCameraBase)

GettheweightofthechildCinemachineVirtualCameraBase.


Syntax

Parameters

vcamType:CinemachineCinemachineVirtualCameraBaseThechildcamera.

ReturnValueType:SingleTheweightofthecamera.Validonlyifcameraisactiveandenabled.

SeeAlsoReferenceCinemachineMixingCameraClassGetWeightOverloadCinemachineNamespace

publicfloatGetWeight(


)

CopyC# JavaScript


Cinemachine

CinemachineMixingCameraInvalidateListOfChildrenMethod

Invalidatethecachedlistofchildcameras.


Syntax



protectedvoidInvalidateListOfChildren()

CopyC# JavaScript



Cinemachine

CinemachineMixingCameraIsLiveChildMethod



Syntax

Parameters






)

CopyC# JavaScript


Cinemachine

CinemachineMixingCameraOnEnableMethod



Syntax




CopyC# JavaScript



Cinemachine

CinemachineMixingCameraOnTransformChildrenChangedMethod



Syntax




CopyC# JavaScript



Cinemachine

CinemachineMixingCameraOnValidateMethod

Makessuretheweightsarenon-negative


Syntax




CopyC# JavaScript



Cinemachine

CinemachineMixingCameraRemovePostPipelineStageHookMethod



Syntax

Parameters






)

CopyC# JavaScript



Cinemachine

CinemachineMixingCameraSetWeightMethod





Top





Cinemachine

CinemachineMixingCameraSetWeightMethod(Int32,Single)

Settheweightofthechildatanindex.


Syntax

Parameters

indexType:SystemInt32Thechildindex.OnlyimmediateCinemachineVirtualCameraBasechildrenarecounted.

wType:SystemSingleTheweighttoset.Canbeanynon-negativenumber.

SeeAlsoReferenceCinemachineMixingCameraClassSetWeightOverloadCinemachineNamespace

publicvoidSetWeight(

intindex,

floatw

)

CopyC# JavaScript



Cinemachine

CinemachineMixingCameraSetWeightMethod(CinemachineVirtualCameraBase,Single)



Syntax

Parameters

vcamType:CinemachineCinemachineVirtualCameraBaseThechildcamera.

wType:SystemSingleTheweighttoset.Canbeanynon-negativenumber.

SeeAlsoReferenceCinemachineMixingCameraClass

publicvoidSetWeight(


floatw

)

CopyC# JavaScript


SetWeightOverloadCinemachineNamespace




Cinemachine

CinemachineMixingCameraUpdateCameraStateMethod

CalledbyCinemachineCoreatdesignatedupdatetimesothevcamcanpositionitselfandtrackitstargets.Thisimplementationcomputesandcachestheweightedblendofthetrackedcameras.


Syntax

Parameters




SeeAlsoReference


Vector3worldUp,

floatdeltaTime

)

CopyC# JavaScript


CinemachineMixingCameraClassCinemachineNamespace




Cinemachine

CinemachineMixingCameraValidateListOfChildrenMethod

Rebuildthecachedlistofchildcameras.


Syntax



protectedvoidValidateListOfChildren()

CopyC# JavaScript



Cinemachine

CinemachineMixingCameraFields







m_Weight0 Weightofthefirsttrackedcamera

m_Weight1 Weightofthesecondtrackedcamera

m_Weight2 Weightofthethirdtrackedcamera

m_Weight3 Weightofthefourthtrackedcamera

m_Weight4 Weightofthefifthtrackedcamera

m_Weight5 Weightofthesixthtrackedcamera

m_Weight6 Weightoftheseventhtrackedcamera

m_Weight7 Weightoftheeighthtrackedcamera

MaxCameras Themaximumnumberoftrackedcameras.Ifyouwanttoaddcameras,doithereinthesourcecode,andbesuretoaddtheextramembervariablesandtomaketheappropriatechangesinGetWeight()andSetWeight().Theinspectorwillfigureitselfoutbasedonthisvalue.

OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.


Top





Cinemachine

CinemachineMixingCameram_Weight0Field

Weightofthefirsttrackedcamera


Syntax




[TooltipAttribute("Theweightofthefirsttrackedcamera")]

publicfloatm_Weight0

CopyC# JavaScript




Cinemachine


Weightofthesecondtrackedcamera


Syntax




[TooltipAttribute("Theweightofthesecondtrackedcamera")]


CopyC# JavaScript




Cinemachine


Weightofthethirdtrackedcamera


Syntax




[TooltipAttribute("Theweightofthethirdtrackedcamera")]


CopyC# JavaScript




Cinemachine


Weightofthefourthtrackedcamera


Syntax




[TooltipAttribute("Theweightofthefourthtrackedcamera")]


CopyC# JavaScript




Cinemachine


Weightofthefifthtrackedcamera


Syntax




[TooltipAttribute("Theweightofthefifthtrackedcamera")]


CopyC# JavaScript




Cinemachine


Weightofthesixthtrackedcamera


Syntax




[TooltipAttribute("Theweightofthesixthtrackedcamera")]


CopyC# JavaScript




Cinemachine


Weightoftheseventhtrackedcamera


Syntax




[TooltipAttribute("Theweightoftheseventhtrackedcamera")]


CopyC# JavaScript




Cinemachine


Weightoftheeighthtrackedcamera


Syntax




[TooltipAttribute("Theweightoftheeighthtrackedcamera")]


CopyC# JavaScript




Cinemachine

CinemachineMixingCameraMaxCamerasField

Themaximumnumberoftrackedcameras.Ifyouwanttoaddmorecameras,doithereinthesourcecode,andbesuretoaddtheextramembervariablesandtomaketheappropriatechangesinGetWeight()andSetWeight().Theinspectorwillfigureitselfoutbasedonthisvalue.


Syntax




publicconstintMaxCameras=8

CopyC# JavaScript




Cinemachine

CinemachineOrbitalTransposerClass

ThisisaCinemachineComponentinthetheBodysectionofthecomponentpipeline.Itsjobistopositionthecamerainavariablerelationshiptoathevcam'sFollowtargetobject,withoffsetsanddamping.Thiscomponentistypicallyusedtoimplementacamerathatfollowsitstarget.Itcanacceptplayerinputfromaninputdevice,whichallowstheplayertodynamicallycontroltherelationshipbetweenthecameraandthetarget,forexamplewithajoystick.TheOrbitalTransposerintroducestheconceptof__Heading__,whichisthedirectioninwhichthetargetismoving,andtheOrbitalTransposerwillattempttopositionthecamerainrelationshiptotheheading,whichisbydefaultdirectlybehindthetarget.YoucancontrolthedefaultrelationshipbyadjustingtheHeadingBiassetting.IfyouattachaninputcontrollertotheOrbitalTransposer,thentheplayercanalsocontrolthewaythecamerapositionsitselfinrelationtothetargetheading.Thisallowsthecameratomovetoanyspotonanorbitaroundthetarget.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineTransposerCinemachineCinemachineOrbitalTransposer


Syntax


TheCinemachineOrbitalTransposertypeexposesthefollowingmembers.


AngularDamping Dampingspeedsforeachofthe3axesofthetarget'srotation(InheritedfromCinemachineTransposer.)

Damping Dampingspeedsforeachofthe3axesoftheoffsetfromtarget(InheritedfromCinemachineTransposer.)

EffectiveOffset Getthetargetoffset,withsanitization(InheritedfromCinemachineTransposer.)


IsValid TrueifcomponentisenabledandhasavalidFollowtarget(Inheritedfrom





publicclassCinemachineOrbitalTransposer:CinemachineTransposer

CopyC# JavaScript

CinemachineTransposer.)


Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage(InheritedfromCinemachineTransposer.)



Top


GeTargetCameraPosition InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget(InheritedfromCinemachineTransposer

GetReferenceOrientation InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget(InheritedfromCinemachineTransposer

InitPrevFrameStateInfo Initializesthestateforpreviousframeifappropriate.

(InheritedfromCinemachineTransposer

MutateCameraState Positionsthevirtualcameraaccordingtothetransposerrules.(OverridesCinemachineTransposerMutateCameraState(CameraStateSingle).)

OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.Thisimplementationaddsthedeltatothefollowoffset,afterzeroingoutlocalx.(OverridesCinemachineTransposerOnPositionDragged(Vector3)

OnValidate (OverridesCinemachineTransposer

TrackTarget Positionsthevirtualcameraaccordingtothetransposerrules.(InheritedfromCinemachineTransposer

UpdateHeading Wheninslavemode,thisshouldbecalledonceandonlyonceeveryhrametoupdatetheheading.slavemode,thisiscalledautomatically.

Top


m_BindingMode Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget(InheritedfromCinemachineTransposer.)

m_FollowOffset Thedistancewhichthetransposerwillattempttomaintainfromthe

transposersubject(InheritedfromCinemachineTransposer.)

m_Heading ThedefinitionofForward.Camerawillfollowbehind.

m_HeadingIsSlave Drivethex-axissettingprogrammatically.Automaticheadingupdatingwillbedisabled.

m_PitchDamping Howaggressivelythecameratriestotrackthetargetrotation'sXangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.(InheritedfromCinemachineTransposer.)

m_RecenterToTargetHeading ParametersthatcontrolAutomatingHeadingRecentering

m_RollDamping Howaggressivelythecameratriestotrackthetargetrotation'sZangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.(InheritedfromCinemachineTransposer.)

m_XAxis Axisrepresentingthecurrentheading.Valueisindegreesandrepresentsarotationabouttheupvector

m_XDamping HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors(InheritedfromCinemachineTransposer.)

m_YawDamping Howaggressivelythecameratriestotrackthetargetrotation'sYangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.(InheritedfromCinemachineTransposer.)

m_YDamping HowaggressivelythecameratriestomaintaintheoffsetintheY-axis.Smallnumbersaremoreresponsive,rapidly

translatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors(InheritedfromCinemachineTransposer.)

m_ZDamping HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors(InheritedfromCinemachineTransposer.)

Top





Cinemachine

CinemachineOrbitalTransposerProperties



AngularDamping Dampingspeedsforeachofthe3axesofthetarget'srotation(InheritedfromCinemachineTransposer.)

Damping Dampingspeedsforeachofthe3axesoftheoffsetfromtarget(InheritedfromCinemachineTransposer.)

EffectiveOffset Getthetargetoffset,withsanitization(InheritedfromCinemachineTransposer.)


IsValid TrueifcomponentisenabledandhasavalidFollowtarget(InheritedfromCinemachineTransposer.)


Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage(InheritedfromCinemachineTransposer.)



Top

SeeAlsoReferenceCinemachineOrbitalTransposerClassCinemachineNamespace




Cinemachine

CinemachineOrbitalTransposerMethods



GeTargetCameraPosition InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget(InheritedfromCinemachineTransposer

GetReferenceOrientation InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget(InheritedfromCinemachineTransposer

InitPrevFrameStateInfo Initializesthestateforpreviousframeifappropriate.(InheritedfromCinemachineTransposer

MutateCameraState Positionsthevirtualcameraaccordingtothetransposerrules.(OverridesCinemachineTransposerMutateCameraState(CameraStateSingle).)

OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.Thisimplementationaddsthedeltatothefollowoffset,afterzeroingoutlocalx.(OverridesCinemachineTransposerOnPositionDragged(Vector3)

OnValidate (OverridesCinemachineTransposer

TrackTarget Positionsthevirtualcameraaccordingtothetransposerrules.(InheritedfromCinemachineTransposer

UpdateHeading Wheninslavemode,thisshouldbecalledonceandonlyonceeveryhrametoupdatetheheading.slavemode,thisiscalledautomatically.

Top





Cinemachine

CinemachineOrbitalTransposerMutateCameraStateMethod



Syntax

Parameters







floatdeltaTime

)

CopyC# JavaScript




Cinemachine

CinemachineOrbitalTransposerOnPositionDraggedMethod

APIfortheeditor,toprocessapositiondragfromtheuser.Thisimplementationaddsthedeltatothefollowoffset,afterzeroingoutlocalx.


Syntax

Parameters




publicoverridevoidOnPositionDragged(

Vector3delta

)

CopyC# JavaScript



Cinemachine

CinemachineOrbitalTransposerOnValidateMethod

[Missing<summary>documentationfor"M:Cinemachine.CinemachineOrbitalTransposer.OnValidate"]


Syntax




CopyC# JavaScript



Cinemachine

CinemachineOrbitalTransposerUpdateHeadingMethod

Wheninslavemode,thisshouldbecalledonceandonlyonceeveryhrametoupdatetheheading.Whennotinslavemode,thisiscalledautomatically.


Syntax

Parameters

deltaTimeType:SystemSingle[Missing<paramname="deltaTime"/>documentationfor"M:Cinemachine.CinemachineOrbitalTransposer.UpdateHeading(System.Single,UnityEngine.Vector3)"]

upType:Vector3[Missing<paramname="up"/>documentationfor"M:Cinemachine.CinemachineOrbitalTransposer.UpdateHeading(System.Single,UnityEngine.Vector3)"]

SeeAlsoReference

publicvoidUpdateHeading(

floatdeltaTime,

Vector3up

)

CopyC# JavaScript


CinemachineOrbitalTransposerClassCinemachineNamespace




Cinemachine

CinemachineOrbitalTransposerFields



m_BindingMode Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget(InheritedfromCinemachineTransposer.)

m_FollowOffset Thedistancewhichthetransposerwillattempttomaintainfromthetransposersubject(InheritedfromCinemachineTransposer.)

m_Heading ThedefinitionofForward.Camerawillfollowbehind.

m_HeadingIsSlave Drivethex-axissettingprogrammatically.Automaticheadingupdatingwillbedisabled.

m_PitchDamping Howaggressivelythecameratriestotrackthetargetrotation'sXangle.

Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.(InheritedfromCinemachineTransposer.)

m_RecenterToTargetHeading ParametersthatcontrolAutomatingHeadingRecentering

m_RollDamping Howaggressivelythecameratriestotrackthetargetrotation'sZangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.(InheritedfromCinemachineTransposer.)

m_XAxis Axisrepresentingthecurrentheading.Valueisindegreesandrepresentsarotationabouttheupvector

m_XDamping HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.

Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors(InheritedfromCinemachineTransposer.)

m_YawDamping Howaggressivelythecameratriestotrackthetargetrotation'sYangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.(InheritedfromCinemachineTransposer.)

m_YDamping HowaggressivelythecameratriestomaintaintheoffsetintheY-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors(InheritedfromCinemachineTransposer.)

m_ZDamping HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremore

responsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors(InheritedfromCinemachineTransposer.)

Top





Cinemachine

CinemachineOrbitalTransposerm_HeadingField

ThedefinitionofForward.Camerawillfollowbehind.


Syntax

FieldValueType:CinemachineOrbitalTransposerHeading



[SpaceAttribute]

[TooltipAttribute("ThedefinitionofForward.Camerawillfollowbehind.")]

publicCinemachineOrbitalTransposerHeadingm_Heading

CopyC# JavaScript



Cinemachine

CinemachineOrbitalTransposerm_HeadingIsSlaveField

Drivethex-axissettingprogrammatically.Automaticheadingupdatingwillbedisabled.


Syntax




[HideInInspector]


publicboolm_HeadingIsSlave

CopyC# JavaScript




Cinemachine

CinemachineOrbitalTransposerm_RecenterToTargetHeadingField

ParametersthatcontrolAutomatingHeadingRecentering


Syntax

FieldValueType:CinemachineOrbitalTransposerRecentering



[TooltipAttribute("Automaticheadingrecentering.Thesettingsheredefineshowthecamerawillrepositionitselfintheabsenceofplayerinput.")]

publicCinemachineOrbitalTransposerRecenteringm_RecenterToTargetHeading

CopyC# JavaScript



Cinemachine

CinemachineOrbitalTransposerm_XAxisField

Axisrepresentingthecurrentheading.Valueisindegreesandrepresentsarotationabouttheupvector


Syntax




[TooltipAttribute("HeadingControl.Thesettingsherecontrolthebehaviourofthecamerainresponsetotheplayer'sinput.")]

publicAxisStatem_XAxis

CopyC# JavaScript



Cinemachine

CinemachineOrbitalTransposerHeadingStructure

Howthe"forward"directionisdefined.Orbitaloffsetisinrelationtotheforwarddirection.


Syntax

TheCinemachineOrbitalTransposerHeadingtypeexposesthefollowingmembers.


CinemachineOrbitalTransposerHeading Constructor

Top


m_HeadingBias AdditionalYrotation



publicstructHeading

CopyC# JavaScript

appliedtothetargetheading.Whenthisvalueis0,thecamerawillbeplacedbehindthetarget

m_HeadingDefinition Themethodbywhichthe'defaultheading'iscalculatedifrecenteringtotargetheadingisenabled

m_VelocityFilterStrength Sizeofthevelocitysamplingwindowfortargetheadingfilter.Usedonlyifderivingheadingfromtarget'smovement

Top





Cinemachine

CinemachineOrbitalTransposerHeadingConstructor

Constructor


Syntax

Parameters

defType:CinemachineCinemachineOrbitalTransposerHeadingHeadingDefinition[Missing<paramname="def"/>documentationfor"M:Cinemachine.CinemachineOrbitalTransposer.Heading.#ctor(Cinemachine.CinemachineOrbitalTransposer.Heading.HeadingDefinition,System.Int32,System.Single)"]

filterStrengthType:SystemInt32[Missing<paramname="filterStrength"/>documentationfor"M:Cinemachine.CinemachineOrbitalTransposer.Heading.#ctor(Cinemachine.CinemachineOrbitalTransposer.Heading.HeadingDefinition,System.Int32,System.Single)"]

biasType:SystemSingle[Missing<paramname="bias"/>documentationfor"M:Cinemachine.CinemachineOrbitalTransposer.Heading.#ctor(Cinemachine.CinemachineOrbitalTransposer.Heading.HeadingDefinition,System.Int32,System.Single)"]

publicHeading(

CinemachineOrbitalTransposerHeadingHeadingDefinition

intfilterStrength,

floatbias

)

CopyC# JavaScript



SeeAlsoReferenceCinemachineOrbitalTransposerHeadingStructureCinemachineNamespace




Cinemachine

HeadingFields

TheCinemachineOrbitalTransposerHeadingtypeexposesthefollowingmembers.


m_HeadingBias AdditionalYrotationappliedtothetargetheading.Whenthisvalueis0,thecamerawillbeplacedbehindthetarget

m_HeadingDefinition Themethodbywhichthe'defaultheading'iscalculatedifrecenteringtotargetheadingisenabled

m_VelocityFilterStrength Sizeofthevelocitysamplingwindowfortargetheadingfilter.Usedonlyifderivingheadingfromtarget'smovement

Top


Cinemachine

CinemachineOrbitalTransposerHeadingField

AdditionalYrotationappliedtothetargetheading.Whenthisvalueis0,thecamerawillbeplacedbehindthetarget


Syntax




[RangeAttribute(-180f,180f)]

[TooltipAttribute("WherethecameraisplacedwhentheX-axisvalueiszero.ThisisarotationindegreesaroundtheYaxis.Whenthisvalueis0,thecamerawillbeplacedbehindthetarget.Nonzerooffsetswillrotatethezeropositionaroundthetarget.")]

publicfloatm_HeadingBias

CopyC# JavaScript




Cinemachine


Themethodbywhichthe'defaultheading'iscalculatedifrecenteringtotargetheadingisenabled


Syntax

FieldValueType:CinemachineOrbitalTransposerHeadingHeadingDefinition



[TooltipAttribute("How'forward'isdefined.Thecamerawillbeplacedbydefaultbehindthetarget.PositionDeltawillconsider'forward'tobethedirectioninwhichthetargetismoving.")]

publicCinemachineOrbitalTransposerHeadingHeadingDefinition

CopyC# JavaScript



Cinemachine


Sizeofthevelocitysamplingwindowfortargetheadingfilter.Usedonlyifderivingheadingfromtarget'smovement


Syntax





[TooltipAttribute("Sizeofthevelocitysamplingwindowfortargetheadingfilter.Thisfiltersoutirregularitiesinthetarget'smovement.Usedonlyifderivingheadingfromtarget'smovement(PositionDeltaorVelocity)")]

publicintm_VelocityFilterStrength

CopyC# JavaScript




Cinemachine

CinemachineOrbitalTransposerHeadingEnumeration

Setsthealgorithmfordeterminingthetarget'sheadingforpurposesofre-centeringthecamera


Syntax

Members


PositionDelta 0 Targetheadingcalculatedfromthedifferencebetweenitspositiononlastupdateandcurrentframe.

Velocity 1 TargetheadingcalculatedfromitsRigidbody'svelocity.IfnoRigidbodyexists,itwillfallbacktoHeadingDerivationMode.PositionDelta

TargetForward 2 TargetheadingcalculatedfromtheTargetTransform'seulerYangle


publicenumHeadingDefinition

CopyC# JavaScript

WorldForward 3 Defaultheadingisaconstantworldspaceheading.





Cinemachine

CinemachineOrbitalTransposerRecenteringStructure

Controlshowautomaticorbitrecenteringoccurs


Syntax

TheCinemachineOrbitalTransposerRecenteringtypeexposesthefollowingmembers.


Validate CallthisfromOnValidate()

Top


m_enabled Ifchecked,willenableautomaticrecenteringof



publicstructRecentering

CopyC# JavaScript

thecamerabasedontheheadingcalculationmode.IfFALSE,recentingisdisabled.

m_RecenteringTime Maximumangularspeedofrecentering.Willaccelerateintoanddecelerateoutofthis

m_RecenterWaitTime Ifnoinputhasbeendetected,thecamerawillwaitthislonginsecondsbeforemovingitsheadingtothedefaultheading.

Top





Cinemachine

RecenteringMethods



Validate CallthisfromOnValidate()

Top

SeeAlsoReferenceCinemachineOrbitalTransposerRecenteringStructureCinemachineNamespace




Cinemachine

CinemachineOrbitalTransposerRecenteringMethod

CallthisfromOnValidate()


Syntax




CopyC# JavaScript



Cinemachine

RecenteringFields



m_enabled Ifchecked,willenableautomaticrecenteringofthecamerabasedontheheadingcalculationmode.IfFALSE,recentingisdisabled.

m_RecenteringTime Maximumangularspeedofrecentering.Willaccelerateintoanddecelerateoutofthis

m_RecenterWaitTime Ifnoinputhasbeendetected,thecamerawillwaitthislonginsecondsbeforemovingitsheadingtothedefaultheading.

Top


Cinemachine

CinemachineOrbitalTransposerRecenteringField

Ifchecked,willenableautomaticrecenteringofthecamerabasedontheheadingcalculationmode.IfFALSE,recentingisdisabled.


Syntax




[TooltipAttribute("Ifchecked,willenableautomaticrecenteringofthecamerabasedontheheadingdefinition.Ifunchecked,recentingisdisabled.")]

publicboolm_enabled

CopyC# JavaScript




Cinemachine


Maximumangularspeedofrecentering.Willaccelerateintoanddecelerateoutofthis


Syntax




[TooltipAttribute("Maximumangularspeedofrecentering.Willaccelerateintoanddecelerateoutofthis.")]

publicfloatm_RecenteringTime

CopyC# JavaScript




Cinemachine


Ifnoinputhasbeendetected,thecamerawillwaitthislonginsecondsbeforemovingitsheadingtothedefaultheading.


Syntax




[TooltipAttribute("Ifnoinputhasbeendetected,thecamerawillwaitthislonginsecondsbeforemovingitsheadingtothezeroposition.")]

publicfloatm_RecenterWaitTime

CopyC# JavaScript




Cinemachine

CinemachinePathClass

Definesaworld-spacepath,consistingofanarrayofwaypoints,eachofwhichhasposition,tangent,androllsettings.Bezierinterpolationisperformedbetweenthewaypoints,togetasmoothandcontinuouspath.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachinePathBaseCinemachineCinemachinePath


Syntax

TheCinemachinePathtypeexposesthefollowingmembers.



[AddComponentMenu("Cinemachine/CinemachinePath")]


publicclassCinemachinePath:CinemachinePathBase

CopyC# JavaScript


CinemachinePath

Top


DistanceCacheSampleStepsPerSegment Whencalculatingthedistancecache,samplethepaththismanytimesbetweenpoints(OverridesCinemachinePathBase

Looped Trueifthepathendsarejoinedtoformacontinuousloop(OverridesCinemachinePathBase

MaxPos Themaximumvalueforthepathposition(OverridesCinemachinePathBase

MinPos Theminimumvalueforthepathposition(OverridesCinemachinePathBase

PathLength Getthelengthofthepathindistanceunits.isnotvalid,thencallingthiswillregenerationofthepathdistancecache(InheritedfromCinemachinePathBase

Top


DistanceCacheIsValid Seewhetherthedistancecacheisvalid.valid,thenanycalltoGetPathLength()orGetPathPositionFromDistance()willpotentiallycostlyregenerationofthepathdistancecache(InheritedfromCinemachinePathBase

EvaluateOrientation Gettheorientationthecurveatapointalongthepath.(OverridesCinemachinePathBaseEvaluateOrientation(Single)

EvaluateOrientationAtUnit Gettheorientationthecurveatapointalongthepath.(InheritedfromCinemachinePathBase

EvaluatePosition Getaworldspacepositionofapointalongthepath(OverridesCinemachinePathBaseEvaluatePosition(Single)

EvaluatePositionAtUnit Getaworldspacepositionofapointalongthepath(InheritedfromCinemachinePathBase

EvaluateTangent Getthetangentofthecurveatapointalongthepath.(OverridesCinemachinePathBaseEvaluateTangent(Single)

EvaluateTangentAtUnit Getthetangentofthecurveatapointalongthepath.(InheritedfromCinemachinePathBase

FindClosestPoint Findtheclosestpointonthepathtoagivenworldspacetargetpoint.(InheritedfromCinemachinePathBase

GetPathDistanceFromPosition Getthepathposition(inpathunits)correspondingtothisdistancealongthepath.isnotvalid,thencallingthiswillcostlyregenerationofthepathdistancecache(InheritedfromCinemachinePathBase

GetPathPositionFromDistance Getthepathposition(inpathunits)correspondingtothisdistancealongthepath.isnotvalid,thencallingthiswillcostlyregenerationofthepathdistancecache

(InheritedfromCinemachinePathBase

InvalidateDistanceCache Callthisifthepathchangesinsuchawayastoaffectdistancesorothercachedpathelements(InheritedfromCinemachinePathBase

MaxUnit Getthemaximumvalue,forthegivenunitytype(InheritedfromCinemachinePathBase

MinUnit Gettheminimumvalue,forthegivenunitytype(InheritedfromCinemachinePathBase

NormalizePathDistance Normalizeadistancealongthepathbasedonthepathlength.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache(InheritedfromCinemachinePathBase

NormalizePos Getanormalizedpathposition,takingspinsintoaccountiflooped(InheritedfromCinemachinePathBase

NormalizeUnit Normalizetheunit,sothatitliesbetweenMinUmitandMaxUnit(InheritedfromCinemachinePathBase

Top


m_Appearance Thesettingsthatcontrolhowthepathwillappearintheeditorsceneview.(InheritedfromCinemachinePathBase.)

m_Looped Ifchecked,thenthepathends

arejoinedtoformacontinuousloop

m_Resolution Pathsamplesperwaypoint(InheritedfromCinemachinePathBase.)

m_Waypoints Thewaypointsthatdefinethepath.Theywillbeinterpolatedusingabeziercurve

Top





Cinemachine

CinemachinePathConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachinePath.#ctor"]


Syntax

SeeAlsoReferenceCinemachinePathClassCinemachineNamespace


publicCinemachinePath()

CopyC# JavaScript



Cinemachine

CinemachinePathProperties








Top


Cinemachine

CinemachinePathDistanceCacheSampleStepsPerSegmentProperty

Whencalculatingthedistancecache,samplethepaththismanytimesbetweenpoints


Syntax




publicoverrideintDistanceCacheSampleStepsPerSegment

CopyC# JavaScript




Cinemachine

CinemachinePathLoopedProperty

Trueifthepathendsarejoinedtoformacontinuousloop


Syntax




publicoverrideboolLooped{get;}

CopyC# JavaScript




Cinemachine

CinemachinePathMaxPosProperty

Themaximumvalueforthepathposition


Syntax




publicoverridefloatMaxPos{get;}

CopyC# JavaScript




Cinemachine

CinemachinePathMinPosProperty

Theminimumvalueforthepathposition


Syntax




publicoverridefloatMinPos{get;}

CopyC# JavaScript




Cinemachine

CinemachinePathMethods












GetPathPositionFromDistance Getthepathposition(inpathunits)correspondingtothisdistancealongthepath.isnotvalid,thencallingthiswillcostlyregenerationofthepathdistancecache(InheritedfromCinemachinePathBase

InvalidateDistanceCache Callthisifthepathchangesinsuchawayastoaffectdistancesorothercachedpathelements(InheritedfromCinemachinePathBase






Top





Cinemachine

CinemachinePathEvaluateOrientationMethod

Gettheorientationthecurveatapointalongthepath.


Syntax

Parameters

posType:SystemSinglePostionalongthepath.Neednotbenormalized.

ReturnValueType:QuaternionWorld-spaceorientationofthepath,asdefinedbytangent,up,androll.



publicoverrideQuaternionEvaluateOrientation(

floatpos

)

CopyC# JavaScript



Cinemachine

CinemachinePathEvaluatePositionMethod

Getaworldspacepositionofapointalongthepath


Syntax

Parameters


ReturnValueType:Vector3World-spacepositionofthepointalongatpathatpos



publicoverrideVector3EvaluatePosition(

floatpos

)

CopyC# JavaScript




Cinemachine

CinemachinePathEvaluateTangentMethod

Getthetangentofthecurveatapointalongthepath.


Syntax

Parameters


ReturnValueType:Vector3World-spacedirectionofthepathtangent.Lengthofthevectorrepresentsthetangentstrength



publicoverrideVector3EvaluateTangent(

floatpos

)

CopyC# JavaScript



Cinemachine

CinemachinePathFields




m_Looped Ifchecked,thenthepathendsarejoinedtoformacontinuousloop



Top




Cinemachine

CinemachinePathm_LoopedField

Ifchecked,thenthepathendsarejoinedtoformacontinuousloop


Syntax




[TooltipAttribute("Ifchecked,thenthepathendsarejoinedtoformacontinuousloop.")]

publicboolm_Looped

CopyC# JavaScript




Cinemachine

CinemachinePathm_WaypointsField

Thewaypointsthatdefinethepath.Theywillbeinterpolatedusingabeziercurve


Syntax

FieldValueType:CinemachinePathWaypoint



[TooltipAttribute("Thewaypointsthatdefinethepath.Theywillbeinterpolatedusingabeziercurve.")]

publicCinemachinePathWaypoint[]m_Waypoints

CopyC# JavaScript



Cinemachine

CinemachinePathWaypointStructure

Awaypointalongthepath


Syntax

TheCinemachinePathWaypointtypeexposesthefollowingmembers.


position Positioninpath-localspace

roll Definestherollofthepathatthiswaypoint.Theotherorientationaxesareinferredfromthetangentandworldup.

tangent Offsetfromtheposition,whichdefinesthetangentofthecurveatthewaypoint.Thelengthofthetangentencodesthestrengthofthebezierhandle.Thesamehandleisusedsymmetricallyonboth



publicstructWaypoint

CopyC# JavaScript

sidesofthewaypoint,toensuresmoothness.

Top





Cinemachine

WaypointFields

TheCinemachinePathWaypointtypeexposesthefollowingmembers.




tangent Offsetfromtheposition,whichdefinesthetangentofthecurveatthewaypoint.Thelengthofthetangentencodesthestrengthofthebezierhandle.Thesamehandleisusedsymmetricallyonbothsidesofthewaypoint,toensuresmoothness.

Top

SeeAlsoReferenceCinemachinePathWaypointStructureCinemachineNamespace




Cinemachine

CinemachinePathWaypointpositionField

Positioninpath-localspace


Syntax




[TooltipAttribute("Positioninpath-localspace")]

publicVector3position

CopyC# JavaScript



Cinemachine

CinemachinePathWaypointrollField

Definestherollofthepathatthiswaypoint.Theotherorientationaxesareinferredfromthetangentandworldup.


Syntax




[TooltipAttribute("Definestherollofthepathatthiswaypoint.Theotherorientationaxesareinferredfromthetangentandworldup.")]

publicfloatroll

CopyC# JavaScript




Cinemachine

CinemachinePathWaypointtangentField

Offsetfromtheposition,whichdefinesthetangentofthecurveatthewaypoint.Thelengthofthetangentencodesthestrengthofthebezierhandle.Thesamehandleisusedsymmetricallyonbothsidesofthewaypoint,toensuresmoothness.


Syntax




[TooltipAttribute("Offsetfromtheposition,whichdefinesthetangentofthecurveatthewaypoint.Thelengthofthetangentencodesthestrengthofthebezierhandle.Thesamehandleisusedsymmetricallyonbothsidesofthewaypoint,toensuresmoothness.")]

publicVector3tangent

CopyC# JavaScript



Cinemachine

CinemachinePathBaseClass

Abstractbaseclassforaworld-spacepath,suitableforacameradollytrack.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachinePathBaseCinemachineCinemachinePathCinemachineCinemachineSmoothPath


Syntax

TheCinemachinePathBasetypeexposesthefollowingmembers.


CinemachinePathBase

Top

publicabstractclassCinemachinePathBase:MonoBehaviour

CopyC# JavaScript



DistanceCacheSampleStepsPerSegment Whencalculatingthedistancecache,samplethepaththismanytimesbetweenpoints

Looped Trueifthepathendsarejoinedtoformacontinuousloop

MaxPos Themaximumvalueforthepathposition

MinPos Theminimumvalueforthepathposition

PathLength Getthelengthofthepathindistanceunits.Ifthe

distancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache

Top


DistanceCacheIsValid Seewhetherthedistancecacheisvalid.Ifit'snotvalid,thenanycalltoGetPathLength()orGetPathPositionFromDistance()willtriggerapotentiallycostlyregenerationofthepathdistancecache

EvaluateOrientation Gettheorientationthecurveatapointalongthepath.

EvaluateOrientationAtUnit Gettheorientationthecurveatapointalongthepath.

EvaluatePosition Getaworldspacepositionofapointalongthepath

EvaluatePositionAtUnit Getaworldspacepositionofapointalongthepath

EvaluateTangent Getthetangentofthecurveatapointalongthepath.

EvaluateTangentAtUnit Getthetangentofthecurveatapointalongthepath.

FindClosestPoint Findtheclosestpointonthepathtoagivenworldspacetargetpoint.

GetPathDistanceFromPosition Getthepathposition(inpathunits)correspondingtothisdistancealongthepath.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache

GetPathPositionFromDistance Getthepathposition(inpathunits)correspondingtothisdistancealongthepath.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache

InvalidateDistanceCache Callthisifthepathchangesinsuchawayastoaffectdistancesorothercachedpathelements

MaxUnit Getthemaximumvalue,forthegivenunitytype

MinUnit Gettheminimumvalue,forthegivenunitytype

NormalizePathDistance Normalizeadistancealongthepathbasedonthepathlength.

Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache

NormalizePos Getanormalizedpathposition,takingspinsintoaccountiflooped

NormalizeUnit Normalizetheunit,sothatitliesbetweenMinUmitandMaxUnit

Top


m_Appearance Thesettingsthatcontrolhowthepathwillappearintheeditorsceneview.

m_Resolution Pathsamplesperwaypoint

Top





Cinemachine

CinemachinePathBaseConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachinePathBase.#ctor"]


Syntax

SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace


protectedCinemachinePathBase()

CopyC# JavaScript



Cinemachine

CinemachinePathBaseProperties



DistanceCacheSampleStepsPerSegment Whencalculatingthedistancecache,samplethepaththismanytimesbetweenpoints

Looped Trueifthepathendsarejoinedtoformacontinuousloop

MaxPos Themaximumvalueforthepathposition

MinPos Theminimumvalueforthe

pathposition

PathLength Getthelengthofthepathindistanceunits.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache

Top





Cinemachine

CinemachinePathBaseDistanceCacheSampleStepsPerSegmentProperty



Syntax




publicabstractintDistanceCacheSampleStepsPerSegment

CopyC# JavaScript




Cinemachine

CinemachinePathBaseLoopedProperty



Syntax




publicabstractboolLooped{get;}

CopyC# JavaScript




Cinemachine

CinemachinePathBaseMaxPosProperty



Syntax




publicabstractfloatMaxPos{get;}

CopyC# JavaScript




Cinemachine

CinemachinePathBaseMinPosProperty



Syntax




publicabstractfloatMinPos{get;}

CopyC# JavaScript




Cinemachine

CinemachinePathBasePathLengthProperty

Getthelengthofthepathindistanceunits.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache


Syntax

ReturnValueType:SingleThelengthofthepathindistanceunits,whensampledatthisrate



publicfloatPathLength{get;}

CopyC# JavaScript




Cinemachine

CinemachinePathBaseMethods



DistanceCacheIsValid Seewhetherthedistancecacheisvalid.Ifit'snotvalid,thenanycalltoGetPathLength()orGetPathPositionFromDistance()willtriggerapotentiallycostlyregenerationofthepathdistancecache

EvaluateOrientation Gettheorientationthecurveatapointalongthepath.

EvaluateOrientationAtUnit Gettheorientationthecurveatapointalongthepath.

EvaluatePosition Getaworldspacepositionofapointalongthepath

EvaluatePositionAtUnit Getaworldspacepositionofapointalongthepath

EvaluateTangent Getthetangentofthecurveatapointalongthepath.

EvaluateTangentAtUnit Getthetangentofthecurveatapointalongthepath.

FindClosestPoint Findtheclosestpointonthe

pathtoagivenworldspacetargetpoint.

GetPathDistanceFromPosition Getthepathposition(inpathunits)correspondingtothisdistancealongthepath.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache

GetPathPositionFromDistance Getthepathposition(inpathunits)correspondingtothisdistancealongthepath.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache

InvalidateDistanceCache Callthisifthepathchangesinsuchawayastoaffectdistancesorothercachedpathelements

MaxUnit Getthemaximumvalue,forthegivenunitytype

MinUnit Gettheminimumvalue,forthegivenunitytype

NormalizePathDistance Normalizeadistancealongthepathbasedonthepathlength.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache

NormalizePos Getanormalizedpathposition,

takingspinsintoaccountiflooped

NormalizeUnit Normalizetheunit,sothatitliesbetweenMinUmitandMaxUnit

Top





Cinemachine

CinemachinePathBaseDistanceCacheIsValidMethod

Seewhetherthedistancecacheisvalid.Ifit'snotvalid,thenanycalltoGetPathLength()orGetPathPositionFromDistance()willtriggerapotentiallycostlyregenerationofthepathdistancecache


Syntax

ReturnValueType:BooleanWhetherthecacheisvalidforthissamplingrate



publicboolDistanceCacheIsValid()

CopyC# JavaScript




Cinemachine

CinemachinePathBaseEvaluateOrientationMethod



Syntax

Parameters


ReturnValueType:QuaternionWorld-spaceorientationofthepath



publicabstractQuaternionEvaluateOrientation(

floatpos

)

CopyC# JavaScript




Cinemachine

CinemachinePathBaseEvaluateOrientationAtUnitMethod



Syntax

Parameters


unitsType:CinemachineCinemachinePathBasePositionUnitsTheunittousewheninterpretingthevalueofpos.

ReturnValueType:QuaternionWorld-spaceorientationofthepath

SeeAlsoReferenceCinemachinePathBaseClass

publicQuaternionEvaluateOrientationAtUnit(

floatpos,

CinemachinePathBasePositionUnitsunits

)

CopyC# JavaScript


Cinemachine

CinemachinePathBaseEvaluatePositionMethod



Syntax

Parameters





publicabstractVector3EvaluatePosition(

floatpos

)

CopyC# JavaScript




Cinemachine

CinemachinePathBaseEvaluatePositionAtUnitMethod



Syntax

Parameters





publicVector3EvaluatePositionAtUnit(

floatpos,


)

CopyC# JavaScript


Cinemachine

CinemachinePathBaseEvaluateTangentMethod



Syntax

Parameters





publicabstractVector3EvaluateTangent(

floatpos

)

CopyC# JavaScript



Cinemachine

CinemachinePathBaseEvaluateTangentAtUnitMethod



Syntax

Parameters




SeeAlsoReference

publicVector3EvaluateTangentAtUnit(

floatpos,


)

CopyC# JavaScript


CinemachinePathBaseClassCinemachineNamespace




Cinemachine

CinemachinePathBaseFindClosestPointMethod

Findtheclosestpointonthepathtoagivenworldspacetargetpoint.


Syntax

Parameters

pType:Vector3Worldspacetargetthatwewanttoapproach

startSegmentType:SystemInt32Inwhatsegmentofthepathtostartthesearch.ASegmentisasectionofpathbetween2waypoints.

searchRadiusType:SystemInt32HowmanysegmentsoneithersideofthestartSegmenttosearch.-1meansnolimit,i.e.searchtheentirepath

stepsPerSegmentType:SystemInt32

publicvirtualfloatFindClosestPoint(

Vector3p,

intstartSegment,

intsearchRadius,

intstepsPerSegment

)

CopyC# JavaScript




Wesearchasegmentbydividingitintothismanystraightpieces.Thehigherthenumber,themoreaccuratetheresult,butperformanceisproportionallyslowerforhighernumbers

ReturnValueType:SingleThepositionalongthepaththatisclosesttothetargetpoint.ThevalueisinPathUnits,notDistanceunits.

RemarksPerformancecouldbeimprovedbycheckingtheboundingpolygonofeachsegment,andonlyenteringthebestsegment(s)






Cinemachine

CinemachinePathBaseGetPathDistanceFromPositionMethod

Getthepathposition(inpathunits)correspondingtothisdistancealongthepath.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache


Syntax

Parameters

posType:SystemSingle[Missing<paramname="pos"/>documentationfor"M:Cinemachine.CinemachinePathBase.GetPathDistanceFromPosition(System.Single)"]



publicfloatGetPathDistanceFromPosition(

floatpos

)

CopyC# JavaScript



Cinemachine

CinemachinePathBaseGetPathPositionFromDistanceMethod

Getthepathposition(inpathunits)correspondingtothisdistancealongthepath.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache


Syntax

Parameters

distanceType:SystemSingle[Missing<paramname="distance"/>documentationfor"M:Cinemachine.CinemachinePathBase.GetPathPositionFromDistance(System.Single)"]



publicfloatGetPathPositionFromDistance(

floatdistance

)

CopyC# JavaScript



Cinemachine

CinemachinePathBaseInvalidateDistanceCacheMethod

Callthisifthepathchangesinsuchawayastoaffectdistancesorothercachedpathelements


Syntax



publicvirtualvoidInvalidateDistanceCache()

CopyC# JavaScript



Cinemachine

CinemachinePathBaseMaxUnitMethod

Getthemaximumvalue,forthegivenunitytype


Syntax

Parameters

unitsType:CinemachineCinemachinePathBasePositionUnitsTheuniottype

ReturnValueType:SingleThemaximumallowablevalueforthispath



publicfloatMaxUnit(


)

CopyC# JavaScript




Cinemachine

CinemachinePathBaseMinUnitMethod

Gettheminimumvalue,forthegivenunitytype


Syntax

Parameters

unitsType:CinemachineCinemachinePathBasePositionUnitsTheuniottype

ReturnValueType:SingleTheminimumallowablevalueforthispath



publicfloatMinUnit(


)

CopyC# JavaScript




Cinemachine

CinemachinePathBaseNormalizePathDistanceMethod

Normalizeadistancealongthepathbasedonthepathlength.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache


Syntax

Parameters

distanceType:SystemSingleThedistancetonormalize

ReturnValueType:SingleThenormalizeddistance,rangingfrom0topathlength


publicfloatNormalizePathDistance(

floatdistance

)

CopyC# JavaScript



Cinemachine

CinemachinePathBaseNormalizePosMethod

Getanormalizedpathposition,takingspinsintoaccountiflooped


Syntax

Parameters

posType:SystemSinglePositionalongthepath

ReturnValueType:SingleNormalizedposition,betweenMinPosandMaxPos



publicvirtualfloatNormalizePos(

floatpos

)

CopyC# JavaScript





Cinemachine

CinemachinePathBaseNormalizeUnitMethod

Normalizetheunit,sothatitliesbetweenMinUmitandMaxUnit


Syntax

Parameters

posType:SystemSingleThevaluetobenormalized

unitsType:CinemachineCinemachinePathBasePositionUnitsTheunittype

ReturnValueType:SingleThenormalizedvalueofpos,betweenMinUnitandMaxUnit


publicvirtualfloatNormalizeUnit(

floatpos,


)

CopyC# JavaScript



Cinemachine

CinemachinePathBaseFields



m_Appearance Thesettingsthatcontrolhowthepathwillappearintheeditorsceneview.

m_Resolution Pathsamplesperwaypoint

Top





Cinemachine

CinemachinePathBasem_AppearanceField

Thesettingsthatcontrolhowthepathwillappearintheeditorsceneview.


Syntax

FieldValueType:CinemachinePathBaseAppearance



[TooltipAttribute("Thesettingsthatcontrolhowthepathwillappearintheeditorsceneview.")]

publicCinemachinePathBaseAppearancem_Appearance

CopyC# JavaScript



Cinemachine

CinemachinePathBasem_ResolutionField

Pathsamplesperwaypoint


Syntax




[TooltipAttribute("Pathsamplesperwaypoint.Thisisusedforcalculatingpathdistances.")]


publicintm_Resolution

CopyC# JavaScript




Cinemachine

CinemachinePathBaseAppearanceClass

Thisclassholdsthesettingsthatcontrolhowthepathwillappearintheeditorsceneview.Thepathisnotvisibleinthegameview

InheritanceHierarchySystemObjectCinemachineCinemachinePathBaseAppearance


Syntax

TheCinemachinePathBaseAppearancetypeexposesthefollowingmembers.


CinemachinePathBaseAppearance

Top

Fields



publicclassAppearance

CopyC# JavaScript


Name Description

inactivePathColor

pathColor

width

Top





Cinemachine

CinemachinePathBaseAppearanceConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachinePathBase.Appearance.#ctor"]


Syntax

SeeAlsoReferenceCinemachinePathBaseAppearanceClassCinemachineNamespace


publicAppearance()

CopyC# JavaScript



Cinemachine

AppearanceFields

TheCinemachinePathBaseAppearancetypeexposesthefollowingmembers.


inactivePathColor

pathColor

width

Top





Cinemachine

CinemachinePathBaseAppearanceinactivePathColorField

[Missing<summary>documentationfor"F:Cinemachine.CinemachinePathBase.Appearance.inactivePathColor"]


Syntax

FieldValueType:Color



[TooltipAttribute("Thecolorofthepathitselfwhenitisinactiveintheeditor")]

publicColorinactivePathColor

CopyC# JavaScript



Cinemachine

CinemachinePathBaseAppearancepathColorField

[Missing<summary>documentationfor"F:Cinemachine.CinemachinePathBase.Appearance.pathColor"]


Syntax

FieldValueType:Color



[TooltipAttribute("Thecolorofthepathitselfwhenitisactiveintheeditor")]

publicColorpathColor

CopyC# JavaScript



Cinemachine

CinemachinePathBaseAppearancewidthField

[Missing<summary>documentationfor"F:Cinemachine.CinemachinePathBase.Appearance.width"]


Syntax




[TooltipAttribute("Thewidthoftherailroad-tracksthataredrawntorepresentthepath")]


publicfloatwidth

CopyC# JavaScript




Cinemachine

CinemachinePathBasePositionUnitsEnumeration



Syntax

Members


PathUnits 0 UsePathPositionunits,where0isfirstwaypoint,1issecondwaypoint,etc

Distance 1 UseDistanceAlongPath.PathwillbesampledaccordingtoitsResolutionsetting,andadistancelookuptablewillbecachedinternally

SeeAlsoReference

publicenumPositionUnits

CopyC# JavaScript

Cinemachine

CinemachinePipelineClass

InternalcontainerforCinemachineComponentBase.Doesnothingbutcontain.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachinePipeline


Syntax

TheCinemachinePipelinetypeexposesthefollowingmembers.


CinemachinePipeline

Top

SeeAlso


publicsealedclassCinemachinePipeline:MonoBehaviour

CopyC# JavaScript


Cinemachine

CinemachinePipelineConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachinePipeline.#ctor"]


Syntax

SeeAlsoReferenceCinemachinePipelineClassCinemachineNamespace


publicCinemachinePipeline()

CopyC# JavaScript



Cinemachine

CinemachinePOVClass

ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.Itsjobistoaimthecamerainresponsetotheuser'smouseorjoystickinput.Thecomposerdoesnotchangethecamera'sposition.Itwillonlypanandtiltthecamerawhereitis,inordertogetthedesiredframing.Tomovethecamera,youhavetousethevirtualcamera'sBodysection.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachinePOV


Syntax

TheCinemachinePOVtypeexposesthefollowingmembers.

Constructors





publicclassCinemachinePOV:CinemachineComponentBase

CopyC# JavaScript


Name Description

CinemachinePOV

Top







VirtualCamera GettheassociatedCinemachineVirtualCameraBase(Inheritedfrom


Top


MutateCameraState Appliestheaxisvaluesandorientsthecameraaccordingly(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)


Top


m_HorizontalAxis TheHorizontalaxis.Valueis-180..180.Controlsthehorizontalorientation

m_VerticalAxis TheVerticalaxis.Valueis-90..90.Controlstheverticalorientation

Top


Cinemachine

CinemachinePOVConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachinePOV.#ctor"]


Syntax

SeeAlsoReferenceCinemachinePOVClassCinemachineNamespace


publicCinemachinePOV()

CopyC# JavaScript



Cinemachine

CinemachinePOVProperties









(InheritedfromCinemachineComponentBase.)

Top





Cinemachine

CinemachinePOVIsValidProperty



Syntax





CopyC# JavaScript




Cinemachine

CinemachinePOVStageProperty



Syntax





CopyC# JavaScript



Cinemachine

CinemachinePOVMethods



MutateCameraState Appliestheaxisvaluesandorientsthecameraaccordingly(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)


Top





Cinemachine

CinemachinePOVMutateCameraStateMethod

Appliestheaxisvaluesandorientsthecameraaccordingly


Syntax

Parameters


deltaTimeType:SystemSingleUsedforcalculatingdamping.Notused.





floatdeltaTime

)

CopyC# JavaScript




Cinemachine

CinemachinePOVFields



m_HorizontalAxis TheHorizontalaxis.Valueis-180..180.Controlsthehorizontalorientation

m_VerticalAxis TheVerticalaxis.Valueis-90..90.Controlstheverticalorientation

Top





Cinemachine

CinemachinePOVm_HorizontalAxisField

TheHorizontalaxis.Valueis-180..180.Controlsthehorizontalorientation


Syntax




[TooltipAttribute("TheHorizontalaxis.Valueis-180..180.Controlsthehorizontalorientation")]

publicAxisStatem_HorizontalAxis

CopyC# JavaScript



Cinemachine

CinemachinePOVm_VerticalAxisField

TheVerticalaxis.Valueis-90..90.Controlstheverticalorientation


Syntax




[TooltipAttribute("TheVerticalaxis.Valueis-90..90.Controlstheverticalorientation")]

publicAxisStatem_VerticalAxis

CopyC# JavaScript



Cinemachine

CinemachineSmoothPathClass

Definesaworld-spacepath,consistingofanarrayofwaypoints,eachofwhichhaspositionandrollsettings.Bezierinterpolationisperformedbetweenthewaypoints,togetasmoothandcontinuouspath.Thepathwillpassthroughallwaypoints,and(unlikeCinemachinePath)firstandsecondordercontinuityisguaranteed

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachinePathBaseCinemachineCinemachineSmoothPath


Syntax

TheCinemachineSmoothPathtypeexposesthefollowingmembers.



[AddComponentMenu("Cinemachine/CinemachineSmoothPath")]


publicclassCinemachineSmoothPath:CinemachinePathBase

CopyC# JavaScript


CinemachineSmoothPath

Top







Top











GetPathPositionFromDistance Getthepathposition(inpathunits)correspondingtothisdistancealongthepath.isnotvalid,thencallingthiswillcostlyregenerationofthepathdistancecache

(InheritedfromCinemachinePathBase

InvalidateDistanceCache Callthisifthepathchangesinsuchawayastoaffectdistancesorothercachedpathelements(OverridesCinemachinePathBaseInvalidateDistanceCache






Top






Top





Cinemachine

CinemachineSmoothPathConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineSmoothPath.#ctor"]


Syntax

SeeAlsoReferenceCinemachineSmoothPathClassCinemachineNamespace


publicCinemachineSmoothPath()

CopyC# JavaScript



Cinemachine

CinemachineSmoothPathProperties








Top

SeeAlsoReferenceCinemachineSmoothPathClass

Cinemachine

CinemachineSmoothPathDistanceCacheSampleStepsPerSegmentProperty



Syntax




publicoverrideintDistanceCacheSampleStepsPerSegment

CopyC# JavaScript




Cinemachine

CinemachineSmoothPathLoopedProperty



Syntax




publicoverrideboolLooped{get;}

CopyC# JavaScript




Cinemachine

CinemachineSmoothPathMaxPosProperty



Syntax




publicoverridefloatMaxPos{get;}

CopyC# JavaScript




Cinemachine

CinemachineSmoothPathMinPosProperty



Syntax




publicoverridefloatMinPos{get;}

CopyC# JavaScript




Cinemachine

CinemachineSmoothPathMethods








EvaluateTangent Getthetangentofthecurveatapointalongthepath.(Overrides

CinemachinePathBaseEvaluateTangent(Single)




GetPathPositionFromDistance Getthepathposition(inpathunits)correspondingtothisdistancealongthepath.isnotvalid,thencallingthiswillcostlyregenerationofthepathdistancecache(InheritedfromCinemachinePathBase

InvalidateDistanceCache Callthisifthepathchangesinsuchawayastoaffectdistancesorothercachedpathelements(OverridesCinemachinePathBaseInvalidateDistanceCache






Top





Cinemachine

CinemachineSmoothPathEvaluateOrientationMethod



Syntax

Parameters


ReturnValueType:QuaternionWorld-spaceorientationofthepath,asdefinedbytangent,up,androll.



publicoverrideQuaternionEvaluateOrientation(

floatpos

)

CopyC# JavaScript



Cinemachine

CinemachineSmoothPathEvaluatePositionMethod



Syntax

Parameters





publicoverrideVector3EvaluatePosition(

floatpos

)

CopyC# JavaScript




Cinemachine

CinemachineSmoothPathEvaluateTangentMethod



Syntax

Parameters





publicoverrideVector3EvaluateTangent(

floatpos

)

CopyC# JavaScript



Cinemachine

CinemachineSmoothPathInvalidateDistanceCacheMethod

Callthisifthepathchangesinsuchawayastoaffectdistancesorothercachedpathelements


Syntax



publicoverridevoidInvalidateDistanceCache()

CopyC# JavaScript



Cinemachine

CinemachineSmoothPathFields







Top




Cinemachine

CinemachineSmoothPathm_LoopedField

Ifchecked,thenthepathendsarejoinedtoformacontinuousloop


Syntax




[TooltipAttribute("Ifchecked,thenthepathendsarejoinedtoformacontinuousloop.")]

publicboolm_Looped

CopyC# JavaScript




Cinemachine

CinemachineSmoothPathm_WaypointsField

Thewaypointsthatdefinethepath.Theywillbeinterpolatedusingabeziercurve


Syntax

FieldValueType:CinemachineSmoothPathWaypoint



[TooltipAttribute("Thewaypointsthatdefinethepath.Theywillbeinterpolatedusingabeziercurve.")]

publicCinemachineSmoothPathWaypoint[]m_Waypoints

CopyC# JavaScript



Cinemachine

CinemachineSmoothPathWaypointStructure

Awaypointalongthepath


Syntax

TheCinemachineSmoothPathWaypointtypeexposesthefollowingmembers.




Top

SeeAlso



publicstructWaypoint

CopyC# JavaScript

Cinemachine

WaypointFields

TheCinemachineSmoothPathWaypointtypeexposesthefollowingmembers.




Top

SeeAlsoReferenceCinemachineSmoothPathWaypointStructureCinemachineNamespace




Cinemachine

CinemachineSmoothPathWaypointpositionField

Positioninpath-localspace


Syntax




[TooltipAttribute("Positioninpath-localspace")]

publicVector3position

CopyC# JavaScript



Cinemachine

CinemachineSmoothPathWaypointrollField

Definestherollofthepathatthiswaypoint.Theotherorientationaxesareinferredfromthetangentandworldup.


Syntax




[TooltipAttribute("Definestherollofthepathatthiswaypoint.Theotherorientationaxesareinferredfromthetangentandworldup.")]

publicfloatroll

CopyC# JavaScript




Cinemachine

CinemachineStateDrivenCameraClass

Thisisavirtualcamera"manager"thatownsandmanagesacollectionofchildVirtualCameras.Thesechildvcamsaremappedtoindividualstatesinananimationstatemachine,allowingyoutoassociatespecificvcamstospecificanimationstates.Whenthatstateisactiveinthestatemachine,thentheassociatedcamerawillbeactivated.Youcandefinecustomblendsandtransitionsbetweenchildcameras.Inordertousethisbehaviour,youmusthaveananimatedtarget(i.e.anobjectanimatedwithastatemachine)todrivethebehaviour.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineStateDrivenCamera


Syntax


[ExecuteInEditMode]


[AddComponentMenu("Cinemachine/CinemachineStateDrivenCamera")]

publicclassCinemachineStateDrivenCamera:CinemachineVirtualCameraBase

CopyC# JavaScript


TheCinemachineStateDrivenCameratypeexposesthefollowingmembers.









Name GetthenameoftheVirtualCamera.implementationreturnstheownerGameObject's

name.(InheritedfromCinemachineVirtualCameraBase







Top



CreateFakeHashName APIfortheinspectoreditor.implementnestedstate









OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.(InheritedfromCinemachineVirtualCameraBase










Top



m_AnimatedTarget Thestatemachinewhosestatechangeswilldrivethiscamera'schoiceofactivechild

m_CustomBlends Thisistheassetwhichcontainscustomsettingsforspecificchildblends.

m_DefaultBlend Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCamerachildren.




m_Instructions Thesetofinstructionsassociatingvirtualcameraswithstates.Theseinstructionsareusedtochoosethelivechildatanygivenmoment

m_LayerIndex WhichlayerinthetargetFSMtoobserve

m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspector

UI.(InheritedfromCinemachineVirtualCameraBase





Top


Cinemachine

CinemachineStateDrivenCameraProperties









LookAt GetthecurrentLookAttarget.

LookAtifparentisnon-nullandnospecificLookAtdefinedforthiscamera(OverridesCinemachineVirtualCameraBase








Top

SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace




Cinemachine

CinemachineStateDrivenCameraChildCamerasProperty



Syntax





CopyC# JavaScript



Cinemachine

CinemachineStateDrivenCameraDescriptionProperty



Syntax





CopyC# JavaScript




Cinemachine

CinemachineStateDrivenCameraFollowProperty



Syntax





CopyC# JavaScript



Cinemachine

CinemachineStateDrivenCameraIsBlendingProperty



Syntax





CopyC# JavaScript




Cinemachine

CinemachineStateDrivenCameraLiveChildProperty

Getthecurrent"best"childvirtualcamera,thatwouldbechoseniftheStateDrivenCamerawereactive.


Syntax





CopyC# JavaScript



Cinemachine

CinemachineStateDrivenCameraLiveChildOrSelfProperty

Returnthelivechild.


Syntax





CopyC# JavaScript



Cinemachine

CinemachineStateDrivenCameraLookAtProperty



Syntax





CopyC# JavaScript



Cinemachine

CinemachineStateDrivenCameraStateProperty

TheStateofthecurrentlivechild


Syntax





CopyC# JavaScript



Cinemachine

CinemachineStateDrivenCameraMethods




CreateFakeHashName APIfortheinspectoreditor.implementnestedstate









OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.(InheritedfromCinemachineVirtualCameraBase










Top





Cinemachine

CinemachineStateDrivenCameraCreateFakeHashNameMethod

APIfortheinspectoreditor.Animationmoduledoesnothavehashesforstateparents,sowehavetoinventtheminordertoimplementnestedstatehandling


Syntax

Parameters

parentHashType:SystemInt32[Missing<paramname="parentHash"/>documentationfor"M:Cinemachine.CinemachineStateDrivenCamera.CreateFakeHashName(System.Int32,System.String)"]

stateNameType:SystemString[Missing<paramname="stateName"/>documentationfor"M:Cinemachine.CinemachineStateDrivenCamera.CreateFakeHashName(System.Int32,System.String)"]

ReturnValueType:String[Missing<returns>documentationfor"M:Cinemachine.CinemachineStateDrivenCamera.CreateFakeHashName(System.Int32,System.String)"]

publicstaticstringCreateFakeHashName(

intparentHash,

stringstateName

)

CopyC# JavaScript




Cinemachine

CinemachineStateDrivenCameraIsLiveChildMethod



Syntax

Parameters






)

CopyC# JavaScript


Cinemachine

CinemachineStateDrivenCameraOnEnableMethod



Syntax




CopyC# JavaScript



Cinemachine

CinemachineStateDrivenCameraOnTransformChildrenChangedMethod



Syntax




CopyC# JavaScript



Cinemachine

CinemachineStateDrivenCameraRemovePostPipelineStageHookMethod



Syntax

Parameters






)

CopyC# JavaScript



Cinemachine

CinemachineStateDrivenCameraUpdateCameraStateMethod



Syntax

Parameters


deltaTimeType:SystemSingleDeltatimefortime-basedeffects(ignoreiflessthanorequalto0)


SeeAlso


Vector3worldUp,

floatdeltaTime

)

CopyC# JavaScript


ReferenceCinemachineStateDrivenCameraClassCinemachineNamespace




Cinemachine

CinemachineStateDrivenCameraValidateInstructionsMethod

InternalAPIfortheinspectoreditor.


Syntax



publicvoidValidateInstructions()

CopyC# JavaScript



Cinemachine

CinemachineStateDrivenCameraFields




m_AnimatedTarget Thestatemachinewhosestatechangeswilldrivethiscamera'schoiceofactivechild

m_CustomBlends Thisistheassetwhichcontainscustomsettingsforspecificchildblends.

m_DefaultBlend Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCamerachildren.




m_Instructions Thesetofinstructionsassociatingvirtualcameraswithstates.Theseinstructionsareusedtochoosethelivechildatanygivenmoment

m_LayerIndex WhichlayerinthetargetFSMtoobserve




m_ShowDebugText Whenenabled,thecurrent

cameraandblendwillbeindicatedinthegamewindow,fordebugging


Top





Cinemachine

CinemachineStateDrivenCameram_AnimatedTargetField

Thestatemachinewhosestatechangeswilldrivethiscamera'schoiceofactivechild


Syntax

FieldValueType:Animator



[SpaceAttribute]

[TooltipAttribute("Thestatemachinewhosestatechangeswilldrivethiscamera'schoiceofactivechild")]

publicAnimatorm_AnimatedTarget

CopyC# JavaScript



Cinemachine

CinemachineStateDrivenCameram_CustomBlendsField

Thisistheassetwhichcontainscustomsettingsforspecificchildblends.


Syntax




[TooltipAttribute("Thisistheassetwhichcontainscustomsettingsforspecificchildblends")]


CopyC# JavaScript



Cinemachine

CinemachineStateDrivenCameram_DefaultBlendField

Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCamerachildren.


Syntax





[TooltipAttribute("Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCamerachildren")]


CopyC# JavaScript



Cinemachine

CinemachineStateDrivenCameram_EnableAllChildCamerasField

Forceallchildcamerastobeenabled.ThisisusefulifanimatingtheminTimeline,butconsumesextraresources.


Syntax




[TooltipAttribute("Forceallchildcamerastobeenabled.ThisisusefulifanimatingtheminTimeline,butconsumesextraresources")]

publicboolm_EnableAllChildCameras

CopyC# JavaScript




Cinemachine

CinemachineStateDrivenCameram_FollowField

Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildrig.Maybeempty


Syntax




[TooltipAttribute("Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildcamera.Maybeemptyifallofthechildrendefinetargetsoftheirown.")]



CopyC# JavaScript



Cinemachine

CinemachineStateDrivenCameram_InstructionsField

Thesetofinstructionsassociatingvirtualcameraswithstates.Theseinstructionsareusedtochoosethelivechildatanygivenmoment


Syntax

FieldValueType:CinemachineStateDrivenCameraInstruction



[TooltipAttribute("Thesetofinstructionsassociatingvirtualcameraswithstates.Theseinstructionsareusedtochoosethelivechildatanygivenmoment")]

publicCinemachineStateDrivenCameraInstruction[]m_Instructions

CopyC# JavaScript



Cinemachine

CinemachineStateDrivenCameram_LayerIndexField

WhichlayerinthetargetFSMtoobserve


Syntax




[TooltipAttribute("Whichlayerinthetargetstatemachinetoobserve")]

publicintm_LayerIndex

CopyC# JavaScript




Cinemachine

CinemachineStateDrivenCameram_LookAtField

Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildrig.Maybeempty


Syntax




[TooltipAttribute("Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildcamera.Maybeemptyifallofthechildrendefinetargetsoftheirown.")]



CopyC# JavaScript



Cinemachine

CinemachineStateDrivenCameram_ShowDebugTextField



Syntax






CopyC# JavaScript




Cinemachine

CinemachineStateDrivenCameraInstructionStructure

ThisrepresentsasingleinstrunctiontotheStateDrivenCamera.ItassociatesanstatefromthestatemachinewithachildVirtualCamera,andalsoholdsactivationtuningparameters.


Syntax

TheCinemachineStateDrivenCameraInstructiontypeexposesthefollowingmembers.


m_ActivateAfter Howlongtowait(inseconds)beforeactivatingthevirtualcamera.Thisfiltersoutveryshortstatedurations

m_FullHash Thefullhashoftheanimationstate

m_MinDuration Theminimumlengthoftime(inseconds)tokeepavirtual


publicstructInstruction

CopyC# JavaScript

cameraactive

m_VirtualCamera Thevirtualcameratoactivatewhrntheanimationstatebecomesactive

Top





Cinemachine

InstructionFields

TheCinemachineStateDrivenCameraInstructiontypeexposesthefollowingmembers.


m_ActivateAfter Howlongtowait(inseconds)beforeactivatingthevirtualcamera.Thisfiltersoutveryshortstatedurations

m_FullHash Thefullhashoftheanimationstate

m_MinDuration Theminimumlengthoftime(inseconds)tokeepavirtualcameraactive

m_VirtualCamera Thevirtualcameratoactivatewhrntheanimationstatebecomesactive

Top

SeeAlsoReferenceCinemachineStateDrivenCameraInstructionStructureCinemachineNamespace




Cinemachine

CinemachineStateDrivenCameraInstructionField

Howlongtowait(inseconds)beforeactivatingthevirtualcamera.Thisfiltersoutveryshortstatedurations


Syntax




[TooltipAttribute("Howlongtowait(inseconds)beforeactivatingthevirtualcamera.Thisfiltersoutveryshortstatedurations")]

publicfloatm_ActivateAfter

CopyC# JavaScript




Cinemachine


Thefullhashoftheanimationstate


Syntax




[TooltipAttribute("Thefullhashoftheanimationstate")]

publicintm_FullHash

CopyC# JavaScript




Cinemachine


Theminimumlengthoftime(inseconds)tokeepavirtualcameraactive


Syntax




[TooltipAttribute("Theminimumlengthoftime(inseconds)tokeepavirtualcameraactive")]

publicfloatm_MinDuration

CopyC# JavaScript




Cinemachine


Thevirtualcameratoactivatewhrntheanimationstatebecomesactive


Syntax




[TooltipAttribute("Thevirtualcameratoactivatewhrntheanimationstatebecomesactive")]

publicCinemachineVirtualCameraBasem_VirtualCamera

CopyC# JavaScript



Cinemachine

CinemachineTargetGroupClass

Definesagroupoftargetobjects,eachwitharadiusandaweight.Theweightisusedwhencalculatingtheaveragepositionofthetargetgroup.Higher-weightedmembersofthegroupwillcountmore.Theboundingboxiscalculatedbytakingthememberpositions,weight,andradiiintoaccount.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineTargetGroup


Syntax

TheCinemachineTargetGrouptypeexposesthefollowingmembers.



[AddComponentMenu("Cinemachine/CinemachineTargetGroup")]


[ExecuteInEditMode]

publicclassCinemachineTargetGroup:MonoBehaviour

CopyC# JavaScript


CinemachineTargetGroup

Top


BoundingBox Theaxis-alignedboundingboxofthegroup,computedusingthetargetspositionsandradii

IsEmpty Returntrueiftherearenomemberswithweight>0

Top


GetViewSpaceBoundingBox Theaxis-alignedboundingboxofthegroup,inaspecificreferenceframe

Top


m_PositionMode Howthegroup'spositioniscalculated

m_RotationMode Howthegroup'sorientationiscalculated

m_Targets Thetargetobjects,together

withtheirweightsandradii,thatwillcontributetothegroup'saverageposition,orientation,andsize

m_UpdateMethod Whentoupdatethegroup'stransformbasedonthepositionofthegroupmembers

Top





Cinemachine

CinemachineTargetGroupConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineTargetGroup.#ctor"]


Syntax

SeeAlsoReferenceCinemachineTargetGroupClassCinemachineNamespace


publicCinemachineTargetGroup()

CopyC# JavaScript



Cinemachine

CinemachineTargetGroupProperties



BoundingBox Theaxis-alignedboundingboxofthegroup,computedusingthetargetspositionsandradii

IsEmpty Returntrueiftherearenomemberswithweight>0

Top





Cinemachine

CinemachineTargetGroupBoundingBoxProperty

Theaxis-alignedboundingboxofthegroup,computedusingthetargetspositionsandradii


Syntax




publicBoundsBoundingBox{get;}

CopyC# JavaScript



Cinemachine

CinemachineTargetGroupIsEmptyProperty

Returntrueiftherearenomemberswithweight>0


Syntax




publicboolIsEmpty{get;}

CopyC# JavaScript




Cinemachine

CinemachineTargetGroupMethods



GetViewSpaceBoundingBox Theaxis-alignedboundingboxofthegroup,inaspecificreferenceframe

Top





Cinemachine

CinemachineTargetGroupGetViewSpaceBoundingBoxMethod

Theaxis-alignedboundingboxofthegroup,inaspecificreferenceframe


Syntax

Parameters

mViewType:Matrix4x4Theframeofreferenceinwhichtocomputetheboundingbox

ReturnValueType:BoundsTheaxis-alignedboundingboxofthegroup,inthedesiredframeofreference


publicBoundsGetViewSpaceBoundingBox(

Matrix4x4mView

)

CopyC# JavaScript

Cinemachine

CinemachineTargetGroupFields



m_PositionMode Howthegroup'spositioniscalculated

m_RotationMode Howthegroup'sorientationiscalculated

m_Targets Thetargetobjects,togetherwiththeirweightsandradii,thatwillcontributetothegroup'saverageposition,orientation,andsize

m_UpdateMethod Whentoupdatethegroup'stransformbasedonthepositionofthegroupmembers

Top





Cinemachine

CinemachineTargetGroupm_PositionModeField

Howthegroup'spositioniscalculated


Syntax

FieldValueType:CinemachineTargetGroupPositionMode



[TooltipAttribute("Howthegroup'spositioniscalculated.SelectGroupCenterforthecenteroftheboundingbox,andGroupAverageforaweightedaverageofthepositionsofthemembers.")]

publicCinemachineTargetGroupPositionModem_PositionMode

CopyC# JavaScript



Cinemachine

CinemachineTargetGroupm_RotationModeField

Howthegroup'sorientationiscalculated


Syntax

FieldValueType:CinemachineTargetGroupRotationMode



[TooltipAttribute("Howthegroup'srotationiscalculated.SelectManualtousethevalueinthegroup'stransform,andGroupAverageforaweightedaverageoftheorientationsofthemembers.")]

publicCinemachineTargetGroupRotationModem_RotationMode

CopyC# JavaScript



Cinemachine

CinemachineTargetGroupm_TargetsField

Thetargetobjects,togetherwiththeirweightsandradii,thatwillcontributetothegroup'saverageposition,orientation,andsize


Syntax

FieldValueType:CinemachineTargetGroupTarget




[TooltipAttribute("Thetargetobjects,togetherwiththeirweightsandradii,thatwillcontributetothegroup'saverageposition,orientation,andsize.")]

publicCinemachineTargetGroupTarget[]m_Targets

CopyC# JavaScript



Cinemachine

CinemachineTargetGroupm_UpdateMethodField

Whentoupdatethegroup'stransformbasedonthepositionofthegroupmembers


Syntax

FieldValueType:CinemachineTargetGroupUpdateMethod



[TooltipAttribute("Whentoupdatethegroup'stransformbasedonthepositionofthegroupmembers")]

publicCinemachineTargetGroupUpdateMethodm_UpdateMethod

CopyC# JavaScript



Cinemachine

CinemachineTargetGroupPositionModeEnumeration

Howthegroup'spositioniscalculated


Syntax

Members


GroupCenter 0 Grouppositionwillbethecenterofthegroup'saxis-alignedboundingbox

GroupAverage 1 Grouppositionwillbetheweightedaverageofthepositionsofthemembers

SeeAlsoReference


publicenumPositionMode

CopyC# JavaScript

Cinemachine

CinemachineTargetGroupRotationModeEnumeration

Howthegroup'sorientationiscalculated


Syntax

Members


Manual 0 Manuallysetinthegroup'stransform

GroupAverage 1 Weightedaverageoftheorientationofitsmembers.



publicenumRotationMode

CopyC# JavaScript

Cinemachine

CinemachineTargetGroupTargetStructure

Holdstheinformationthatrepresentsamemberofthegroup


Syntax

TheCinemachineTargetGroupTargettypeexposesthefollowingmembers.


radius Theradiusofthetarget,usedforcalculatingtheboundingbox.Cannotbenegative

target Thetargetobjects.Thisobject'spositionandorientationwillcontributetothegroup'saveragepositionandorientation,inaccordancewithitsweight

weight Howmuchweighttogivethetarget



publicstructTarget

CopyC# JavaScript

whenaveraging.Cannotbenegative

Top





Cinemachine

TargetFields

TheCinemachineTargetGroupTargettypeexposesthefollowingmembers.


radius Theradiusofthetarget,usedforcalculatingtheboundingbox.Cannotbenegative

target Thetargetobjects.Thisobject'spositionandorientationwillcontributetothegroup'saveragepositionandorientation,inaccordancewithitsweight

weight Howmuchweighttogivethetargetwhenaveraging.Cannotbenegative

Top

SeeAlsoReferenceCinemachineTargetGroupTargetStructureCinemachineNamespace




Cinemachine

CinemachineTargetGroupTargetradiusField

Theradiusofthetarget,usedforcalculatingtheboundingbox.Cannotbenegative


Syntax




[TooltipAttribute("Theradiusofthetarget,usedforcalculatingtheboundingbox.Cannotbenegative")]

publicfloatradius

CopyC# JavaScript




Cinemachine

CinemachineTargetGroupTargettargetField

Thetargetobjects.Thisobject'spositionandorientationwillcontributetothegroup'saveragepositionandorientation,inaccordancewithitsweight


Syntax




[TooltipAttribute("Thetargetobjects.Thisobject'spositionandorientationwillcontributetothegroup'saveragepositionandorientation,inaccordancewithitsweight")]

publicTransformtarget

CopyC# JavaScript



Cinemachine

CinemachineTargetGroupTargetweightField

Howmuchweighttogivethetargetwhenaveraging.Cannotbenegative


Syntax




[TooltipAttribute("Howmuchweighttogivethetargetwhenaveraging.Cannotbenegative")]

publicfloatweight

CopyC# JavaScript




Cinemachine

CinemachineTargetGroupUpdateMethodEnumeration



Syntax

Members


Update 0 UpdatedinnormalMonoBehaviourUpdate.

FixedUpdate 1 UpdatedinsyncwiththePhysicsmodule,inFixedUpdate

LateUpdate 2 UpdatedinMonoBehaviourLateUpdate.

SeeAlsoReference


CopyC# JavaScript

Cinemachine

CinemachineTrackedDollyClass

ACinemachineVirtualCameraBodycomponentthatconstrainscameramotiontoaCinemachinePath.Thecameracanmovealongthepath.Thisbehaviourcanoperateintwomodes:manualpositioning,andAuto-Dollypositioning.InManualmode,thecamera'spositionisspecifiedbyanimatingthePathPositionfield.InAuto-Dollymode,thePathPositionfieldisanimatedautomaticallyeveryframebyfindingthepositiononthepaththat'sclosesttothevirtualcamera'sFollowtarget.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineTrackedDolly


Syntax

TheCinemachineTrackedDollytypeexposesthefollowingmembers.





publicclassCinemachineTrackedDolly:CinemachineComponentBase

CopyC# JavaScript



CinemachineTrackedDolly

Top



IsValid Trueifcomponentisenabledandhasapath(OverridesCinemachineComponentBaseIsValid.)





Top



OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.implementationaddsthedeltatothefollowoffset.(OverridesCinemachineComponentBaseOnPositionDragged(Vector3)

Top


m_AutoDolly Controlshowautomaticdollyingoccurs

m_CameraUp Howtosetthevirtualcamera'sUpvector.Thiswillaffectthescreencomposition.

m_Path Thepathtowhichthecamerawillbeconstrained.Thismustbenon-null.

m_PathOffset Wheretoputthecamera

realtivetothepathpostion.Xisperpendiculartothepath,Yisup,andZisparalleltothepath.

m_PathPosition Thepositionalongthepathatwhichthecamerawillbeplaced.Thiscanbeanimateddirectly,orsetautomaticallybytheAuto-DollyfeaturetogetascloseaspossibletotheFollowtarget.

m_PitchDamping "Howaggressivelythecameratriestotrackthetargetrotation'sXangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.


m_RollDamping Howaggressivelythecameratriestotrackthetargetrotation'sZangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.

m_XDamping Howaggressivelythecameratriestomaintaintheoffsetperpendiculartothepath.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbers

giveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors

m_YawDamping Howaggressivelythecameratriestotrackthetargetrotation'sYangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.

m_YDamping Howaggressivelythecameratriestomaintaintheoffsetinthepath-localupdirection.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors

m_ZDamping Howaggressivelythecameratriestomaintaintheoffsetparalleltothepath.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors

Top





Cinemachine

CinemachineTrackedDollyConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineTrackedDolly.#ctor"]


Syntax

SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace


publicCinemachineTrackedDolly()

CopyC# JavaScript



Cinemachine

CinemachineTrackedDollyProperties




IsValid Trueifcomponentisenabledandhasapath(OverridesCinemachineComponentBaseIsValid.)





Top





Cinemachine

CinemachineTrackedDollyIsValidProperty

Trueifcomponentisenabledandhasapath


Syntax





CopyC# JavaScript




Cinemachine

CinemachineTrackedDollyStageProperty



Syntax





CopyC# JavaScript



Cinemachine

CinemachineTrackedDollyMethods





Top





Cinemachine

CinemachineTrackedDollyMutateCameraStateMethod



Syntax

Parameters


deltaTimeType:SystemSingleUsedfordamping.Iflessthat0,nodampingisdone.





floatdeltaTime

)

CopyC# JavaScript




Cinemachine

CinemachineTrackedDollyOnPositionDraggedMethod

APIfortheeditor,toprocessapositiondragfromtheuser.Thisimplementationaddsthedeltatothefollowoffset.


Syntax

Parameters





Vector3delta

)

CopyC# JavaScript



Cinemachine

CinemachineTrackedDollyFields



m_AutoDolly Controlshowautomaticdollyingoccurs

m_CameraUp Howtosetthevirtualcamera'sUpvector.Thiswillaffectthescreencomposition.

m_Path Thepathtowhichthecamerawillbeconstrained.Thismustbenon-null.

m_PathOffset Wheretoputthecamerarealtivetothepathpostion.Xisperpendiculartothepath,Yisup,andZisparalleltothepath.

m_PathPosition Thepositionalongthepathatwhichthecamerawillbeplaced.Thiscanbeanimateddirectly,orsetautomaticallybytheAuto-DollyfeaturetogetascloseaspossibletotheFollowtarget.

m_PitchDamping "Howaggressivelythecameratriestotrackthetargetrotation'sXangle.Small

numbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.



m_XDamping Howaggressivelythecameratriestomaintaintheoffsetperpendiculartothepath.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors


m_YDamping Howaggressivelythecameratriestomaintaintheoffsetin

thepath-localupdirection.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors

m_ZDamping Howaggressivelythecameratriestomaintaintheoffsetparalleltothepath.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors

Top





Cinemachine

CinemachineTrackedDollym_AutoDollyField

Controlshowautomaticdollyingoccurs


Syntax

FieldValueType:CinemachineTrackedDollyAutoDolly



[TooltipAttribute("Controlshowautomaticdollyingoccurs.AFollowtargetisnecessarytousethisfeature.")]

publicCinemachineTrackedDollyAutoDollym_AutoDolly

CopyC# JavaScript



Cinemachine

CinemachineTrackedDollym_CameraUpField

Howtosetthevirtualcamera'sUpvector.Thiswillaffectthescreencomposition.


Syntax

FieldValueType:CinemachineTrackedDollyCameraUpMode



[TooltipAttribute("Howtosetthevirtualcamera'sUpvector.Thiswillaffectthescreencomposition,becausethecameraAimbehaviourswillalwaystrytorespecttheUpdirection.")]

publicCinemachineTrackedDollyCameraUpModem_CameraUp

CopyC# JavaScript



Cinemachine

CinemachineTrackedDollym_PathField

Thepathtowhichthecamerawillbeconstrained.Thismustbenon-null.


Syntax

FieldValueType:CinemachinePathBase



[TooltipAttribute("Thepathtowhichthecamerawillbeconstrained.Thismustbenon-null.")]

publicCinemachinePathBasem_Path

CopyC# JavaScript



Cinemachine

CinemachineTrackedDollym_PathOffsetField

Wheretoputthecamerarealtivetothepathpostion.Xisperpendiculartothepath,Yisup,andZisparalleltothepath.


Syntax




[TooltipAttribute("Wheretoputthecamerarelativetothepathposition.Xisperpendiculartothepath,Yisup,andZisparalleltothepath.Thisallowsthecameratobeoffsetfromthepathitself(asifonatripod,forexample).")]

publicVector3m_PathOffset

CopyC# JavaScript



Cinemachine

CinemachineTrackedDollym_PathPositionField

Thepositionalongthepathatwhichthecamerawillbeplaced.Thiscanbeanimateddirectly,orsetautomaticallybytheAuto-DollyfeaturetogetascloseaspossibletotheFollowtarget.


Syntax




[TooltipAttribute("Thepositionalongthepathatwhichthecamerawillbeplaced.Thiscanbeanimateddirectly,orsetautomaticallybytheAuto-DollyfeaturetogetascloseaspossibletotheFollowtarget.ThevalueisinterpretedaccordingtothePositionUnitssetting.")]

publicfloatm_PathPosition

CopyC# JavaScript




Cinemachine

CinemachineTrackedDollym_PitchDampingField

"Howaggressivelythecameratriestotrackthetargetrotation'sXangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.


Syntax





[TooltipAttribute("Howaggressivelythecameratriestotrackthetargetrotation'sXangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.")]

publicfloatm_PitchDamping

CopyC# JavaScript




Cinemachine

CinemachineTrackedDollym_PositionUnitsField



Syntax

FieldValueType:CinemachinePathBasePositionUnits



[TooltipAttribute("HowtointerpretPathPosition.IfsettoPathUnits,valuesareasfollows:0representsthefirstwaypointonthepath,1isthesecond,andsoon.Valuesin-betweenarepointsonthepathinbetweenthewaypoints.IfsettoDistance,thenPathPositionrepresentsdistancealongthepath.")]

publicCinemachinePathBasePositionUnitsm_PositionUnits

CopyC# JavaScript



Cinemachine

CinemachineTrackedDollym_RollDampingField

Howaggressivelythecameratriestotrackthetargetrotation'sZangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.


Syntax





[TooltipAttribute("Howaggressivelythecameratriestotrackthetargetrotation'sZangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.")]

publicfloatm_RollDamping

CopyC# JavaScript




Cinemachine

CinemachineTrackedDollym_XDampingField

Howaggressivelythecameratriestomaintaintheoffsetperpendiculartothepath.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors


Syntax





[TooltipAttribute("Howaggressivelythecameratriestomaintainitspositioninadirectionperpendiculartothepath.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]


CopyC# JavaScript




Cinemachine

CinemachineTrackedDollym_YawDampingField

Howaggressivelythecameratriestotrackthetargetrotation'sYangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.


Syntax





[TooltipAttribute("Howaggressivelythecameratriestotrackthetargetrotation'sYangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.")]

publicfloatm_YawDamping

CopyC# JavaScript




Cinemachine

CinemachineTrackedDollym_YDampingField

Howaggressivelythecameratriestomaintaintheoffsetinthepath-localupdirection.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors


Syntax





[TooltipAttribute("Howaggressivelythecameratriestomaintainitspositioninthepath-localupdirection.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]


CopyC# JavaScript




Cinemachine

CinemachineTrackedDollym_ZDampingField

Howaggressivelythecameratriestomaintaintheoffsetparalleltothepath.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors


Syntax





[TooltipAttribute("Howaggressivelythecameratriestomaintainitspositioninadirectionparalleltothepath.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]


CopyC# JavaScript




Cinemachine

CinemachineTrackedDollyAutoDollyStructure

Controlshowautomaticdollyingoccurs


Syntax

TheCinemachineTrackedDollyAutoDollytypeexposesthefollowingmembers.


CinemachineTrackedDollyAutoDolly Constructorwithspecificfieldvalues

Top




publicstructAutoDolly

CopyC# JavaScript

m_Enabled Ifchecked,willenableautomaticdolly,whichchoosesapathpositionthatisascloseaspossibletotheFollowtarget.

m_PositionOffset Offset,incurrentpositionunits,fromtheclosestpointonthepathtothefollowtarget.

m_SearchRadius Searchuptohowmanywaypointsoneithersideofthecurrentposition.Use0forEntirepath

m_SearchResolution Wesearchbetweenwaypointsbydividingthesegmentintothismanystraightpieces.Thehigherthenumber,themoreaccuratetheresult,butperformanceisproportionallyslowerforhighernumbers

Top





Cinemachine

CinemachineTrackedDollyAutoDollyConstructor

Constructorwithspecificfieldvalues


Syntax

Parameters

enabledType:SystemBoolean[Missing<paramname="enabled"/>documentationfor"M:Cinemachine.CinemachineTrackedDolly.AutoDolly.#ctor(System.Boolean,System.Single,System.Int32,System.Int32)"]

positionOffsetType:SystemSingle[Missing<paramname="positionOffset"/>documentationfor"M:Cinemachine.CinemachineTrackedDolly.AutoDolly.#ctor(System.Boolean,System.Single,System.Int32,System.Int32)"]

searchRadiusType:SystemInt32[Missing<paramname="searchRadius"/>documentationfor"M:Cinemachine.CinemachineTrackedDolly.AutoDolly.#ctor(System.Boolean,System.Single,System.Int32,System.Int32)"]

stepsPerSegment

publicAutoDolly(

boolenabled,

floatpositionOffset,

intsearchRadius,

intstepsPerSegment

)

CopyC# JavaScript




Type:SystemInt32[Missing<paramname="stepsPerSegment"/>documentationfor"M:Cinemachine.CinemachineTrackedDolly.AutoDolly.#ctor(System.Boolean,System.Single,System.Int32,System.Int32)"]

SeeAlsoReferenceCinemachineTrackedDollyAutoDollyStructureCinemachineNamespace





Cinemachine

AutoDollyFields

TheCinemachineTrackedDollyAutoDollytypeexposesthefollowingmembers.


m_Enabled Ifchecked,willenableautomaticdolly,whichchoosesapathpositionthatisascloseaspossibletotheFollowtarget.

m_PositionOffset Offset,incurrentpositionunits,fromtheclosestpointonthepathtothefollowtarget.

m_SearchRadius Searchuptohowmanywaypointsoneithersideofthecurrentposition.Use0forEntirepath

m_SearchResolution Wesearchbetweenwaypointsbydividingthesegmentintothismanystraightpieces.Thehigherthenumber,themoreaccuratetheresult,butperformanceisproportionallyslowerforhighernumbers

Top

Cinemachine

CinemachineTrackedDollyAutoDollym_EnabledField

Ifchecked,willenableautomaticdolly,whichchoosesapathpositionthatisascloseaspossibletotheFollowtarget.


Syntax




[TooltipAttribute("Ifchecked,willenableautomaticdolly,whichchoosesapathpositionthatisascloseaspossibletotheFollowtarget.Note:thiscanhavesignificantperformanceimpact")]

publicboolm_Enabled

CopyC# JavaScript




Cinemachine

CinemachineTrackedDollyAutoDollym_PositionOffsetField

Offset,incurrentpositionunits,fromtheclosestpointonthepathtothefollowtarget.


Syntax




[TooltipAttribute("Offset,incurrentpositionunits,fromtheclosestpointonthepathtothefollowtarget")]

publicfloatm_PositionOffset

CopyC# JavaScript




Cinemachine

CinemachineTrackedDollyAutoDollym_SearchRadiusField

Searchuptohowmanywaypointsoneithersideofthecurrentposition.Use0forEntirepath


Syntax




[TooltipAttribute("Searchuptohowmanywaypointsoneithersideofthecurrentposition.Use0forEntirepath.")]

publicintm_SearchRadius

CopyC# JavaScript




Cinemachine

CinemachineTrackedDollyAutoDollym_SearchResolutionField

Wesearchbetweenwaypointsbydividingthesegmentintothismanystraightpieces.Thehigherthenumber,themoreaccuratetheresult,butperformanceisproportionallyslowerforhighernumbers


Syntax




[FormerlySerializedAsAttribute("m_StepsPerSegment")]

[TooltipAttribute("Wesearchbetweenwaypointsbydividingthesegmentintothismanystraightpieces.Thehigherthenumber,themoreaccuratetheresult,butperformanceisproportionallyslowerforhighernumbers")]

publicintm_SearchResolution

CopyC# JavaScript




Cinemachine

CinemachineTrackedDollyCameraUpModeEnumeration

Differentwaystosetthecamera'supvector


Syntax


Default 0 Leavethecamera'supvectoralone.ItwillbesetaccordingtotheBrain'sWorldUp.

Path 1 Taketheupvectorfromthepath'supvectoratthecurrentpoint

PathNoRoll 2 Taketheupvectorfromthepath'sup


publicenumCameraUpMode

CopyC# JavaScript

vectoratthecurrentpoint,butwiththerollzeroedout

FollowTarget 3 TaketheupvectorfromtheFollowtarget'supvector

FollowTargetNoRoll 4 TaketheupvectorfromtheFollowtarget'supvector,butwiththerollzeroedout





Cinemachine

CinemachineTransposerClass

ThisisaCinemachineComponentintheBodysectionofthecomponentpipeline.Itsjobistopositionthecamerainafixedrelationshiptothevcam'sFollowtargetobject,withoffsetsanddamping.TheTansposerwillonlychangethecamera'spositioninspace.Itwillnotre-orientorotherwiseaimthecamera.Totothat,youneedtoinstructthevcamintheAimsectionofitspipeline.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineTransposerCinemachineCinemachineOrbitalTransposer


Syntax

TheCinemachineTransposertypeexposesthefollowingmembers.





publicclassCinemachineTransposer:CinemachineComponentBase

CopyC# JavaScript



CinemachineTransposer

Top


AngularDamping Dampingspeedsforeachofthe3axesofthetarget'srotation

Damping Dampingspeedsforeachofthe3axesoftheoffsetfromtarget

EffectiveOffset Getthetargetoffset,withsanitization




Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage

(OverridesCinemachineComponentBaseStage.)



Top


GeTargetCameraPosition InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget

GetReferenceOrientation InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget




OnValidate

TrackTarget Positionsthevirtualcameraaccordingtothetransposerrules.

Top



m_FollowOffset Thedistancewhichthetransposerwillattempttomaintainfromthetransposersubject

m_PitchDamping Howaggressivelythecameratriestotrackthetargetrotation'sXangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.


m_XDamping HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.

Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors



m_ZDamping HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamera

behaviors

Top





Cinemachine

CinemachineTransposerConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineTransposer.#ctor"]


Syntax

SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace


publicCinemachineTransposer()

CopyC# JavaScript



Cinemachine

CinemachineTransposerProperties



AngularDamping Dampingspeedsforeachofthe3axesofthetarget'srotation

Damping Dampingspeedsforeachofthe3axesoftheoffsetfromtarget

EffectiveOffset Getthetargetoffset,withsanitization




Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage

(OverridesCinemachineComponentBaseStage.)



Top





Cinemachine

CinemachineTransposerAngularDampingProperty

Dampingspeedsforeachofthe3axesofthetarget'srotation


Syntax




protectedVector3AngularDamping{get;}

CopyC# JavaScript



Cinemachine

CinemachineTransposerDampingProperty

Dampingspeedsforeachofthe3axesoftheoffsetfromtarget


Syntax




protectedVector3Damping{get;}

CopyC# JavaScript



Cinemachine

CinemachineTransposerEffectiveOffsetProperty

Getthetargetoffset,withsanitization


Syntax




protectedVector3EffectiveOffset{get;}

CopyC# JavaScript



Cinemachine

CinemachineTransposerIsValidProperty

TrueifcomponentisenabledandhasavalidFollowtarget


Syntax





CopyC# JavaScript




Cinemachine

CinemachineTransposerStageProperty



Syntax





CopyC# JavaScript



Cinemachine

CinemachineTransposerMethods



GeTargetCameraPosition InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget

GetReferenceOrientation InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget




OnValidate

TrackTarget Positionsthevirtualcameraaccordingtothetransposerrules.

Top

SeeAlso

ReferenceCinemachineTransposerClassCinemachineNamespace




Cinemachine

CinemachineTransposerGeTargetCameraPositionMethod

InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget


Syntax

Parameters

worldUpType:Vector3[Missing<paramname="worldUp"/>documentationfor"M:Cinemachine.CinemachineTransposer.GeTargetCameraPosition(UnityEngine.Vector3)"]

ReturnValueType:Vector3[Missing<returns>documentationfor"M:Cinemachine.CinemachineTransposer.GeTargetCameraPosition(UnityEngine.Vector3)"]


publicVector3GeTargetCameraPosition(

Vector3worldUp

)

CopyC# JavaScript

Cinemachine

CinemachineTransposerGetReferenceOrientationMethod

InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget


Syntax

Parameters

worldUpType:Vector3[Missing<paramname="worldUp"/>documentationfor"M:Cinemachine.CinemachineTransposer.GetReferenceOrientation(UnityEngine.Vector3)"]

ReturnValueType:Quaternion[Missing<returns>documentationfor"M:Cinemachine.CinemachineTransposer.GetReferenceOrientation(UnityEngine.Vector3)"]


publicQuaternionGetReferenceOrientation(

Vector3worldUp

)

CopyC# JavaScript

Cinemachine

CinemachineTransposerInitPrevFrameStateInfoMethod

Initializesthestateforpreviousframeifappropriate.


Syntax

Parameters

curStateType:CinemachineCameraState[Missing<paramname="curState"/>documentationfor"M:Cinemachine.CinemachineTransposer.InitPrevFrameStateInfo(Cinemachine.CameraState@,System.Single)"]

deltaTimeType:SystemSingle[Missing<paramname="deltaTime"/>documentationfor"M:Cinemachine.CinemachineTransposer.InitPrevFrameStateInfo(Cinemachine.CameraState@,System.Single)"]


protectedvoidInitPrevFrameStateInfo(


floatdeltaTime

)

CopyC# JavaScript


Cinemachine

CinemachineTransposerMutateCameraStateMethod



Syntax

Parameters







floatdeltaTime

)

CopyC# JavaScript




Cinemachine

CinemachineTransposerOnPositionDraggedMethod

APIfortheeditor,toprocessapositiondragfromtheuser.Thisimplementationaddsthedeltatothefollowoffset.


Syntax

Parameters





Vector3delta

)

CopyC# JavaScript



Cinemachine

CinemachineTransposerOnValidateMethod

[Missing<summary>documentationfor"M:Cinemachine.CinemachineTransposer.OnValidate"]


Syntax



protectedvirtualvoidOnValidate()

CopyC# JavaScript



Cinemachine

CinemachineTransposerTrackTargetMethod



Syntax

Parameters


upType:Vector3Currentcameraup

desiredCameraOffsetType:Vector3Wherewewanttoputthecamerarelativetothefollowtarget

outTargetPositionType:Vector3Resultingcameraposition

protectedvoidTrackTarget(

floatdeltaTime,

Vector3up,

Vector3desiredCameraOffset,

outVector3outTargetPosition,

outQuaternionoutTargetOrient

)

CopyC# JavaScript


outTargetOrientType:QuaternionDampedtargetorientation





Cinemachine

CinemachineTransposerFields




m_FollowOffset Thedistancewhichthetransposerwillattempttomaintainfromthetransposersubject

m_PitchDamping Howaggressivelythecameratriestotrackthetargetrotation'sXangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.


m_XDamping HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersare

moreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors



m_ZDamping HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyresponding

camera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors

Top





Cinemachine

CinemachineTransposerm_BindingModeField



Syntax

FieldValueType:CinemachineTransposerBindingMode



[TooltipAttribute("Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget.Thisisalsousedtosetthecamera'sUpvector,whichwillbemaintainedwhenaimingthecamera.")]

publicCinemachineTransposerBindingModem_BindingMode

CopyC# JavaScript



Cinemachine

CinemachineTransposerm_FollowOffsetField

Thedistancewhichthetransposerwillattempttomaintainfromthetransposersubject


Syntax




[TooltipAttribute("ThedistancevectorthatthetransposerwillattempttomaintainfromtheFollowtarget")]

publicVector3m_FollowOffset

CopyC# JavaScript



Cinemachine

CinemachineTransposerm_PitchDampingField

Howaggressivelythecameratriestotrackthetargetrotation'sXangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.


Syntax





[TooltipAttribute("Howaggressivelythecameratriestotrackthetargetrotation'sXangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.")]

publicfloatm_PitchDamping

CopyC# JavaScript




Cinemachine

CinemachineTransposerm_RollDampingField

Howaggressivelythecameratriestotrackthetargetrotation'sZangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.


Syntax





[TooltipAttribute("Howaggressivelythecameratriestotrackthetargetrotation'sZangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.")]

publicfloatm_RollDamping

CopyC# JavaScript




Cinemachine

CinemachineTransposerm_XDampingField

HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors


Syntax





[TooltipAttribute("HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]


CopyC# JavaScript




Cinemachine

CinemachineTransposerm_YawDampingField

Howaggressivelythecameratriestotrackthetargetrotation'sYangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.


Syntax





[TooltipAttribute("Howaggressivelythecameratriestotrackthetargetrotation'sYangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.")]

publicfloatm_YawDamping

CopyC# JavaScript




Cinemachine

CinemachineTransposerm_YDampingField

HowaggressivelythecameratriestomaintaintheoffsetintheY-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors


Syntax





[TooltipAttribute("HowaggressivelythecameratriestomaintaintheoffsetintheY-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]


CopyC# JavaScript




Cinemachine

CinemachineTransposerm_ZDampingField

HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors


Syntax





[TooltipAttribute("HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]


CopyC# JavaScript




Cinemachine

CinemachineTransposerBindingModeEnumeration



Syntax


LockToTargetOnAssign 0 CamerawillbeboundtotheFollowtargetusingaframeofreferenceconsistingofthetarget'slocalframeatthemomentwhenthe


publicenumBindingMode

CopyC# JavaScript

virtualcamerawasenabled,orwhenthetargetwasassigned.

LockToTargetWithWorldUp 1 CamerawillbeboundtotheFollowtargetusingaframeofreferenceconsistingofthetarget'slocalframe,withthetiltandrollzeroedout.

LockToTargetNoRoll 2 CamerawillbeboundtotheFollowtargetusingaframeofreferenceconsistingofthetarget'slocalframe,withtherollzeroedout.

LockToTarget 3 CamerawillbeboundtotheFollowtargetusingthetarget's

localframe.

WorldSpace 4 CamerawillbeboundtotheFollowtargetusingaworldspaceoffset.

SimpleFollowWithWorldUp 5 Offsetswillbecalculatedrelativetothetarget,usingCamera-localaxes





Cinemachine

CinemachineVirtualCameraClass

ThisbehaviourisintendedtobeattachedtoanemptyTransformGameObject,anditrepresentsaVirtualCamerawithintheUnityscene.TheVirtualCamerawillanimateitsTransformaccordingtotherulescontainedinitsCinemachineComponentpipeline(Aim,Body,andNoise).WhenthevirtualcameraisLive,theUnitycamerawillassumethepositionandorientationofthevirtualcamera.Avirtualcameraisnotacamera.Instead,itcanbethoughtofasacameracontroller,notunlikeacameraman.ItcandrivetheUnityCameraandcontrolitsposition,orientation,lenssettings,andPostProcessingeffects.EachVirtualCameraownsitsownCinemachineComponentPipeline,throughwhichyouprovidetheinstructionsfordynamicallytrackingspecificgameobjects.Avirtualcameraisverylightweight,anddoesnorenderingofitsown.ItmerelytracksinterestingGameObjects,andpositionsitselfaccordingly.Atypicalgamecanhavedozensofvirtualcameras,eachsetuptofollowaparticularcharacterorcaptureaparticularevent.AVirtualCameracanbeinanyofthreestates:***Live**:ThevirtualcameraisactivelycontrollingtheUnityCamera.Thevirtualcameraistrackingitstargetsandbeingupdatedeveryframe.***Standby**:Thevirtualcameraistrackingitstargetsandbeingupdatedeveryframe,butnoUnityCameraisactivelybeingcontrolledbyit.ThisisthestateofavirtualcamerathatisenabledinthescenebutperhapsatalowerprioritythantheLivevirtualcamera.***Disabled**:Thevirtualcameraispresentbutdisabledinthescene.Itisnotactivelytrackingitstargetsandsoconsumesnoprocessingpower.However,thevirtualcameracanbemadelivefromtheTimeline.TheUnityCameracanbedrivenbyanyvirtualcamerainthescene.Thegamelogiccanchoosethevirtualcameratomakelivebymanipulatingthevirtualcameras'enabledflagsandtheirpriorities,basedongamelogic.Inordertobedrivenbyavirtualcamera,theUnityCameramusthaveaCinemachineBrainbehaviour,whichwillselectthemosteligiblevirtualcamerabasedonitspriorityoronothercriteria,andwillmanageblending.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineVirtualCamera


Syntax

TheCinemachineVirtualCameratypeexposesthefollowingmembers.


CinemachineVirtualCamera

Top



[ExecuteInEditMode]


[AddComponentMenu("Cinemachine/CinemachineVirtualCamera")]

publicclassCinemachineVirtualCamera:CinemachineVirtualCameraBase

CopyC# JavaScript



Follow GettheFollowtargetfortheBodycomponentintheCinemachinePipeline.Ifthisvcamisapartofameta-cameracollection,thentheowner'stargetusedifthelocaltargetisnull.(OverridesCinemachineVirtualCameraBase


LookAt GettheLookAttargetfortheAimcomponentintheCinemachinePipeline.Ifthisvcamisapartofameta-cameracollection,thentheowner'stargetusedifthelocaltargetisnull.(OverridesCinemachineVirtualCameraBase


ParentCamera Supportformeta-virtual-cameras.thesituationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.PrivatearmiesareimplementedasTransform

childrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase



State TheCameraStateobjectholdsalloftheinformationnecessarytopositiontheUnitycamera.Itistheoutputofthisclass.(OverridesCinemachineVirtualCameraBase

UserIsDragging APIfortheeditor,tomakethedraggingofpositionhandlesbehavebetter.



Top

Methods

Name Description

AddCinemachineComponentT Addacomponenttothecinemachinepipeline.

AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.becalledaftereachpipelinestage,toallowotherstohookintothepipeline.(Inheritedfrom

DestroyCinemachineComponentT Removeacomponentfromthecinemachinepipeline.

GetCinemachineComponent(CinemachineCoreStage) Getthecomponentsetforaspecificstage.

GetCinemachineComponentT Getanexistingcomponentofaspecifictypefromthecinemachinepipeline.

GetComponentOwner GetthehiddenCinemachinePipelinechildobject.

GetComponentPipeline Getthecomponentpipelineownedbythehiddenchildpiplinecontainer.GetCinemachineComponentmethod.

InvalidateComponentPipeline EditorAPI:Callthiswhenchangingthepipelinefromtheeditor.


IsLiveChild Checkwhetherthevcamalivechildofthiscamera.classimplementationalwaysreturnsfalse.(Inheritedfrom

MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereissometimestheneedtopushonetothetop,makingitthecurrentLivecameraifqueuewithitspeers.vcamisenabled:themostrecentonegoestothetopoftheprioritysubqueue.ofitsprioritypeers.

thenthisvcamwillbecomeLive.(Inheritedfrom

OnDestroy CallstheDestroyPipelineDelegatefordestroyingthehiddenchildobject,tosupportundo.(Overrides


OnEnable Makesurethatthepipelinecacheisup-to-date.(Overrides

OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.


OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.implementationmustbecalledbyanyoverriddenmethod.(Inheritedfrom

OnValidate Enforceboundsforfields,whenchangedininspector.(Overrides

PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,thechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledbecalledonLateUpdateinstead.doesnothing.(Inheritedfrom

RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.(Inheritedfrom

ResolveFollow Returnsthisvcam'sFollowtarget,orifthatisnull,willretruntheparentvcam'sFollowtarget.

(Inheritedfrom

ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretruntheparentvcam'sLookAttarget.(Inheritedfrom



UpdateCameraState CalledbyCinemachineCoreatLateUpdatetimecanpositionitselfandtrackitstargets.itspipelineandgenerateaCameraStateforthisframe.(OverridesCinemachineVirtualCameraBaseSingle)

Top



CreatePipelineOverride Overridecomponentpipelinecreation.ThisneedstobedonebytheeditortosupportUndo.TheoverridemustdoexactlythesamethingastheCreatePipelinemethodinthisclass.

DestroyPipelineOverride Overridecomponentpipelinedestruction.ThisneedstobedonebytheeditortosupportUndo.


m_Follow Theobjectthatthecamerawantstomovewith(theBodytarget).TheBodycomponentoftheCinemachineComponentpipelinewillrefertothistargetandpositionthevcaminaccordancewithrulesandsettingsthatareprovidedtoit.Ifthisisnull,thenthevcam'sTransformpositionwillbeused.

m_Lens SpecifiestheLensSettingsofthisVirtualCamera.ThesesettingswillbetransferredtotheUnitycamerawhenthevcamislive.


m_LookAt Theobjectthatthecamerawantstolookat(theAimtarget).AimcomponentoftheCinemachineComponentpipelinewillrefertothistargetandorientthevcaminaccordancewithrulesandsettingsthatareprovidedto

it.Ifthisisnull,thenthevcam'sTransformorientationwillbeused.



PipelineName ThisisthenameofthehiddenGameObjectthatwillbecreatedasachildobjectofthevirtualcamera.ThishiddengameobjectactsasacontainerforthepolymorphicCinemachineComponentpipeline.TheInspectorUIfortheVirtualCameraprovidesaccesstothispipleline,asdotheCinemachineComponent-familyofpublicmethodsinthisclass.lifecycleofthepipelineGameObjectismanagedautomatically.

Top

SeeAlsoReferenceCinemachineNamespaceCinemachineCinemachineVirtualCameraBaseCinemachineLensSettingsCinemachineCinemachineComposerCinemachineCinemachineTransposerCinemachineCinemachineBasicMultiChannelPerlin




Cinemachine

CinemachineVirtualCameraConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineVirtualCamera.#ctor"]


Syntax

SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace


publicCinemachineVirtualCamera()

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraProperties




Follow GettheFollowtargetfortheBodycomponentintheCinemachinePipeline.Ifthisvcamisapartofameta-cameracollection,thentheowner'stargetusedifthelocaltargetisnull.(OverridesCinemachineVirtualCameraBase


LookAt GettheLookAttargetfortheAimcomponentintheCinemachinePipeline.Ifthisvcamisapartofameta-cameracollection,thentheowner'stargetusedifthelocaltargetisnull.(OverridesCinemachineVirtualCameraBase


ParentCamera Supportformeta-virtual-cameras.thesituationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.PrivatearmiesareimplementedasTransformchildrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase



State TheCameraStateobjectholdsalloftheinformationnecessarytopositiontheUnitycamera.Itistheoutputofthisclass.(OverridesCinemachineVirtualCameraBase

UserIsDragging APIfortheeditor,tomakethedraggingofpositionhandlesbehavebetter.



Top





Cinemachine

CinemachineVirtualCameraFollowProperty

GettheFollowtargetfortheBodycomponentintheCinemachinePipeline.Ifthisvcamisapartofameta-cameracollection,thentheowner'stargetwillbeusedifthelocaltargetisnull.


Syntax





CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraLookAtProperty

GettheLookAttargetfortheAimcomponentintheCinemachinePipeline.Ifthisvcamisapartofameta-cameracollection,thentheowner'stargetwillbeusedifthelocaltargetisnull.


Syntax





CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraStateProperty

TheCameraStateobjectholdsalloftheinformationnecessarytopositiontheUnitycamera.Itistheoutputofthisclass.


Syntax





CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraUserIsDraggingProperty

APIfortheeditor,tomakethedraggingofpositionhandlesbehavebetter.


Syntax




publicboolUserIsDragging{get;set;}

CopyC# JavaScript




Cinemachine

CinemachineVirtualCameraMethods



AddCinemachineComponentT Addacomponenttothecinemachinepipeline.

AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.becalledaftereachpipelinestage,toallowotherstohookintothepipeline.(Inheritedfrom

DestroyCinemachineComponentT Removeacomponentfromthecinemachinepipeline.



GetComponentOwner GetthehiddenCinemachinePipelinechildobject.

GetComponentPipeline Getthecomponentpipelineownedbythehiddenchildpiplinecontainer.GetCinemachineComponentmethod.

InvalidateComponentPipeline EditorAPI:Callthiswhenchangingthepipelinefromtheeditor.


IsLiveChild Checkwhetherthevcamalivechildofthiscamera.classimplementationalwaysreturnsfalse.(Inheritedfrom

MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereissometimestheneedtopushonetothetop,makingitthecurrentLivecameraifqueuewithitspeers.vcamisenabled:themostrecentonegoestothetopoftheprioritysubqueue.ofitsprioritypeers.thenthisvcamwillbecomeLive.(Inheritedfrom

OnDestroy CallstheDestroyPipelineDelegatefordestroyingthehiddenchildobject,tosupportundo.(Overrides


OnEnable Makesurethatthepipelinecacheisup-to-date.(Overrides

OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.


OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.implementationmustbecalledbyanyoverriddenmethod.(Inheritedfrom

OnValidate Enforceboundsforfields,whenchangedininspector.(Overrides

PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schild

cameras,thechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledbecalledonLateUpdateinstead.doesnothing.(Inheritedfrom

RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.(Inheritedfrom

ResolveFollow Returnsthisvcam'sFollowtarget,orifthatisnull,willretruntheparentvcam'sFollowtarget.(Inheritedfrom

ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretruntheparentvcam'sLookAttarget.(Inheritedfrom



UpdateCameraState CalledbyCinemachineCoreatLateUpdatetimecanpositionitselfandtrackitstargets.itspipelineandgenerateaCameraStateforthisframe.(OverridesCinemachineVirtualCameraBaseSingle)

Top


Cinemachine

CinemachineVirtualCameraAddCinemachineComponentMethod

Addacomponenttothecinemachinepipeline.


Syntax

TypeParameters

T

ReturnValueType:T[Missing<returns>documentationfor"M:Cinemachine.CinemachineVirtualCamera.AddCinemachineComponent``1"]



publicTAddCinemachineComponent<T>()

whereT:CinemachineComponentBase

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraDestroyCinemachineComponentMethod

Removeacomponentfromthecinemachinepipeline.


Syntax

TypeParameters

T



publicvoidDestroyCinemachineComponent<T>()


CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraGetCinemachineComponentMethod




Top





Cinemachine

CinemachineVirtualCameraGetCinemachineComponentMethod

Getanexistingcomponentofaspecifictypefromthecinemachinepipeline.


Syntax

TypeParameters

T

ReturnValueType:T[Missing<returns>documentationfor"M:Cinemachine.CinemachineVirtualCamera.GetCinemachineComponent``1"]

SeeAlsoReferenceCinemachineVirtualCameraClassGetCinemachineComponentOverloadCinemachineNamespace


publicTGetCinemachineComponent<T>()


CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraGetCinemachineComponentMethod(CinemachineCoreStage)

Getthecomponentsetforaspecificstage.


Syntax

Parameters

stageType:CinemachineCinemachineCoreStageThestageforwhichwewantthecomponent

ReturnValueType:CinemachineComponentBaseTheCinemachinecomponentforthatstage,ornullifnotdefined

SeeAlsoReferenceCinemachineVirtualCameraClassGetCinemachineComponentOverloadCinemachineNamespace

publicCinemachineComponentBaseGetCinemachineComponent

CinemachineCoreStagestage

)

CopyC# JavaScript

Cinemachine

CinemachineVirtualCameraGetComponentOwnerMethod

GetthehiddenCinemachinePipelinechildobject.


Syntax

ReturnValueType:Transform[Missing<returns>documentationfor"M:Cinemachine.CinemachineVirtualCamera.GetComponentOwner"]



publicTransformGetComponentOwner()

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraGetComponentPipelineMethod

Getthecomponentpipelineownedbythehiddenchildpiplinecontainer.Formostpurposes,itispreferabletousetheGetCinemachineComponentmethod.


Syntax

ReturnValueType:CinemachineComponentBase[Missing<returns>documentationfor"M:Cinemachine.CinemachineVirtualCamera.GetComponentPipeline"]



publicCinemachineComponentBase[]GetComponentPipeline

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraInvalidateComponentPipelineMethod

EditorAPI:Callthiswhenchangingthepipelinefromtheeditor.Willforcearebuildofthepipelinecache.


Syntax



publicvoidInvalidateComponentPipeline()

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraOnDestroyMethod

CallstheDestroyPipelineDelegatefordestroyingthehiddenchildobject,tosupportundo.


Syntax




CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraOnEnableMethod

Makesurethatthepipelinecacheisup-to-date.


Syntax




CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraOnPositionDraggedMethod

APIfortheeditor,toprocessapositiondragfromtheuser.


Syntax

Parameters

deltaType:Vector3[Missing<paramname="delta"/>documentationfor"M:Cinemachine.CinemachineVirtualCamera.OnPositionDragged(UnityEngine.Vector3)"]



publicvoidOnPositionDragged(

Vector3delta

)

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraOnValidateMethod

Enforceboundsforfields,whenchangedininspector.


Syntax




CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraUpdateCameraStateMethod

CalledbyCinemachineCoreatLateUpdatetimesothevcamcanpositionitselfandtrackitstargets.ThisclasswillinvokeitspipelineandgenerateaCameraStateforthisframe.


Syntax

Parameters

worldUpType:Vector3[Missing<paramname="worldUp"/>documentationfor"M:Cinemachine.CinemachineVirtualCamera.UpdateCameraState(UnityEngine.Vector3,System.Single)"]

deltaTimeType:SystemSingle[Missing<paramname="deltaTime"/>documentationfor"M:Cinemachine.CinemachineVirtualCamera.UpdateCameraState(UnityEngine.Vector3,System.Single)"]



Vector3worldUp,

floatdeltaTime

)

CopyC# JavaScript


Cinemachine

CinemachineVirtualCameraFields




CreatePipelineOverride Overridecomponentpipelinecreation.ThisneedstobedonebytheeditortosupportUndo.TheoverridemustdoexactlythesamethingastheCreatePipelinemethodinthisclass.

DestroyPipelineOverride Overridecomponentpipelinedestruction.ThisneedstobedonebytheeditortosupportUndo.


m_Follow Theobjectthatthecamerawantstomovewith(theBodytarget).

TheBodycomponentoftheCinemachineComponentpipelinewillrefertothistargetandpositionthevcaminaccordancewithrulesandsettingsthatareprovidedtoit.Ifthisisnull,thenthevcam'sTransformpositionwillbeused.

m_Lens SpecifiestheLensSettingsofthisVirtualCamera.ThesesettingswillbetransferredtotheUnitycamerawhenthevcamislive.


m_LookAt Theobjectthatthecamerawantstolookat(theAimtarget).AimcomponentoftheCinemachineComponentpipelinewillrefertothistargetandorientthevcaminaccordancewithrulesandsettingsthatareprovidedtoit.Ifthisisnull,thenthevcam'sTransformorientationwillbeused.



PipelineName ThisisthenameofthehiddenGameObjectthatwillbecreatedasachildobjectofthevirtualcamera.ThishiddengameobjectactsasacontainerforthepolymorphicCinemachineComponentpipeline.TheInspectorUIfortheVirtualCameraprovidesaccesstothispipleline,asdotheCinemachineComponent-familyofpublicmethodsinthisclass.lifecycleofthepipelineGameObjectismanagedautomatically.

Top





Cinemachine

CinemachineVirtualCameraCreatePipelineOverrideField



Syntax

FieldValueType:CinemachineVirtualCameraCreatePipelineDelegate



publicstaticCinemachineVirtualCameraCreatePipelineDelegate

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraDestroyPipelineOverrideField



Syntax

FieldValueType:CinemachineVirtualCameraDestroyPipelineDelegate



publicstaticCinemachineVirtualCameraDestroyPipelineDelegate

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameram_FollowField

Theobjectthatthecamerawantstomovewith(theBodytarget).TheBodycomponentoftheCinemachineComponentpipelinewillrefertothistargetandpositionthevcaminaccordancewithrulesandsettingsthatareprovidedtoit.Ifthisisnull,thenthevcam'sTransformpositionwillbeused.


Syntax




[TooltipAttribute("Theobjectthatthecamerawantstomovewith(theBodytarget).Ifthisisnull,thenthevcam'sTransformpositionwilldefinethecamera'sposition.")]



CopyC# JavaScript



Cinemachine

CinemachineVirtualCameram_LensField

SpecifiestheLensSettingsofthisVirtualCamera.ThesesettingswillbetransferredtotheUnitycamerawhenthevcamislive.


Syntax




[FormerlySerializedAsAttribute("m_LensAttributes")]

[TooltipAttribute("SpecifiesthelenspropertiesofthisVirtualCamera.ThisgenerallymirrorstheUnityCamera'slenssettings,andwillbeusedtodrivetheUnitycamerawhenthevcamisactive.")]

[LensSettingsPropertyAttribute]

publicLensSettingsm_Lens

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameram_LookAtField

Theobjectthatthecamerawantstolookat(theAimtarget).TheAimcomponentoftheCinemachineComponentpipelinewillrefertothistargetandorientthevcaminaccordancewithrulesandsettingsthatareprovidedtoit.Ifthisisnull,thenthevcam'sTransformorientationwillbeused.


Syntax




[TooltipAttribute("Theobjectthatthecamerawantstolookat(theAimtarget).Ifthisisnull,thenthevcam'sTransformorientationwilldefinethecamera'sorientation.")]



CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraPipelineNameField

ThisisthenameofthehiddenGameObjectthatwillbecreatedasachildobjectofthevirtualcamera.ThishiddengameobjectactsasacontainerforthepolymorphicCinemachineComponentpipeline.TheInspectorUIfortheVirtualCameraprovidesaccesstothispipleline,asdotheCinemachineComponent-familyofpublicmethodsinthisclass.ThelifecycleofthepipelineGameObjectismanagedautomatically.


Syntax




publicconststringPipelineName="cm"

CopyC# JavaScript




Cinemachine

CinemachineVirtualCameraCreatePipelineDelegateDelegate

Overridecomponentpipelinecreation.ThisneedstobedonebytheeditortosupportUndo.TheoverridemustdoexactlythesamethingastheCreatePipelinemethodintheCinemachineVirtualCameraclass.


Syntax

Parameters

vcamType:CinemachineCinemachineVirtualCamera

nameType:SystemString

copyFromType:CinemachineCinemachineComponentBase

ReturnValueType:Transform

SeeAlso

publicdelegateTransformCreatePipelineDelegate(

CinemachineVirtualCameravcam,

stringname,

CinemachineComponentBase[]copyFrom

)

CopyC# JavaScript


Cinemachine

CinemachineVirtualCameraDestroyPipelineDelegateDelegate



Syntax

Parameters

pipelineType:GameObject



publicdelegatevoidDestroyPipelineDelegate(

GameObjectpipeline

)

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseClass

BaseclassforaMonobehaviourthatrepresentsaVirtualCamerawithintheUnityscene.ThisisintendedtobeattachedtoanemptyTransformGameObject.InheritedclassescanbeeitherstandalonevirtualcamerassuchasCinemachineVirtualCamera,ormeta-camerassuchasCinemachineClearShotorCinemachineFreeLook.ACinemachineVirtualCameraBaseexposesaPriorityproperty.Whenthebehaviourisenabledinthegame,theVirtualCameraisautomaticallyplacedinaqueuemaintainedbythestaticCinemachineCoresingleton.Thequeueissortedbypriority.WhenaUnitycameraisequippedwithaCinemachineBrainbehaviour,thebrainwillchoosethecameraattheheadofthequeue.IfyouhavemultipleUnitycameraswithCinemachineBrainbehaviours(sayinasplit-screencontext),thenyoucanfilterthequeuebysettingthecullingflagsonthevirtualcameras.ThecullingmaskoftheUnityCamerawillthenactasafilterforthebrain.Apartfromthis,thereisnothingthatpreventsavirtualcamerafromcontrollingmultipleUnitycamerassimultaneously.

InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseMore...


SyntaxCopy


TheCinemachineVirtualCameraBasetypeexposesthefollowingmembers.


CinemachineVirtualCameraBase

Top


Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo

Follow GettheFollowtargetfortheBodycomponentintheCinemachinePipeline.

LiveChildOrSelf Justreturnsself.

LookAt GettheLookAttargetfortheAimcomponentintheCinemachinePipeline.


publicabstractclassCinemachineVirtualCameraBase

ICinemachineCamera

CopyC# JavaScript

Name GetthenameoftheVirtualCamera.BaseimplementationreturnstheownerGameObject'sname.

ParentCamera Supportformeta-virtual-cameras.Thisisthesituationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.PrivatearmiesareimplementedasTransformchildrenoftheparentvcam.

PreviousStateIsValid SetthistoforcethenextupdatetoignoredeltaTimeandresetitself

Priority GetthePriorityofthevirtualcamera.ThisdeterminesitsplacementintheCinemachineCore'squeueofeligibleshots.

State TheCameraStateobjectholdsalloftheinformationnecessarytoposition

theUnitycamera.Itistheoutputofthisclass.

ValidatingStreamVersion Versionthatwaslaststreamed,forupgradinglegacy

VirtualCameraGameObject TheGameObjectowneroftheVirtualCamerabehaviour.

Top


AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.Thiswillbecalledaftereachpipelinestage,toallowotherstohookintothepipeline.SeeCinemachineCore.Stage.

InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforallparentcameras(ifany).

IsLiveChild Checkwhetherthevcamalivechildofthiscamera.Thisbaseclassimplementationalwaysreturnsfalse.

MoveToTopOfPrioritySubqueue Whenmultiplevirtual

camerashavethehighestpriority,thereissometimestheneedtopushonetothetop,makingitthecurrentLivecameraifitsharesthehighestpriorityinthequeuewithitspeers.Thishappensautomaticallywhenanewvcamisenabled:themostrecentonegoestothetopoftheprioritysubqueue.Usethismethodtopushavcamtothetopofitsprioritypeers.Ifitanditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.



OnEnable Baseclassimplementationaddsthevirtualcamerafromthepriorityqueue.


OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.Baseclassimplementationmustbecalledbyanyoverriddenmethod.

OnValidate Enforceboundsforfields,whenchangedininspector.Callbaseclassimplementationatthebeginningofoverriddenmethod.Afterbasemethodiscalled,ValidatingStreamVersionwillbevalid.

PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,inordertoallowtheparenttoprepareitschildren.IfthechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledpriortoeveryFixedUpdate,butitmightbecalledonLateUpdateinstead.Baseclassimplementationdoesnothing.

RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.


ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretruntheparentvcam'sLookAttarget.

Start Baseclassimplementationdoesnothing.

Update Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.

UpdateCameraState CalledbyCinemachineCoreatdesignatedupdatetimethevcamcanpositionitselfandtrackitstargets.Donotcallthismethod.Lettheframeworkdoitattheappropriatetime

Top



m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.

m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.

m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthis

camera.Highernumbershavegreaterpriority.

OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.

Top


InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineBlendListCameraCinemachineCinemachineClearShotCinemachineCinemachineExternalCameraCinemachineCinemachineFreeLookCinemachineCinemachineMixingCameraCinemachineCinemachineStateDrivenCameraCinemachineCinemachineVirtualCamera





Cinemachine

CinemachineVirtualCameraBaseConstructor

[Missing<summary>documentationfor"M:Cinemachine.CinemachineVirtualCameraBase.#ctor"]


Syntax

SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace


protectedCinemachineVirtualCameraBase()

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseProperties




Follow GettheFollowtargetfortheBodycomponentintheCinemachinePipeline.

LiveChildOrSelf Justreturnsself.

LookAt GettheLookAttargetfortheAimcomponentintheCinemachinePipeline.

Name GetthenameoftheVirtualCamera.BaseimplementationreturnstheownerGameObject'sname.

ParentCamera Supportformeta-

virtual-cameras.Thisisthesituationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.PrivatearmiesareimplementedasTransformchildrenoftheparentvcam.

PreviousStateIsValid SetthistoforcethenextupdatetoignoredeltaTimeandresetitself

Priority GetthePriorityofthevirtualcamera.ThisdeterminesitsplacementintheCinemachineCore'squeueofeligibleshots.

State TheCameraStateobjectholdsalloftheinformationnecessarytopositiontheUnitycamera.Itistheoutputofthisclass.

ValidatingStreamVersion Versionthatwaslaststreamed,forupgradinglegacy

VirtualCameraGameObject TheGameObjectowneroftheVirtualCamerabehaviour.

Top





Cinemachine

CinemachineVirtualCameraBaseDescriptionProperty



Syntax




publicvirtualstringDescription{get;}

CopyC# JavaScript




Cinemachine

CinemachineVirtualCameraBaseFollowProperty

GettheFollowtargetfortheBodycomponentintheCinemachinePipeline.


Syntax




publicabstractTransformFollow{get;set;}

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseLiveChildOrSelfProperty

Justreturnsself.


Syntax




publicvirtualICinemachineCameraLiveChildOrSelf{

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseLookAtProperty

GettheLookAttargetfortheAimcomponentintheCinemachinePipeline.


Syntax




publicabstractTransformLookAt{get;set;}

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseNameProperty

GetthenameoftheVirtualCamera.BaseimplementationreturnstheownerGameObject'sname.


Syntax

PropertyValueType:StringImplementsICinemachineCameraName



publicstringName{get;}

CopyC# JavaScript




Cinemachine

CinemachineVirtualCameraBaseParentCameraProperty

Supportformeta-virtual-cameras.Thisisthesituationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.PrivatearmiesareimplementedasTransformchildrenoftheparentvcam.


Syntax

PropertyValueType:ICinemachineCameraImplementsICinemachineCameraParentCamera



publicICinemachineCameraParentCamera{get;}

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBasePreviousStateIsValidProperty

SetthistoforcethenextupdatetoignoredeltaTimeandresetitself


Syntax




publicboolPreviousStateIsValid{get;set;}

CopyC# JavaScript




Cinemachine

CinemachineVirtualCameraBasePriorityProperty

GetthePriorityofthevirtualcamera.ThisdeterminesitsplacementintheCinemachineCore'squeueofeligibleshots.


Syntax

PropertyValueType:Int32ImplementsICinemachineCameraPriority



publicintPriority{get;set;}

CopyC# JavaScript




Cinemachine

CinemachineVirtualCameraBaseStateProperty

TheCameraStateobjectholdsalloftheinformationnecessarytopositiontheUnitycamera.Itistheoutputofthisclass.


Syntax




publicabstractCameraStateState{get;}

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseValidatingStreamVersionProperty

Versionthatwaslaststreamed,forupgradinglegacy


Syntax




publicintValidatingStreamVersion{get;}

CopyC# JavaScript




Cinemachine

CinemachineVirtualCameraBaseVirtualCameraGameObjectProperty

TheGameObjectowneroftheVirtualCamerabehaviour.


Syntax

PropertyValueType:GameObjectImplementsICinemachineCameraVirtualCameraGameObject



publicGameObjectVirtualCameraGameObject{get;}

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseMethods



AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.Thiswillbecalledaftereachpipelinestage,toallowotherstohookintothepipeline.SeeCinemachineCore.Stage.

InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforallparentcameras(ifany).

IsLiveChild Checkwhetherthevcamalivechildofthiscamera.Thisbaseclassimplementationalwaysreturnsfalse.

MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereissometimestheneedtopushonetothetop,makingitthecurrent

Livecameraifitsharesthehighestpriorityinthequeuewithitspeers.Thishappensautomaticallywhenanewvcamisenabled:themostrecentonegoestothetopoftheprioritysubqueue.Usethismethodtopushavcamtothetopofitsprioritypeers.Ifitanditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.



OnEnable Baseclassimplementationaddsthevirtualcamerafromthepriorityqueue.


OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.Baseclassimplementationmustbecalledbyanyoverriddenmethod.

OnValidate Enforceboundsforfields,whenchangedininspector.Callbaseclass

implementationatthebeginningofoverriddenmethod.Afterbasemethodiscalled,ValidatingStreamVersionwillbevalid.

PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,inordertoallowtheparenttoprepareitschildren.IfthechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledpriortoeveryFixedUpdate,butitmightbecalledonLateUpdateinstead.Baseclassimplementationdoesnothing.

RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.


ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretruntheparentvcam'sLookAttarget.

Start Baseclassimplementationdoesnothing.

Update Baseclassimplementationmakessurethepriority

queueremainsup-to-date.

UpdateCameraState CalledbyCinemachineCoreatdesignatedupdatetimethevcamcanpositionitselfandtrackitstargets.Donotcallthismethod.Lettheframeworkdoitattheappropriatetime

Top





Cinemachine

CinemachineVirtualCameraBaseAddPostPipelineStageHookMethod

Adelegatetohookintothestatecalculationpipeline.Thiswillbecalledaftereachpipelinestage,toallowotherstohookintothepipeline.SeeCinemachineCore.Stage.


Syntax

Parameters

dType:CinemachineCinemachineVirtualCameraBaseOnPostPipelineStageDelegateThedelegatetocall.



publicvirtualvoidAddPostPipelineStageHook(


)

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseInvokePostPipelineStageCallbackMethod

InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforallparentcameras(ifany).


Syntax

Parameters

vcamType:CinemachineCinemachineVirtualCameraBase[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineVirtualCameraBase.InvokePostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

stageType:CinemachineCinemachineCoreStage[Missing<paramname="stage"/>documentationfor"M:Cinemachine.CinemachineVirtualCameraBase.InvokePostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

newStateType:CinemachineCameraState[Missing<paramname="newState"/>documentationfor"M:Cinemachine.CinemachineVirtualCameraBase.InvokePostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]

protectedvoidInvokePostPipelineStageCallback(



refCameraStatenewState,

floatdeltaTime

)

CopyC# JavaScript

deltaTimeType:SystemSingle[Missing<paramname="deltaTime"/>documentationfor"M:Cinemachine.CinemachineVirtualCameraBase.InvokePostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]






Cinemachine

CinemachineVirtualCameraBaseIsLiveChildMethod

Checkwhetherthevcamalivechildofthiscamera.Thisbaseclassimplementationalwaysreturnsfalse.


Syntax

Parameters



SeeAlsoReferenceCinemachineVirtualCameraBaseClass

publicvirtualboolIsLiveChild(


)

CopyC# JavaScript


Cinemachine

CinemachineVirtualCameraBaseMoveToTopOfPrioritySubqueueMethod

Whenmultiplevirtualcamerashavethehighestpriority,thereissometimestheneedtopushonetothetop,makingitthecurrentLivecameraifitsharesthehighestpriorityinthequeuewithitspeers.Thishappensautomaticallywhenanewvcamisenabled:themostrecentonegoestothetopoftheprioritysubqueue.Usethismethodtopushavcamtothetopofitsprioritypeers.Ifitanditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.


Syntax



publicvoidMoveToTopOfPrioritySubqueue()

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseOnDestroyMethod

Baseclassimplementationremovesthevirtualcamerafromthepriorityqueue.


Syntax



protectedvirtualvoidOnDestroy()

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseOnDisableMethod

Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.


Syntax



protectedvirtualvoidOnDisable()

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseOnEnableMethod

Baseclassimplementationaddsthevirtualcamerafromthepriorityqueue.


Syntax



protectedvirtualvoidOnEnable()

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseOnTransformParentChangedMethod



Syntax



protectedvirtualvoidOnTransformParentChanged()

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseOnTransitionFromCameraMethod

Notificationthatthisvirtualcameraisgoinglive.Baseclassimplementationmustbecalledbyanyoverriddenmethod.


Syntax

Parameters





publicvirtualvoidOnTransitionFromCamera(


)

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseOnValidateMethod

Enforceboundsforfields,whenchangedininspector.Callbaseclassimplementationatthebeginningofoverriddenmethod.Afterbasemethodiscalled,ValidatingStreamVersionwillbevalid.


Syntax



protectedvirtualvoidOnValidate()

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBasePreUpdateChildCamerasMethod

Thisiscalledpriortotheupdatingofthevcam'schildcameras,inordertoallowtheparenttoprepareitschildren.IfthechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledpriortoeveryFixedUpdate,butitmightbecalledonLateUpdateinstead.Baseclassimplementationdoesnothing.


Syntax

Parameters



ImplementsICinemachineCameraPreUpdateChildCameras(Vector3,Single)

SeeAlso

publicvirtualvoidPreUpdateChildCameras(

Vector3worldUp,

floatdeltaTime

)

CopyC# JavaScript


ReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace




Cinemachine

CinemachineVirtualCameraBaseRemovePostPipelineStageHookMethod

RemoveaPipelinestagehookcallback.


Syntax

Parameters




publicvirtualvoidRemovePostPipelineStageHook(


)

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseResolveFollowMethod

Returnsthisvcam'sFollowtarget,orifthatisnull,willretruntheparentvcam'sFollowtarget.


Syntax

Parameters

localFollowType:TransformThisvcam'sFollowvalue.

ReturnValueType:TransformThesamevalue,ortheparent'sifnullandaparentexists.



protectedTransformResolveFollow(

TransformlocalFollow

)

CopyC# JavaScript


Cinemachine

CinemachineVirtualCameraBaseResolveLookAtMethod

Returnsthisvcam'sLookAttarget,orifthatisnull,willretruntheparentvcam'sLookAttarget.


Syntax

Parameters

localLookAtType:TransformThisvcam'sLookAtvalue.

ReturnValueType:TransformThesamevalue,ortheparent'sifnullandaparentexists.



protectedTransformResolveLookAt(

TransformlocalLookAt

)

CopyC# JavaScript


Cinemachine

CinemachineVirtualCameraBaseStartMethod

Baseclassimplementationdoesnothing.


Syntax



protectedvirtualvoidStart()

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseUpdateMethod



Syntax



protectedvirtualvoidUpdate()

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseUpdateCameraStateMethod

CalledbyCinemachineCoreatdesignatedupdatetimesothevcamcanpositionitselfandtrackitstargets.Donotcallthismethod.Lettheframeworkdoitattheappropriatetime


Syntax

Parameters




SeeAlsoReference

publicabstractvoidUpdateCameraState(

Vector3worldUp,

floatdeltaTime

)

CopyC# JavaScript


CinemachineVirtualCameraBaseClassCinemachineNamespace




Cinemachine

CinemachineVirtualCameraBaseFields




m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.

m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.

m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.

OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaion

mustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.

Top





Cinemachine

CinemachineVirtualCameraBaseCinemachineGUIDebuggerCallbackField

Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.


Syntax




[HideInInspector]


publicActionCinemachineGUIDebuggerCallback

CopyC# JavaScript




Cinemachine

CinemachineVirtualCameraBasem_ExcludedPropertiesInInspectorField

Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.


Syntax




[HideInInspector]

[SerializeField]


publicstring[]m_ExcludedPropertiesInInspector

CopyC# JavaScript




Cinemachine

CinemachineVirtualCameraBasem_LockStageInInspectorField

Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.


Syntax

FieldValueType:CinemachineCoreStage



[HideInInspector]

[SerializeField]


publicCinemachineCoreStage[]m_LockStageInInspector

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBasem_PriorityField

Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.


Syntax





[TooltipAttribute("Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.")]

publicintm_Priority

CopyC# JavaScript




Cinemachine

CinemachineVirtualCameraBaseOnPostPipelineStageField

Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.


Syntax

FieldValueType:CinemachineVirtualCameraBaseOnPostPipelineStageDelegate



protectedCinemachineVirtualCameraBaseOnPostPipelineStageDelegate

CopyC# JavaScript



Cinemachine

CinemachineVirtualCameraBaseOnPostPipelineStageDelegateDelegate

Adelegatetohookintothestatecalculationpipeline.Thiswillbecalledaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.Parameters:*CinemachineVirtualCameraBasevcam:thevirtualcamerabeingupdated*CinemachineCore.Stagestage:whatstageinthepipelinehasjustbeenupdated*refCameraStatenewState:thecurrentstateofthevcam*floatdeltaTime:theframetimestep.Lessthan0means"don'tconsiderthepreviousframe"


Syntax

Parameters

vcamType:CinemachineCinemachineVirtualCameraBase

stageType:CinemachineCinemachineCoreStage

newState

publicdelegatevoidOnPostPipelineStageDelegate(



refCameraStatenewState,

floatdeltaTime

)

CopyC# JavaScript

Type:CinemachineCameraStatedeltaTime

Type:SystemSingle






Cinemachine

DocumentationSortingAttributeClass

Atrtributetocontroltheautomaticgenerationofdocumentation.

InheritanceHierarchySystemObjectSystemAttributeCinemachineDocumentationSortingAttribute


Syntax

TheDocumentationSortingAttributetypeexposesthefollowingmembers.


DocumentationSortingAttribute Contructorwithspecificvalues

Top

Properties


publicsealedclassDocumentationSortingAttribute:

CopyC# JavaScript



Name Description

Category Refinementlevelofthedocumentation.Themorerefined,themoreisexcluded.

SortOrder Wherethistypeappearsinthemanual.Smallernumbersortearlier.

Top





Cinemachine

DocumentationSortingAttributeConstructor

Contructorwithspecificvalues


Syntax

Parameters

sortOrderType:SystemSingle[Missing<paramname="sortOrder"/>documentationfor"M:Cinemachine.DocumentationSortingAttribute.#ctor(System.Single,Cinemachine.DocumentationSortingAttribute.Level)"]

categoryType:CinemachineDocumentationSortingAttributeLevel[Missing<paramname="category"/>documentationfor"M:Cinemachine.DocumentationSortingAttribute.#ctor(System.Single,Cinemachine.DocumentationSortingAttribute.Level)"]

SeeAlsoReferenceDocumentationSortingAttributeClassCinemachineNamespace

publicDocumentationSortingAttribute(

floatsortOrder,

DocumentationSortingAttributeLevelcategory

)

CopyC# JavaScript


Cinemachine

DocumentationSortingAttributeProperties

TheDocumentationSortingAttributetypeexposesthefollowingmembers.


Category Refinementlevelofthedocumentation.Themorerefined,themoreisexcluded.

SortOrder Wherethistypeappearsinthemanual.Smallernumbersortearlier.

Top





Cinemachine

DocumentationSortingAttributeCategoryProperty

Refinementlevelofthedocumentation.Themorerefined,themoreisexcluded.


Syntax

PropertyValueType:DocumentationSortingAttributeLevel



publicDocumentationSortingAttributeLevelCategory{

CopyC# JavaScript



Cinemachine

DocumentationSortingAttributeSortOrderProperty

Wherethistypeappearsinthemanual.Smallernumbersortearlier.


Syntax




publicfloatSortOrder{get;}

CopyC# JavaScript




Cinemachine

DocumentationSortingAttributeLevelEnumeration

Refinementlevelofthedocumentation


Syntax

Members


Undoc 0 Typeisexcludedfromdocumentation

API 1 TypeisdocumentedintheAPIreference

UserRef 2 Typeisdocumentedinthehighly-refinedUserManual


publicenumLevel

CopyC# JavaScript

Cinemachine

ICinemachineCameraInterface

AnabstractrepresentationofavirtualcamerawhichliveswithintheUnityscene


Syntax

TheICinemachineCameratypeexposesthefollowingmembers.



Follow Thethingthecamerawantstofollow(movingcamera).Maybenull.

LiveChildOrSelf Forcamerasthatimplementchildcameras,returnthelivechild,otherwise,justreturnsself.

publicinterfaceICinemachineCamera

CopyC# JavaScript

LookAt Thethingthecamerawantstolookat(aim).Maybenull.

Name Getsthenameofthisvirtualcamera.Forusewhendecidinghowtoblendtoorfromthiscamera

ParentCamera Forcamerasthatimplementchildcameras,returnstheparentvcam,otherwisenull.

Priority GetsthepriorityofthisICinemachineCamera.Thevirtualcamerawillbeinsertedintotheglobalprioritystackbasedonthisvalue.

State Camerastateatthecurrenttime.

VirtualCameraGameObject Getsthevirtualcameragameattachedtothisclass.

Top


IsLiveChild Checkwhetherthevcamisalivechildofthiscamera.

OnTransitionFromCamera Notificationthatanewcameraisbeingactivated.

thecurrentlyactivecamera.Bothmaybeactivesimultaneouslyforawhile,ifblending.

PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,inordertoallowtheparenttoprepareitschildren.childrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledpriortoeveryFixedUpdate,butitmightbecalledonLateUpdateinstead.

UpdateCameraState UpdatesthisCinemachineCamera.Foranactivecamerathisshouldbecalledonceandonlyonceeachframe.this,youshouldnevercallthismethoddirectly.CinemachineCore.UpdateVirtualCamera(ICinemachineCamera,float),whichhasprotectionagainstmultiplecallsperframe.

Top





Cinemachine

ICinemachineCameraProperties




Follow Thethingthecamerawantstofollow(movingcamera).Maybenull.

LiveChildOrSelf Forcamerasthatimplementchildcameras,returnthelivechild,otherwise,justreturnsself.

LookAt Thethingthecamerawantstolookat(aim).Maybenull.

Name Getsthenameofthisvirtualcamera.Forusewhendecidinghowtoblendtoorfromthiscamera

ParentCamera Forcamerasthatimplementchildcameras,returnsthe

parentvcam,otherwisenull.

Priority GetsthepriorityofthisICinemachineCamera.Thevirtualcamerawillbeinsertedintotheglobalprioritystackbasedonthisvalue.

State Camerastateatthecurrenttime.

VirtualCameraGameObject Getsthevirtualcameragameattachedtothisclass.

Top

SeeAlsoReferenceICinemachineCameraInterfaceCinemachineNamespace




Cinemachine

ICinemachineCameraDescriptionProperty



Syntax




stringDescription{get;}

CopyC# JavaScript




Cinemachine

ICinemachineCameraFollowProperty

Thethingthecamerawantstofollow(movingcamera).Maybenull.


Syntax




TransformFollow{get;set;}

CopyC# JavaScript



Cinemachine

ICinemachineCameraLiveChildOrSelfProperty

Forcamerasthatimplementchildcameras,returnthelivechild,otherwise,justreturnsself.


Syntax




ICinemachineCameraLiveChildOrSelf{get;}

CopyC# JavaScript



Cinemachine

ICinemachineCameraLookAtProperty

Thethingthecamerawantstolookat(aim).Maybenull.


Syntax




TransformLookAt{get;set;}

CopyC# JavaScript



Cinemachine

ICinemachineCameraNameProperty

Getsthenameofthisvirtualcamera.Forusewhendecidinghowtoblendtoorfromthiscamera


Syntax




stringName{get;}

CopyC# JavaScript




Cinemachine

ICinemachineCameraParentCameraProperty

Forcamerasthatimplementchildcameras,returnstheparentvcam,otherwisenull.


Syntax




ICinemachineCameraParentCamera{get;}

CopyC# JavaScript



Cinemachine

ICinemachineCameraPriorityProperty

GetsthepriorityofthisICinemachineCamera.Thevirtualcamerawillbeinsertedintotheglobalprioritystackbasedonthisvalue.


Syntax




intPriority{get;set;}

CopyC# JavaScript




Cinemachine

ICinemachineCameraStateProperty

Camerastateatthecurrenttime.


Syntax




CameraStateState{get;}

CopyC# JavaScript



Cinemachine

ICinemachineCameraVirtualCameraGameObjectProperty

Getsthevirtualcameragameattachedtothisclass.


Syntax

PropertyValueType:GameObject



GameObjectVirtualCameraGameObject{get;}

CopyC# JavaScript



Cinemachine

ICinemachineCameraMethods



IsLiveChild Checkwhetherthevcamisalivechildofthiscamera.

OnTransitionFromCamera Notificationthatanewcameraisbeingactivated.thecurrentlyactivecamera.Bothmaybeactivesimultaneouslyforawhile,ifblending.

PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,inordertoallowtheparenttoprepareitschildren.childrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledpriortoeveryFixedUpdate,butitmightbecalledonLateUpdateinstead.

UpdateCameraState UpdatesthisCinemachineCamera.Foranactivecamerathisshouldbecalledonceandonlyonceeachframe.this,youshouldnevercallthismethoddirectly.CinemachineCore.UpdateVirtualCamera(ICinemachineCamera,float),whichhasprotectionagainstmultiplecallsperframe.

Top




Cinemachine

ICinemachineCameraIsLiveChildMethod

Checkwhetherthevcamisalivechildofthiscamera.


Syntax

Parameters


ReturnValueType:BooleanTrueifthevcamiscurrentlyactivelyinfluencingthestateofthisvcam



boolIsLiveChild(


)

CopyC# JavaScript



Cinemachine

ICinemachineCameraOnTransitionFromCameraMethod

Notificationthatanewcameraisbeingactivated.Thisissenttothecurrentlyactivecamera.Bothmaybeactivesimultaneouslyforawhile,ifblending.


Syntax

Parameters




voidOnTransitionFromCamera(


)

CopyC# JavaScript



Cinemachine

ICinemachineCameraPreUpdateChildCamerasMethod

Thisiscalledpriortotheupdatingofthevcam'schildcameras,inordertoallowtheparenttoprepareitschildren.IfthechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledpriortoeveryFixedUpdate,butitmightbecalledonLateUpdateinstead.


Syntax

Parameters




voidPreUpdateChildCameras(

Vector3worldUp,

floatdeltaTime

)

CopyC# JavaScript


Cinemachine

ICinemachineCameraUpdateCameraStateMethod

UpdatesthisCinemachineCamera.Foranactivecamerathisshouldbecalledonceandonlyonceeachframe.Toguaranteethis,youshouldnevercallthismethoddirectly.AlwaysuseCinemachineCore.UpdateVirtualCamera(ICinemachineCamera,float),whichhasprotectionagainstmultiplecallsperframe.


Syntax

Parameters



SeeAlsoReferenceICinemachineCameraInterface

voidUpdateCameraState(

Vector3worldUp,

floatdeltaTime

)

CopyC# JavaScript


Cinemachine

LensSettingsStructure

DescribestheFOVandclipplanesforacamera.ThisgenerallymirrorstheUnityCamera'slenssettings,andwillbeusedtodrivetheUnitycamerawhenthevcamisactive.


Syntax

TheLensSettingstypeexposesthefollowingmembers.


LensSettings ExplicitconstructorforthisLensSettings

Top


FromCamera CreatesanewLensSettings,copyingthevaluesfromthe



publicstructLensSettings

CopyC# JavaScript

suppliedCamera

Lerp LinearlyblendsthefieldsoftwoLensSettingsandreturnstheresult

Validate Makesurelenssettingsaresane.CallthisfromOnValidate().

Top


Default DefaultLensSettings

Dutch Thedutch(tilt)tobeappliedtothecamera.Indegrees

FarClipPlane ThefarclipplaneforthisLensSettings

FieldOfView Thisisthecameraviewinverticaldegrees.Forcinematicpeople,a50mmlensonasuper-35mmsensorwouldequala19.6degreeFOV

NearClipPlane ThenearclipplaneforthisLensSettings

OrthographicSize Whenusinganorthographiccamera,thisdefinestheheight,inworldco-ordinates,ofthecameraview.

Top

SeeAlso

Cinemachine

LensSettingsConstructor

ExplicitconstructorforthisLensSettings


Syntax

Parameters

fovType:SystemSingleTheVerticalfieldofview

orthographicSizeType:SystemSingleIforthographic,thisisthehalf-heightofthescreen

nearClipType:SystemSingleThenearclipplane

farClipType:SystemSingleThefarclipplane

publicLensSettings(

floatfov,

floatorthographicSize,

floatnearClip,

floatfarClip,

floatdutch,

boolortho,

floataspect

)

CopyC# JavaScript





dutchType:SystemSingleCameraroll,indegrees.ThisisappliedattheendWhetherthelensisorthographicTheaspectratioofthelensWidth/heightaftershotcomposition.

orthoType:SystemBoolean[Missing<paramname="ortho"/>documentationfor"M:Cinemachine.LensSettings.#ctor(System.Single,System.Single,System.Single,System.Single,System.Single,System.Boolean,System.Single)"]

aspectType:SystemSingle[Missing<paramname="aspect"/>documentationfor"M:Cinemachine.LensSettings.#ctor(System.Single,System.Single,System.Single,System.Single,System.Single,System.Boolean,System.Single)"]

SeeAlsoReferenceLensSettingsStructureCinemachineNamespace







Cinemachine

LensSettingsMethods



FromCamera CreatesanewLensSettings,copyingthevaluesfromthesuppliedCamera

Lerp LinearlyblendsthefieldsoftwoLensSettingsandreturnstheresult

Validate Makesurelenssettingsaresane.CallthisfromOnValidate().

Top





Cinemachine

LensSettingsFromCameraMethod

CreatesanewLensSettings,copyingthevaluesfromthesuppliedCamera


Syntax

Parameters

fromCameraType:CameraTheCamerafromwhichtheFoV,nearandfarclipplaneswillbecopied.

ReturnValueType:LensSettings[Missing<returns>documentationfor"M:Cinemachine.LensSettings.FromCamera(UnityEngine.Camera)"]


publicstaticLensSettingsFromCamera(

CamerafromCamera

)

CopyC# JavaScript

Cinemachine

LensSettingsLerpMethod

LinearlyblendsthefieldsoftwoLensSettingsandreturnstheresult


Syntax

Parameters

lensAType:CinemachineLensSettingsTheLensSettingstoblendfrom

lensBType:CinemachineLensSettingsTheLensSettingstoblendto

tType:SystemSingleTheinterpolationvalue.Internallyclampedtotherange[0,1]

ReturnValueType:LensSettingsInterpolatedsettings

SeeAlso

publicstaticLensSettingsLerp(

LensSettingslensA,

LensSettingslensB,

floatt

)

CopyC# JavaScript


ReferenceLensSettingsStructureCinemachineNamespace




Cinemachine

LensSettingsValidateMethod

Makesurelenssettingsaresane.CallthisfromOnValidate().


Syntax




CopyC# JavaScript



Cinemachine

LensSettingsFields



Default DefaultLensSettings

Dutch Thedutch(tilt)tobeappliedtothecamera.Indegrees

FarClipPlane ThefarclipplaneforthisLensSettings

FieldOfView Thisisthecameraviewinverticaldegrees.Forcinematicpeople,a50mmlensonasuper-35mmsensorwouldequala19.6degreeFOV

NearClipPlane ThenearclipplaneforthisLensSettings

OrthographicSize Whenusinganorthographiccamera,thisdefinestheheight,inworldco-ordinates,ofthecameraview.

Top

SeeAlsoReferenceLensSettingsStructure

Cinemachine

LensSettingsDefaultField

DefaultLensSettings


Syntax




publicstaticLensSettingsDefault

CopyC# JavaScript



Cinemachine

LensSettingsDutchField

Thedutch(tilt)tobeappliedtothecamera.Indegrees


Syntax




[RangeAttribute(-180f,180f)]

[TooltipAttribute("CameraZroll,ortilt,indegrees.")]

publicfloatDutch

CopyC# JavaScript




Cinemachine

LensSettingsFarClipPlaneField

ThefarclipplaneforthisLensSettings


Syntax




[TooltipAttribute("Thisdefinesthefarregionoftherenderablerangeofthecamerafrustum.Typicallyyouwanttosetthisvalueaslowaspossiblewithoutcuttingoffdesireddistantobjects")]

publicfloatFarClipPlane

CopyC# JavaScript




Cinemachine

LensSettingsFieldOfViewField

Thisisthecameraviewinverticaldegrees.Forcinematicpeople,a50mmlensonasuper-35mmsensorwouldequala19.6degreeFOV


Syntax





[TooltipAttribute("Thisisthecameraviewinverticaldegrees.Forcinematicpeople,a50mmlensonasuper-35mmsensorwouldequala19.6degreeFOV")]

publicfloatFieldOfView

CopyC# JavaScript




Cinemachine

LensSettingsNearClipPlaneField

ThenearclipplaneforthisLensSettings


Syntax




[TooltipAttribute("Thisdefinesthenearregionintherenderablerangeofthecamerafrustum.Raisingthisvaluewillstopthegamefromdrawingthingsnearthecamera,whichcansometimescomeinhandy.Largervalueswillalsoincreaseyourshadowresolution.")]

publicfloatNearClipPlane

CopyC# JavaScript




Cinemachine

LensSettingsOrthographicSizeField

Whenusinganorthographiccamera,thisdefinestheheight,inworldco-ordinates,ofthecameraview.


Syntax




[TooltipAttribute("Whenusinganorthographiccamera,thisdefinesthehalf-height,inworldcoordinates,ofthecameraview.")]

publicfloatOrthographicSize

CopyC# JavaScript




Cinemachine

LensSettingsPropertyAttributeClass

PropertyappliedtoLensSettings.Usedforcustomdrawingintheinspector.

InheritanceHierarchySystemObjectSystemAttributePropertyAttributeCinemachineLensSettingsPropertyAttribute


Syntax

TheLensSettingsPropertyAttributetypeexposesthefollowingmembers.


LensSettingsPropertyAttribute

Top

SeeAlso

publicsealedclassLensSettingsPropertyAttribute:

CopyC# JavaScript



Cinemachine

LensSettingsPropertyAttributeConstructor

[Missing<summary>documentationfor"M:Cinemachine.LensSettingsPropertyAttribute.#ctor"]


Syntax

SeeAlsoReferenceLensSettingsPropertyAttributeClassCinemachineNamespace


publicLensSettingsPropertyAttribute()

CopyC# JavaScript



Cinemachine

NoiseSettingsClass

Thisisanassetthatdefinesanoiseprofile.Anoiseprofileistheshapeofthenoiseasafunctionoftime.Youcanbuildarbitrarilycomplexshapesbycombiningdifferentbaseperlinnoisefrequenciesatdifferentamplitudes.Thefrequenciesandamplitudesshouldbechosenwithcare,toensureaninterestingnoisequalitythatisnotobviouslyrepetitive.Asamathematicalside-note,anyarbitraryperiodiccurvecanbebrokendownintoaseriesoffixed-amplitudesine-wavesaddedtogether.Thisiscalledfourierdecomposition,andisthebasisofmuchsignalprocessing.Itdoesn'treallyhavemuchtodowiththisasset,butit'ssuperinteresting!

InheritanceHierarchySystemObjectObjectScriptableObjectCinemachineNoiseSettings


Syntax

TheNoiseSettingstypeexposesthefollowingmembers.



publicsealedclassNoiseSettings:ScriptableObject

CopyC# JavaScript


NoiseSettings

Top


OrientationNoise GetsthearrayoforientationnoisechannelsforthisNoiseSettings

PositionNoise GetsthearrayofpositionalnoisechannelsforthisNoiseSettings

Top





Cinemachine

NoiseSettingsConstructor

[Missing<summary>documentationfor"M:Cinemachine.NoiseSettings.#ctor"]


Syntax

SeeAlsoReferenceNoiseSettingsClassCinemachineNamespace


publicNoiseSettings()

CopyC# JavaScript



Cinemachine

NoiseSettingsProperties

TheNoiseSettingstypeexposesthefollowingmembers.


OrientationNoise GetsthearrayoforientationnoisechannelsforthisNoiseSettings

PositionNoise GetsthearrayofpositionalnoisechannelsforthisNoiseSettings

Top





Cinemachine

NoiseSettingsOrientationNoiseProperty

GetsthearrayoforientationnoisechannelsforthisNoiseSettings


Syntax

PropertyValueType:NoiseSettingsTransformNoiseParams



publicNoiseSettingsTransformNoiseParams[]OrientationNoise

CopyC# JavaScript



Cinemachine

NoiseSettingsPositionNoiseProperty

GetsthearrayofpositionalnoisechannelsforthisNoiseSettings


Syntax

PropertyValueType:NoiseSettingsTransformNoiseParams



publicNoiseSettingsTransformNoiseParams[]PositionNoise

CopyC# JavaScript



Cinemachine

NoiseSettingsNoiseParamsStructure

Describesthebehaviourforachannelofnoise


Syntax

TheNoiseSettingsNoiseParamstypeexposesthefollowingmembers.


Amplitude Theamplitudeofthenoiseforthischannel.Largernumbersvibratehigher

Frequency Thefrequencyofnoiseforthischannel.Highermagnitudesvibratefaster

Top

SeeAlso



publicstructNoiseParams

CopyC# JavaScript

Cinemachine

NoiseParamsFields

TheNoiseSettingsNoiseParamstypeexposesthefollowingmembers.


Amplitude Theamplitudeofthenoiseforthischannel.Largernumbersvibratehigher

Frequency Thefrequencyofnoiseforthischannel.Highermagnitudesvibratefaster

Top

SeeAlsoReferenceNoiseSettingsNoiseParamsStructureCinemachineNamespace




Cinemachine

NoiseSettingsNoiseParamsAmplitudeField

Theamplitudeofthenoiseforthischannel.Largernumbersvibratehigher


Syntax




[TooltipAttribute("Theamplitudeofthenoiseforthischannel.Largernumbersvibratehigher.")]

publicfloatAmplitude

CopyC# JavaScript




Cinemachine

NoiseSettingsNoiseParamsFrequencyField

Thefrequencyofnoiseforthischannel.Highermagnitudesvibratefaster


Syntax




[TooltipAttribute("Thefrequencyofnoiseforthischannel.Highermagnitudesvibratefaster.")]

publicfloatFrequency

CopyC# JavaScript




Cinemachine

NoiseSettingsTransformNoiseParamsStructure

Containsthebehaviourofnoiseforthenoisemoduleforall3cardinalaxesofthecamera


Syntax

TheNoiseSettingsTransformNoiseParamstypeexposesthefollowingmembers.


X NoisedefinitionforX-axis

Y NoisedefinitionforY-axis

Z NoisedefinitionforZ-axis

Top

SeeAlso



publicstructTransformNoiseParams

CopyC# JavaScript

Cinemachine

TransformNoiseParamsFields

TheNoiseSettingsTransformNoiseParamstypeexposesthefollowingmembers.


X NoisedefinitionforX-axis

Y NoisedefinitionforY-axis

Z NoisedefinitionforZ-axis

Top

SeeAlsoReferenceNoiseSettingsTransformNoiseParamsStructureCinemachineNamespace




Cinemachine

NoiseSettingsTransformNoiseParamsField

NoisedefinitionforX-axis


Syntax

FieldValueType:NoiseSettingsNoiseParams



[TooltipAttribute("NoisedefinitionforX-axis")]

publicNoiseSettingsNoiseParamsX

CopyC# JavaScript



Cinemachine


NoisedefinitionforY-axis


Syntax




[TooltipAttribute("NoisedefinitionforY-axis")]

publicNoiseSettingsNoiseParamsY

CopyC# JavaScript



Cinemachine


NoisedefinitionforZ-axis


Syntax




[TooltipAttribute("NoisedefinitionforZ-axis")]

publicNoiseSettingsNoiseParamsZ

CopyC# JavaScript



Cinemachine

NoSaveDuringPlayAttributeClass

Suppressesplay-mode-saveforafield.Useitifthecalseehas[SaveDuringPlay]attributebuttherearefieldsintheclassthatshouldn'tbesaved.

InheritanceHierarchySystemObjectSystemAttributePropertyAttributeCinemachineNoSaveDuringPlayAttribute


Syntax

TheNoSaveDuringPlayAttributetypeexposesthefollowingmembers.


NoSaveDuringPlayAttribute

Top

SeeAlso

publicsealedclassNoSaveDuringPlayAttribute:PropertyAttribute

CopyC# JavaScript



Cinemachine

NoSaveDuringPlayAttributeConstructor

[Missing<summary>documentationfor"M:Cinemachine.NoSaveDuringPlayAttribute.#ctor"]


Syntax

SeeAlsoReferenceNoSaveDuringPlayAttributeClassCinemachineNamespace


publicNoSaveDuringPlayAttribute()

CopyC# JavaScript



Cinemachine

SaveDuringPlayAttributeClass

Invokeplay-mode-saveforaclass.Thisclass'sfieldswillbescanneduponexitingplaymode,anditspropertyvalueswillbeappliedtothesceneobject.ThisisastopgapmeasurethatwillbecomeobsoleteonceUnityimplementsplay-mode-saveinamoregeneralway.

InheritanceHierarchySystemObjectSystemAttributeCinemachineSaveDuringPlayAttribute


Syntax

TheSaveDuringPlayAttributetypeexposesthefollowingmembers.


SaveDuringPlayAttribute

Top

SeeAlsoReference

publicsealedclassSaveDuringPlayAttribute:Attribute

CopyC# JavaScript



Cinemachine

SaveDuringPlayAttributeConstructor

[Missing<summary>documentationfor"M:Cinemachine.SaveDuringPlayAttribute.#ctor"]


Syntax

SeeAlsoReferenceSaveDuringPlayAttributeClassCinemachineNamespace


publicSaveDuringPlayAttribute()

CopyC# JavaScript



Cinemachine

Cinemachine.UtilityNamespace

Cinemachinenon-domainutilitiesandUnityextensionsandhelpers

Classes Class Description

CinemachineGameWindowDebug ManagesonscreenpositionsforCinemachinedebuggingoutput

Damper UtilitytoperformrealisticdampingoffloatorVector3values.Thealgorithmisbasedonexponentiallydecayingthedeltauntilonlyanegligibleamountremains.

ReflectionHelpers Anad-hoccollectionofhelpersforreflection,usedby

Cinemachineoritseditortoolsinvariousplaces

UnityQuaternionExtensions ExtentionstotheQuaternionclass,useninvariousplacesbyCinemachine

UnityRectExtensions Ad-hocxxtentionstotheRectstructure,usedbyCinemachine

UnityVectorExtensions ExtensionstotheVector3class,usedbyCinemachine




Cinemachine

CinemachineGameWindowDebugClass

ManagesonscreenpositionsforCinemachinedebuggingoutput

InheritanceHierarchySystemObjectCinemachine.UtilityCinemachineGameWindowDebug

Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)

Syntax

TheCinemachineGameWindowDebugtypeexposesthefollowingmembers.


CinemachineGameWindowDebug

Top


GetScreenPos Reserveanon-screen

publicclassCinemachineGameWindowDebug

CopyC# JavaScript


rectanglefordebuggingoutput.

ReleaseScreenPos ReleaseascreenrectanglepreviouslyobtainedthroughGetScreenPos()

Top

SeeAlsoReferenceCinemachine.UtilityNamespace




Cinemachine

CinemachineGameWindowDebugConstructor

[Missing<summary>documentationfor"M:Cinemachine.Utility.CinemachineGameWindowDebug.#ctor"]


Syntax

SeeAlsoReferenceCinemachineGameWindowDebugClassCinemachine.UtilityNamespace


publicCinemachineGameWindowDebug()

CopyC# JavaScript



Cinemachine

CinemachineGameWindowDebugMethods

TheCinemachineGameWindowDebugtypeexposesthefollowingmembers.


GetScreenPos Reserveanon-screenrectanglefordebuggingoutput.

ReleaseScreenPos ReleaseascreenrectanglepreviouslyobtainedthroughGetScreenPos()

Top





Cinemachine

CinemachineGameWindowDebugGetScreenPosMethod

Reserveanon-screenrectanglefordebuggingoutput.


Syntax

Parameters

clientType:ObjectTheclientcaller.Thisisusedasahandle.

textType:SystemStringSampletext,fordeterminingrectanglesize

styleType:GUIStyleWhatstylewillbeusedtodraw,usedherefordeterminingrectsize

ReturnValueType:RectAnareaonthegamescreenlargeenoughtoprintthetextinthe

publicstaticRectGetScreenPos(

Objectclient,

stringtext,

GUIStylestyle

)

CopyC# JavaScript


styleindicated





Cinemachine

CinemachineGameWindowDebugReleaseScreenPosMethod

ReleaseascreenrectanglepreviouslyobtainedthroughGetScreenPos()


Syntax

Parameters

clientType:ObjectTheclientcaller.Usedasahandle.



publicstaticvoidReleaseScreenPos(

Objectclient

)

CopyC# JavaScript



Cinemachine

DamperClass

UtilitytoperformrealisticdampingoffloatorVector3values.Thealgorithmisbasedonexponentiallydecayingthedeltauntilonlyanegligibleamountremains.

InheritanceHierarchySystemObjectCinemachine.UtilityDamper


Syntax

TheDampertypeexposesthefollowingmembers.


Damp(Single,Single,Single)

Getadampedversionofaquantity.Thisistheportionofthequantitythatwilltakeeffectoverthegiventime.

Damp(Vector3,Single,Single)


publicstaticclassDamper

CopyC# JavaScript


Damp(Vector3,Vector3,Single)


Top


kNegligibleResidual Standardresidual

Top





Cinemachine

DamperMethods








Top

SeeAlsoReferenceDamperClassCinemachine.UtilityNamespace




Cinemachine

DamperDampMethod








Top





Cinemachine

DamperDampMethod(Single,Single,Single)



Syntax

Parameters

initialType:SystemSingleTheamountthatwillbedamped

dampTimeType:SystemSingleTherateofdamping.Thisisthetimeitwouldtaketoreducetheoriginalamounttoanegligiblepercentage

deltaTimeType:SystemSingleThetimeoverwhichtodamp

ReturnValueType:Single

publicstaticfloatDamp(

floatinitial,

floatdampTime,

floatdeltaTime

)

CopyC# JavaScript





Thedampedamount.Thiswillbetheoriginalamountscaledbyavaluebetween0and1.

SeeAlsoReferenceDamperClassDampOverloadCinemachine.UtilityNamespace




Cinemachine

DamperDampMethod(Vector3,Single,Single)



Syntax

Parameters

initialType:Vector3Theamountthatwillbedamped

dampTimeType:SystemSingleTherateofdamping.Thisisthetimeitwouldtaketoreducetheoriginalamounttoanegligiblepercentage


ReturnValueType:Vector3

publicstaticVector3Damp(

Vector3initial,

floatdampTime,

floatdeltaTime

)

CopyC# JavaScript



Cinemachine

DamperDampMethod(Vector3,Vector3,Single)



Syntax

Parameters

initialType:Vector3Theamountthatwillbedamped

dampTimeType:Vector3Therateofdamping.Thisisthetimeitwouldtaketoreducetheoriginalamounttoanegligiblepercentage


ReturnValueType:Vector3

publicstaticVector3Damp(

Vector3initial,

Vector3dampTime,

floatdeltaTime

)

CopyC# JavaScript


Cinemachine

DamperFields

TheDampertypeexposesthefollowingmembers.


kNegligibleResidual Standardresidual

Top





Cinemachine

DamperkNegligibleResidualField

Standardresidual


Syntax




publicconstfloatkNegligibleResidual=0.01f

CopyC# JavaScript




Cinemachine

ReflectionHelpersClass

Anad-hoccollectionofhelpersforreflection,usedbyCinemachineoritseditortoolsinvariousplaces

InheritanceHierarchySystemObjectCinemachine.UtilityReflectionHelpers


Syntax

TheReflectionHelperstypeexposesthefollowingmembers.


AccessInternalFieldT Cheaterextensiontoaccessinternalfieldofanobject

CopyFields Copythefieldsfromoneobjecttoanother

GetFieldPathTType,TValue

Returnsastringpathfromanexpression-mostly


publicstaticclassReflectionHelpers

CopyC# JavaScript


usedtoretrieveserializedpropertieswithouthardcodingthefieldpath.Safer,andallowsforproperrefactoring.

GetParentObject Gettheobjectownerofafield.Thismethodprocessesthe'.'separatortogetfromtheobjectthatownsthecompoundfieldtotheobjectthatownstheleaffield

Top





Cinemachine

ReflectionHelpersMethods

TheReflectionHelperstypeexposesthefollowingmembers.


AccessInternalFieldT Cheaterextensiontoaccessinternalfieldofanobject

CopyFields Copythefieldsfromoneobjecttoanother

GetFieldPathTType,TValue

Returnsastringpathfromanexpression-mostlyusedtoretrieveserializedpropertieswithouthardcodingthefieldpath.Safer,andallowsforproperrefactoring.

GetParentObject Gettheobjectownerofafield.Thismethodprocessesthe'.'separatortogetfromtheobjectthatownsthecompoundfieldtotheobjectthatownstheleaffield

Top

SeeAlso

ReferenceReflectionHelpersClassCinemachine.UtilityNamespace




Cinemachine

ReflectionHelpersAccessInternalFieldMethod

Cheaterextensiontoaccessinternalfieldofanobject


Syntax

Parameters

typeType:SystemTypeThetypeofthefield

objType:SystemObjectTheobjecttoaccess

memberNameType:SystemStringThestringnameofthefieldtoaccess

TypeParameters

T

publicstaticTAccessInternalField<T>(

thisTypetype,

Objectobj,

stringmemberName

)

CopyC# JavaScript

http://msdn2.microsoft.com/en-us/library/42892f65



ReturnValueType:TThevalueofthefieldintheobjectsUsageNoteInVisualBasicandC#,youcancallthismethodasaninstancemethodonanyobjectoftypeType.Whenyouuseinstancemethodsyntaxtocallthismethod,omitthefirstparameter.Formoreinformation,seeExtensionMethods(VisualBasic)orExtensionMethods(C#ProgrammingGuide).

SeeAlsoReferenceReflectionHelpersClassCinemachine.UtilityNamespace


http://msdn2.microsoft.com/en-us/library/42892f65

http://msdn.microsoft.com/en-us/library/bb384936.aspx




Cinemachine

ReflectionHelpersCopyFieldsMethod

Copythefieldsfromoneobjecttoanother


Syntax

Parameters

srcType:SystemObjectThesourceobjecttocopyfrom

dstType:SystemObjectThedestinationobjecttocopyto

bindingAttr(Optional)Type:System.ReflectionBindingFlagsThemasktofiltertheattributes.Onlythosefieldsthatgetcaughtinthefilterwillbecopied

SeeAlso

publicstaticvoidCopyFields(

Objectsrc,

Objectdst,

BindingFlagsbindingAttr=BindingFlags.Default|

)

CopyC# JavaScript



http://msdn2.microsoft.com/en-us/library/cexkb29a

ReferenceReflectionHelpersClassCinemachine.UtilityNamespace




Cinemachine

ReflectionHelpersGetFieldPathTTypeTValueMethod

Returnsastringpathfromanexpression-mostlyusedtoretrieveserializedpropertieswithouthardcodingthefieldpath.Safer,andallowsforproperrefactoring.


Syntax

Parameters

exprType:System.Linq.ExpressionsExpressionFuncTType,TValue[Missing<paramname="expr"/>documentationfor"M:Cinemachine.Utility.ReflectionHelpers.GetFieldPath``2(System.Linq.Expressions.Expression{System.Func{``0,``1}})"]

TypeParameters

TTypeTValue

ReturnValueType:String[Missing<returns>documentationfor"M:Cinemachine.Utility.ReflectionHelpers.GetFieldPath``2(System.Linq.Expressions.Expression{System.Func{``0,``1}})"]

publicstaticstringGetFieldPath<TType,TValue>(

Expression<Func<TType,TValue>>expr

)

CopyC# JavaScript




Cinemachine

ReflectionHelpersGetParentObjectMethod

Gettheobjectownerofafield.Thismethodprocessesthe'.'separatortogetfromtheobjectthatownsthecompoundfieldtotheobjectthatownstheleaffield


Syntax

Parameters

pathType:SystemStringThenameofthefield,whichmaycontain'.'separators

objType:SystemObjecttheownerofthecompoundfield

ReturnValueType:Object[Missing<returns>documentationfor"M:Cinemachine.Utility.ReflectionHelpers.GetParentObject(System.String,System.Object)"]

publicstaticObjectGetParentObject(

stringpath,

Objectobj

)

CopyC# JavaScript




Cinemachine

UnityQuaternionExtensionsClass

ExtentionstotheQuaternionclass,useninvariousplacesbyCinemachine

InheritanceHierarchySystemObjectCinemachine.UtilityUnityQuaternionExtensions


Syntax

TheUnityQuaternionExtensionstypeexposesthefollowingmembers.


ApplyCameraRotation Applyrotations,firstaboutworldup,thenabout(travelling)localright.rot.yisrotationaboutworldUp,androt.xissecondrotation,aboutlocalright.

publicstaticclassUnityQuaternionExtensions

CopyC# JavaScript


GetCameraRotationToTarget Gettherotations,firstaboutworldup,thenabout(travelling)localright,necessarytoalignthequaternion'sforwardwiththetargetdirection.Thisrepresentsthetripodheadmovementneededtolookatthetarget.Thisformulationmakesiteasytointerpolatewithoutintroducingspuriousroll.

Normalized Normalizeaquaternion

SlerpWithReferenceUp Thisisaslerpthatmimicsacameraoperator'smovementinthatitchoosesapaththatavoidsthelowerhemisphere,asdefinedbytheupparam

Top

SeeAlsoReference

Cinemachine.UtilityNamespace




Cinemachine

UnityQuaternionExtensionsMethods

TheUnityQuaternionExtensionstypeexposesthefollowingmembers.


ApplyCameraRotation Applyrotations,firstaboutworldup,thenabout(travelling)localright.rot.yisrotationaboutworldUp,androt.xissecondrotation,aboutlocalright.

GetCameraRotationToTarget Gettherotations,firstaboutworldup,thenabout(travelling)localright,necessarytoalignthequaternion'sforwardwiththetargetdirection.Thisrepresentsthetripodheadmovementneededtolookatthetarget.Thisformulationmakesiteasyto

interpolatewithoutintroducingspuriousroll.

Normalized Normalizeaquaternion


Top

SeeAlsoReferenceUnityQuaternionExtensionsClassCinemachine.UtilityNamespace




Cinemachine

UnityQuaternionExtensionsApplyCameraRotationMethod

Applyrotations,firstaboutworldup,thenabout(travelling)localright.rot.yisrotationaboutworldUp,androt.xissecondrotation,aboutlocalright.


Syntax

Parameters

orientType:Quaternion[Missing<paramname="orient"/>documentationfor"M:Cinemachine.Utility.UnityQuaternionExtensions.ApplyCameraRotation(UnityEngine.Quaternion,UnityEngine.Vector2,UnityEngine.Vector3)"]

rotType:Vector2Vector2.yisrotationaboutworldUp,andVector2.xissecondrotation,aboutlocalright.

worldUpType:Vector3Whichwayisup

publicstaticQuaternionApplyCameraRotation(

thisQuaternionorient,

Vector2rot,

Vector3worldUp

)

CopyC# JavaScript

ReturnValueType:Quaternion[Missing<returns>documentationfor"M:Cinemachine.Utility.UnityQuaternionExtensions.ApplyCameraRotation(UnityEngine.Quaternion,UnityEngine.Vector2,UnityEngine.Vector3)"]

UsageNoteInVisualBasicandC#,youcancallthismethodasaninstancemethodonanyobjectoftypeQuaternion.Whenyouuseinstancemethodsyntaxtocallthismethod,omitthefirstparameter.Formoreinformation,seeExtensionMethods(VisualBasic)orExtensionMethods(C#ProgrammingGuide).







Cinemachine

UnityQuaternionExtensionsGetCameraRotationToTargetMethod

Gettherotations,firstaboutworldup,thenabout(travelling)localright,necessarytoalignthequaternion'sforwardwiththetargetdirection.Thisrepresentsthetripodheadmovementneededtolookatthetarget.Thisformulationmakesiteasytointerpolatewithoutintroducingspuriousroll.


Syntax

Parameters

orientType:Quaternion[Missing<paramname="orient"/>documentationfor"M:Cinemachine.Utility.UnityQuaternionExtensions.GetCameraRotationToTarget(UnityEngine.Quaternion,UnityEngine.Vector3,UnityEngine.Vector3)"]

lookAtDirType:Vector3Theworldspacetargetdirectioninwhichwewanttolook

worldUpType:Vector3Whichwayisup

publicstaticVector2GetCameraRotationToTarget(

thisQuaternionorient,

Vector3lookAtDir,

Vector3worldUp

)

CopyC# JavaScript

ReturnValueType:Vector2Vector2.yisrotationaboutworldUp,andVector2.xissecondrotation,aboutlocalright.UsageNoteInVisualBasicandC#,youcancallthismethodasaninstancemethodonanyobjectoftypeQuaternion.Whenyouuseinstancemethodsyntaxtocallthismethod,omitthefirstparameter.Formoreinformation,seeExtensionMethods(VisualBasic)orExtensionMethods(C#ProgrammingGuide).







Cinemachine

UnityQuaternionExtensionsNormalizedMethod

Normalizeaquaternion


Syntax

Parameters

qType:Quaternion[Missing<paramname="q"/>documentationfor"M:Cinemachine.Utility.UnityQuaternionExtensions.Normalized(UnityEngine.Quaternion)"]

ReturnValueType:QuaternionThenormalizedquaternion.Unitlengthis1.UsageNoteInVisualBasicandC#,youcancallthismethodasaninstancemethodonanyobjectoftypeQuaternion.Whenyouuseinstancemethodsyntaxtocallthismethod,omitthefirstparameter.Formoreinformation,seeExtensionMethods(VisualBasic)orExtensionMethods(C#ProgrammingGuide).

publicstaticQuaternionNormalized(

thisQuaternionq

)

CopyC# JavaScript



Cinemachine

UnityQuaternionExtensionsSlerpWithReferenceUpMethod

Thisisaslerpthatmimicsacameraoperator'smovementinthatitchoosesapaththatavoidsthelowerhemisphere,asdefinedbytheupparam


Syntax

Parameters

qAType:QuaternionFirstdirection

qBType:QuaternionSeconddirection

tType:SystemSingleInterpolationamount

upType:Vector3

publicstaticQuaternionSlerpWithReferenceUp(

QuaternionqA,

QuaternionqB,

floatt,

Vector3up

)

CopyC# JavaScript


Definestheupdirection

ReturnValueType:Quaternion[Missing<returns>documentationfor"M:Cinemachine.Utility.UnityQuaternionExtensions.SlerpWithReferenceUp(UnityEngine.Quaternion,UnityEngine.Quaternion,System.Single,UnityEngine.Vector3)"]





Cinemachine

UnityRectExtensionsClass

Ad-hocxxtentionstotheRectstructure,usedbyCinemachine

InheritanceHierarchySystemObjectCinemachine.UtilityUnityRectExtensions


Syntax

TheUnityRectExtensionstypeexposesthefollowingmembers.


Inflated Inflatearect

Top



publicstaticclassUnityRectExtensions

CopyC# JavaScript




Cinemachine

UnityRectExtensionsMethods

TheUnityRectExtensionstypeexposesthefollowingmembers.


Inflated Inflatearect

Top

SeeAlsoReferenceUnityRectExtensionsClassCinemachine.UtilityNamespace




Cinemachine

UnityRectExtensionsInflatedMethod

Inflatearect


Syntax

Parameters

rType:Rect[Missing<paramname="r"/>documentationfor"M:Cinemachine.Utility.UnityRectExtensions.Inflated(UnityEngine.Rect,UnityEngine.Vector2)"]

deltaType:Vector2xandyareadded/subtractedfto/fromtheedgesoftherect,inflatingitinalldirections

ReturnValueType:RectTheinflatedrectUsageNoteInVisualBasicandC#,youcancallthismethodasaninstancemethodonanyobjectoftypeRect.Whenyouuseinstancemethod

publicstaticRectInflated(

thisRectr,

Vector2delta

)

CopyC# JavaScript

syntaxtocallthismethod,omitthefirstparameter.Formoreinformation,seeExtensionMethods(VisualBasic)orExtensionMethods(C#ProgrammingGuide).

SeeAlsoReferenceUnityRectExtensionsClassCinemachine.UtilityNamespace






Cinemachine

UnityVectorExtensionsClass

ExtensionstotheVector3class,usedbyCinemachine

InheritanceHierarchySystemObjectCinemachine.UtilityUnityVectorExtensions


Syntax

TheUnityVectorExtensionstypeexposesthefollowingmembers.


AlmostZero IsthevectorwithinEpsilonofzerolength?

ClosestPointOnSegment(Vector2,Vector2,Vector2)

Gettheclosestpointonalinesegment.


Gettheclosestpoint

publicstaticclassUnityVectorExtensions

CopyC# JavaScript


onalinesegment.

ProjectOntoPlane Returnsanon-normalizedprojectionofthesuppliedvectorontoaplaneasdescribedbyitsnormal

SignedAngle Getasignedanglebetweentwovectors


Top


Epsilon AusefulEpsilon

Top

Cinemachine

UnityVectorExtensionsMethods



AlmostZero IsthevectorwithinEpsilonofzerolength?





ProjectOntoPlane Returnsanon-normalizedprojectionofthesuppliedvectorontoaplaneasdescribedbyitsnormal

SignedAngle Getasignedanglebetweentwovectors


Top

SeeAlsoReferenceUnityVectorExtensionsClassCinemachine.UtilityNamespace




Cinemachine

UnityVectorExtensionsAlmostZeroMethod

IsthevectorwithinEpsilonofzerolength?


Syntax

Parameters

vType:Vector3[Missing<paramname="v"/>documentationfor"M:Cinemachine.Utility.UnityVectorExtensions.AlmostZero(UnityEngine.Vector3)"]

ReturnValueType:BooleanTrueifthesquaremagnitudeofthevectoriswithinEpsilonofzeroUsageNoteInVisualBasicandC#,youcancallthismethodasaninstancemethodonanyobjectoftypeVector3.Whenyouuseinstancemethodsyntaxtocallthismethod,omitthefirstparameter.Formoreinformation,seeExtensionMethods(VisualBasic)orExtensionMethods(C#ProgrammingGuide).

publicstaticboolAlmostZero(

thisVector3v

)

CopyC# JavaScript




Cinemachine

UnityVectorExtensionsClosestPointOnSegmentMethod






Top





Cinemachine

UnityVectorExtensionsClosestPointOnSegmentMethod(Vector2,Vector2,Vector2)



Syntax

Parameters

pType:Vector2Apointinspace

s0Type:Vector2Startoflinesegment

s1Type:Vector2Endoflinesegment

ReturnValueType:SingleTheinterpolationparameterrepresentingthepointonthesegment,with0==s0,and1==s1

publicstaticfloatClosestPointOnSegment(

thisVector2p,

Vector2s0,

Vector2s1

)

CopyC# JavaScript


UsageNoteInVisualBasicandC#,youcancallthismethodasaninstancemethodonanyobjectoftypeVector2.Whenyouuseinstancemethodsyntaxtocallthismethod,omitthefirstparameter.Formoreinformation,seeExtensionMethods(VisualBasic)orExtensionMethods(C#ProgrammingGuide).

SeeAlsoReferenceUnityVectorExtensionsClassClosestPointOnSegmentOverloadCinemachine.UtilityNamespace






Cinemachine

UnityVectorExtensionsClosestPointOnSegmentMethod(Vector3,Vector3,Vector3)



Syntax

Parameters

pType:Vector3Apointinspace

s0Type:Vector3Startoflinesegment

s1Type:Vector3Endoflinesegment

ReturnValueType:SingleTheinterpolationparameterrepresentingthepointonthesegment,with0==s0,and1==s1

publicstaticfloatClosestPointOnSegment(

thisVector3p,

Vector3s0,

Vector3s1

)

CopyC# JavaScript


UsageNoteInVisualBasicandC#,youcancallthismethodasaninstancemethodonanyobjectoftypeVector3.Whenyouuseinstancemethodsyntaxtocallthismethod,omitthefirstparameter.Formoreinformation,seeExtensionMethods(VisualBasic)orExtensionMethods(C#ProgrammingGuide).

SeeAlsoReferenceUnityVectorExtensionsClassClosestPointOnSegmentOverloadCinemachine.UtilityNamespace






Cinemachine

UnityVectorExtensionsProjectOntoPlaneMethod

Returnsanon-normalizedprojectionofthesuppliedvectorontoaplaneasdescribedbyitsnormal


Syntax

Parameters

vectorType:Vector3[Missing<paramname="vector"/>documentationfor"M:Cinemachine.Utility.UnityVectorExtensions.ProjectOntoPlane(UnityEngine.Vector3,UnityEngine.Vector3)"]

planeNormalType:Vector3Thenormalthatdefinestheplane.Cannotbezero-length.

ReturnValueType:Vector3ThecomponentofthevectorthatliesintheplaneUsageNoteInVisualBasicandC#,youcancallthismethodasaninstancemethodonanyobjectoftypeVector3.Whenyouuseinstance

publicstaticVector3ProjectOntoPlane(

thisVector3vector,

Vector3planeNormal

)

CopyC# JavaScript

methodsyntaxtocallthismethod,omitthefirstparameter.Formoreinformation,seeExtensionMethods(VisualBasic)orExtensionMethods(C#ProgrammingGuide).







Cinemachine

UnityVectorExtensionsSignedAngleMethod

Getasignedanglebetweentwovectors


Syntax

Parameters

fromType:Vector3Startdirection

toType:Vector3Enddirection

refNormalType:Vector3Thisisneededinordertodeterminethesign.Forexample,iffromantolieontheXZplane,thenthiswouldbetheYunitvector,orindeedanyvectorwhich,whendottedwithYunitvector,wouldgiveapositiveresult.

ReturnValue

publicstaticfloatSignedAngle(

Vector3from,

Vector3to,

Vector3refNormal

)

CopyC# JavaScript

Type:SingleThesignedanglebetweenthevectors






Cinemachine

UnityVectorExtensionsSlerpWithReferenceUpMethod

Thisisaslerpthatmimicsacameraoperator'smovementinthatitchoosesapaththatavoidsthelowerhemisphere,asdefinedbytheupparam


Syntax

Parameters

vAType:Vector3Firstdirection

vBType:Vector3Seconddirection

tType:SystemSingleInterpolationamount

upType:Vector3

publicstaticVector3SlerpWithReferenceUp(

Vector3vA,

Vector3vB,

floatt,

Vector3up

)

CopyC# JavaScript


Definestheupdirection

ReturnValueType:Vector3[Missing<returns>documentationfor"M:Cinemachine.Utility.UnityVectorExtensions.SlerpWithReferenceUp(UnityEngine.Vector3,UnityEngine.Vector3,System.Single,UnityEngine.Vector3)"]





Cinemachine

UnityVectorExtensionsFields



Epsilon AusefulEpsilon

Top





Cinemachine

UnityVectorExtensionsEpsilonField

AusefulEpsilon


Syntax




publicconstfloatEpsilon=0.0001f

CopyC# JavaScript




cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman....

Documents