![Page 1: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1.jpg)
Cinemachine
![Page 2: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2.jpg)
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,
![Page 3: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/3.jpg)
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.
![Page 4: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/4.jpg)
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
![Page 5: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/5.jpg)
Cinemachine
![Page 6: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/6.jpg)
VersionHistory
Thetopicsinthissectiondescribethevariouschangesmadetothe[TODO:ProjectTitle]overthelifeoftheproject.
VersionHistorySelectaversionbelowtoseeadescriptionofitschanges.
Version2.0
Version2.1
SeeAlsoOtherResourcesWelcometoCinemachine
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 7: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/7.jpg)
Cinemachine
![Page 8: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/8.jpg)
Version2.0
Version2.0wasreleasedonJuly23,2017.
ChangesinThisReleaseThisisacompleteoverhaulofCinemachine1.0,andcontainsmanynewfeaturesandimplementations.
Unfortunatelyitwasnotpossibletomaintainback-compatibilitywithCinemachine1,andsoanyCinemachinecontentcreatedwithearlierversionswillhavetobere-createdusingthisversion.
PleaseseetheCinemachineForumforacompletelistofchangesinthisrelease.
SeeAlsoOtherResourcesVersionHistory
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 9: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/9.jpg)
Cinemachine
![Page 10: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/10.jpg)
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
![Page 11: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/11.jpg)
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.
![Page 12: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/12.jpg)
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.
![Page 13: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/13.jpg)
ClearshotandSDC:don'tresetstateifdeactivated.
FreeLookdestroy-nomoreorphanrigs.
FixedstrangebuilderrorthatonlyshowedupinMonoDevelop.
FreeLookwasnotrespectingX-axisaccelanddecel.Headingspeedhadtobecrazyhigh.NowsameasOrbital(warning:mayhavetore-tunesettingsonexistingFreeLooks).
Recentertotargetheadingwasnotmovingsmoothlyinsomecircumstances.
Colliderraycastsnolongerhittriggers.
Noise:handlevariabledeltaTimegracefully.
State-Driven-Camera:don'tgenerateerrorswhenanimatedtargetisinactive.
Severaljitterandjudderissuesresolved.
SeeAlsoOtherResourcesVersionHistory
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 14: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/14.jpg)
Cinemachine
![Page 15: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/15.jpg)
Namespaces
NamespacesNamespace Description
Cinemachine ThisnamespaceholdstheCoreCinemachinecode.
Cinemachine.Utility Cinemachinenon-domainutilitiesandUnityextensionsandhelpers
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 16: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/16.jpg)
Cinemachine
![Page 17: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/17.jpg)
CinemachineNamespace
ThisnamespaceholdstheCoreCinemachinecode.
Classes Class Description
CinemachineBasicMultiChannelPerlin AsapartoftheCinemachinePipelineimplementingtheNoisestage,thiscomponentaddsPerlinNoisetotheCamerastate,intheCorrectionoftheCameraState.iscreatedbyusingapredefinednoiseprofileasset.theshapeofthenoiseovertime.Youcanscalethisinamplitudeorintime,toproducefamilyofdifferentnoisesusingthesameprofile.
CinemachineBlend Describesablendbetween2CinemachineVirtualCameras,andholdsthetheblend.
CinemachineBlendDefinitionPropertyAttribute PropertyappliedtoCinemachineBlendDefinition.Usedforcustomdrawingintheinspector.
CinemachineBlenderSettings AssetthatdefinestherulesforblendingbetweenVirtualCameras.
![Page 18: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/18.jpg)
CinemachineBlendListCamera Thisisavirtualcamera"manager"thatownsandmanagesacollectionVirtualCameras.cameragoeslive,thesechildvcamsareenabled,oneafteranother,holdingeachcameraforadesignatedtime.betweencamerasarespecified.Thelastcameraisheldindefinitely.
CinemachineBrain CinemachineBrainisthelinkbetweentheUnityCameraandtheCinemachineVirtualCamerasinthescene.monitorstheprioritystacktochoosethecurrentCamera,andblendwithanotherifnecessary.importantly,CamerastatetotheattachedUnityCamera.CinemachineBrainisalsotheplacewhererulesforblendingbetweenvirtualcamerasdefined.Camerablendingisaninterpolationovertimeofonevirtualcameratoanother.Ifyouthinkofvirtualcamerasascameramen,thenblendingisalittlelikeonecameramansmoothlypassingthecameratoanothercameraman.timeoverwhichtoblend,aswellastheblendcurveshape.thatacameracutisjustazero-timeblend.
![Page 19: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/19.jpg)
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
![Page 20: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/20.jpg)
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
![Page 21: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/21.jpg)
intheBoundingVolumefield.
CinemachineCore AsingletonthatmanagescompletelistsofCinemachineBrainand,CinemachineVirtualCameras,andthepriorityqueue.servicestokeepingtrackofwhetherCinemachineVirtualCamerashaveeachframe.
CinemachineDollyCart ThisisaverysimplebehaviourthatconstrainsitstransformtoaCinemachinePath.usedtoanimateanyobjectsalongapath,orasaFollowtargetforCinemachineVirtualCameras.
CinemachineExtension BaseclassforaCinemachineVirtualCameraextensionmodule.HooksintotheCinemachinePipeline.
CinemachineExternalCamera Thiscomponentwillexposeanon-cinemachinecameratothecinemachinesystem,toparticipateinblends.itasacomponentalongsideanexistingUnityCameracomponent.
CinemachineFollowZoom Anadd-onmoduleforCinemachineVirtualCamerathatadjuststokeepthetargetobjectataconstantsizeonthescreen,regardlessofcameraandtarget
![Page 22: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/22.jpg)
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
![Page 23: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/23.jpg)
towardsa3rdpersoncameraexperience.arounditssubjectwiththreeseparatecamerarigsdefiningringsaroundthetarget.Eachrighasitsownradius,heightoffset,composer,andlenssettings.Dependingonthecamera'spositionalongthesplineconnectingthesethreerigs,thesesettingsareinterpolatedtogivethefinalcamerapositionandstate.
CinemachineGroupComposer ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.Itsjobistoaimthecameraatatargetobject,withconfigurableoffsets,damping,andcompositionrules.addition,ifthetargetisaCinemachineTargetGroup,thebehaviourwilladjusttheFOVandthecameradistancetoensurethattheentiregroupoftargetsisframedproperly.
CinemachineHardLockToTarget ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.ItsjobistoplacethecameraontheFollowTarget.
CinemachineHardLookAt ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.ItsjobistoaimthecamerahardattheLookAt
![Page 24: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/24.jpg)
target.
CinemachineMixingCamera CinemachineMixingCameraisa"managercamera"thattakesonthestateoftheweightedaverageofthestatesofitschildvirtualcameras.ofslotsaremadeavailableforcameras,ratherthanadynamicarray.WedoitthiswayinordertosupportweightanimationfromtheTimeline.animatearrayelements.
CinemachineOrbitalTransposer ThisisaCinemachineComponentinthetheBodysectionofthecomponentpipeline.positionthecamerainavariablerelationshiptoathevcam'sFollowtargetobject,withoffsetsanddamping.typicallyusedtoimplementacamerathatfollowsitstarget.canacceptplayerinputfromaninputdevice,whichallowstheplayertodynamicallycontroltherelationshipbetweenthecameraandthetarget,ajoystick.TheOrbitalTransposerintroducestheconceptof__Heading__,whichisthedirectionthetargetismoving,andtheOrbitalTransposerwillattempttopositionthecamerainrelationshiptotheheading,whichisbydefaultdirectlybehindthetarget.
![Page 25: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/25.jpg)
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
![Page 26: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/26.jpg)
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
![Page 27: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/27.jpg)
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
![Page 28: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/28.jpg)
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.
![Page 29: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/29.jpg)
Atypicalgameofvirtualcameras,eachsetuptofollowaparticularcharactercaptureaparticularevent.VirtualCameracanbeinanyofthreestates:virtualcameraisactivelycontrollingtheUnityCamera.Thevirtualcameraistrackingitstargetsandbeingupdatedeveryframe.***Standby**:ThevirtualcameraistrackingitstargetsandbeingupdatedbutnoUnityCameraisactivelybeingcontrolledbyit.ThisisstateofavirtualcamerathatisenabledinthescenebutperhapsatatheLivevirtualcamera.**Disabled**:Thevirtualcameraispresentbutdisabledinthescene.Itisnotactivelytrackingitstargetsandsoconsumesnoprocessingpower.However,virtualcameracanbemadelivefromtheTimeline.Cameracanbedrivenbyanyvirtualcamerainthescene.Thegamelogiccanchoosethevirtualcameratomakelivebymanipulatingthevirtualcameras'enabledflagsandtheirpriorities,basedongamelogic.Inordertobedrivenbyavirtualcamera,theUnityCameramusthaveaCinemachineBrainbehaviour,whichwillselectthemosteligiblevirtualcamerabasedonitspriority
![Page 30: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/30.jpg)
criteria,andwillmanageblending.
CinemachineVirtualCameraBase BaseclassforaMonobehaviourthatrepresentsaVirtualCamerawithintheUnityscene.intendedtobeattachedtoanemptyTransformGameObject.InheritedclassescanbeeitherstandalonevirtualcamerassuchasCinemachineVirtualCamera,ormeta-camerassuchasCinemachineClearShotorCinemachineFreeLook.CinemachineVirtualCameraBaseexposesaPriorityproperty.Whenthebehaviourisinthegame,theVirtualCameraisautomaticallyplacedinaqueuemaintainedbythestaticCinemachineCoresingleton.Thequeueissortedbypriority.WhenaUnitycameraisequippedwithaCinemachineBrainbehaviour,thebrainwillchoosethecameraattheheadofthequeue.havemultipleUnitycameraswithCinemachineBrainbehaviours(sayinasplit-screencontext),thenyoucanfilterthequeuebysettingthecullingflagsonthevirtualcameras.cullingmaskoftheCamerawillthenactasafilterforthebrain.thereisnothingthatpreventsavirtualcamerafromcontrollingmultipleUnitycameras
![Page 31: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/31.jpg)
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.
![Page 32: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/32.jpg)
SaveDuringPlayAttribute Invokeplay-mode-saveforaclass.Thisclass'sfieldswillbescanneduponexitingplaymode,anditspropertyvalueswillbeappliedtothesceneobject.ThisisastopgapmeasurethatwillbecomeobsoleteonceUnityimplementsplay-mode-saveinamoregeneralway.
Structures Structure Description
AxisState Axisstatefordefiningtoreacttoplayerinput.Thesettingsherecontroltheresponsivenessoftheaxistoplayerinput.
CameraState TheoutputoftheCinemachineengineforaspecificvirtualcamera.informationinthisstructcanbeblended,andprovideswhatisneededtocalculateanappropriatecameraposition,orientation,andlenssetting.RawvaluesarewhattheCinemachine
![Page 33: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/33.jpg)
behavioursgenerate.Thecorrectionchannelholdsperturbationstotherawvalues-e.g.noiseorsmoothing,orobstacleavoidancecorrections.Coirrectionsarenotconsideredwhenmakingtime-basedcalculationssuchasdamping.TheFinalpositionandorientationisthecominationoftherawvaluesandcorrections.
CameraStateCustomBlendable Opaquestructurerepresentextrablendablestuffanditsweight.Thebasesystemignoresthisdata-itisintendedforextensionmodules
CinemachineBlendDefinition DefinitionofaCamerablend.structholdstheinformationnecessarytogenerateasuitableAnimationCurveforaCinemachineBlend.
![Page 34: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/34.jpg)
CinemachineBlenderSettingsCustomBlend ContainerspecifyinghowtwospecificCinemachineVirtualCamerasblendtogether.
CinemachineBlendListCameraInstruction ThisrepresentsasingleentryintheinstrunctionlistoftheBlendListCamera.
CinemachineFreeLookOrbit DefinestheheightandradiusoftheRigorbit
CinemachineOrbitalTransposerHeading Howthe"forward"directionisdefined.Orbitaloffsetisinrelationtotheforwarddirection.
CinemachineOrbitalTransposerRecentering Controlshowautomaticorbitrecenteringoccurs
CinemachinePathWaypoint Awaypointalongthepath
CinemachineSmoothPathWaypoint Awaypointalongthepath
CinemachineStateDrivenCameraInstruction ThisrepresentsasingleinstrunctiontotheStateDrivenCamera.Itassociatesanstatefromthestatemachinewithachild
![Page 35: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/35.jpg)
VirtualCamera,andalsoholdsactivationtuningparameters.
CinemachineTargetGroupTarget Holdstheinformationthatrepresentsamemberofthegroup
CinemachineTrackedDollyAutoDolly Controlshowautomaticdollyingoccurs
LensSettings DescribestheFOVandclipplanesforacamera.ThisgenerallymirrorstheUnityCamera'slenssettings,andwillbeusedtodrivetheUnitycamerawhenthevcamisactive.
NoiseSettingsNoiseParams Describesthebehaviourforachannelofnoise
NoiseSettingsTransformNoiseParams Containsthebehaviourofnoiseforthenoisemoduleforall3cardinalaxesofthecamera
Interfaces Interface Description
![Page 36: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/36.jpg)
ICinemachineCamera AnabstractrepresentationofavirtualcamerawhichliveswithintheUnityscene
Delegates Delegate
CinemachineCoreAxisInputDelegate
CinemachineFreeLookCreateRigDelegate
CinemachineFreeLookDestroyRigDelegate
CinemachineVirtualCameraCreatePipelineDelegate
CinemachineVirtualCameraDestroyPipelineDelegate
![Page 37: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/37.jpg)
CinemachineVirtualCameraBaseOnPostPipelineStageDelegate
Enumerations Enumeration
CinemachineBlendDefinitionStyle
CinemachineBrainUpdateMethod
CinemachineColliderResolutionStrategy
![Page 38: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/38.jpg)
CinemachineConfinerMode
CinemachineCoreStage
CinemachineCoreUpdateFilter
CinemachineDollyCartUpdateMethod
CinemachineFramingTransposerAdjustmentMode
CinemachineFramingTransposerFramingMode
![Page 39: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/39.jpg)
CinemachineGroupComposerAdjustmentMode
CinemachineGroupComposerFramingMode
CinemachineOrbitalTransposerHeadingHeadingDefinition
CinemachinePathBasePositionUnits
CinemachineTargetGroupPositionMode
CinemachineTargetGroupRotationMode
CinemachineTargetGroupUpdateMethod
![Page 40: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/40.jpg)
CinemachineTrackedDollyCameraUpMode
CinemachineTransposerBindingMode
DocumentationSortingAttributeLevel
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 41: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/41.jpg)
Cinemachine
![Page 42: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/42.jpg)
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
![Page 43: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/43.jpg)
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
![Page 44: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/44.jpg)
oftheinputaxiswillbeinvertedbeforeitisused.
m_MaxSpeed Howfasttheaxisvaluecantravel.Increasingthisnumbermakesthebehaviourmoreresponsivetojoystickinput
Value Thecurrentvalueoftheaxis
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 45: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/45.jpg)
Cinemachine
![Page 46: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/46.jpg)
AxisStateConstructor
Constructorwithspecificvalues
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 47: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/47.jpg)
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
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 48: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/48.jpg)
Cinemachine
![Page 49: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/49.jpg)
AxisStateMethods
TheAxisStatetypeexposesthefollowingmembers.
Methods Name Description
SetThresholds Setstheconstraintsbywhichthisaxiswilloperateon
Update UpdatesthestateofthisaxisbasedontheaxisdefinedbyAxisState.m_AxisName
Validate CallfromOnValidate:Makesurethefieldsaresensible
Top
SeeAlsoReferenceAxisStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 50: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/50.jpg)
Cinemachine
![Page 51: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/51.jpg)
AxisStateSetThresholdsMethod
Setstheconstraintsbywhichthisaxiswilloperateon
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
minValueType:SystemSingleThelowestvaluethisaxiscanachieve
maxValueType:SystemSingleThehighestvaluethisaxiscanachieve
wrapAroundType:SystemBooleanIftrue,valuescommandedgreaterthanmMaxValueorlessthanmMinValuewillwraparound.Iffalse,thevaluewillbeclampedwithintherange.
SeeAlsoReferenceAxisStateStructure
publicvoidSetThresholds(
floatminValue,
floatmaxValue,
boolwrapAround
)
CopyC# JavaScript
![Page 52: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/52.jpg)
CinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 53: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/53.jpg)
Cinemachine
![Page 54: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/54.jpg)
AxisStateUpdateMethod
UpdatesthestateofthisaxisbasedontheaxisdefinedbyAxisState.m_AxisName
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
deltaTimeType:SystemSingleDeltatimeinseconds
ReturnValueType:BooleanReturnstrueifthisaxis'inputwasnon-zerothisUpdate,flaseotherwise
SeeAlsoReferenceAxisStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicboolUpdate(
floatdeltaTime
)
CopyC# JavaScript
![Page 55: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/55.jpg)
![Page 56: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/56.jpg)
Cinemachine
![Page 57: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/57.jpg)
AxisStateValidateMethod
CallfromOnValidate:Makesurethefieldsaresensible
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceAxisStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidValidate()
CopyC# JavaScript
![Page 58: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/58.jpg)
Cinemachine
![Page 59: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/59.jpg)
AxisStateFields
TheAxisStatetypeexposesthefollowingmembers.
Fields Name Description
m_AccelTime TheamountoftimeinsecondsittakestoacceleratetoMaxSpeedwiththesuppliedAxisatitsmaximumvalue
m_DecelTime Theamountoftimeinsecondsittakestodeceleratetheaxistozeroifthesuppliedaxisisinaneutralposition
m_InputAxisName ThenameofthisaxisasspecifiedinUnityInputmanager.Settingtoanemptystringwilldisabletheautomaticupdatingofthisaxis
m_InputAxisValue Thevalueoftheinputaxis.Avalueof0meansnoinputYoucandrivethisdirectlyfromacustominputsystem,oryoucansettheAxisNameandhavethevaluedrivenbytheinternalInputManager
m_InvertAxis Ifchecked,thentherawvalueoftheinputaxiswillbe
![Page 60: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/60.jpg)
invertedbeforeitisused.
m_MaxSpeed Howfasttheaxisvaluecantravel.Increasingthisnumbermakesthebehaviourmoreresponsivetojoystickinput
Value Thecurrentvalueoftheaxis
Top
SeeAlsoReferenceAxisStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 61: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/61.jpg)
Cinemachine
![Page 62: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/62.jpg)
AxisStatem_AccelTimeField
TheamountoftimeinsecondsittakestoacceleratetoMaxSpeedwiththesuppliedAxisatitsmaximumvalue
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceAxisStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("TheamountoftimeinsecondsittakestoacceleratetoMaxSpeedwiththesuppliedAxisatitsmaximumvalue")]
publicfloatm_AccelTime
CopyC# JavaScript
![Page 63: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/63.jpg)
Cinemachine
![Page 64: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/64.jpg)
AxisStatem_DecelTimeField
Theamountoftimeinsecondsittakestodeceleratetheaxistozeroifthesuppliedaxisisinaneutralposition
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceAxisStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theamountoftimeinsecondsittakestodeceleratetheaxistozeroifthesuppliedaxisisinaneutralposition")]
publicfloatm_DecelTime
CopyC# JavaScript
![Page 65: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/65.jpg)
Cinemachine
![Page 66: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/66.jpg)
AxisStatem_InputAxisNameField
ThenameofthisaxisasspecifiedinUnityInputmanager.Settingtoanemptystringwilldisabletheautomaticupdatingofthisaxis
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:String
SeeAlsoReferenceAxisStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[FormerlySerializedAsAttribute("m_AxisName")]
[TooltipAttribute("ThenameofthisaxisasspecifiedinUnityInputmanager.Settingtoanemptystringwilldisabletheautomaticupdatingofthisaxis")]
publicstringm_InputAxisName
CopyC# JavaScript
![Page 67: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/67.jpg)
Cinemachine
![Page 68: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/68.jpg)
AxisStatem_InputAxisValueField
Thevalueoftheinputaxis.Avalueof0meansnoinputYoucandrivethisdirectlyfromacustominputsystem,oryoucansettheAxisNameandhavethevaluedrivenbytheinternalInputManager
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceAxisStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[NoSaveDuringPlayAttribute]
[TooltipAttribute("Thevalueoftheinputaxis.Avalueof0meansnoinput.Youcandrivethisdirectlyfromacustominputsystem,oryoucansettheAxisNameandhavethevaluedrivenbytheinternalInputManager")]
publicfloatm_InputAxisValue
CopyC# JavaScript
![Page 69: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/69.jpg)
Cinemachine
![Page 70: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/70.jpg)
AxisStatem_InvertAxisField
Ifchecked,thentherawvalueoftheinputaxiswillbeinvertedbeforeitisused.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceAxisStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[NoSaveDuringPlayAttribute]
[TooltipAttribute("Ifchecked,thentherawvalueoftheinputaxiswillbeinvertedbeforeitisused")]
publicboolm_InvertAxis
CopyC# JavaScript
![Page 71: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/71.jpg)
Cinemachine
![Page 72: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/72.jpg)
AxisStatem_MaxSpeedField
Howfasttheaxisvaluecantravel.Increasingthisnumbermakesthebehaviourmoreresponsivetojoystickinput
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceAxisStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Themaximumspeedofthisaxisinunits/second")]
publicfloatm_MaxSpeed
CopyC# JavaScript
![Page 73: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/73.jpg)
Cinemachine
![Page 74: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/74.jpg)
AxisStateValueField
Thecurrentvalueoftheaxis
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceAxisStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[NoSaveDuringPlayAttribute]
[TooltipAttribute("Thecurrentvalueoftheaxis.")]
publicfloatValue
CopyC# JavaScript
![Page 75: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/75.jpg)
Cinemachine
![Page 76: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/76.jpg)
CameraStateStructure
TheoutputoftheCinemachineengineforaspecificvirtualcamera.Theinformationinthisstructcanbeblended,andprovideswhatisneededtocalculateanappropriatecameraposition,orientation,andlenssetting.RawvaluesarewhattheCinemachinebehavioursgenerate.Thecorrectionchannelholdsperturbationstotherawvalues-e.g.noiseorsmoothing,orobstacleavoidancecorrections.Coirrectionsarenotconsideredwhenmakingtime-basedcalculationssuchasdamping.TheFinalpositionandorientationisthecominationoftherawvaluesandtheircorrections.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCameraStatetypeexposesthefollowingmembers.
Properties Name Description
CorrectedOrientation Orientationwithcorrectionapplied.
CorrectedPosition Positionwithcorrectionapplied.
Default Statewithdefaultvalues
publicstructCameraState
CopyC# JavaScript
![Page 77: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/77.jpg)
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
![Page 78: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/78.jpg)
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
Methods Name Description
AddCustomBlendable Addacustomblendable
![Page 79: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/79.jpg)
tothepotforeventualapplicationtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules
GetCustomBlendable Getacustomblendablethatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules
Lerp Intelligentlyblendthecontentsoftwostates.
Top
Fields Name Description
kNoPoint Thisconstantrepresents"nopointinspace"or"nodirection".
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 80: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/80.jpg)
Cinemachine
![Page 81: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/81.jpg)
CameraStateProperties
TheCameraStatetypeexposesthefollowingmembers.
Properties Name Description
CorrectedOrientation Orientationwithcorrectionapplied.
CorrectedPosition Positionwithcorrectionapplied.
Default Statewithdefaultvalues
FinalOrientation Orientationwithcorrectionanddutchapplied.Thisiswhatthefinalcameragets.
FinalPosition Positionwithcorrectionapplied.Thisiswhatthefinalcameragets.
HasLookAt ReturnstrueifthisstatehasavalidReferenceLookAtvalue.
Lens CameraLensSettings.
NumCustomBlendables Thenumberofcustomblendablesthatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwise
![Page 82: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/82.jpg)
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
![Page 83: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/83.jpg)
that(orchecktheHasLookAtproperty).
ReferenceUp Whichwayisup.Worldspaceunitvector.
ShotQuality Subjectiveestimationofhow"good"theshotis.Largervaluesmeanbetterquality.Defaultis1.
Top
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 84: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/84.jpg)
Cinemachine
![Page 85: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/85.jpg)
CameraStateCorrectedOrientationProperty
Orientationwithcorrectionapplied.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Quaternion
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicQuaternionCorrectedOrientation{get;}
CopyC# JavaScript
![Page 86: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/86.jpg)
Cinemachine
![Page 87: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/87.jpg)
CameraStateCorrectedPositionProperty
Positionwithcorrectionapplied.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Vector3
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicVector3CorrectedPosition{get;}
CopyC# JavaScript
![Page 88: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/88.jpg)
Cinemachine
![Page 89: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/89.jpg)
CameraStateDefaultProperty
Statewithdefaultvalues
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CameraState
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticCameraStateDefault{get;}
CopyC# JavaScript
![Page 90: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/90.jpg)
Cinemachine
![Page 91: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/91.jpg)
CameraStateFinalOrientationProperty
Orientationwithcorrectionanddutchapplied.Thisiswhatthefinalcameragets.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Quaternion
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicQuaternionFinalOrientation{get;}
CopyC# JavaScript
![Page 92: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/92.jpg)
Cinemachine
![Page 93: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/93.jpg)
CameraStateFinalPositionProperty
Positionwithcorrectionapplied.Thisiswhatthefinalcameragets.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Vector3
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicVector3FinalPosition{get;}
CopyC# JavaScript
![Page 94: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/94.jpg)
Cinemachine
![Page 95: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/95.jpg)
CameraStateHasLookAtProperty
ReturnstrueifthisstatehasavalidReferenceLookAtvalue.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicboolHasLookAt{get;}
CopyC# JavaScript
![Page 96: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/96.jpg)
Cinemachine
![Page 97: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/97.jpg)
CameraStateLensProperty
CameraLensSettings.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:LensSettings
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicLensSettingsLens{get;set;}
CopyC# JavaScript
![Page 98: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/98.jpg)
Cinemachine
![Page 99: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/99.jpg)
CameraStateNumCustomBlendablesProperty
Thenumberofcustomblendablesthatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Int32
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicintNumCustomBlendables{get;}
CopyC# JavaScript
![Page 100: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/100.jpg)
Cinemachine
![Page 101: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/101.jpg)
CameraStateOrientationCorrectionProperty
Orientationcorrection.Thiswillbeaddedtotheraworientation.Thisvaluedoesn'tgetfedbackintothesystemwhencalculatingthenextframe.Canbenoise,orsmoothing,orboth,orsomethingelse.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Quaternion
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicQuaternionOrientationCorrection{get;set;}
CopyC# JavaScript
![Page 102: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/102.jpg)
Cinemachine
![Page 103: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/103.jpg)
CameraStatePositionCorrectionProperty
Positioncorrection.Thiswillbeaddedtotherawposition.Thisvaluedoesn'tgetfedbackintothesystemwhencalculatingthenextframe.Canbenoise,orsmoothing,orboth,orsomethingelse.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Vector3
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicVector3PositionCorrection{get;set;}
CopyC# JavaScript
![Page 104: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/104.jpg)
Cinemachine
![Page 105: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/105.jpg)
CameraStateRawOrientationProperty
Raw(un-corrected)worldspaceorientationofthiscamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Quaternion
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicQuaternionRawOrientation{get;set;}
CopyC# JavaScript
![Page 106: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/106.jpg)
Cinemachine
![Page 107: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/107.jpg)
CameraStateRawPositionProperty
Raw(un-corrected)worldspacepositionofthiscamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Vector3
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicVector3RawPosition{get;set;}
CopyC# JavaScript
![Page 108: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/108.jpg)
Cinemachine
![Page 109: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/109.jpg)
CameraStateReferenceLookAtProperty
Theworldspacefocuspointofthecamera.Whatthecamerawantstolookat.Thereisaspecialconstantdefinetorepresent"nothing".Becarefultocheckforthat(orchecktheHasLookAtproperty).
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Vector3
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicVector3ReferenceLookAt{get;set;}
CopyC# JavaScript
![Page 110: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/110.jpg)
Cinemachine
![Page 111: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/111.jpg)
CameraStateReferenceUpProperty
Whichwayisup.Worldspaceunitvector.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Vector3
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicVector3ReferenceUp{get;set;}
CopyC# JavaScript
![Page 112: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/112.jpg)
Cinemachine
![Page 113: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/113.jpg)
CameraStateShotQualityProperty
Subjectiveestimationofhow"good"theshotis.Largervaluesmeanbetterquality.Defaultis1.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Single
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicfloatShotQuality{get;set;}
CopyC# JavaScript
![Page 114: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/114.jpg)
Cinemachine
![Page 115: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/115.jpg)
CameraStateMethods
TheCameraStatetypeexposesthefollowingmembers.
Methods Name Description
AddCustomBlendable Addacustomblendabletothepotforeventualapplicationtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules
GetCustomBlendable Getacustomblendablethatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules
Lerp Intelligentlyblendthecontentsoftwostates.
Top
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
![Page 116: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/116.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 117: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/117.jpg)
Cinemachine
![Page 118: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/118.jpg)
CameraStateAddCustomBlendableMethod
Addacustomblendabletothepotforeventualapplicationtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
bType:CinemachineCameraStateCustomBlendableThecustomblendabletoadd.Ifb.m_Customisthesameasanalready-addedcustomblendable,thentheywillbemergedandtheweightscombined.
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidAddCustomBlendable(
CameraStateCustomBlendableb
)
CopyC# JavaScript
![Page 119: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/119.jpg)
![Page 120: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/120.jpg)
Cinemachine
![Page 121: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/121.jpg)
CameraStateGetCustomBlendableMethod
Getacustomblendablethatwillbeappliedtothecamera.Thebasesystemmanagesbutotherwiseignoresthisdata-itisintendedforextensionmodules
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
indexType:SystemInt32Whichonetoget.Mustbeinrange[0...NumCustomBlendables)
ReturnValueType:CameraStateCustomBlendableThecustomblendableatthespecifiedindex.
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
publicCameraStateCustomBlendableGetCustomBlendable
intindex
)
CopyC# JavaScript
![Page 122: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/122.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 123: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/123.jpg)
Cinemachine
![Page 124: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/124.jpg)
CameraStateLerpMethod
Intelligentlyblendthecontentsoftwostates.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
stateAType:CinemachineCameraStateThefirststate,correspondingtot=0
stateBType:CinemachineCameraStateThesecondstate,correspondingtot=1
tType:SystemSingleHowmuchtointerpolate.Internallyclampedto0..1
ReturnValueType:CameraStateLinearlyinterpolatedCameraState
SeeAlso
publicstaticCameraStateLerp(
CameraStatestateA,
CameraStatestateB,
floatt
)
CopyC# JavaScript
![Page 125: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/125.jpg)
ReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 126: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/126.jpg)
Cinemachine
![Page 127: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/127.jpg)
CameraStateFields
TheCameraStatetypeexposesthefollowingmembers.
Fields Name Description
kNoPoint Thisconstantrepresents"nopointinspace"or"nodirection".
Top
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 128: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/128.jpg)
Cinemachine
![Page 129: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/129.jpg)
CameraStatekNoPointField
Thisconstantrepresents"nopointinspace"or"nodirection".
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Vector3
SeeAlsoReferenceCameraStateStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticVector3kNoPoint
CopyC# JavaScript
![Page 130: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/130.jpg)
Cinemachine
![Page 131: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/131.jpg)
CameraStateCustomBlendableStructure
Opaquestructurerepresentextrablendablestuffanditsweight.Thebasesystemignoresthisdata-itisintendedforextensionmodules
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCameraStateCustomBlendabletypeexposesthefollowingmembers.
Constructors Name Description
CameraStateCustomBlendable Constructorwithspecificvalues
Top
Fields Name Description
m_Custom Thecustomstuffthattheextentionmodulewillconsider
publicstructCustomBlendable
CopyC# JavaScript
![Page 132: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/132.jpg)
m_Weight Theweightofthecustomstuff.Mustbe0...1
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 133: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/133.jpg)
Cinemachine
![Page 134: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/134.jpg)
CameraStateCustomBlendableConstructor
Constructorwithspecificvalues
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
customType:ObjectThecustomstuffthattheextentionmodulewillconsider
weightType:SystemSingleTheweightofthecustomstuff.Mustbe0...1
SeeAlsoReferenceCameraStateCustomBlendableStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCustomBlendable(
Objectcustom,
floatweight
)
CopyC# JavaScript
![Page 135: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/135.jpg)
![Page 136: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/136.jpg)
Cinemachine
![Page 137: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/137.jpg)
CustomBlendableFields
TheCameraStateCustomBlendabletypeexposesthefollowingmembers.
Fields Name Description
m_Custom Thecustomstuffthattheextentionmodulewillconsider
m_Weight Theweightofthecustomstuff.Mustbe0...1
Top
SeeAlsoReferenceCameraStateCustomBlendableStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 138: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/138.jpg)
Cinemachine
![Page 139: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/139.jpg)
CameraStateCustomBlendablem_CustomField
Thecustomstuffthattheextentionmodulewillconsider
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Object
SeeAlsoReferenceCameraStateCustomBlendableStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicObjectm_Custom
CopyC# JavaScript
![Page 140: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/140.jpg)
Cinemachine
![Page 141: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/141.jpg)
CameraStateCustomBlendablem_WeightField
Theweightofthecustomstuff.Mustbe0...1
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCameraStateCustomBlendableStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicfloatm_Weight
CopyC# JavaScript
![Page 142: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/142.jpg)
Cinemachine
![Page 143: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/143.jpg)
CinemachineBasicMultiChannelPerlinClass
AsapartoftheCinemachinePipelineimplementingtheNoisestage,thiscomponentaddsPerlinNoisetotheCamerastate,intheCorrectionchanneloftheCameraState.Thenoiseiscreatedbyusingapredefinednoiseprofileasset.Thisdefinestheshapeofthenoiseovertime.Youcanscalethisinamplitudeorintime,toproducealargefamilyofdifferentnoisesusingthesameprofile.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineBasicMultiChannelPerlin
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineBasicMultiChannelPerlintypeexposesthefollowingmembers.
[DocumentationSortingAttribute(8f,DocumentationSortingAttribute
[AddComponentMenu("")]
[RequireComponent(typeof(CinemachinePipeline))]
[SaveDuringPlayAttribute]
publicclassCinemachineBasicMultiChannelPerlin:CinemachineComponentBase
CopyC# JavaScript
![Page 144: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/144.jpg)
Properties Name Description
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
![Page 145: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/145.jpg)
Methods Name Description
MutateCameraState AppliesnoisetotheCorrectionchanneloftheCameraStateifthedeltatimeisgreaterthan0.Otherwise,doesnothing.(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.classimplementationdoesnothing.(InheritedfromCinemachineComponentBase
Top
Fields Name Description
m_AmplitudeGain Gaintoapplytotheamplitudesdefinedinthesettingsasset.
m_FrequencyGain Scalefactortoapplytothefrequenciesdefinedinthesettingsasset.
m_NoiseProfile SerializedpropertyforreferencingaNoiseSettingsasset
Top
SeeAlsoReference
![Page 146: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/146.jpg)
CinemachineNamespaceCinemachineNoiseSettings
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 147: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/147.jpg)
Cinemachine
![Page 148: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/148.jpg)
CinemachineBasicMultiChannelPerlinProperties
TheCinemachineBasicMultiChannelPerlintypeexposesthefollowingmembers.
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
IsValid Trueifthecomponentisvalid,i.e.ithasanoisedefinitionandisenabled.(OverridesCinemachineComponentBaseIsValid.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheNoisestage(OverridesCinemachineComponentBaseStage.)
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
![Page 149: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/149.jpg)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)
Top
SeeAlsoReferenceCinemachineBasicMultiChannelPerlinClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 150: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/150.jpg)
Cinemachine
![Page 151: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/151.jpg)
CinemachineBasicMultiChannelPerlinProperty
Trueifthecomponentisvalid,i.e.ithasanoisedefinitionandisenabled.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineBasicMultiChannelPerlinClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideboolIsValid{get;}
CopyC# JavaScript
![Page 152: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/152.jpg)
Cinemachine
![Page 153: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/153.jpg)
CinemachineBasicMultiChannelPerlinProperty
GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheNoisestage
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineCoreStage
SeeAlsoReferenceCinemachineBasicMultiChannelPerlinClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideCinemachineCoreStageStage{get;}
CopyC# JavaScript
![Page 154: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/154.jpg)
Cinemachine
![Page 155: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/155.jpg)
CinemachineBasicMultiChannelPerlinMethods
TheCinemachineBasicMultiChannelPerlintypeexposesthefollowingmembers.
Methods Name Description
MutateCameraState AppliesnoisetotheCorrectionchanneloftheCameraStateifthedeltatimeisgreaterthan0.Otherwise,doesnothing.(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.classimplementationdoesnothing.(InheritedfromCinemachineComponentBase
Top
SeeAlsoReferenceCinemachineBasicMultiChannelPerlinClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 156: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/156.jpg)
Cinemachine
![Page 157: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/157.jpg)
CinemachineBasicMultiChannelPerlinMethod
AppliesnoisetotheCorrectionchanneloftheCameraStateifthedeltatimeisgreaterthan0.Otherwise,doesnothing.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
curStateType:CinemachineCameraStateThecurrentcamerastate
deltaTimeType:SystemSingleHowmuchtoadvancetheperlinnoisegenerator.Noiseisonlyappliedifthisvalueisgreaterthanorequalto0
SeeAlsoReferenceCinemachineBasicMultiChannelPerlinClassCinemachineNamespace
publicoverridevoidMutateCameraState(
refCameraStatecurState,
floatdeltaTime
)
CopyC# JavaScript
![Page 158: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/158.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 159: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/159.jpg)
Cinemachine
![Page 160: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/160.jpg)
CinemachineBasicMultiChannelPerlinFields
TheCinemachineBasicMultiChannelPerlintypeexposesthefollowingmembers.
Fields Name Description
m_AmplitudeGain Gaintoapplytotheamplitudesdefinedinthesettingsasset.
m_FrequencyGain Scalefactortoapplytothefrequenciesdefinedinthesettingsasset.
m_NoiseProfile SerializedpropertyforreferencingaNoiseSettingsasset
Top
SeeAlsoReferenceCinemachineBasicMultiChannelPerlinClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 161: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/161.jpg)
Cinemachine
![Page 162: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/162.jpg)
CinemachineBasicMultiChannelPerlinField
Gaintoapplytotheamplitudesdefinedinthesettingsasset.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineBasicMultiChannelPerlinClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("GaintoapplytotheamplitudesdefinedintheNoiseSettingsasset.1isnormal.Settingthisto0completelymutesthenoise.")]
publicfloatm_AmplitudeGain
CopyC# JavaScript
![Page 163: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/163.jpg)
Cinemachine
![Page 164: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/164.jpg)
CinemachineBasicMultiChannelPerlinField
Scalefactortoapplytothefrequenciesdefinedinthesettingsasset.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineBasicMultiChannelPerlinClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("ScalefactortoapplytothefrequenciesdefinedintheNoiseSettingsasset.1isnormal.Largermagnitudeswillmakethenoiseshakemorerapidly.")]
publicfloatm_FrequencyGain
CopyC# JavaScript
![Page 165: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/165.jpg)
Cinemachine
![Page 166: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/166.jpg)
CinemachineBasicMultiChannelPerlinField
SerializedpropertyforreferencingaNoiseSettingsasset
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:NoiseSettings
SeeAlsoReferenceCinemachineBasicMultiChannelPerlinClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[HideInInspector]
[TooltipAttribute("TheassetcontainingtheNoiseProfile.Definethefrequenciesandamplitudestheretomakeacharacteristicnoiseprofile.Makeyourownorjustuseoneofthemanypresets.")]
[FormerlySerializedAsAttribute("m_Definition")]
publicNoiseSettingsm_NoiseProfile
CopyC# JavaScript
![Page 167: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/167.jpg)
Cinemachine
![Page 168: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/168.jpg)
CinemachineBlendClass
Describesablendbetween2CinemachineVirtualCameras,andholdsthecurrentstateoftheblend.
InheritanceHierarchySystemObjectCinemachineCinemachineBlend
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineBlendtypeexposesthefollowingmembers.
Constructors Name Description
CinemachineBlend Constructablend
Top
Properties Name Description
BlendCurve Thecurvethatdescribesthewaytheblendtransitionsovertimefromthefirstcameratothesecond.X-
publicclassCinemachineBlend
CopyC# JavaScript
![Page 169: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/169.jpg)
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
Methods Name Description
![Page 170: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/170.jpg)
UpdateCameraState Makesurethesourcecamerasgetupdated.
Uses DoestheblenduseaspecificCinemachineVirtualCamera?
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 171: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/171.jpg)
Cinemachine
![Page 172: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/172.jpg)
CinemachineBlendConstructor
Constructablend
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 173: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/173.jpg)
Type:SystemSingleCurrenttimeinblend,relativetothestartoftheblend
SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 174: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/174.jpg)
Cinemachine
![Page 175: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/175.jpg)
CinemachineBlendProperties
TheCinemachineBlendtypeexposesthefollowingmembers.
Properties Name Description
BlendCurve Thecurvethatdescribesthewaytheblendtransitionsovertimefromthefirstcameratothesecond.X-axisistimeinsecondsoverwhichtheblendtakesplaceandYaxisisblendweight(0..1)
BlendWeight Thecurrentweightoftheblend.ThisisanevaluationoftheBlendCurveatthecurrenttimerelativetothestartoftheblend.0meanscamA,1meanscamB.
CamA Firstcameraintheblend
CamB Secondcameraintheblend
Description Textdescriptionoftheblend,fordebugging
Duration Durationinsecondsoftheblend.ThisisgivenreadfromtheBlendCurve.
IsComplete Trueifthetimerelativetothestartoftheblendisgreaterthanorequaltotheblendduration
![Page 176: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/176.jpg)
IsValid Validitytestfortheblend.Trueifbothcamerasaredefined.
State ComputetheblendedCameraStateforthecurrenttimeintheblend.
TimeInBlend Thecurrenttimerelativetothestartoftheblend
Top
SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 177: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/177.jpg)
Cinemachine
![Page 178: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/178.jpg)
CinemachineBlendBlendCurveProperty
Thecurvethatdescribesthewaytheblendtransitionsovertimefromthefirstcameratothesecond.X-axisistimeinsecondsoverwhichtheblendtakesplaceandYaxisisblendweight(0..1)
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:AnimationCurve
SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicAnimationCurveBlendCurve{get;set;}
CopyC# JavaScript
![Page 179: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/179.jpg)
Cinemachine
![Page 180: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/180.jpg)
CinemachineBlendBlendWeightProperty
Thecurrentweightoftheblend.ThisisanevaluationoftheBlendCurveatthecurrenttimerelativetothestartoftheblend.0meanscamA,1meanscamB.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Single
SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicfloatBlendWeight{get;}
CopyC# JavaScript
![Page 181: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/181.jpg)
Cinemachine
![Page 182: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/182.jpg)
CinemachineBlendCamAProperty
Firstcameraintheblend
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ICinemachineCamera
SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicICinemachineCameraCamA{get;set;}
CopyC# JavaScript
![Page 183: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/183.jpg)
Cinemachine
![Page 184: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/184.jpg)
CinemachineBlendCamBProperty
Secondcameraintheblend
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ICinemachineCamera
SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicICinemachineCameraCamB{get;set;}
CopyC# JavaScript
![Page 185: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/185.jpg)
Cinemachine
![Page 186: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/186.jpg)
CinemachineBlendDescriptionProperty
Textdescriptionoftheblend,fordebugging
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:String
SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstringDescription{get;}
CopyC# JavaScript
![Page 187: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/187.jpg)
Cinemachine
![Page 188: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/188.jpg)
CinemachineBlendDurationProperty
Durationinsecondsoftheblend.ThisisgivenreadfromtheBlendCurve.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Single
SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicfloatDuration{get;set;}
CopyC# JavaScript
![Page 189: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/189.jpg)
Cinemachine
![Page 190: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/190.jpg)
CinemachineBlendIsCompleteProperty
Trueifthetimerelativetothestartoftheblendisgreaterthanorequaltotheblendduration
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicboolIsComplete{get;}
CopyC# JavaScript
![Page 191: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/191.jpg)
Cinemachine
![Page 192: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/192.jpg)
CinemachineBlendIsValidProperty
Validitytestfortheblend.Trueifbothcamerasaredefined.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicboolIsValid{get;}
CopyC# JavaScript
![Page 193: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/193.jpg)
Cinemachine
![Page 194: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/194.jpg)
CinemachineBlendStateProperty
ComputetheblendedCameraStateforthecurrenttimeintheblend.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CameraState
SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCameraStateState{get;}
CopyC# JavaScript
![Page 195: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/195.jpg)
Cinemachine
![Page 196: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/196.jpg)
CinemachineBlendTimeInBlendProperty
Thecurrenttimerelativetothestartoftheblend
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Single
SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicfloatTimeInBlend{get;set;}
CopyC# JavaScript
![Page 197: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/197.jpg)
Cinemachine
![Page 198: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/198.jpg)
CinemachineBlendMethods
TheCinemachineBlendtypeexposesthefollowingmembers.
Methods Name Description
UpdateCameraState Makesurethesourcecamerasgetupdated.
Uses DoestheblenduseaspecificCinemachineVirtualCamera?
Top
SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 199: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/199.jpg)
Cinemachine
![Page 200: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/200.jpg)
CinemachineBlendUpdateCameraStateMethod
Makesurethesourcecamerasgetupdated.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
worldUpType:Vector3Defaultworldup.Individualvcamsmaymodifythis
deltaTimeType:SystemSingleTimeincrementusedforcalculatingtime-basedbehaviours(e.g.damping)
SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace
VisittheCinemachineForum
publicvoidUpdateCameraState(
Vector3worldUp,
floatdeltaTime
)
CopyC# JavaScript
![Page 202: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/202.jpg)
Cinemachine
![Page 203: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/203.jpg)
CinemachineBlendUsesMethod
DoestheblenduseaspecificCinemachineVirtualCamera?
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
camType:CinemachineICinemachineCameraThecameratotest
ReturnValueType:BooleanTrueifthecameraisinvolvedintheblend
SeeAlsoReferenceCinemachineBlendClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicboolUses(
ICinemachineCameracam
)
CopyC# JavaScript
![Page 204: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/204.jpg)
Cinemachine
![Page 205: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/205.jpg)
CinemachineBlendDefinitionStructure
DefinitionofaCamerablend.ThisstructholdstheinformationnecessarytogenerateasuitableAnimationCurveforaCinemachineBlend.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineBlendDefinitiontypeexposesthefollowingmembers.
Constructors Name Description
CinemachineBlendDefinition Constructor
Top
Properties Name Description
BlendCurve AnAnimationCurvespecifyingthe
[SerializableAttribute]
[DocumentationSortingAttribute(10.2f,DocumentationSortingAttribute
publicstructCinemachineBlendDefinition
CopyC# JavaScript
![Page 206: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/206.jpg)
interpolationdurationandvalueforthiscamerablend.Thetimeofthelastkeyframeisassumedtothebethedurationoftheblend.Y-axisvaluesmustbeinrange[0,1](internallyclampedwithinBlender)andtimemustbeinrangeof[0,+infinity)
Top
Fields Name Description
m_Style Theshapeoftheblendcurve.
m_Time Theduration(inseconds)oftheblend
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 207: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/207.jpg)
Cinemachine
![Page 208: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/208.jpg)
CinemachineBlendDefinitionConstructor
Constructor
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
styleType:CinemachineCinemachineBlendDefinitionStyleTheshapeoftheblendcurve.
timeType:SystemSingleTheduration(inseconds)oftheblend
SeeAlsoReferenceCinemachineBlendDefinitionStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineBlendDefinition(
CinemachineBlendDefinitionStylestyle,
floattime
)
CopyC# JavaScript
![Page 209: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/209.jpg)
![Page 210: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/210.jpg)
Cinemachine
![Page 211: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/211.jpg)
CinemachineBlendDefinitionProperties
TheCinemachineBlendDefinitiontypeexposesthefollowingmembers.
Properties Name Description
BlendCurve AnAnimationCurvespecifyingtheinterpolationdurationandvalueforthiscamerablend.Thetimeofthelastkeyframeisassumedtothebethedurationoftheblend.Y-axisvaluesmustbeinrange[0,1](internallyclampedwithinBlender)andtimemustbeinrangeof[0,+infinity)
Top
SeeAlsoReferenceCinemachineBlendDefinitionStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 212: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/212.jpg)
Cinemachine
![Page 213: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/213.jpg)
CinemachineBlendDefinitionBlendCurveProperty
AnAnimationCurvespecifyingtheinterpolationdurationandvalueforthiscamerablend.Thetimeofthelastkeyframeisassumedtothebethedurationoftheblend.Y-axisvaluesmustbeinrange[0,1](internallyclampedwithinBlender)andtimemustbeinrangeof[0,+infinity)
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:AnimationCurve
SeeAlsoReferenceCinemachineBlendDefinitionStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicAnimationCurveBlendCurve{get;}
CopyC# JavaScript
![Page 214: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/214.jpg)
Cinemachine
![Page 215: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/215.jpg)
CinemachineBlendDefinitionFields
TheCinemachineBlendDefinitiontypeexposesthefollowingmembers.
Fields Name Description
m_Style Theshapeoftheblendcurve.
m_Time Theduration(inseconds)oftheblend
Top
SeeAlsoReferenceCinemachineBlendDefinitionStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 216: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/216.jpg)
Cinemachine
![Page 217: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/217.jpg)
CinemachineBlendDefinitionm_StyleField
Theshapeoftheblendcurve.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineBlendDefinitionStyle
SeeAlsoReferenceCinemachineBlendDefinitionStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Shapeoftheblendcurve")]
publicCinemachineBlendDefinitionStylem_Style
CopyC# JavaScript
![Page 218: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/218.jpg)
Cinemachine
![Page 219: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/219.jpg)
CinemachineBlendDefinitionm_TimeField
Theduration(inseconds)oftheblend
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineBlendDefinitionStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Durationoftheblend,inseconds")]
publicfloatm_Time
CopyC# JavaScript
![Page 220: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/220.jpg)
Cinemachine
![Page 221: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/221.jpg)
CinemachineBlendDefinitionStyleEnumeration
Supportedpredefinedshapesfortheblendcurve.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members
Membername Value Description
Cut 0 Zero-lengthblend
EaseInOut 1 S-shapedcurve,givingagentleandsmoothtransition
EaseIn 2 Linearoutoftheoutgoingshot,andeasyintotheincoming
EaseOut 3 Easyoutoftheoutgoingshot,andlinearintotheincoming
[DocumentationSortingAttribute(10.21f,DocumentationSortingAttribute
publicenumStyle
CopyC# JavaScript
![Page 222: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/222.jpg)
HardIn 4 Easyoutoftheoutgoing,andhardintotheincoming
HardOut 5 Hardoutoftheoutgoing,andeasyintotheincoming
Linear 6 Linearblend.Mechanical-looking.
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 223: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/223.jpg)
Cinemachine
![Page 224: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/224.jpg)
CinemachineBlendDefinitionPropertyAttributeClass
PropertyappliedtoCinemachineBlendDefinition.Usedforcustomdrawingintheinspector.
InheritanceHierarchySystemObjectSystemAttributePropertyAttributeCinemachineCinemachineBlendDefinitionPropertyAttribute
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineBlendDefinitionPropertyAttributetypeexposesthefollowingmembers.
Constructors Name Description
CinemachineBlendDefinitionPropertyAttribute
Top
SeeAlso
publicsealedclassCinemachineBlendDefinitionPropertyAttribute
CopyC# JavaScript
![Page 225: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/225.jpg)
ReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 226: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/226.jpg)
Cinemachine
![Page 227: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/227.jpg)
CinemachineBlendDefinitionPropertyAttributeConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineBlendDefinitionPropertyAttribute.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineBlendDefinitionPropertyAttributeClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineBlendDefinitionPropertyAttribute()
CopyC# JavaScript
![Page 228: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/228.jpg)
Cinemachine
![Page 229: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/229.jpg)
CinemachineBlenderSettingsClass
AssetthatdefinestherulesforblendingbetweenVirtualCameras.
InheritanceHierarchySystemObjectObjectScriptableObjectCinemachineCinemachineBlenderSettings
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineBlenderSettingstypeexposesthefollowingmembers.
Constructors Name Description
CinemachineBlenderSettings
Top
[SerializableAttribute]
[DocumentationSortingAttribute(10f,DocumentationSortingAttribute
publicsealedclassCinemachineBlenderSettings:ScriptableObject
CopyC# JavaScript
![Page 230: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/230.jpg)
Methods Name Description
GetBlendCurveForVirtualCameras Attemptstofindablendcurvewhichmatchesthetoandfromcamerasasspecified.Ifnomatchisfound,thefunctionreturnseitherthedefaultblendforthisBlenderorNULLdependingonthestatereturnDefaultOnNoMatch
Top
Fields Name Description
kBlendFromAnyCameraLabel InternalAPIfortheinspectoreditopr:alabeltorepresentanycamera
m_CustomBlends ThearraycontainingexplicitlydefinedblendsbetweentwoVirtualCameras
Top
SeeAlso
![Page 231: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/231.jpg)
ReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 232: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/232.jpg)
Cinemachine
![Page 233: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/233.jpg)
CinemachineBlenderSettingsConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineBlenderSettings.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineBlenderSettingsClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineBlenderSettings()
CopyC# JavaScript
![Page 234: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/234.jpg)
Cinemachine
![Page 235: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/235.jpg)
CinemachineBlenderSettingsMethods
TheCinemachineBlenderSettingstypeexposesthefollowingmembers.
Methods Name Description
GetBlendCurveForVirtualCameras Attemptstofindablendcurvewhichmatchesthetoandfromcamerasasspecified.Ifnomatchisfound,thefunctionreturnseitherthedefaultblendforthisBlenderorNULLdependingonthestatereturnDefaultOnNoMatch
Top
SeeAlsoReferenceCinemachineBlenderSettingsClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 236: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/236.jpg)
Cinemachine
![Page 237: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/237.jpg)
CinemachineBlenderSettingsGetBlendCurveForVirtualCamerasMethod
Attemptstofindablendcurvewhichmatchesthetoandfromcamerasasspecified.Ifnomatchisfound,thefunctionreturnseitherthedefaultblendforthisBlenderorNULLdependingonthestateofreturnDefaultOnNoMatch.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
fromCameraNameType:SystemStringThegameobjectnameofthefromcamera
toCameraNameType:SystemStringThegameobjectnameofthetocamera
defaultCurveType:AnimationCurveCurvetoreturnifnocurvefound.CanbeNULL.
publicAnimationCurveGetBlendCurveForVirtualCameras
stringfromCameraName,
stringtoCameraName,
AnimationCurvedefaultCurve
)
CopyC# JavaScript
![Page 238: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/238.jpg)
ReturnValueType:AnimationCurve[Missing<returns>documentationfor"M:Cinemachine.CinemachineBlenderSettings.GetBlendCurveForVirtualCameras(System.String,System.String,UnityEngine.AnimationCurve)"]
SeeAlsoReferenceCinemachineBlenderSettingsClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 239: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/239.jpg)
Cinemachine
![Page 240: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/240.jpg)
CinemachineBlenderSettingsFields
TheCinemachineBlenderSettingstypeexposesthefollowingmembers.
Fields Name Description
kBlendFromAnyCameraLabel InternalAPIfortheinspectoreditopr:alabeltorepresentanycamera
m_CustomBlends ThearraycontainingexplicitlydefinedblendsbetweentwoVirtualCameras
Top
SeeAlsoReferenceCinemachineBlenderSettingsClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 241: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/241.jpg)
Cinemachine
![Page 242: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/242.jpg)
CinemachineBlenderSettingskBlendFromAnyCameraLabelField
InternalAPIfortheinspectoreditopr:alabeltorepresentanycamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:String
SeeAlsoReferenceCinemachineBlenderSettingsClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicconststringkBlendFromAnyCameraLabel="**ANYCAMERA**"
CopyC# JavaScript
![Page 243: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/243.jpg)
Cinemachine
![Page 244: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/244.jpg)
CinemachineBlenderSettingsm_CustomBlendsField
ThearraycontainingexplicitlydefinedblendsbetweentwoVirtualCameras
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineBlenderSettingsCustomBlend
SeeAlsoReferenceCinemachineBlenderSettingsClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("ThearraycontainingexplicitlydefinedblendsbetweentwoVirtualCameras")]
publicCinemachineBlenderSettingsCustomBlend[]m_CustomBlends
CopyC# JavaScript
![Page 245: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/245.jpg)
Cinemachine
![Page 246: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/246.jpg)
CinemachineBlenderSettingsCustomBlendStructure
ContainerspecifyinghowtwospecificCinemachineVirtualCamerasblendtogether.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineBlenderSettingsCustomBlendtypeexposesthefollowingmembers.
Fields Name Description
m_Blend
m_From
m_To
Top
SeeAlso
[SerializableAttribute]
[DocumentationSortingAttribute(10.1f,DocumentationSortingAttribute
publicstructCustomBlend
CopyC# JavaScript
![Page 247: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/247.jpg)
ReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 248: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/248.jpg)
Cinemachine
![Page 249: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/249.jpg)
CustomBlendFields
TheCinemachineBlenderSettingsCustomBlendtypeexposesthefollowingmembers.
Fields Name Description
m_Blend
m_From
m_To
Top
SeeAlsoReferenceCinemachineBlenderSettingsCustomBlendStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 250: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/250.jpg)
Cinemachine
![Page 251: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/251.jpg)
CinemachineBlenderSettingsCustomBlendField
[Missing<summary>documentationfor"F:Cinemachine.CinemachineBlenderSettings.CustomBlend.m_Blend"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineBlendDefinition
SeeAlsoReferenceCinemachineBlenderSettingsCustomBlendStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Blendcurvedefinition")]
publicCinemachineBlendDefinitionm_Blend
CopyC# JavaScript
![Page 252: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/252.jpg)
Cinemachine
![Page 253: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/253.jpg)
CinemachineBlenderSettingsCustomBlendField
[Missing<summary>documentationfor"F:Cinemachine.CinemachineBlenderSettings.CustomBlend.m_From"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:String
SeeAlsoReferenceCinemachineBlenderSettingsCustomBlendStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Whenblendingfromthiscamera")]
publicstringm_From
CopyC# JavaScript
![Page 254: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/254.jpg)
Cinemachine
![Page 255: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/255.jpg)
CinemachineBlenderSettingsCustomBlendField
[Missing<summary>documentationfor"F:Cinemachine.CinemachineBlenderSettings.CustomBlend.m_To"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:String
SeeAlsoReferenceCinemachineBlenderSettingsCustomBlendStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Whenblendingtothiscamera")]
publicstringm_To
CopyC# JavaScript
![Page 256: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/256.jpg)
Cinemachine
![Page 257: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/257.jpg)
CinemachineBlendListCameraClass
Thisisavirtualcamera"manager"thatownsandmanagesacollectionofchildVirtualCameras.Whenthecameragoeslive,thesechildvcamsareenabled,oneafteranother,holdingeachcameraforadesignatedtime.Blendsbetweencamerasarespecified.Thelastcameraisheldindefinitely.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineBlendListCamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineBlendListCameratypeexposesthefollowingmembers.
[DocumentationSortingAttribute(13f,DocumentationSortingAttribute
[ExecuteInEditMode]
[DisallowMultipleComponent]
[AddComponentMenu("Cinemachine/CinemachineBlendListCamera")]
publicclassCinemachineBlendListCamera:CinemachineVirtualCameraBase
CopyC# JavaScript
![Page 258: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/258.jpg)
Constructors Name Description
CinemachineBlendListCamera
Top
Properties Name Description
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
![Page 259: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/259.jpg)
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
![Page 260: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/260.jpg)
Top
Methods Name Description
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.
![Page 261: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/261.jpg)
(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
Fields Name Description
CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.
![Page 262: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/262.jpg)
(InheritedfromCinemachineVirtualCameraBase
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
![Page 263: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/263.jpg)
thestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase
m_ShowDebugText Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging
OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 264: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/264.jpg)
Cinemachine
![Page 265: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/265.jpg)
CinemachineBlendListCameraConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineBlendListCamera.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineBlendListCamera()
CopyC# JavaScript
![Page 266: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/266.jpg)
Cinemachine
![Page 267: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/267.jpg)
CinemachineBlendListCameraProperties
TheCinemachineBlendListCameratypeexposesthefollowingmembers.
Properties Name Description
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.
![Page 268: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/268.jpg)
LookAtifparentisnon-nullandnospecificLookAtdefinedforthiscamera(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
![Page 269: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/269.jpg)
Top
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 270: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/270.jpg)
Cinemachine
![Page 271: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/271.jpg)
CinemachineBlendListCameraChildCamerasProperty
Thelistofchildcameras.Thesearejusttheimmediatechildreninthehierarchy.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineVirtualCameraBase
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineVirtualCameraBase[]ChildCameras{
CopyC# JavaScript
![Page 272: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/272.jpg)
Cinemachine
![Page 273: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/273.jpg)
CinemachineBlendListCameraDescriptionProperty
Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:StringImplementsICinemachineCameraDescription
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridestringDescription{get;}
CopyC# JavaScript
![Page 274: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/274.jpg)
Cinemachine
![Page 275: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/275.jpg)
CinemachineBlendListCameraFollowProperty
GetthecurrentFollowtarget.Returnsparent'sFollowifparentisnon-nullandnospecificFollowdefinedforthiscamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:TransformImplementsICinemachineCameraFollow
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideTransformFollow{get;set;}
CopyC# JavaScript
![Page 276: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/276.jpg)
Cinemachine
![Page 277: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/277.jpg)
CinemachineBlendListCameraIsBlendingProperty
Isthereablendinprogress?
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicboolIsBlending{get;}
CopyC# JavaScript
![Page 278: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/278.jpg)
Cinemachine
![Page 279: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/279.jpg)
CinemachineBlendListCameraLiveChildProperty
Getthecurrent"best"childvirtualcamera,thatwouldbechoseniftheStateDrivenCamerawereactive.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ICinemachineCamera
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicICinemachineCameraLiveChild{get;set;}
CopyC# JavaScript
![Page 280: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/280.jpg)
Cinemachine
![Page 281: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/281.jpg)
CinemachineBlendListCameraLiveChildOrSelfProperty
Returnthelivechild.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ICinemachineCameraImplementsICinemachineCameraLiveChildOrSelf
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideICinemachineCameraLiveChildOrSelf{
CopyC# JavaScript
![Page 282: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/282.jpg)
Cinemachine
![Page 283: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/283.jpg)
CinemachineBlendListCameraLookAtProperty
GetthecurrentLookAttarget.Returnsparent'sLookAtifparentisnon-nullandnospecificLookAtdefinedforthiscamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:TransformImplementsICinemachineCameraLookAt
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideTransformLookAt{get;set;}
CopyC# JavaScript
![Page 284: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/284.jpg)
Cinemachine
![Page 285: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/285.jpg)
CinemachineBlendListCameraStateProperty
TheStateofthecurrentlivechild
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CameraStateImplementsICinemachineCameraState
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideCameraStateState{get;}
CopyC# JavaScript
![Page 286: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/286.jpg)
Cinemachine
![Page 287: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/287.jpg)
CinemachineBlendListCameraMethods
TheCinemachineBlendListCameratypeexposesthefollowingmembers.
Methods Name Description
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
![Page 288: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/288.jpg)
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
![Page 289: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/289.jpg)
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 290: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/290.jpg)
Cinemachine
![Page 291: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/291.jpg)
CinemachineBlendListCameraIsLiveChildMethod
Checkwhetherthevcamalivechildofthiscamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineICinemachineCameraTheVirtualCameratocheck
ReturnValueType:BooleanTrueifthevcamiscurrentlyactivelyinfluencingthestateofthisvcamImplementsICinemachineCameraIsLiveChild(ICinemachineCamera)
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
publicoverrideboolIsLiveChild(
ICinemachineCameravcam
)
CopyC# JavaScript
![Page 292: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/292.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 293: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/293.jpg)
Cinemachine
![Page 294: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/294.jpg)
CinemachineBlendListCameraOnEnableMethod
Makessuretheinternalchildcacheisuptodate
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedoverridevoidOnEnable()
CopyC# JavaScript
![Page 295: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/295.jpg)
Cinemachine
![Page 296: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/296.jpg)
CinemachineBlendListCameraOnTransformChildrenChangedMethod
Makessuretheinternalchildcacheisuptodate
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidOnTransformChildrenChanged()
CopyC# JavaScript
![Page 297: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/297.jpg)
Cinemachine
![Page 298: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/298.jpg)
CinemachineBlendListCameraOnTransitionFromCameraMethod
[Missing<summary>documentationfor"M:Cinemachine.CinemachineBlendListCamera.OnTransitionFromCamera(Cinemachine.ICinemachineCamera)"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
fromCamType:CinemachineICinemachineCamera[Missing<paramname="fromCam"/>documentationfor"M:Cinemachine.CinemachineBlendListCamera.OnTransitionFromCamera(Cinemachine.ICinemachineCamera)"]
ImplementsICinemachineCameraOnTransitionFromCamera(ICinemachineCamera)
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
publicoverridevoidOnTransitionFromCamera(
ICinemachineCamerafromCam
)
CopyC# JavaScript
![Page 299: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/299.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 300: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/300.jpg)
Cinemachine
![Page 301: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/301.jpg)
CinemachineBlendListCameraRemovePostPipelineStageHookMethod
RemoveaPipelinestagehookcallback.Makesureitisremovedfromallthechildren.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
dType:CinemachineCinemachineVirtualCameraBaseOnPostPipelineStageDelegateThedelegatetoremove.
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridevoidRemovePostPipelineStageHook(
CinemachineVirtualCameraBaseOnPostPipelineStageDelegate
)
CopyC# JavaScript
![Page 302: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/302.jpg)
Cinemachine
![Page 303: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/303.jpg)
CinemachineBlendListCameraUpdateCameraStateMethod
CalledbyCinemachineCoreatdesignatedupdatetimesothevcamcanpositionitselfandtrackitstargets.Thisimplementationupdatesallthechildren,choosesthebestone,andimplementsanyrequiredblending.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
worldUpType:Vector3DefaultworldUp,setbytheCinemachineBrain
deltaTimeType:SystemSingleDeltatimefortime-basedeffects(ignoreiflessthanorequalto0)
ImplementsICinemachineCameraUpdateCameraState(Vector3,Single)
SeeAlso
publicoverridevoidUpdateCameraState(
Vector3worldUp,
floatdeltaTime
)
CopyC# JavaScript
![Page 304: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/304.jpg)
ReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 305: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/305.jpg)
Cinemachine
![Page 306: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/306.jpg)
CinemachineBlendListCameraValidateInstructionsMethod
InternalAPIfortheinspectoreditor.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidValidateInstructions()
CopyC# JavaScript
![Page 307: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/307.jpg)
Cinemachine
![Page 308: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/308.jpg)
CinemachineBlendListCameraFields
TheCinemachineBlendListCameratypeexposesthefollowingmembers.
Fields Name Description
CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.(InheritedfromCinemachineVirtualCameraBase
m_ChildCameras InternalAPIfortheeditor.usethisfield
m_EnableAllChildCameras Forceallchildcamerastobeenabled.ThisisusefulifanimatingtheminTimeline,butconsumesextraresources.
m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_Follow Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildrig.Maybeempty
![Page 309: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/309.jpg)
m_Instructions Thesetofinstructionsassociatingvirtualcameraswithstates.setofinstructionsforenablingchildcameras
m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_LookAt Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildrig.Maybeempty
m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase
m_ShowDebugText Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging
OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
![Page 310: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/310.jpg)
Top
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 311: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/311.jpg)
Cinemachine
![Page 312: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/312.jpg)
CinemachineBlendListCameram_ChildCamerasField
InternalAPIfortheeditor.Donotusethisfield
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineVirtualCameraBase
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[SerializeField]
[HideInInspector]
[NoSaveDuringPlayAttribute]
publicCinemachineVirtualCameraBase[]m_ChildCameras
CopyC# JavaScript
![Page 313: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/313.jpg)
Cinemachine
![Page 314: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/314.jpg)
CinemachineBlendListCameram_EnableAllChildCamerasField
Forceallchildcamerastobeenabled.ThisisusefulifanimatingtheminTimeline,butconsumesextraresources.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Forceallchildcamerastobeenabled.ThisisusefulifanimatingtheminTimeline,butconsumesextraresources")]
publicboolm_EnableAllChildCameras
CopyC# JavaScript
![Page 315: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/315.jpg)
Cinemachine
![Page 316: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/316.jpg)
CinemachineBlendListCameram_FollowField
Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildrig.Maybeempty
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Transform
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildcamera.Maybeemptyifallofthechildrendefinetargetsoftheirown.")]
[NoSaveDuringPlayAttribute]
publicTransformm_Follow
CopyC# JavaScript
![Page 317: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/317.jpg)
Cinemachine
![Page 318: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/318.jpg)
CinemachineBlendListCameram_InstructionsField
Thesetofinstructionsassociatingvirtualcameraswithstates.Thesetofinstructionsforenablingchildcameras
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineBlendListCameraInstruction
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thesetofinstructionsforenablingchildcameras.")]
publicCinemachineBlendListCameraInstruction[]m_Instructions
CopyC# JavaScript
![Page 319: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/319.jpg)
Cinemachine
![Page 320: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/320.jpg)
CinemachineBlendListCameram_LookAtField
Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildrig.Maybeempty
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Transform
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildcamera.Maybeemptyifallofthechildrendefinetargetsoftheirown.")]
[NoSaveDuringPlayAttribute]
publicTransformm_LookAt
CopyC# JavaScript
![Page 321: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/321.jpg)
Cinemachine
![Page 322: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/322.jpg)
CinemachineBlendListCameram_ShowDebugTextField
Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineBlendListCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Whenenabled,thecurrentchildcameraandblendwillbeindicatedinthegamewindow,fordebugging")]
publicboolm_ShowDebugText
CopyC# JavaScript
![Page 323: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/323.jpg)
Cinemachine
![Page 324: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/324.jpg)
CinemachineBlendListCameraInstructionStructure
ThisrepresentsasingleentryintheinstrunctionlistoftheBlendListCamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineBlendListCameraInstructiontypeexposesthefollowingmembers.
Fields Name Description
m_Blend Howtoblendtothenextvirtualcamerainthelist(ifany)
m_Hold Howlongtowait(inseconds)beforeactivatingthenextvirtualcamerainthelist(ifany)
m_VirtualCamera Thevirtualcameratoactivatewhenthisinstructionbecomes
[SerializableAttribute]
publicstructInstruction
CopyC# JavaScript
![Page 325: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/325.jpg)
active
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 326: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/326.jpg)
Cinemachine
![Page 327: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/327.jpg)
InstructionFields
TheCinemachineBlendListCameraInstructiontypeexposesthefollowingmembers.
Fields Name Description
m_Blend Howtoblendtothenextvirtualcamerainthelist(ifany)
m_Hold Howlongtowait(inseconds)beforeactivatingthenextvirtualcamerainthelist(ifany)
m_VirtualCamera Thevirtualcameratoactivatewhenthisinstructionbecomesactive
Top
SeeAlsoReferenceCinemachineBlendListCameraInstructionStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 328: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/328.jpg)
Cinemachine
![Page 329: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/329.jpg)
CinemachineBlendListCameraInstructionField
Howtoblendtothenextvirtualcamerainthelist(ifany)
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineBlendDefinition
SeeAlsoReferenceCinemachineBlendListCameraInstructionStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[CinemachineBlendDefinitionPropertyAttribute]
[TooltipAttribute("Howtoblendtothenextvirtualcamerainthelist(ifany)")]
publicCinemachineBlendDefinitionm_Blend
CopyC# JavaScript
![Page 330: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/330.jpg)
Cinemachine
![Page 331: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/331.jpg)
CinemachineBlendListCameraInstructionField
Howlongtowait(inseconds)beforeactivatingthenextvirtualcamerainthelist(ifany)
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineBlendListCameraInstructionStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Howlongtowait(inseconds)beforeactivatingthenextvirtualcamerainthelist(ifany)")]
publicfloatm_Hold
CopyC# JavaScript
![Page 332: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/332.jpg)
Cinemachine
![Page 333: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/333.jpg)
CinemachineBlendListCameraInstructionField
Thevirtualcameratoactivatewhenthisinstructionbecomesactive
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineVirtualCameraBase
SeeAlsoReferenceCinemachineBlendListCameraInstructionStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thevirtualcameratoactivatewhenthisinstructionbecomesactive")]
publicCinemachineVirtualCameraBasem_VirtualCamera
CopyC# JavaScript
![Page 334: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/334.jpg)
Cinemachine
![Page 335: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/335.jpg)
CinemachineBrainClass
CinemachineBrainisthelinkbetweentheUnityCameraandtheCinemachineVirtualCamerasinthescene.ItmonitorstheprioritystacktochoosethecurrentVirtualCamera,andblendwithanotherifnecessary.Finallyandmostimportantly,itappliestheVirtualCamerastatetotheattachedUnityCamera.TheCinemachineBrainisalsotheplacewhererulesforblendingbetweenvirtualcamerasaredefined.Camerablendingisaninterpolationovertimeofonevirtualcamerapositionandstatetoanother.Ifyouthinkofvirtualcamerasascameramen,thenblendingisalittlelikeonecameramansmoothlypassingthecameratoanothercameraman.Youcanspecifythetimeoverwhichtoblend,aswellastheblendcurveshape.Notethatacameracutisjustazero-timeblend.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineBrain
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
[DocumentationSortingAttribute(0f,DocumentationSortingAttribute
[ExecuteInEditMode]
[DisallowMultipleComponent]
[AddComponentMenu("Cinemachine/CinemachineBrain")]
[SaveDuringPlayAttribute]
publicclassCinemachineBrain:MonoBehaviour
CopyC# JavaScript
![Page 336: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/336.jpg)
TheCinemachineBraintypeexposesthefollowingmembers.
Constructors Name Description
CinemachineBrain
Top
Properties Name Description
ActiveBlend Getthecurrentblendinprogress.Returnsnullifnone.
ActiveVirtualCamera Getthecurrentactivevirtualcamera.
CurrentCameraState Thecurrentstateappliedtotheunitycamera(maybetheresultofablend)
DefaultWorldUp Getthedefaultworldupforthevirtualcameras.
IsBlending Isthereablendinprogress?
OutputCamera GettheUnityCamerathatisattachedtothisGameObject.Thisisthecamerathatwillbecontrolledbythebrain.
![Page 337: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/337.jpg)
SoloCamera APIfortheUnityEditor.Showthiscameranomatterwhat.Thisisstatic,andsoaffectsallCinemachinebrains.
Top
Methods Name Description
GetSoloGUIColor APIfortheUnityEditor.
IsLive TrueiftheICinemachineCamerathecurrentactivecamera,orpartofacurrentblend,eitherdirectlyorindirectlybecauseitsparentsarelive.
Top
Fields Name Description
m_CameraActivatedEvent Thiseventwillfirewheneveravirtualcameragoeslive.Ifablendisinvolved,thentheeventwillfireonthefirstframeoftheblend
m_CameraCutEvent Thiseventwillfirewheneveravirtualcameragoesliveandthereisnoblend
![Page 338: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/338.jpg)
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
![Page 339: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/339.jpg)
RigidBodyanimation.SmartUpdatewillchoosethebestmethodforeachvirtualcamera,dependingonhowthetargetisanimated.
m_WorldUpOverride Ifset,thisobject'sYaxiswilldefinetheworldspaceUpvectorforallthevirtualcameras.Thisisusefulintop-downgameenvironments.Ifnotset,UpisworldspaceY.
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 340: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/340.jpg)
Cinemachine
![Page 341: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/341.jpg)
CinemachineBrainConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineBrain.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineBrain()
CopyC# JavaScript
![Page 342: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/342.jpg)
Cinemachine
![Page 343: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/343.jpg)
CinemachineBrainProperties
TheCinemachineBraintypeexposesthefollowingmembers.
Properties Name Description
ActiveBlend Getthecurrentblendinprogress.Returnsnullifnone.
ActiveVirtualCamera Getthecurrentactivevirtualcamera.
CurrentCameraState Thecurrentstateappliedtotheunitycamera(maybetheresultofablend)
DefaultWorldUp Getthedefaultworldupforthevirtualcameras.
IsBlending Isthereablendinprogress?
OutputCamera GettheUnityCamerathatisattachedtothisGameObject.Thisisthecamerathatwillbecontrolledbythebrain.
SoloCamera APIfortheUnityEditor.Showthiscameranomatterwhat.Thisisstatic,andsoaffectsallCinemachinebrains.
![Page 344: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/344.jpg)
Top
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 345: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/345.jpg)
Cinemachine
![Page 346: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/346.jpg)
CinemachineBrainActiveBlendProperty
Getthecurrentblendinprogress.Returnsnullifnone.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineBlend
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineBlendActiveBlend{get;}
CopyC# JavaScript
![Page 347: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/347.jpg)
Cinemachine
![Page 348: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/348.jpg)
CinemachineBrainActiveVirtualCameraProperty
Getthecurrentactivevirtualcamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ICinemachineCamera
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicICinemachineCameraActiveVirtualCamera{get
CopyC# JavaScript
![Page 349: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/349.jpg)
Cinemachine
![Page 350: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/350.jpg)
CinemachineBrainCurrentCameraStateProperty
Thecurrentstateappliedtotheunitycamera(maybetheresultofablend)
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CameraState
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCameraStateCurrentCameraState{get;}
CopyC# JavaScript
![Page 351: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/351.jpg)
Cinemachine
![Page 352: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/352.jpg)
CinemachineBrainDefaultWorldUpProperty
Getthedefaultworldupforthevirtualcameras.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Vector3
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicVector3DefaultWorldUp{get;}
CopyC# JavaScript
![Page 353: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/353.jpg)
Cinemachine
![Page 354: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/354.jpg)
CinemachineBrainIsBlendingProperty
Isthereablendinprogress?
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicboolIsBlending{get;}
CopyC# JavaScript
![Page 355: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/355.jpg)
Cinemachine
![Page 356: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/356.jpg)
CinemachineBrainOutputCameraProperty
GettheUnityCamerathatisattachedtothisGameObject.Thisisthecamerathatwillbecontrolledbythebrain.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Camera
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCameraOutputCamera{get;}
CopyC# JavaScript
![Page 357: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/357.jpg)
Cinemachine
![Page 358: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/358.jpg)
CinemachineBrainSoloCameraProperty
APIfortheUnityEditor.Showthiscameranomatterwhat.Thisisstatic,andsoaffectsallCinemachinebrains.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ICinemachineCamera
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticICinemachineCameraSoloCamera{get;
CopyC# JavaScript
![Page 359: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/359.jpg)
Cinemachine
![Page 360: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/360.jpg)
CinemachineBrainMethods
TheCinemachineBraintypeexposesthefollowingmembers.
Methods Name Description
GetSoloGUIColor APIfortheUnityEditor.
IsLive TrueiftheICinemachineCamerathecurrentactivecamera,orpartofacurrentblend,eitherdirectlyorindirectlybecauseitsparentsarelive.
Top
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 361: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/361.jpg)
Cinemachine
![Page 362: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/362.jpg)
CinemachineBrainGetSoloGUIColorMethod
APIfortheUnityEditor.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
ReturnValueType:ColorColorusedtoindicatethatacameraisinSolomode.
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticColorGetSoloGUIColor()
CopyC# JavaScript
![Page 363: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/363.jpg)
Cinemachine
![Page 364: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/364.jpg)
CinemachineBrainIsLiveMethod
TrueiftheICinemachineCamerathecurrentactivecamera,orpartofacurrentblend,eitherdirectlyorindirectlybecauseitsparentsarelive.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineICinemachineCameraThecameratotestwhetheritislive
ReturnValueType:BooleanTrueifthecameraislive(directlyorindirectly)orpartofablendinprogress.
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicboolIsLive(
ICinemachineCameravcam
)
CopyC# JavaScript
![Page 365: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/365.jpg)
![Page 366: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/366.jpg)
Cinemachine
![Page 367: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/367.jpg)
CinemachineBrainFields
TheCinemachineBraintypeexposesthefollowingmembers.
Fields Name Description
m_CameraActivatedEvent Thiseventwillfirewheneveravirtualcameragoeslive.Ifablendisinvolved,thentheeventwillfireonthefirstframeoftheblend
m_CameraCutEvent Thiseventwillfirewheneveravirtualcameragoesliveandthereisnoblend
m_CustomBlends Thisistheassetwhichcontainscustomsettingsforspecificblends.
m_DefaultBlend Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras.
m_IgnoreTimeScale Whenenabled,thecameraswillalwaysrespondinreal-timetouserinputand
![Page 368: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/368.jpg)
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
![Page 369: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/369.jpg)
worldspaceY.
Top
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 370: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/370.jpg)
Cinemachine
![Page 371: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/371.jpg)
CinemachineBrainm_CameraActivatedEventField
Thiseventwillfirewheneveravirtualcameragoeslive.Ifablendisinvolved,thentheeventwillfireonthefirstframeoftheblend
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineBrainVcamEvent
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thiseventwillfirewheneveravirtualcameragoeslive.Ifablendisinvolved,thentheeventwillfireonthefirstframeoftheblend.")]
publicCinemachineBrainVcamEventm_CameraActivatedEvent
CopyC# JavaScript
![Page 372: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/372.jpg)
Cinemachine
![Page 373: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/373.jpg)
CinemachineBrainm_CameraCutEventField
Thiseventwillfirewheneveravirtualcameragoesliveandthereisnoblend
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineBrainBrainEvent
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thiseventwillfirewheneveravirtualcameragoesliveandthereisnoblend")]
publicCinemachineBrainBrainEventm_CameraCutEvent
CopyC# JavaScript
![Page 374: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/374.jpg)
Cinemachine
![Page 375: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/375.jpg)
CinemachineBrainm_CustomBlendsField
Thisistheassetwhichcontainscustomsettingsforspecificblends.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineBlenderSettings
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thisistheassetthatcontainscustomsettingsforblendsbetweenspecificvirtualcamerasinyourscene")]
publicCinemachineBlenderSettingsm_CustomBlends
CopyC# JavaScript
![Page 376: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/376.jpg)
Cinemachine
![Page 377: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/377.jpg)
CinemachineBrainm_DefaultBlendField
Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineBlendDefinition
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[CinemachineBlendDefinitionPropertyAttribute]
[TooltipAttribute("Theblendthatisusedincaseswhereyouhaven'texplicitlydefinedablendbetweentwoVirtualCameras")]
publicCinemachineBlendDefinitionm_DefaultBlend
CopyC# JavaScript
![Page 378: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/378.jpg)
Cinemachine
![Page 379: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/379.jpg)
CinemachineBrainm_IgnoreTimeScaleField
Whenenabled,thecameraswillalwaysrespondinreal-timetouserinputanddamping,evenifthegameisrunninginslowmotion
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Whenenabled,thecameraswillalwaysrespondinreal-timetouserinputanddamping,evenifthegameisrunninginslowmotion")]
publicboolm_IgnoreTimeScale
CopyC# JavaScript
![Page 380: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/380.jpg)
Cinemachine
![Page 381: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/381.jpg)
CinemachineBrainm_ShowCameraFrustumField
Whenenabled,showsthecamera'sfrustuminthesceneview.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Whenenabled,thecamera'sfrustumwillbeshownatalltimesinthesceneview")]
publicboolm_ShowCameraFrustum
CopyC# JavaScript
![Page 382: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/382.jpg)
Cinemachine
![Page 383: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/383.jpg)
CinemachineBrainm_ShowDebugTextField
Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging")]
publicboolm_ShowDebugText
CopyC# JavaScript
![Page 384: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/384.jpg)
Cinemachine
![Page 385: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/385.jpg)
CinemachineBrainm_UpdateMethodField
Dependingonhowthetargetobjectsareanimated,adjusttheupdatemethodtominimizethepotentialjitter.UseFixedUpdateifallyourtargetsareanimatedwithforRigidBodyanimation.SmartUpdatewillchoosethebestmethodforeachvirtualcamera,dependingonhowthetargetisanimated.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineBrainUpdateMethod
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("UseFixedUpdateifallyourtargetsareanimatedduringFixedUpdate(e.g.RigidBodies),LateUpdateifallyourtargetsareanimatedduringthenormalUpdateloop,andSmartUpdateifyouwantCinemachinetodotheappropriatethingonaper-targetbasis.SmartUpdateistherecommendedsetting")]
publicCinemachineBrainUpdateMethodm_UpdateMethod
CopyC# JavaScript
![Page 386: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/386.jpg)
Cinemachine
![Page 387: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/387.jpg)
CinemachineBrainm_WorldUpOverrideField
Ifset,thisobject'sYaxiswilldefinetheworldspaceUpvectorforallthevirtualcameras.Thisisusefulintop-downgameenvironments.Ifnotset,UpisworldspaceY.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Transform
SeeAlsoReferenceCinemachineBrainClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Ifset,thisobject'sYaxiswilldefinetheworldspaceUpvectorforallthevirtualcameras.Thisisusefulforinstanceintop-downgameenvironments.Ifnotset,UpisworldspaceY.Settingthisappropriatelyisimportant,becauseVirtualCamerasdon'tlikelookingstraightuporstraightdown.")]
publicTransformm_WorldUpOverride
CopyC# JavaScript
![Page 388: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/388.jpg)
Cinemachine
![Page 389: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/389.jpg)
CinemachineBrainBrainEventClass
EventwithaCinemachineBrainparameter
InheritanceHierarchySystemObjectUnityEventBaseUnityEventCinemachineBrainCinemachineCinemachineBrainBrainEvent
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineBrainBrainEventtypeexposesthefollowingmembers.
Constructors Name Description
CinemachineBrainBrainEvent
Top
Methods
[SerializableAttribute]
publicclassBrainEvent:UnityEvent<CinemachineBrain
CopyC# JavaScript
![Page 390: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/390.jpg)
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.)
![Page 391: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/391.jpg)
ToString (InheritedfromUnityEventBase.)
ValidateRegistration(MethodInfo,Object,PersistentListenerMode)
(InheritedfromUnityEventBase.)
ValidateRegistration(MethodInfo,Object,PersistentListenerMode,Type)
(InheritedfromUnityEventBase.)
Top
ExplicitInterfaceImplementations Name
UnityEngine#ISerializationCallbackReceiver#OnAfterDeserialize
UnityEngine#ISerializationCallbackReceiver#OnBeforeSerialize
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 392: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/392.jpg)
Cinemachine
![Page 393: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/393.jpg)
CinemachineBrainBrainEventConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineBrain.BrainEvent.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineBrainBrainEventClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicBrainEvent()
CopyC# JavaScript
![Page 394: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/394.jpg)
Cinemachine
![Page 395: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/395.jpg)
BrainEventMethods
TheCinemachineBrainBrainEventtypeexposesthefollowingmembers.
Methods 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 (Inheritedfrom
![Page 396: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/396.jpg)
UnityEventBase.)
RemoveListener(UnityActionUTP) (InheritedfromUnityEventCinemachineBrain
RemoveListener(Object,MethodInfo)
(InheritedfromUnityEventBase.)
SetPersistentListenerState (InheritedfromUnityEventBase.)
ToString (InheritedfromUnityEventBase.)
ValidateRegistration(MethodInfo,Object,PersistentListenerMode)
(InheritedfromUnityEventBase.)
ValidateRegistration(MethodInfo,Object,PersistentListenerMode,Type)
(InheritedfromUnityEventBase.)
Top
ExplicitInterfaceImplementations Name
UnityEngine#ISerializationCallbackReceiver#OnAfterDeserialize
UnityEngine#ISerializationCallbackReceiver#OnBeforeSerialize
Top
SeeAlsoReferenceCinemachineBrainBrainEventClass
![Page 397: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/397.jpg)
CinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 398: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/398.jpg)
Cinemachine
![Page 399: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/399.jpg)
CinemachineBrainUpdateMethodEnumeration
Thisenumdefinestheoptionsavailablefortheupdatemethod.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members
Membername Value Description
FixedUpdate 0 VirtualcamerasareupdatedinsyncwiththePhysicsmodule,inFixedUpdate
LateUpdate 1 VirtualcamerasareupdatedinMonoBehaviourLateUpdate.
SmartUpdate 2 Virtualcamerasareupdatedaccordingtohowthetargetis
[DocumentationSortingAttribute(0.1f,DocumentationSortingAttribute
publicenumUpdateMethod
CopyC# JavaScript
![Page 400: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/400.jpg)
updated.
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 401: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/401.jpg)
Cinemachine
![Page 402: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/402.jpg)
CinemachineBrainVcamEventClass
EventwithaICinemachineCameraparameter
InheritanceHierarchySystemObjectUnityEventBaseUnityEventICinemachineCameraCinemachineCinemachineBrainVcamEvent
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineBrainVcamEventtypeexposesthefollowingmembers.
Constructors Name Description
CinemachineBrainVcamEvent
Top
Methods
[SerializableAttribute]
publicclassVcamEvent:UnityEvent<ICinemachineCamera
CopyC# JavaScript
![Page 403: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/403.jpg)
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
RemoveListener(Object,MethodInfo)
(InheritedfromUnityEventBase
SetPersistentListenerState (InheritedfromUnityEventBase
ToString (InheritedfromUnityEventBase
ValidateRegistration(MethodInfo,Object,PersistentListenerMode)
(InheritedfromUnityEventBase
ValidateRegistration(MethodInfo,Object,PersistentListenerMode,
(InheritedfromUnityEventBase
![Page 404: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/404.jpg)
Type)
Top
ExplicitInterfaceImplementations Name
UnityEngine#ISerializationCallbackReceiver#OnAfterDeserialize
UnityEngine#ISerializationCallbackReceiver#OnBeforeSerialize
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 405: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/405.jpg)
Cinemachine
![Page 406: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/406.jpg)
CinemachineBrainVcamEventConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineBrain.VcamEvent.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineBrainVcamEventClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicVcamEvent()
CopyC# JavaScript
![Page 407: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/407.jpg)
Cinemachine
![Page 408: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/408.jpg)
VcamEventMethods
TheCinemachineBrainVcamEventtypeexposesthefollowingmembers.
Methods 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
RemoveListener(Object,MethodInfo)
(InheritedfromUnityEventBase
![Page 409: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/409.jpg)
SetPersistentListenerState (InheritedfromUnityEventBase
ToString (InheritedfromUnityEventBase
ValidateRegistration(MethodInfo,Object,PersistentListenerMode)
(InheritedfromUnityEventBase
ValidateRegistration(MethodInfo,Object,PersistentListenerMode,Type)
(InheritedfromUnityEventBase
Top
ExplicitInterfaceImplementations Name
UnityEngine#ISerializationCallbackReceiver#OnAfterDeserialize
UnityEngine#ISerializationCallbackReceiver#OnBeforeSerialize
Top
SeeAlsoReferenceCinemachineBrainVcamEventClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 410: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/410.jpg)
Cinemachine
![Page 411: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/411.jpg)
CinemachineClearShotClass
CinemachineClearShotisa"managercamera"thatownsandmanagesasetofVirtualCameragameObjectchildren.WhenLive,theClearShotwillcheckthechildren,andchoosetheonewiththebestqualityshotandmakeitLive.Thiscanbeaverypowerfultool.IfthechildcamerashaveCinemachineColliderextensions,theywillanalyzethescenefortargetobstructions,optimaltargetdistance,andotheritems,andreporttheirassessmentofshotqualitybacktotheClearShotparent,whowillthenchoosethebestone.Youcanusethistosetupcomplexmulti-cameracoverageofascene,andbeassuredthataclearshotofthetargetwillalwaysbeavailable.Ifmultiplechildcamerashavethesameshotquality,theonewiththehighestprioritywillbechosen.YoucanalsodefinecustomblendsbetweentheClearShotchildren.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineClearShot
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
[DocumentationSortingAttribute(12f,DocumentationSortingAttribute
[ExecuteInEditMode]
[DisallowMultipleComponent]
[AddComponentMenu("Cinemachine/CinemachineClearShot")]
CopyC# JavaScript
![Page 412: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/412.jpg)
TheCinemachineClearShottypeexposesthefollowingmembers.
Constructors Name Description
CinemachineClearShot
Top
Properties Name Description
ChildCameras Thelistofchildcameras.Thesearejusttheimmediatechildreninthehierarchy.
Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo(OverridesCinemachineVirtualCameraBase
Follow GetthecurrentFollowtarget.Returnsparent'sFollowifparentisnon-nullandnospecificFollowdefinedforthiscamera(OverridesCinemachineVirtualCameraBase
IsBlending Isthereablendinprogress?
LiveChild Getthecurrent"best"childvirtualcamera,thatwouldbechoseniftheClearShotcamerawereactive.
LiveChildOrSelf Returnthelivechild.(Overrides
publicclassCinemachineClearShot:CinemachineVirtualCameraBase
![Page 413: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/413.jpg)
CinemachineVirtualCameraBase
LookAt GetthecurrentLookAttarget.LookAtifparentisnon-nullandnospecificLookAtdefinedforthiscamera(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 TheCameraStateofthecurrentlylivechild(OverridesCinemachineVirtualCameraBase
ValidatingStreamVersion Versionthatwaslaststreamed,forupgradinglegacy(InheritedfromCinemachineVirtualCameraBase
![Page 414: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/414.jpg)
VirtualCameraGameObject TheGameObjectowneroftheVirtualCamerabehaviour.(InheritedfromCinemachineVirtualCameraBase
Top
Methods Name Description
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
![Page 415: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/415.jpg)
OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.(OverridesCinemachineVirtualCameraBase
OnValidate Enforceboundsforfields,whenchangedininspector.basemethodiscalled,ValidatingStreamVersionwillbevalid.(InheritedfromCinemachineVirtualCameraBase
PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,areupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledLateUpdateinstead.Baseclassimplementationdoesnothing.(InheritedfromCinemachineVirtualCameraBase
RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.(OverridesCinemachineVirtualCameraBase
ResetRandomization IfRandomizeChoiceisenabled,callthistore-randomizethechildrennextframe.
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
Top
Fields Name Description
![Page 416: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/416.jpg)
CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.(InheritedfromCinemachineVirtualCameraBase
m_ActivateAfter Waitthismanysecondsbeforeactivatinganewchildcamera
m_ChildCameras InternalAPIfortheeditor.usethisfiled.
m_CustomBlends Thisistheassetwhichcontainscustomsettingsforspecificblends
m_DefaultBlend Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras
m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_Follow Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildcamera.Maybeempty.
m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_LookAt Defaultobjectforthecamerachildrentolookat(theaim
![Page 417: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/417.jpg)
target),ifnotspecifiedinachildcamera.Maybeempty.
m_MinDuration Anactivecameramustbeactiveforatleastthismanyseconds,unlessahigher-prioritycamerawantstoactivate
m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase
m_RandomizeChoice Ifchecked,camerachoicewillberandomizedifmultiplecamerasareequallydesirable.childlistorderwillbeused
m_ShowDebugText Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging
OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
Top
![Page 418: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/418.jpg)
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 419: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/419.jpg)
Cinemachine
![Page 420: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/420.jpg)
CinemachineClearShotConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineClearShot.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineClearShot()
CopyC# JavaScript
![Page 421: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/421.jpg)
Cinemachine
![Page 422: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/422.jpg)
CinemachineClearShotProperties
TheCinemachineClearShottypeexposesthefollowingmembers.
Properties Name Description
ChildCameras Thelistofchildcameras.Thesearejusttheimmediatechildreninthehierarchy.
Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo(OverridesCinemachineVirtualCameraBase
Follow GetthecurrentFollowtarget.Returnsparent'sFollowifparentisnon-nullandnospecificFollowdefinedforthiscamera(OverridesCinemachineVirtualCameraBase
IsBlending Isthereablendinprogress?
LiveChild Getthecurrent"best"childvirtualcamera,thatwouldbechoseniftheClearShotcamerawereactive.
LiveChildOrSelf Returnthelivechild.(OverridesCinemachineVirtualCameraBase
LookAt GetthecurrentLookAttarget.LookAtifparentisnon-nullandnospecific
![Page 423: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/423.jpg)
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 TheCameraStateofthecurrentlylivechild(OverridesCinemachineVirtualCameraBase
ValidatingStreamVersion Versionthatwaslaststreamed,forupgradinglegacy(InheritedfromCinemachineVirtualCameraBase
VirtualCameraGameObject TheGameObjectowneroftheVirtualCamerabehaviour.(InheritedfromCinemachineVirtualCameraBase
![Page 424: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/424.jpg)
Top
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 425: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/425.jpg)
Cinemachine
![Page 426: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/426.jpg)
CinemachineClearShotChildCamerasProperty
Thelistofchildcameras.Thesearejusttheimmediatechildreninthehierarchy.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineVirtualCameraBase
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineVirtualCameraBase[]ChildCameras{
CopyC# JavaScript
![Page 427: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/427.jpg)
Cinemachine
![Page 428: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/428.jpg)
CinemachineClearShotDescriptionProperty
Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:StringImplementsICinemachineCameraDescription
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridestringDescription{get;}
CopyC# JavaScript
![Page 429: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/429.jpg)
Cinemachine
![Page 430: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/430.jpg)
CinemachineClearShotFollowProperty
GetthecurrentFollowtarget.Returnsparent'sFollowifparentisnon-nullandnospecificFollowdefinedforthiscamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:TransformImplementsICinemachineCameraFollow
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideTransformFollow{get;set;}
CopyC# JavaScript
![Page 431: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/431.jpg)
Cinemachine
![Page 432: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/432.jpg)
CinemachineClearShotIsBlendingProperty
Isthereablendinprogress?
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicboolIsBlending{get;}
CopyC# JavaScript
![Page 433: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/433.jpg)
Cinemachine
![Page 434: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/434.jpg)
CinemachineClearShotLiveChildProperty
Getthecurrent"best"childvirtualcamera,thatwouldbechoseniftheClearShotcamerawereactive.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ICinemachineCamera
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicICinemachineCameraLiveChild{get;set;}
CopyC# JavaScript
![Page 435: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/435.jpg)
Cinemachine
![Page 436: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/436.jpg)
CinemachineClearShotLiveChildOrSelfProperty
Returnthelivechild.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ICinemachineCameraImplementsICinemachineCameraLiveChildOrSelf
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideICinemachineCameraLiveChildOrSelf{
CopyC# JavaScript
![Page 437: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/437.jpg)
Cinemachine
![Page 438: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/438.jpg)
CinemachineClearShotLookAtProperty
GetthecurrentLookAttarget.Returnsparent'sLookAtifparentisnon-nullandnospecificLookAtdefinedforthiscamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:TransformImplementsICinemachineCameraLookAt
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideTransformLookAt{get;set;}
CopyC# JavaScript
![Page 439: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/439.jpg)
Cinemachine
![Page 440: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/440.jpg)
CinemachineClearShotStateProperty
TheCameraStateofthecurrentlylivechild
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CameraStateImplementsICinemachineCameraState
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideCameraStateState{get;}
CopyC# JavaScript
![Page 441: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/441.jpg)
Cinemachine
![Page 442: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/442.jpg)
CinemachineClearShotMethods
TheCinemachineClearShottypeexposesthefollowingmembers.
Methods Name Description
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.
![Page 443: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/443.jpg)
(InheritedfromCinemachineVirtualCameraBase
OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.(OverridesCinemachineVirtualCameraBase
OnValidate Enforceboundsforfields,whenchangedininspector.basemethodiscalled,ValidatingStreamVersionwillbevalid.(InheritedfromCinemachineVirtualCameraBase
PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,areupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledLateUpdateinstead.Baseclassimplementationdoesnothing.(InheritedfromCinemachineVirtualCameraBase
RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.(OverridesCinemachineVirtualCameraBase
ResetRandomization IfRandomizeChoiceisenabled,callthistore-randomizethechildrennextframe.
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
Top
SeeAlso
![Page 444: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/444.jpg)
ReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 445: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/445.jpg)
Cinemachine
![Page 446: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/446.jpg)
CinemachineClearShotIsLiveChildMethod
Checkwhetherthevcamalivechildofthiscamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineICinemachineCameraTheVirtualCameratocheck
ReturnValueType:BooleanTrueifthevcamiscurrentlyactivelyinfluencingthestateofthisvcamImplementsICinemachineCameraIsLiveChild(ICinemachineCamera)
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
publicoverrideboolIsLiveChild(
ICinemachineCameravcam
)
CopyC# JavaScript
![Page 447: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/447.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 448: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/448.jpg)
Cinemachine
![Page 449: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/449.jpg)
CinemachineClearShotOnEnableMethod
Makessuretheinternalchildcacheisuptodate
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedoverridevoidOnEnable()
CopyC# JavaScript
![Page 450: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/450.jpg)
Cinemachine
![Page 451: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/451.jpg)
CinemachineClearShotOnTransformChildrenChangedMethod
Makessuretheinternalchildcacheisuptodate
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidOnTransformChildrenChanged()
CopyC# JavaScript
![Page 452: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/452.jpg)
Cinemachine
![Page 453: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/453.jpg)
CinemachineClearShotOnTransitionFromCameraMethod
Notificationthatthisvirtualcameraisgoinglive.Thisimplementationresetsthechildrandomization.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
fromCamType:CinemachineICinemachineCameraThecamerabeingdeactivated.Maybenull.
ImplementsICinemachineCameraOnTransitionFromCamera(ICinemachineCamera)
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridevoidOnTransitionFromCamera(
ICinemachineCamerafromCam
)
CopyC# JavaScript
![Page 454: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/454.jpg)
![Page 455: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/455.jpg)
Cinemachine
![Page 456: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/456.jpg)
CinemachineClearShotRemovePostPipelineStageHookMethod
RemoveaPipelinestagehookcallback.Makesureitisremovedfromallthechildren.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
dType:CinemachineCinemachineVirtualCameraBaseOnPostPipelineStageDelegateThedelegatetoremove.
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridevoidRemovePostPipelineStageHook(
CinemachineVirtualCameraBaseOnPostPipelineStageDelegate
)
CopyC# JavaScript
![Page 457: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/457.jpg)
Cinemachine
![Page 458: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/458.jpg)
CinemachineClearShotResetRandomizationMethod
IfRandomizeChoiceisenabled,callthistore-randomizethechildrennextframe.Thisisusefulifyouwanttofreshenuptheshot.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidResetRandomization()
CopyC# JavaScript
![Page 459: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/459.jpg)
Cinemachine
![Page 460: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/460.jpg)
CinemachineClearShotUpdateCameraStateMethod
CalledbyCinemachineCoreatdesignatedupdatetimesothevcamcanpositionitselfandtrackitstargets.Thisimplementationupdatesallthechildren,choosesthebestone,andimplementsanyrequiredblending.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
worldUpType:Vector3DefaultworldUp,setbytheCinemachineBrain
deltaTimeType:SystemSingleDeltatimefortime-basedeffects(ignoreiflessthan0)
ImplementsICinemachineCameraUpdateCameraState(Vector3,Single)
SeeAlso
publicoverridevoidUpdateCameraState(
Vector3worldUp,
floatdeltaTime
)
CopyC# JavaScript
![Page 461: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/461.jpg)
ReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 462: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/462.jpg)
Cinemachine
![Page 463: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/463.jpg)
CinemachineClearShotFields
TheCinemachineClearShottypeexposesthefollowingmembers.
Fields Name Description
CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.(InheritedfromCinemachineVirtualCameraBase
m_ActivateAfter Waitthismanysecondsbeforeactivatinganewchildcamera
m_ChildCameras InternalAPIfortheeditor.usethisfiled.
m_CustomBlends Thisistheassetwhichcontainscustomsettingsforspecificblends
m_DefaultBlend Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras
m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_Follow Defaultobjectforthecamerachildrenwantstomovewith(the
![Page 464: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/464.jpg)
bodytarget),ifnotspecifiedinachildcamera.Maybeempty.
m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_LookAt Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildcamera.Maybeempty.
m_MinDuration Anactivecameramustbeactiveforatleastthismanyseconds,unlessahigher-prioritycamerawantstoactivate
m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase
m_RandomizeChoice Ifchecked,camerachoicewillberandomizedifmultiplecamerasareequallydesirable.childlistorderwillbeused
m_ShowDebugText Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging
OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.
![Page 465: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/465.jpg)
Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
Top
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 466: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/466.jpg)
Cinemachine
![Page 467: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/467.jpg)
CinemachineClearShotm_ActivateAfterField
Waitthismanysecondsbeforeactivatinganewchildcamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Waitthismanysecondsbeforeactivatinganewchildcamera")]
publicfloatm_ActivateAfter
CopyC# JavaScript
![Page 468: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/468.jpg)
Cinemachine
![Page 469: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/469.jpg)
CinemachineClearShotm_ChildCamerasField
InternalAPIfortheeditor.Donotusethisfiled.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineVirtualCameraBase
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[SerializeField]
[HideInInspector]
[NoSaveDuringPlayAttribute]
publicCinemachineVirtualCameraBase[]m_ChildCameras
CopyC# JavaScript
![Page 470: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/470.jpg)
Cinemachine
![Page 471: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/471.jpg)
CinemachineClearShotm_CustomBlendsField
Thisistheassetwhichcontainscustomsettingsforspecificblends
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineBlenderSettings
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[HideInInspector]
publicCinemachineBlenderSettingsm_CustomBlends
CopyC# JavaScript
![Page 472: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/472.jpg)
Cinemachine
![Page 473: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/473.jpg)
CinemachineClearShotm_DefaultBlendField
Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineBlendDefinition
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[CinemachineBlendDefinitionPropertyAttribute]
[TooltipAttribute("Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCameras")]
publicCinemachineBlendDefinitionm_DefaultBlend
CopyC# JavaScript
![Page 474: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/474.jpg)
Cinemachine
![Page 475: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/475.jpg)
CinemachineClearShotm_FollowField
Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildcamera.Maybeempty.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Transform
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildcamera.Maybeemptyifallchildrenspecifytargetsoftheirown.")]
[NoSaveDuringPlayAttribute]
publicTransformm_Follow
CopyC# JavaScript
![Page 476: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/476.jpg)
Cinemachine
![Page 477: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/477.jpg)
CinemachineClearShotm_LookAtField
Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildcamera.Maybeempty.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Transform
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildcamera.Maybeemptyifallchildrenspecifytargetsoftheirown.")]
[NoSaveDuringPlayAttribute]
publicTransformm_LookAt
CopyC# JavaScript
![Page 478: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/478.jpg)
Cinemachine
![Page 479: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/479.jpg)
CinemachineClearShotm_MinDurationField
Anactivecameramustbeactiveforatleastthismanyseconds,unlessahigher-prioritycamerawantstoactivate
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Anactivecameramustbeactiveforatleastthismanyseconds,unlessahigher-prioritycamerawantstoactivate")]
publicfloatm_MinDuration
CopyC# JavaScript
![Page 480: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/480.jpg)
Cinemachine
![Page 481: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/481.jpg)
CinemachineClearShotm_RandomizeChoiceField
Ifchecked,camerachoicewillberandomizedifmultiplecamerasareequallydesirable.Otherwise,childlistorderwillbeused
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Ifchecked,camerachoicewillberandomizedifmultiplecamerasareequallydesirable.Otherwise,childlistorderandchildcameraprioritywillbeused.")]
publicboolm_RandomizeChoice
CopyC# JavaScript
![Page 482: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/482.jpg)
Cinemachine
![Page 483: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/483.jpg)
CinemachineClearShotm_ShowDebugTextField
Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineClearShotClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Whenenabled,thecurrentchildcameraandblendwillbeindicatedinthegamewindow,fordebugging")]
[NoSaveDuringPlayAttribute]
publicboolm_ShowDebugText
CopyC# JavaScript
![Page 484: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/484.jpg)
Cinemachine
![Page 485: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/485.jpg)
CinemachineColliderClass
Anadd-onmoduleforCinemachineVirtualCamerathatpost-processesthefinalpositionofthevirtualcamera.Basedonthesuppliedsettings,theColliderwillattempttopreservethelineofsightwiththeLookAttargetofthevirtualcamerabymovingawayfromobjectsthatwillobstructtheview.Additionally,theCollidercanbeusedtoassesstheshotqualityandreportthisasafieldinthecameraState.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineExtensionCinemachineCinemachineCollider
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineCollidertypeexposesthefollowingmembers.
Properties
[DocumentationSortingAttribute(15f,DocumentationSortingAttribute
[ExecuteInEditMode]
[AddComponentMenu("")]
[SaveDuringPlayAttribute]
publicclassCinemachineCollider:CinemachineExtension
CopyC# JavaScript
![Page 486: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/486.jpg)
Name Description
DebugPaths InspectorAPIfordebuggingcollisionresolutionpath
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineExtension.)
Top
Methods Name Description
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,
![Page 487: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/487.jpg)
CinemachineCoreStage,CameraState
Top
Fields Name Description
m_AvoidObstacles Whenenabled,willattempttoresolvesituationswherethelineofsighttothetargetisblockedbyanobstacle
m_CameraRadius Camerawilltrytomaintainthisdistancefromanyobstacle.IncreasethisvalueifyouareseeinginsideobstaclesduetoalargeFOVonthecamera.
m_CollideAgainst TheUnitylayermaskagainstwhichthecolliderwillraycast.
m_Damping Thegradualnessofcollisionresolution.
![Page 488: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/488.jpg)
Highernumberswillmovethecameramoregraduallyawayfromobstructions.
m_DistanceLimit Theraycastdistancetotestforwhencheckingifthelineofsighttothiscamera'stargetisclear.
m_MaximumEffort Upperlimitonhowmanyobstaclehitstoprocess.Highernumbersmayimpactperformance.Inmostenvironments,4isenough.
m_MinimumDistanceFromTarget Obstaclesclosertothetargetthanthiswillnotbeseen
m_OptimalTargetDistance Ifgreaterthanzero,ahigherscorewillbegiventoshotswhenthetargetisclosertothisdistance.Set
![Page 489: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/489.jpg)
thistozerotodisablethisfeature
m_Strategy ThewayinwhichtheColliderwillattempttopreservesightofthetarget.
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 490: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/490.jpg)
Cinemachine
![Page 491: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/491.jpg)
CinemachineColliderProperties
TheCinemachineCollidertypeexposesthefollowingmembers.
Properties Name Description
DebugPaths InspectorAPIfordebuggingcollisionresolutionpath
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineExtension.)
Top
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 492: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/492.jpg)
Cinemachine
![Page 493: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/493.jpg)
CinemachineColliderDebugPathsProperty
InspectorAPIfordebuggingcollisionresolutionpath
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ListListVector3
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicList<List<Vector3>>DebugPaths{get;}
CopyC# JavaScript
![Page 494: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/494.jpg)
Cinemachine
![Page 495: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/495.jpg)
CinemachineColliderMethods
TheCinemachineCollidertypeexposesthefollowingmembers.
Methods Name Description
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
![Page 496: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/496.jpg)
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 497: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/497.jpg)
Cinemachine
![Page 498: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/498.jpg)
CinemachineColliderCameraWasDisplacedMethod
Seewhetherthevirtualcamerahasbeenmovednbythecollider
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineCinemachineVirtualCameraBaseThevirtualcamerainquestion.Thismightbedifferentfromthevirtualcamerathatownsthecollider,intheeventthatthecamerahaschildren
ReturnValueType:BooleanTrueifthevirtualcamerahasbeendisplacedduetocollisionortargetobstruction
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
publicboolCameraWasDisplaced(
CinemachineVirtualCameraBasevcam
)
CopyC# JavaScript
![Page 499: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/499.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 500: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/500.jpg)
Cinemachine
![Page 501: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/501.jpg)
CinemachineColliderIsTargetObscuredMethod
Seewheteranobjectisblockingthecamera'sviewofthetarget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineICinemachineCameraThevirtualcamerainquestion.Thismightbedifferentfromthevirtualcamerathatownsthecollider,intheeventthatthecamerahaschildren
ReturnValueType:BooleanTrueifsomethingisblockingtheview
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
publicboolIsTargetObscured(
ICinemachineCameravcam
)
CopyC# JavaScript
![Page 502: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/502.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 503: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/503.jpg)
Cinemachine
![Page 504: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/504.jpg)
CinemachineColliderOnDestroyMethod
Cleanup
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedoverridevoidOnDestroy()
CopyC# JavaScript
![Page 505: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/505.jpg)
Cinemachine
![Page 506: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/506.jpg)
CinemachineColliderPostPipelineStageCallbackMethod
Callcacktotothecollisionresolutionandshotevaluation
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 507: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/507.jpg)
deltaTimeType:SystemSingle[Missing<paramname="deltaTime"/>documentationfor"M:Cinemachine.CinemachineCollider.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 508: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/508.jpg)
Cinemachine
![Page 509: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/509.jpg)
CinemachineColliderFields
TheCinemachineCollidertypeexposesthefollowingmembers.
Fields Name Description
m_AvoidObstacles Whenenabled,willattempttoresolvesituationswherethelineofsighttothetargetisblockedbyanobstacle
m_CameraRadius Camerawilltrytomaintainthisdistancefromanyobstacle.IncreasethisvalueifyouareseeinginsideobstaclesduetoalargeFOVonthecamera.
m_CollideAgainst TheUnitylayermaskagainstwhichthecolliderwillraycast.
m_Damping The
![Page 510: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/510.jpg)
gradualnessofcollisionresolution.Highernumberswillmovethecameramoregraduallyawayfromobstructions.
m_DistanceLimit Theraycastdistancetotestforwhencheckingifthelineofsighttothiscamera'stargetisclear.
m_MaximumEffort Upperlimitonhowmanyobstaclehitstoprocess.Highernumbersmayimpactperformance.Inmostenvironments,4isenough.
m_MinimumDistanceFromTarget Obstaclesclosertothetargetthanthiswillnotbeseen
m_OptimalTargetDistance Ifgreaterthanzero,ahigherscorewillbegiventoshots
![Page 511: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/511.jpg)
whenthetargetisclosertothisdistance.Setthistozerotodisablethisfeature
m_Strategy ThewayinwhichtheColliderwillattempttopreservesightofthetarget.
Top
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 512: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/512.jpg)
Cinemachine
![Page 513: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/513.jpg)
CinemachineColliderm_AvoidObstaclesField
Whenenabled,willattempttoresolvesituationswherethelineofsighttothetargetisblockedbyanobstacle
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[SpaceAttribute]
[TooltipAttribute("Whenenabled,willattempttoresolvesituationswherethelineofsighttothetargetisblockedbyanobstacle")]
[FormerlySerializedAsAttribute("m_PreserveLineOfSight")]
publicboolm_AvoidObstacles
CopyC# JavaScript
![Page 514: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/514.jpg)
Cinemachine
![Page 515: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/515.jpg)
CinemachineColliderm_CameraRadiusField
Camerawilltrytomaintainthisdistancefromanyobstacle.IncreasethisvalueifyouareseeinginsideobstaclesduetoalargeFOVonthecamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Camerawilltrytomaintainthisdistancefromanyobstacle.Trytokeepthisvaluesmall.IncreaseitifyouareseeinginsideobstaclesduetoalargeFOVonthecamera.")]
publicfloatm_CameraRadius
CopyC# JavaScript
![Page 516: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/516.jpg)
Cinemachine
![Page 517: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/517.jpg)
CinemachineColliderm_CollideAgainstField
TheUnitylayermaskagainstwhichthecolliderwillraycast.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:LayerMask
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[HeaderAttribute("ObstacleDetection")]
[TooltipAttribute("TheUnitylayermaskagainstwhichthecolliderwillraycast")]
publicLayerMaskm_CollideAgainst
CopyC# JavaScript
![Page 518: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/518.jpg)
Cinemachine
![Page 519: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/519.jpg)
CinemachineColliderm_DampingField
Thegradualnessofcollisionresolution.Highernumberswillmovethecameramoregraduallyawayfromobstructions.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,10f)]
[TooltipAttribute("Thegradualnessofcollisionresolution.Highernumberswillmovethecameramoregraduallyawayfromobstructions.")]
[FormerlySerializedAsAttribute("m_Smoothing")]
publicfloatm_Damping
CopyC# JavaScript
![Page 520: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/520.jpg)
Cinemachine
![Page 521: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/521.jpg)
CinemachineColliderm_DistanceLimitField
Theraycastdistancetotestforwhencheckingifthelineofsighttothiscamera'stargetisclear.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Themaximumraycastdistancewhencheckingifthelineofsighttothiscamera'stargetisclear.Ifthesettingis0orless,thecurrentactualdistancetotargetwillbeused.")]
[FormerlySerializedAsAttribute("m_LineOfSightFeelerDistance")]
publicfloatm_DistanceLimit
CopyC# JavaScript
![Page 522: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/522.jpg)
Cinemachine
![Page 523: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/523.jpg)
CinemachineColliderm_MaximumEffortField
Upperlimitonhowmanyobstaclehitstoprocess.Highernumbersmayimpactperformance.Inmostenvironments,4isenough.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Int32
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(1f,10f)]
[TooltipAttribute("Upperlimitonhowmanyobstaclehitstoprocess.Highernumbersmayimpactperformance.Inmostenvironments,4isenough.")]
publicintm_MaximumEffort
CopyC# JavaScript
![Page 524: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/524.jpg)
Cinemachine
![Page 525: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/525.jpg)
CinemachineColliderm_MinimumDistanceFromTargetField
Obstaclesclosertothetargetthanthiswillnotbeseen
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Obstaclesclosertothetargetthanthiswillnotbeseen")]
publicfloatm_MinimumDistanceFromTarget
CopyC# JavaScript
![Page 526: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/526.jpg)
Cinemachine
![Page 527: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/527.jpg)
CinemachineColliderm_OptimalTargetDistanceField
Ifgreaterthanzero,ahigherscorewillbegiventoshotswhenthetargetisclosertothisdistance.Setthistozerotodisablethisfeature
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[HeaderAttribute("ShotEvaluation")]
[TooltipAttribute("Ifgreaterthanzero,ahigherscorewillbegiventoshotswhenthetargetisclosertothisdistance.Setthistozerotodisablethisfeature.")]
publicfloatm_OptimalTargetDistance
CopyC# JavaScript
![Page 528: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/528.jpg)
Cinemachine
![Page 529: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/529.jpg)
CinemachineColliderm_StrategyField
ThewayinwhichtheColliderwillattempttopreservesightofthetarget.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineColliderResolutionStrategy
SeeAlsoReferenceCinemachineColliderClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("ThewayinwhichtheColliderwillattempttopreservesightofthetarget.")]
publicCinemachineColliderResolutionStrategym_Strategy
CopyC# JavaScript
![Page 530: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/530.jpg)
Cinemachine
![Page 531: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/531.jpg)
CinemachineColliderResolutionStrategyEnumeration
ThewayinwhichtheColliderwillattempttopreservesightofthetarget.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members Membername Value Description
PullCameraForward 0 CamerawillbepulledforwardalongitsZaxisuntilitisinfrontofthenearestobstacle
PreserveCameraHeight 1 Inadditiontopullingthecameraforward,aneffortwillbemadeto
publicenumResolutionStrategy
CopyC# JavaScript
![Page 532: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/532.jpg)
returnthecameratoitsoriginalheight
PreserveCameraDistance 2 Inadditiontopullingthecameraforward,aneffortwillbemadetoreturnthecameratoitsoriginaldistancefromthetarget
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 533: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/533.jpg)
Cinemachine
![Page 534: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/534.jpg)
CinemachineComponentBaseClass
AnabstractrepresentationofamutatoractingonaCinemachineVirtualCamera
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseMore...
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineComponentBasetypeexposesthefollowingmembers.
Constructors Name Description
CinemachineComponentBase
[DocumentationSortingAttribute(24f,DocumentationSortingAttribute
publicabstractclassCinemachineComponentBase:MonoBehaviour
CopyC# JavaScript
![Page 535: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/535.jpg)
Top
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.
IsValid Returnstrueifthisobjectisenabledandsetuptoproduceresults.
LookAtTarget Returnstheownervcam'sLookAttarget.
Stage Whatpartofthepipelinethisfitsinto
VcamState Returnstheownervcam'sCameraState.
VirtualCamera GettheassociatedCinemachineVirtualCameraBase
Top
Methods Name Description
MutateCameraState Mutatesthecamerastate.Thisstatewilllaterbeappliedtothecamera.
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.Baseclassimplementationdoes
![Page 536: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/536.jpg)
nothing.
Top
Fields Name Description
Epsilon Usefulconstantforverysmallfloats
Top
SeeAlsoReferenceCinemachineNamespace
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineBasicMultiChannelPerlinCinemachineCinemachineComposerCinemachineCinemachineFramingTransposerCinemachineCinemachineHardLockToTargetCinemachineCinemachineHardLookAtCinemachineCinemachinePOVCinemachineCinemachineTrackedDollyCinemachineCinemachineTransposer
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 537: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/537.jpg)
Cinemachine
![Page 538: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/538.jpg)
CinemachineComponentBaseConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineComponentBase.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineComponentBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedCinemachineComponentBase()
CopyC# JavaScript
![Page 539: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/539.jpg)
Cinemachine
![Page 540: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/540.jpg)
CinemachineComponentBaseProperties
TheCinemachineComponentBasetypeexposesthefollowingmembers.
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.
IsValid Returnstrueifthisobjectisenabledandsetuptoproduceresults.
LookAtTarget Returnstheownervcam'sLookAttarget.
Stage Whatpartofthepipelinethisfitsinto
VcamState Returnstheownervcam'sCameraState.
VirtualCamera GettheassociatedCinemachineVirtualCameraBase
Top
SeeAlsoReferenceCinemachineComponentBaseClass
![Page 541: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/541.jpg)
CinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 542: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/542.jpg)
Cinemachine
![Page 543: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/543.jpg)
CinemachineComponentBaseFollowTargetProperty
Returnstheownervcam'sFollowtarget.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Transform
SeeAlsoReferenceCinemachineComponentBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicTransformFollowTarget{get;}
CopyC# JavaScript
![Page 544: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/544.jpg)
Cinemachine
![Page 545: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/545.jpg)
CinemachineComponentBaseIsValidProperty
Returnstrueifthisobjectisenabledandsetuptoproduceresults.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineComponentBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicabstractboolIsValid{get;}
CopyC# JavaScript
![Page 546: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/546.jpg)
Cinemachine
![Page 547: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/547.jpg)
CinemachineComponentBaseLookAtTargetProperty
Returnstheownervcam'sLookAttarget.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Transform
SeeAlsoReferenceCinemachineComponentBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicTransformLookAtTarget{get;}
CopyC# JavaScript
![Page 548: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/548.jpg)
Cinemachine
![Page 549: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/549.jpg)
CinemachineComponentBaseStageProperty
Whatpartofthepipelinethisfitsinto
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineCoreStage
SeeAlsoReferenceCinemachineComponentBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicabstractCinemachineCoreStageStage{get;}
CopyC# JavaScript
![Page 550: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/550.jpg)
Cinemachine
![Page 551: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/551.jpg)
CinemachineComponentBaseVcamStateProperty
Returnstheownervcam'sCameraState.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CameraState
SeeAlsoReferenceCinemachineComponentBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCameraStateVcamState{get;}
CopyC# JavaScript
![Page 552: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/552.jpg)
Cinemachine
![Page 553: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/553.jpg)
CinemachineComponentBaseVirtualCameraProperty
GettheassociatedCinemachineVirtualCameraBase
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineVirtualCameraBase
SeeAlsoReferenceCinemachineComponentBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineVirtualCameraBaseVirtualCamera{
CopyC# JavaScript
![Page 554: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/554.jpg)
Cinemachine
![Page 555: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/555.jpg)
CinemachineComponentBaseMethods
TheCinemachineComponentBasetypeexposesthefollowingmembers.
Methods Name Description
MutateCameraState Mutatesthecamerastate.Thisstatewilllaterbeappliedtothecamera.
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.Baseclassimplementationdoesnothing.
Top
SeeAlsoReferenceCinemachineComponentBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 556: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/556.jpg)
Cinemachine
![Page 557: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/557.jpg)
CinemachineComponentBaseMutateCameraStateMethod
Mutatesthecamerastate.Thisstatewilllaterbeappliedtothecamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
curStateType:CinemachineCameraStateInputstatethatmustbemutated
deltaTimeType:SystemSingleDeltatimefortime-basedeffects(ignoreiflessthan0)
SeeAlsoReferenceCinemachineComponentBaseClassCinemachineNamespace
VisittheCinemachineForum
publicabstractvoidMutateCameraState(
refCameraStatecurState,
floatdeltaTime
)
CopyC# JavaScript
![Page 559: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/559.jpg)
Cinemachine
![Page 560: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/560.jpg)
CinemachineComponentBaseOnPositionDraggedMethod
APIfortheeditor,toprocessapositiondragfromtheuser.Baseclassimplementationdoesnothing.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
deltaType:Vector3Theamountdraggedthisframe
SeeAlsoReferenceCinemachineComponentBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvirtualvoidOnPositionDragged(
Vector3delta
)
CopyC# JavaScript
![Page 561: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/561.jpg)
Cinemachine
![Page 562: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/562.jpg)
CinemachineComponentBaseFields
TheCinemachineComponentBasetypeexposesthefollowingmembers.
Fields Name Description
Epsilon Usefulconstantforverysmallfloats
Top
SeeAlsoReferenceCinemachineComponentBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 563: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/563.jpg)
Cinemachine
![Page 564: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/564.jpg)
CinemachineComponentBaseEpsilonField
Usefulconstantforverysmallfloats
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineComponentBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedconstfloatEpsilon=0.0001f
CopyC# JavaScript
![Page 565: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/565.jpg)
Cinemachine
![Page 566: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/566.jpg)
CinemachineComposerClass
ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.Itsjobistoaimthecameraatthevcam'sLookAttargetobject,withconfigurableoffsets,damping,andcompositionrules.Thecomposerdoesnotchangethecamera'sposition.Itwillonlypanandtiltthecamerawhereitis,inordertogetthedesiredframing.Tomovethecamera,youhavetousethevirtualcamera'sBodysection.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineComposerCinemachineCinemachineGroupComposer
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineComposertypeexposesthefollowingmembers.
[DocumentationSortingAttribute(3f,DocumentationSortingAttribute
[ExecuteInEditMode]
[AddComponentMenu("")]
[RequireComponent(typeof(CinemachinePipeline))]
[SaveDuringPlayAttribute]
publicclassCinemachineComposer:CinemachineComponentBase
CopyC# JavaScript
![Page 567: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/567.jpg)
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
HardGuideRect InternalAPIfortheinspectoreditor
IsValid TrueifcomponentisenabledandhasaLookAtdefined(OverridesCinemachineComponentBaseIsValid.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
SoftGuideRect InternalAPIfortheinspectoreditor
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage(OverridesCinemachineComponentBaseStage.)
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)
![Page 568: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/568.jpg)
Top
Methods Name Description
GetTrackedPoint Applythetargetoffsetstothetargetlocation.
MutateCameraState Appliesthecomposerrulesandorientsthecameraaccordingly(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.classimplementationdoesnothing.(InheritedfromCinemachineComponentBase
Top
Fields Name Description
m_BiasX Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone
m_BiasY Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone
m_DeadZoneHeight Camerawillnotrotateverticallyifthetargetiswithinthisrangeoftheposition
m_DeadZoneWidth Camerawillnotrotate
![Page 569: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/569.jpg)
horizontallyifthetargetiswithinthisrangeoftheposition
m_HorizontalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-horizontaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.
m_LookaheadSmoothing Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag
m_LookaheadTime Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothe
![Page 570: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/570.jpg)
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
![Page 571: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/571.jpg)
m_TrackedObjectOffset Targetoffsetfromtheobject'scenterinLOCALspacewhichtheComposertracks.Usethistofine-tunethetrackingtargetpositionwhenthedesiredareaisnotinthetrackedobject'scenter
m_VerticalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-verticaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.
OnGUICallback UsedbytheInspectorEditortodisplayon-screenguides.
Top
SeeAlsoReference
![Page 572: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/572.jpg)
CinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 573: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/573.jpg)
Cinemachine
![Page 574: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/574.jpg)
CinemachineComposerProperties
TheCinemachineComposertypeexposesthefollowingmembers.
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
HardGuideRect InternalAPIfortheinspectoreditor
IsValid TrueifcomponentisenabledandhasaLookAtdefined(OverridesCinemachineComponentBaseIsValid.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
SoftGuideRect InternalAPIfortheinspectoreditor
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage(OverridesCinemachineComponentBaseStage.)
VcamState Returnstheownervcam's
![Page 575: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/575.jpg)
CameraState.(InheritedfromCinemachineComponentBase.)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)
Top
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 576: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/576.jpg)
Cinemachine
![Page 577: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/577.jpg)
CinemachineComposerHardGuideRectProperty
InternalAPIfortheinspectoreditor
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Rect
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicRectHardGuideRect{get;set;}
CopyC# JavaScript
![Page 578: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/578.jpg)
Cinemachine
![Page 579: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/579.jpg)
CinemachineComposerIsValidProperty
TrueifcomponentisenabledandhasaLookAtdefined
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideboolIsValid{get;}
CopyC# JavaScript
![Page 580: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/580.jpg)
Cinemachine
![Page 581: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/581.jpg)
CinemachineComposerSoftGuideRectProperty
InternalAPIfortheinspectoreditor
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Rect
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicRectSoftGuideRect{get;set;}
CopyC# JavaScript
![Page 582: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/582.jpg)
Cinemachine
![Page 583: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/583.jpg)
CinemachineComposerStageProperty
GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineCoreStage
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideCinemachineCoreStageStage{get;}
CopyC# JavaScript
![Page 584: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/584.jpg)
Cinemachine
![Page 585: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/585.jpg)
CinemachineComposerMethods
TheCinemachineComposertypeexposesthefollowingmembers.
Methods Name Description
GetTrackedPoint Applythetargetoffsetstothetargetlocation.
MutateCameraState Appliesthecomposerrulesandorientsthecameraaccordingly(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.classimplementationdoesnothing.(InheritedfromCinemachineComponentBase
Top
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 586: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/586.jpg)
Cinemachine
![Page 587: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/587.jpg)
CinemachineComposerGetTrackedPointMethod
Applythetargetoffsetstothetargetlocation.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
lookAtType:Vector3TheunoffsetLookAtpoint
ReturnValueType:Vector3TheLookAtpointwiththeoffsetapplied
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedvirtualVector3GetTrackedPoint(
Vector3lookAt
)
CopyC# JavaScript
![Page 588: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/588.jpg)
![Page 589: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/589.jpg)
Cinemachine
![Page 590: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/590.jpg)
CinemachineComposerMutateCameraStateMethod
Appliesthecomposerrulesandorientsthecameraaccordingly
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
curStateType:CinemachineCameraStateThecurrentcamerastate
deltaTimeType:SystemSingleUsedforcalculatingdamping.Iflessthanzero,thentargetwillsnaptothecenterofthedeadzone.
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForum
publicoverridevoidMutateCameraState(
refCameraStatecurState,
floatdeltaTime
)
CopyC# JavaScript
![Page 592: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/592.jpg)
Cinemachine
![Page 593: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/593.jpg)
CinemachineComposerFields
TheCinemachineComposertypeexposesthefollowingmembers.
Fields Name Description
m_BiasX Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone
m_BiasY Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone
m_DeadZoneHeight Camerawillnotrotateverticallyifthetargetiswithinthisrangeoftheposition
m_DeadZoneWidth Camerawillnotrotatehorizontallyifthetargetiswithinthisrangeoftheposition
m_HorizontalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-horizontaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecamerato
![Page 594: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/594.jpg)
keepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.
m_LookaheadSmoothing Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag
m_LookaheadTime Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.
![Page 595: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/595.jpg)
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
![Page 596: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/596.jpg)
m_VerticalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-verticaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.
OnGUICallback UsedbytheInspectorEditortodisplayon-screenguides.
Top
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 597: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/597.jpg)
Cinemachine
![Page 598: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/598.jpg)
CinemachineComposerm_BiasXField
Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(-0.5f,0.5f)]
[TooltipAttribute("Anon-zerobiaswillmovethetargetpositionhorizontallyawayfromthecenterofthesoftzone.")]
publicfloatm_BiasX
CopyC# JavaScript
![Page 599: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/599.jpg)
Cinemachine
![Page 600: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/600.jpg)
CinemachineComposerm_BiasYField
Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(-0.5f,0.5f)]
[TooltipAttribute("Anon-zerobiaswillmovethetargetpositionverticallyawayfromthecenterofthesoftzone.")]
publicfloatm_BiasY
CopyC# JavaScript
![Page 601: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/601.jpg)
Cinemachine
![Page 602: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/602.jpg)
CinemachineComposerm_DeadZoneHeightField
Camerawillnotrotateverticallyifthetargetiswithinthisrangeoftheposition
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,1f)]
[TooltipAttribute("Camerawillnotrotateverticallyifthetargetiswithinthisrangeoftheposition.")]
publicfloatm_DeadZoneHeight
CopyC# JavaScript
![Page 603: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/603.jpg)
Cinemachine
![Page 604: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/604.jpg)
CinemachineComposerm_DeadZoneWidthField
Camerawillnotrotatehorizontallyifthetargetiswithinthisrangeoftheposition
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,1f)]
[TooltipAttribute("Camerawillnotrotatehorizontallyifthetargetiswithinthisrangeoftheposition.")]
publicfloatm_DeadZoneWidth
CopyC# JavaScript
![Page 605: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/605.jpg)
Cinemachine
![Page 606: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/606.jpg)
CinemachineComposerm_HorizontalDampingField
Howaggressivelythecameratriestofollowthetargetinthescreen-horizontaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[SpaceAttribute]
[RangeAttribute(0f,20f)]
[TooltipAttribute("Howaggressivelythecameratriestofollowthetargetinthescreen-horizontaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.")]
publicfloatm_HorizontalDamping
CopyC# JavaScript
![Page 607: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/607.jpg)
![Page 608: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/608.jpg)
Cinemachine
![Page 609: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/609.jpg)
CinemachineComposerm_LookaheadSmoothingField
Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag")]
[RangeAttribute(3f,30f)]
publicfloatm_LookaheadSmoothing
CopyC# JavaScript
![Page 610: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/610.jpg)
Cinemachine
![Page 611: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/611.jpg)
CinemachineComposerm_LookaheadTimeField
Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.")]
[RangeAttribute(0f,1f)]
publicfloatm_LookaheadTime
CopyC# JavaScript
![Page 612: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/612.jpg)
![Page 613: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/613.jpg)
Cinemachine
![Page 614: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/614.jpg)
CinemachineComposerm_ScreenXField
Horizontalscreenpositionfortarget.Thecamerawillrotatetothepositionthetrackedobjecthere
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[SpaceAttribute]
[RangeAttribute(0f,1f)]
[TooltipAttribute("Horizontalscreenpositionfortarget.Thecamerawillrotatetopositionthetrackedobjecthere.")]
publicfloatm_ScreenX
CopyC# JavaScript
![Page 615: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/615.jpg)
Cinemachine
![Page 616: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/616.jpg)
CinemachineComposerm_ScreenYField
Verticalscreenpositionfortarget,Thecamerawillrotatetotopositionthetrackedobjecthere
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,1f)]
[TooltipAttribute("Verticalscreenpositionfortarget,Thecamerawillrotatetopositionthetrackedobjecthere.")]
publicfloatm_ScreenY
CopyC# JavaScript
![Page 617: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/617.jpg)
Cinemachine
![Page 618: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/618.jpg)
CinemachineComposerm_SoftZoneHeightField
Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,2f)]
[TooltipAttribute("Whentargetiswithinthisregion,camerawillgraduallyrotateverticallytore-aligntowardsthedesiredposition,dependingonthedampingspeed.")]
publicfloatm_SoftZoneHeight
CopyC# JavaScript
![Page 619: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/619.jpg)
Cinemachine
![Page 620: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/620.jpg)
CinemachineComposerm_SoftZoneWidthField
Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,2f)]
[TooltipAttribute("Whentargetiswithinthisregion,camerawillgraduallyrotatehorizontallytore-aligntowardsthedesiredposition,dependingonthedampingspeed.")]
publicfloatm_SoftZoneWidth
CopyC# JavaScript
![Page 621: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/621.jpg)
Cinemachine
![Page 622: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/622.jpg)
CinemachineComposerm_TrackedObjectOffsetField
Targetoffsetfromtheobject'scenterinLOCALspacewhichtheComposertracks.Usethistofine-tunethetrackingtargetpositionwhenthedesiredareaisnotinthetrackedobject'scenter
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Vector3
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Targetoffsetfromthetargetobject'scenterintarget-localspace.Usethistofine-tunethetrackingtargetpositionwhenthedesiredareaisnotthetrackedobject'scenter.")]
publicVector3m_TrackedObjectOffset
CopyC# JavaScript
![Page 623: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/623.jpg)
Cinemachine
![Page 624: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/624.jpg)
CinemachineComposerm_VerticalDampingField
Howaggressivelythecameratriestofollowthetargetinthescreen-verticaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("Howaggressivelythecameratriestofollowthetargetinthescreen-verticaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.")]
publicfloatm_VerticalDamping
CopyC# JavaScript
![Page 625: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/625.jpg)
Cinemachine
![Page 626: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/626.jpg)
CinemachineComposerOnGUICallbackField
UsedbytheInspectorEditortodisplayon-screenguides.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Action
SeeAlsoReferenceCinemachineComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[NoSaveDuringPlayAttribute]
[HideInInspector]
publicActionOnGUICallback
CopyC# JavaScript
![Page 627: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/627.jpg)
Cinemachine
![Page 628: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/628.jpg)
CinemachineConfinerClass
Anadd-onmoduleforCinemachineVirtualCamerathatpost-processesthefinalpositionofthevirtualcamera.Itwillconfinethevirtualcamera'spositiontothevolumespecifiedintheBoundingVolumefield.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineExtensionCinemachineCinemachineConfiner
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineConfinertypeexposesthefollowingmembers.
Constructors Name Description
[DocumentationSortingAttribute(22f,DocumentationSortingAttribute
[ExecuteInEditMode]
[AddComponentMenu("")]
[SaveDuringPlayAttribute]
publicclassCinemachineConfiner:CinemachineExtension
CopyC# JavaScript
![Page 629: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/629.jpg)
CinemachineConfiner
Top
Properties Name Description
IsValid Checkiftheboundingvolumeisdefined
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineExtension.)
Top
Methods Name Description
Awake Connecttovirtualcamerapipeline.implementation(InheritedfromCinemachineExtension
CameraWasDisplaced Seewhetherthevirtualcamerahasbeenmovedbytheconfiner
GetAllExtraStatesT Ineffeicientmethodtogetallextrastateinforforallvcams.only,notruntime!(InheritedfromCinemachineExtension
GetExtraStateT Becauseextensionscanbeplacedonmanagercamsandwillinthatforallthevcamchildren,vcam-specificstateinformationdefineaclasstoholdyourstateinfo(InheritedfromCinemachineExtension
InvalidatePathCache Callthisiftheboundingshape'spointschangeatruntime
![Page 630: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/630.jpg)
OnDestroy Disconnectfromvirtualcamerapipeline.baseimplementation(InheritedfromCinemachineExtension
PostPipelineStageCallback Callbacktotothecameraconfining(OverridesCinemachineExtensionPostPipelineStageCallback(CinemachineVirtualCameraBase,CinemachineCoreStage,CameraState
Top
Fields Name Description
m_BoundingShape2D The2Dshapewithinwhichthecameraistobecontained.
m_BoundingVolume Thevolumewithinwhichthecameraistobecontained.
m_ConfineMode Theconfinercanoperateusinga2Dboundingshapeora3Dboundingvolume
m_ConfineScreenEdges Ifcameraisorthographic,screenedgeswillbeconfinedtothevolume.
m_Damping Howgraduallytoreturnthecameratotheboundingvolumeifitgoesbeyondtheborders
![Page 631: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/631.jpg)
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 632: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/632.jpg)
Cinemachine
![Page 633: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/633.jpg)
CinemachineConfinerConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineConfiner.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineConfinerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineConfiner()
CopyC# JavaScript
![Page 634: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/634.jpg)
Cinemachine
![Page 635: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/635.jpg)
CinemachineConfinerProperties
TheCinemachineConfinertypeexposesthefollowingmembers.
Properties Name Description
IsValid Checkiftheboundingvolumeisdefined
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineExtension.)
Top
SeeAlsoReferenceCinemachineConfinerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 636: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/636.jpg)
Cinemachine
![Page 637: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/637.jpg)
CinemachineConfinerIsValidProperty
Checkiftheboundingvolumeisdefined
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineConfinerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicboolIsValid{get;}
CopyC# JavaScript
![Page 638: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/638.jpg)
Cinemachine
![Page 639: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/639.jpg)
CinemachineConfinerMethods
TheCinemachineConfinertypeexposesthefollowingmembers.
Methods Name Description
Awake Connecttovirtualcamerapipeline.implementation(InheritedfromCinemachineExtension
CameraWasDisplaced Seewhetherthevirtualcamerahasbeenmovedbytheconfiner
GetAllExtraStatesT Ineffeicientmethodtogetallextrastateinforforallvcams.only,notruntime!(InheritedfromCinemachineExtension
GetExtraStateT Becauseextensionscanbeplacedonmanagercamsandwillinthatforallthevcamchildren,vcam-specificstateinformationdefineaclasstoholdyourstateinfo(InheritedfromCinemachineExtension
InvalidatePathCache Callthisiftheboundingshape'spointschangeatruntime
OnDestroy Disconnectfromvirtualcamerapipeline.baseimplementation(InheritedfromCinemachineExtension
PostPipelineStageCallback Callbacktotothecameraconfining(OverridesCinemachineExtensionPostPipelineStageCallback(CinemachineVirtualCameraBase,CinemachineCoreStage,CameraState
Top
![Page 640: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/640.jpg)
SeeAlsoReferenceCinemachineConfinerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 641: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/641.jpg)
Cinemachine
![Page 642: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/642.jpg)
CinemachineConfinerCameraWasDisplacedMethod
Seewhetherthevirtualcamerahasbeenmovedbytheconfiner
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineCinemachineVirtualCameraBaseThevirtualcamerainquestion.Thismightbedifferentfromthevirtualcamerathatownstheconfiner,intheeventthatthecamerahaschildren
ReturnValueType:BooleanTrueifthevirtualcamerahasbeenrepositioned
SeeAlsoReferenceCinemachineConfinerClassCinemachineNamespace
publicboolCameraWasDisplaced(
CinemachineVirtualCameraBasevcam
)
CopyC# JavaScript
![Page 643: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/643.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 644: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/644.jpg)
Cinemachine
![Page 645: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/645.jpg)
CinemachineConfinerInvalidatePathCacheMethod
Callthisiftheboundingshape'spointschangeatruntime
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineConfinerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidInvalidatePathCache()
CopyC# JavaScript
![Page 646: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/646.jpg)
Cinemachine
![Page 647: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/647.jpg)
CinemachineConfinerPostPipelineStageCallbackMethod
Callbacktotothecameraconfining
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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)"]
protectedoverridevoidPostPipelineStageCallback(
CinemachineVirtualCameraBasevcam,
CinemachineCoreStagestage,
refCameraStatestate,
floatdeltaTime
)
CopyC# JavaScript
![Page 648: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/648.jpg)
deltaTimeType:SystemSingle[Missing<paramname="deltaTime"/>documentationfor"M:Cinemachine.CinemachineConfiner.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]
SeeAlsoReferenceCinemachineConfinerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 649: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/649.jpg)
Cinemachine
![Page 650: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/650.jpg)
CinemachineConfinerFields
TheCinemachineConfinertypeexposesthefollowingmembers.
Fields Name Description
m_BoundingShape2D The2Dshapewithinwhichthecameraistobecontained.
m_BoundingVolume Thevolumewithinwhichthecameraistobecontained.
m_ConfineMode Theconfinercanoperateusinga2Dboundingshapeora3Dboundingvolume
m_ConfineScreenEdges Ifcameraisorthographic,screenedgeswillbeconfinedtothevolume.
m_Damping Howgraduallytoreturnthecameratotheboundingvolumeifitgoesbeyondtheborders
Top
SeeAlso
![Page 651: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/651.jpg)
ReferenceCinemachineConfinerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 652: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/652.jpg)
Cinemachine
![Page 653: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/653.jpg)
CinemachineConfinerm_BoundingShape2DField
The2Dshapewithinwhichthecameraistobecontained.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Collider2D
SeeAlsoReferenceCinemachineConfinerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("The2Dshapewithinwhichthecameraistobecontained")]
publicCollider2Dm_BoundingShape2D
CopyC# JavaScript
![Page 654: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/654.jpg)
Cinemachine
![Page 655: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/655.jpg)
CinemachineConfinerm_BoundingVolumeField
Thevolumewithinwhichthecameraistobecontained.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Collider
SeeAlsoReferenceCinemachineConfinerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thevolumewithinwhichthecameraistobecontained")]
publicColliderm_BoundingVolume
CopyC# JavaScript
![Page 656: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/656.jpg)
Cinemachine
![Page 657: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/657.jpg)
CinemachineConfinerm_ConfineModeField
Theconfinercanoperateusinga2Dboundingshapeora3Dboundingvolume
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineConfinerMode
SeeAlsoReferenceCinemachineConfinerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theconfinercanoperateusinga2Dboundingshapeora3Dboundingvolume")]
publicCinemachineConfinerModem_ConfineMode
CopyC# JavaScript
![Page 658: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/658.jpg)
Cinemachine
![Page 659: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/659.jpg)
CinemachineConfinerm_ConfineScreenEdgesField
Ifcameraisorthographic,screenedgeswillbeconfinedtothevolume.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineConfinerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Ifcameraisorthographic,screenedgeswillbeconfinedtothevolume.Ifnotchecked,thenonlythecameracenterwillbeconfined")]
publicboolm_ConfineScreenEdges
CopyC# JavaScript
![Page 660: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/660.jpg)
Cinemachine
![Page 661: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/661.jpg)
CinemachineConfinerm_DampingField
Howgraduallytoreturnthecameratotheboundingvolumeifitgoesbeyondtheborders
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineConfinerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Howgraduallytoreturnthecameratotheboundingvolumeifitgoesbeyondtheborders.Highernumbersaremoregradual.")]
[RangeAttribute(0f,10f)]
publicfloatm_Damping
CopyC# JavaScript
![Page 662: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/662.jpg)
Cinemachine
![Page 663: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/663.jpg)
CinemachineConfinerModeEnumeration
Theconfinercanoperateusinga2Dboundingshapeora3Dboundingvolume
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members Membername Value Description
Confine2D 0
Confine3D 1
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicenumMode
CopyC# JavaScript
![Page 664: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/664.jpg)
Cinemachine
![Page 665: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/665.jpg)
CinemachineCoreClass
AsingletonthatmanagescompletelistsofCinemachineBrainand,CinemachineVirtualCameras,andthepriorityqueue.ProvidesservicestokeepingtrackofwhetherCinemachineVirtualCamerashavebeenupdatedeachframe.
InheritanceHierarchySystemObjectCinemachineCinemachineCore
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineCoretypeexposesthefollowingmembers.
Constructors Name Description
CinemachineCore
Top
Properties Name Description
BrainCount Accessthearrayofactive
publicsealedclassCinemachineCore
CopyC# JavaScript
![Page 666: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/666.jpg)
CinemachineBrainsinthescene
Instance Getthesingletoninstance
VirtualCameraCount ListofallactiveCinemachineVirtualCamerasforallbrains.Thislistiskeptsortedbypriority.
Top
Methods Name Description
FindPotentialTargetBrain TrytofindaCinemachineBraintoassociatewithaCinemachineVirtualCamera.ThefirstCinemachineBraininwhichthisCinemachineVirtualCameraislivewillbeused.Ifnone,thenthefirstactiveCinemachineBrainwillbeused.BrainswithOutputCamera==nullwillnotbereturned.Finalresultmaybenull.
GenerateCameraActivationEvent Signalthatthevirtualhasbeenactivated.Ifthecameraislive,thenallCinemachineBrains
![Page 667: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/667.jpg)
thatareshowingitwillsendanactivationevent.
GenerateCameraCutEvent Signalthatthevirtualcamera'scontentisdiscontinuousWRTthepreviousframe.Ifthecameraislive,thenallCinemachineBrainsthatareshowingitwillsendacutevent.
GetActiveBrain AccessthearrayofactiveCinemachineBrainsinthescenewithoutgebneratinggarbage
GetVcamUpdateStatus Internaluseonly
GetVirtualCamera AccessthearrayofactiveICinemachineCamerainthescenewithoutgebneratinggarbage
IsLive IsthisvirtualcameracurrentlyactivelycontrollinganyCamera?
Top
Fields Name Description
![Page 668: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/668.jpg)
GetInputAxis DelegateforoverridingUnity'sdefaultinputsystem.Ifyousetthis,thenyourdelegatewillbecalledinsteadofSystem.Input.GetAxis(axisName)wheneverin-gameuserinputisneeded.
kStreamingVersion Dataversionstring.Usedtoupgradefromlegacyprojects
kVersionString Human-readableCinemachineVersion
sShowHiddenObjects Iftrue,showhiddenCinemachineobjects,tomakemanualscriptmappingpossible.
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 669: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/669.jpg)
Cinemachine
![Page 670: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/670.jpg)
CinemachineCoreConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineCore.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineCore()
CopyC# JavaScript
![Page 671: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/671.jpg)
Cinemachine
![Page 672: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/672.jpg)
CinemachineCoreProperties
TheCinemachineCoretypeexposesthefollowingmembers.
Properties Name Description
BrainCount AccessthearrayofactiveCinemachineBrainsinthescene
Instance Getthesingletoninstance
VirtualCameraCount ListofallactiveCinemachineVirtualCamerasforallbrains.Thislistiskeptsortedbypriority.
Top
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 673: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/673.jpg)
Cinemachine
![Page 674: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/674.jpg)
CinemachineCoreBrainCountProperty
AccessthearrayofactiveCinemachineBrainsinthescene
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Int32
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicintBrainCount{get;}
CopyC# JavaScript
![Page 675: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/675.jpg)
Cinemachine
![Page 676: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/676.jpg)
CinemachineCoreInstanceProperty
Getthesingletoninstance
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineCore
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticCinemachineCoreInstance{get;}
CopyC# JavaScript
![Page 677: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/677.jpg)
Cinemachine
![Page 678: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/678.jpg)
CinemachineCoreVirtualCameraCountProperty
ListofallactiveCinemachineVirtualCamerasforallbrains.Thislistiskeptsortedbypriority.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Int32
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicintVirtualCameraCount{get;}
CopyC# JavaScript
![Page 679: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/679.jpg)
Cinemachine
![Page 680: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/680.jpg)
CinemachineCoreMethods
TheCinemachineCoretypeexposesthefollowingmembers.
Methods Name Description
FindPotentialTargetBrain TrytofindaCinemachineBraintoassociatewithaCinemachineVirtualCamera.ThefirstCinemachineBraininwhichthisCinemachineVirtualCameraislivewillbeused.Ifnone,thenthefirstactiveCinemachineBrainwillbeused.BrainswithOutputCamera==nullwillnotbereturned.Finalresultmaybenull.
GenerateCameraActivationEvent Signalthatthevirtualhasbeenactivated.Ifthecameraislive,thenallCinemachineBrainsthatareshowingitwillsendanactivationevent.
GenerateCameraCutEvent Signalthatthevirtual
![Page 681: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/681.jpg)
camera'scontentisdiscontinuousWRTthepreviousframe.Ifthecameraislive,thenallCinemachineBrainsthatareshowingitwillsendacutevent.
GetActiveBrain AccessthearrayofactiveCinemachineBrainsinthescenewithoutgebneratinggarbage
GetVcamUpdateStatus Internaluseonly
GetVirtualCamera AccessthearrayofactiveICinemachineCamerainthescenewithoutgebneratinggarbage
IsLive IsthisvirtualcameracurrentlyactivelycontrollinganyCamera?
Top
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 682: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/682.jpg)
Cinemachine
![Page 683: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/683.jpg)
CinemachineCoreFindPotentialTargetBrainMethod
TrytofindaCinemachineBraintoassociatewithaCinemachineVirtualCamera.ThefirstCinemachineBraininwhichthisCinemachineVirtualCameraislivewillbeused.Ifnone,thenthefirstactiveCinemachineBrainwillbeused.BrainswithOutputCamera==nullwillnotbereturned.Finalresultmaybenull.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineICinemachineCameraVirtualcamerawhosepotentialbrainweneed.
ReturnValueType:CinemachineBrainFirstCinemachineBrainfoundthatmightbeappropriateforthisvcam,ornull
SeeAlso
publicCinemachineBrainFindPotentialTargetBrain(
ICinemachineCameravcam
)
CopyC# JavaScript
![Page 684: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/684.jpg)
ReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 685: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/685.jpg)
Cinemachine
![Page 686: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/686.jpg)
CinemachineCoreGenerateCameraActivationEventMethod
Signalthatthevirtualhasbeenactivated.Ifthecameraislive,thenallCinemachineBrainsthatareshowingitwillsendanactivationevent.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineICinemachineCamera[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineCore.GenerateCameraActivationEvent(Cinemachine.ICinemachineCamera)"]
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidGenerateCameraActivationEvent(
ICinemachineCameravcam
)
CopyC# JavaScript
![Page 687: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/687.jpg)
Cinemachine
![Page 688: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/688.jpg)
CinemachineCoreGenerateCameraCutEventMethod
Signalthatthevirtualcamera'scontentisdiscontinuousWRTthepreviousframe.Ifthecameraislive,thenallCinemachineBrainsthatareshowingitwillsendacutevent.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineICinemachineCamera[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineCore.GenerateCameraCutEvent(Cinemachine.ICinemachineCamera)"]
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidGenerateCameraCutEvent(
ICinemachineCameravcam
)
CopyC# JavaScript
![Page 689: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/689.jpg)
Cinemachine
![Page 690: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/690.jpg)
CinemachineCoreGetActiveBrainMethod
AccessthearrayofactiveCinemachineBrainsinthescenewithoutgebneratinggarbage
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
indexType:SystemInt32Indexofthebraintoaccess,range0-BrainCount
ReturnValueType:CinemachineBrainThebrainatthespecifiedindex
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForum
publicCinemachineBrainGetActiveBrain(
intindex
)
CopyC# JavaScript
![Page 692: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/692.jpg)
Cinemachine
![Page 693: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/693.jpg)
CinemachineCoreGetVcamUpdateStatusMethod
Internaluseonly
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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)"]
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
publicCinemachineCoreUpdateFilterGetVcamUpdateStatus
ICinemachineCameravcam
)
CopyC# JavaScript
![Page 694: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/694.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 695: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/695.jpg)
Cinemachine
![Page 696: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/696.jpg)
CinemachineCoreGetVirtualCameraMethod
AccessthearrayofactiveICinemachineCamerainthescenewithoutgebneratinggarbage
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
indexType:SystemInt32Indexofthecameratoaccess,range0-VirtualCameraCount
ReturnValueType:ICinemachineCameraThevirtualcameraatthespecifiedindex
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForum
publicICinemachineCameraGetVirtualCamera(
intindex
)
CopyC# JavaScript
![Page 698: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/698.jpg)
Cinemachine
![Page 699: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/699.jpg)
CinemachineCoreIsLiveMethod
IsthisvirtualcameracurrentlyactivelycontrollinganyCamera?
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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)"]
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicboolIsLive(
ICinemachineCameravcam
)
CopyC# JavaScript
![Page 700: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/700.jpg)
![Page 701: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/701.jpg)
Cinemachine
![Page 702: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/702.jpg)
CinemachineCoreFields
TheCinemachineCoretypeexposesthefollowingmembers.
Fields Name Description
GetInputAxis DelegateforoverridingUnity'sdefaultinputsystem.Ifyousetthis,thenyourdelegatewillbecalledinsteadofSystem.Input.GetAxis(axisName)wheneverin-gameuserinputisneeded.
kStreamingVersion Dataversionstring.Usedtoupgradefromlegacyprojects
kVersionString Human-readableCinemachineVersion
sShowHiddenObjects Iftrue,showhiddenCinemachineobjects,tomakemanualscriptmappingpossible.
Top
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForum
![Page 704: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/704.jpg)
Cinemachine
![Page 705: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/705.jpg)
CinemachineCoreGetInputAxisField
DelegateforoverridingUnity'sdefaultinputsystem.Ifyousetthis,thenyourdelegatewillbecalledinsteadofSystem.Input.GetAxis(axisName)wheneverin-gameuserinputisneeded.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineCoreAxisInputDelegate
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticCinemachineCoreAxisInputDelegateGetInputAxis
CopyC# JavaScript
![Page 706: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/706.jpg)
Cinemachine
![Page 707: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/707.jpg)
CinemachineCorekStreamingVersionField
Dataversionstring.Usedtoupgradefromlegacyprojects
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Int32
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticreadonlyintkStreamingVersion
CopyC# JavaScript
![Page 708: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/708.jpg)
Cinemachine
![Page 709: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/709.jpg)
CinemachineCorekVersionStringField
Human-readableCinemachineVersion
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:String
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticreadonlystringkVersionString
CopyC# JavaScript
![Page 710: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/710.jpg)
Cinemachine
![Page 711: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/711.jpg)
CinemachineCoresShowHiddenObjectsField
Iftrue,showhiddenCinemachineobjects,tomakemanualscriptmappingpossible.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineCoreClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticboolsShowHiddenObjects
CopyC# JavaScript
![Page 712: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/712.jpg)
Cinemachine
![Page 713: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/713.jpg)
CinemachineCoreAxisInputDelegateDelegate
DelegateforoverridingUnity'sdefaultinputsystem.Returnsthevalueofthenamedaxis.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
axisNameType:SystemString
ReturnValueType:Single
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicdelegatefloatAxisInputDelegate(
stringaxisName
)
CopyC# JavaScript
![Page 714: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/714.jpg)
Cinemachine
![Page 715: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/715.jpg)
CinemachineCoreStageEnumeration
StagesintheCinemachineComponentpipeline,usedforUIorganization>.Thisenumdefinesthepipelineorder.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members
Membername Value Description
Body 0 Secondstage:positionthecamerainspace
Aim 1 Thirdstage:orientthecameratopointatthetarget
Noise 2 Finalstage:applynoise(thisisdoneseparately,intheCorrectionchanneloftheCameraState)
SeeAlso
publicenumStage
CopyC# JavaScript
![Page 716: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/716.jpg)
ReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 717: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/717.jpg)
Cinemachine
![Page 718: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/718.jpg)
CinemachineCoreUpdateFilterEnumeration
Internaluseonly
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members Membername Value Description
Fixed 0
Late 1
Any 2
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicenumUpdateFilter
CopyC# JavaScript
![Page 719: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/719.jpg)
Cinemachine
![Page 720: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/720.jpg)
CinemachineDollyCartClass
ThisisaverysimplebehaviourthatconstrainsitstransformtoaCinemachinePath.Itcanbeusedtoanimateanyobjectsalongapath,orasaFollowtargetforCinemachineVirtualCameras.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineDollyCart
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineDollyCarttypeexposesthefollowingmembers.
Constructors Name Description
CinemachineDollyCart
Top
[DocumentationSortingAttribute(21f,DocumentationSortingAttribute
[ExecuteInEditMode]
publicclassCinemachineDollyCart:MonoBehaviour
CopyC# JavaScript
![Page 721: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/721.jpg)
Fields Name Description
m_Path Thepathtofollow
m_Position Thecart'scurrentpositiononthepath,indistanceunits
m_PositionUnits HowtointerpretthePathPosition
m_Speed Movethecartwiththisspeed
m_UpdateMethod Whentomovethecart,ifVelocityisnon-zero
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 722: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/722.jpg)
Cinemachine
![Page 723: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/723.jpg)
CinemachineDollyCartConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineDollyCart.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineDollyCartClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineDollyCart()
CopyC# JavaScript
![Page 724: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/724.jpg)
Cinemachine
![Page 725: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/725.jpg)
CinemachineDollyCartFields
TheCinemachineDollyCarttypeexposesthefollowingmembers.
Fields Name Description
m_Path Thepathtofollow
m_Position Thecart'scurrentpositiononthepath,indistanceunits
m_PositionUnits HowtointerpretthePathPosition
m_Speed Movethecartwiththisspeed
m_UpdateMethod Whentomovethecart,ifVelocityisnon-zero
Top
SeeAlsoReferenceCinemachineDollyCartClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 726: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/726.jpg)
Cinemachine
![Page 727: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/727.jpg)
CinemachineDollyCartm_PathField
Thepathtofollow
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachinePathBase
SeeAlsoReferenceCinemachineDollyCartClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thepathtofollow")]
publicCinemachinePathBasem_Path
CopyC# JavaScript
![Page 728: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/728.jpg)
Cinemachine
![Page 729: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/729.jpg)
CinemachineDollyCartm_PositionField
Thecart'scurrentpositiononthepath,indistanceunits
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineDollyCartClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thepositionalongthepathatwhichthecartwillbeplaced.Thiscanbeanimateddirectlyor,ifthevelocityisnon-zero,willbeupdatedautomatically.ThevalueisinterpretedaccordingtothePositionUnitssetting.")]
[FormerlySerializedAsAttribute("m_CurrentDistance")]
publicfloatm_Position
CopyC# JavaScript
![Page 730: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/730.jpg)
Cinemachine
![Page 731: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/731.jpg)
CinemachineDollyCartm_PositionUnitsField
HowtointerpretthePathPosition
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachinePathBasePositionUnits
SeeAlsoReferenceCinemachineDollyCartClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("HowtointerpretthePathPosition.IfsettoPathUnits,valuesareasfollows:0representsthefirstwaypointonthepath,1isthesecond,andsoon.Valuesin-betweenarepointsonthepathinbetweenthewaypoints.IfsettoDistance,thenPathPositionrepresentsdistancealongthepath.")]
publicCinemachinePathBasePositionUnitsm_PositionUnits
CopyC# JavaScript
![Page 732: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/732.jpg)
Cinemachine
![Page 733: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/733.jpg)
CinemachineDollyCartm_SpeedField
Movethecartwiththisspeed
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineDollyCartClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Movethecartwiththisspeedalongthepath.ThevalueisinterpretedaccordingtothePositionUnitssetting.")]
[FormerlySerializedAsAttribute("m_Velocity")]
publicfloatm_Speed
CopyC# JavaScript
![Page 734: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/734.jpg)
Cinemachine
![Page 735: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/735.jpg)
CinemachineDollyCartm_UpdateMethodField
Whentomovethecart,ifVelocityisnon-zero
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineDollyCartUpdateMethod
SeeAlsoReferenceCinemachineDollyCartClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Whentomovethecart,ifVelocityisnon-zero")]
publicCinemachineDollyCartUpdateMethodm_UpdateMethod
CopyC# JavaScript
![Page 736: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/736.jpg)
Cinemachine
![Page 737: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/737.jpg)
CinemachineDollyCartUpdateMethodEnumeration
Thisenumdefinestheoptionsavailablefortheupdatemethod.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members
Membername Value Description
Update 0 UpdatedinnormalMonoBehaviourUpdate.
FixedUpdate 1 UpdatedinsyncwiththePhysicsmodule,inFixedUpdate
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicenumUpdateMethod
CopyC# JavaScript
![Page 738: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/738.jpg)
![Page 739: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/739.jpg)
Cinemachine
![Page 740: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/740.jpg)
CinemachineExtensionClass
BaseclassforaCinemachineVirtualCameraextensionmodule.HooksintotheCinemachinePipeline.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineExtensionCinemachineCinemachineColliderCinemachineCinemachineConfinerCinemachineCinemachineFollowZoom
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineExtensiontypeexposesthefollowingmembers.
Constructors Name Description
CinemachineExtension
[DocumentationSortingAttribute(23f,DocumentationSortingAttribute
publicabstractclassCinemachineExtension:MonoBehaviour
CopyC# JavaScript
![Page 741: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/741.jpg)
Top
Properties Name Description
VirtualCamera GettheassociatedCinemachineVirtualCameraBase
Top
Methods Name Description
Awake Connecttovirtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation
GetAllExtraStatesT Ineffeicientmethodtogetallextrastateinforforallvcams.IntendedforEditoruseonly,notruntime!
GetExtraStateT Becauseextensionscanbeplacedonmanagercamsandwillinthatcasebecalledforallthevcamchildren,vcam-specificstateinformationshouldbestoredhere.Justdefineaclasstoholdyourstateinfoand
![Page 742: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/742.jpg)
useitexclusivelywhencallingthis.
OnDestroy Disconnectfromvirtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation
PostPipelineStageCallback Thiscallbackwillbecalledafterthevirtualcamerahasimplementedeachstageinthepipeline.Thismethodmaymodifythereferencedstate.IfdeltaTimelessthan0,resetallstateinfoandperformnodamping.
Top
Fields Name Description
Epsilon Usefulconstantforverysmallfloats
Top
SeeAlsoReferenceCinemachineNamespace
![Page 743: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/743.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 744: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/744.jpg)
Cinemachine
![Page 745: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/745.jpg)
CinemachineExtensionConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineExtension.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineExtensionClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedCinemachineExtension()
CopyC# JavaScript
![Page 746: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/746.jpg)
Cinemachine
![Page 747: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/747.jpg)
CinemachineExtensionProperties
TheCinemachineExtensiontypeexposesthefollowingmembers.
Properties Name Description
VirtualCamera GettheassociatedCinemachineVirtualCameraBase
Top
SeeAlsoReferenceCinemachineExtensionClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 748: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/748.jpg)
Cinemachine
![Page 749: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/749.jpg)
CinemachineExtensionVirtualCameraProperty
GettheassociatedCinemachineVirtualCameraBase
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineVirtualCameraBase
SeeAlsoReferenceCinemachineExtensionClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineVirtualCameraBaseVirtualCamera{
CopyC# JavaScript
![Page 750: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/750.jpg)
Cinemachine
![Page 751: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/751.jpg)
CinemachineExtensionMethods
TheCinemachineExtensiontypeexposesthefollowingmembers.
Methods Name Description
Awake Connecttovirtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation
GetAllExtraStatesT Ineffeicientmethodtogetallextrastateinforforallvcams.IntendedforEditoruseonly,notruntime!
GetExtraStateT Becauseextensionscanbeplacedonmanagercamsandwillinthatcasebecalledforallthevcamchildren,vcam-specificstateinformationshouldbestoredhere.Justdefineaclasstoholdyourstateinfoanduseitexclusivelywhencallingthis.
OnDestroy Disconnectfrom
![Page 752: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/752.jpg)
virtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation
PostPipelineStageCallback Thiscallbackwillbecalledafterthevirtualcamerahasimplementedeachstageinthepipeline.Thismethodmaymodifythereferencedstate.IfdeltaTimelessthan0,resetallstateinfoandperformnodamping.
Top
SeeAlsoReferenceCinemachineExtensionClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 753: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/753.jpg)
Cinemachine
![Page 754: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/754.jpg)
CinemachineExtensionAwakeMethod
Connecttovirtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineExtensionClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedvirtualvoidAwake()
CopyC# JavaScript
![Page 755: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/755.jpg)
Cinemachine
![Page 756: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/756.jpg)
CinemachineExtensionGetAllExtraStatesMethod
Ineffeicientmethodtogetallextrastateinforforallvcams.IntendedforEditoruseonly,notruntime!
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TypeParameters
T
ReturnValueType:ListT[Missing<returns>documentationfor"M:Cinemachine.CinemachineExtension.GetAllExtraStates``1"]
SeeAlsoReferenceCinemachineExtensionClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedList<T>GetAllExtraStates<T>()
whereT:class,new()
CopyC# JavaScript
![Page 757: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/757.jpg)
Cinemachine
![Page 758: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/758.jpg)
CinemachineExtensionGetExtraStateMethod
Becauseextensionscanbeplacedonmanagercamsandwillinthatcasebecalledforallthevcamchildren,vcam-specificstateinformationshouldbestoredhere.Justdefineaclasstoholdyourstateinfoanduseitexclusivelywhencallingthis.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineICinemachineCamera[Missing<paramname="vcam"/>documentationfor"M:Cinemachine.CinemachineExtension.GetExtraState``1(Cinemachine.ICinemachineCamera)"]
TypeParameters
T
ReturnValueType:T[Missing<returns>documentationfor
protectedTGetExtraState<T>(
ICinemachineCameravcam
)
whereT:class,new()
CopyC# JavaScript
![Page 759: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/759.jpg)
"M:Cinemachine.CinemachineExtension.GetExtraState``1(Cinemachine.ICinemachineCamera)"]
SeeAlsoReferenceCinemachineExtensionClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 760: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/760.jpg)
Cinemachine
![Page 761: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/761.jpg)
CinemachineExtensionOnDestroyMethod
Disconnectfromvirtualcamerapipeline.Overrideimplementationsmustcallthisbaseimplementation
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineExtensionClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedvirtualvoidOnDestroy()
CopyC# JavaScript
![Page 762: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/762.jpg)
Cinemachine
![Page 763: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/763.jpg)
CinemachineExtensionPostPipelineStageCallbackMethod
Thiscallbackwillbecalledafterthevirtualcamerahasimplementedeachstageinthepipeline.Thismethodmaymodifythereferencedstate.IfdeltaTimelessthan0,resetallstateinfoandperformnodamping.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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(
CinemachineVirtualCameraBasevcam,
CinemachineCoreStagestage,
refCameraStatestate,
floatdeltaTime
)
CopyC# JavaScript
![Page 764: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/764.jpg)
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)"]
SeeAlsoReferenceCinemachineExtensionClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 765: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/765.jpg)
Cinemachine
![Page 766: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/766.jpg)
CinemachineExtensionFields
TheCinemachineExtensiontypeexposesthefollowingmembers.
Fields Name Description
Epsilon Usefulconstantforverysmallfloats
Top
SeeAlsoReferenceCinemachineExtensionClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 767: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/767.jpg)
Cinemachine
![Page 768: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/768.jpg)
CinemachineExtensionEpsilonField
Usefulconstantforverysmallfloats
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineExtensionClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedconstfloatEpsilon=0.0001f
CopyC# JavaScript
![Page 769: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/769.jpg)
Cinemachine
![Page 770: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/770.jpg)
CinemachineExternalCameraClass
Thiscomponentwillexposeanon-cinemachinecameratothecinemachinesystem,allowingittoparticipateinblends.JustadditasacomponentalongsideanexistingUnityCameracomponent.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineExternalCamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineExternalCameratypeexposesthefollowingmembers.
[DocumentationSortingAttribute(14f,DocumentationSortingAttribute
[RequireComponent(typeof(Camera))]
[DisallowMultipleComponent]
[ExecuteInEditMode]
[AddComponentMenu("Cinemachine/CinemachineExternalCamera")]
publicclassCinemachineExternalCamera:CinemachineVirtualCameraBase
CopyC# JavaScript
![Page 771: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/771.jpg)
Constructors Name Description
CinemachineExternalCamera
Top
Properties Name Description
Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo(InheritedfromCinemachineVirtualCameraBase
Follow Thisvcamdefinesnotargets(OverridesCinemachineVirtualCameraBase
LiveChildOrSelf Justreturnsself.(InheritedfromCinemachineVirtualCameraBase
LookAt Theobjectthatthecameraislookingat(OverridesCinemachineVirtualCameraBase
Name GetthenameoftheVirtualCamera.BaseimplementationreturnstheownerGameObject'sname.(InheritedfromCinemachineVirtualCameraBase
ParentCamera Supportformeta-virtual-cameras.thesituationwhereavirtualcameraisin
![Page 772: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/772.jpg)
factthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.PrivatearmiesareimplementedasTransformchildrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase
PreviousStateIsValid SetthistoforcethenextupdatetoignoredeltaTimeandresetitself(InheritedfromCinemachineVirtualCameraBase
Priority GetthePriorityofthevirtualcamera.ThisdeterminesitsplacementCinemachineCore'squeueofeligibleshots.(InheritedfromCinemachineVirtualCameraBase
State GettheCameraState,asweareabletoconstructonefromtheUnityCamera(OverridesCinemachineVirtualCameraBase
ValidatingStreamVersion Versionthatwaslaststreamed,forupgradinglegacy(InheritedfromCinemachineVirtualCameraBase
VirtualCameraGameObject TheGameObjectowneroftheVirtualCamerabehaviour.(InheritedfromCinemachineVirtualCameraBase
Top
![Page 773: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/773.jpg)
Methods Name Description
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.(InheritedfromCinemachineVirtualCameraBase
OnDisable Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase
OnEnable Baseclassimplementationaddsthevirtualcamerafromthepriorityqueue.(InheritedfromCinemachineVirtualCameraBase
![Page 774: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/774.jpg)
OnTransformParentChanged Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(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
Start Baseclassimplementationdoesnothing.(InheritedfromCinemachineVirtualCameraBase
Update Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase
![Page 775: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/775.jpg)
UpdateCameraState ConstructaCameraStateobjectfromtheUnityCamera(OverridesCinemachineVirtualCameraBaseSingle).)
Top
Fields Name Description
CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.(InheritedfromCinemachineVirtualCameraBase
m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_LookAt Theobjectthatthecameraislookingat.
m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase
![Page 776: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/776.jpg)
OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 777: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/777.jpg)
Cinemachine
![Page 778: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/778.jpg)
CinemachineExternalCameraConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineExternalCamera.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineExternalCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineExternalCamera()
CopyC# JavaScript
![Page 779: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/779.jpg)
Cinemachine
![Page 780: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/780.jpg)
CinemachineExternalCameraProperties
TheCinemachineExternalCameratypeexposesthefollowingmembers.
Properties Name Description
Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo(InheritedfromCinemachineVirtualCameraBase
Follow Thisvcamdefinesnotargets(OverridesCinemachineVirtualCameraBase
LiveChildOrSelf Justreturnsself.(InheritedfromCinemachineVirtualCameraBase
LookAt Theobjectthatthecameraislookingat(OverridesCinemachineVirtualCameraBase
Name GetthenameoftheVirtualCamera.BaseimplementationreturnstheownerGameObject'sname.(InheritedfromCinemachineVirtualCameraBase
ParentCamera Supportformeta-virtual-cameras.
![Page 781: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/781.jpg)
thesituationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.PrivatearmiesareimplementedasTransformchildrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase
PreviousStateIsValid SetthistoforcethenextupdatetoignoredeltaTimeandresetitself(InheritedfromCinemachineVirtualCameraBase
Priority GetthePriorityofthevirtualcamera.ThisdeterminesitsplacementCinemachineCore'squeueofeligibleshots.(InheritedfromCinemachineVirtualCameraBase
State GettheCameraState,asweareabletoconstructonefromtheUnityCamera(OverridesCinemachineVirtualCameraBase
ValidatingStreamVersion Versionthatwaslaststreamed,forupgradinglegacy(InheritedfromCinemachineVirtualCameraBase
VirtualCameraGameObject TheGameObjectowneroftheVirtualCamerabehaviour.(InheritedfromCinemachineVirtualCameraBase
Top
![Page 782: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/782.jpg)
SeeAlsoReferenceCinemachineExternalCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 783: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/783.jpg)
Cinemachine
![Page 784: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/784.jpg)
CinemachineExternalCameraFollowProperty
Thisvcamdefinesnotargets
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:TransformImplementsICinemachineCameraFollow
SeeAlsoReferenceCinemachineExternalCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideTransformFollow{get;set;}
CopyC# JavaScript
![Page 785: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/785.jpg)
Cinemachine
![Page 786: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/786.jpg)
CinemachineExternalCameraLookAtProperty
Theobjectthatthecameraislookingat
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:TransformImplementsICinemachineCameraLookAt
SeeAlsoReferenceCinemachineExternalCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideTransformLookAt{get;set;}
CopyC# JavaScript
![Page 787: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/787.jpg)
Cinemachine
![Page 788: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/788.jpg)
CinemachineExternalCameraStateProperty
GettheCameraState,asweareabletoconstructonefromtheUnityCamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CameraStateImplementsICinemachineCameraState
SeeAlsoReferenceCinemachineExternalCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideCameraStateState{get;}
CopyC# JavaScript
![Page 789: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/789.jpg)
Cinemachine
![Page 790: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/790.jpg)
CinemachineExternalCameraMethods
TheCinemachineExternalCameratypeexposesthefollowingmembers.
Methods Name Description
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.
![Page 791: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/791.jpg)
(InheritedfromCinemachineVirtualCameraBase
OnDisable Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase
OnEnable Baseclassimplementationaddsthevirtualcamerafromthepriorityqueue.(InheritedfromCinemachineVirtualCameraBase
OnTransformParentChanged Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(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
![Page 792: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/792.jpg)
ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretruntheparentvcam'sLookAttarget.(InheritedfromCinemachineVirtualCameraBase
Start Baseclassimplementationdoesnothing.(InheritedfromCinemachineVirtualCameraBase
Update Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase
UpdateCameraState ConstructaCameraStateobjectfromtheUnityCamera(OverridesCinemachineVirtualCameraBaseSingle).)
Top
SeeAlsoReferenceCinemachineExternalCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 793: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/793.jpg)
Cinemachine
![Page 794: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/794.jpg)
CinemachineExternalCameraUpdateCameraStateMethod
ConstructaCameraStateobjectfromtheUnityCamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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)"]
ImplementsICinemachineCameraUpdateCameraState(Vector3,Single)
SeeAlsoReference
publicoverridevoidUpdateCameraState(
Vector3worldUp,
floatdeltaTime
)
CopyC# JavaScript
![Page 795: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/795.jpg)
CinemachineExternalCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 796: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/796.jpg)
Cinemachine
![Page 797: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/797.jpg)
CinemachineExternalCameraFields
TheCinemachineExternalCameratypeexposesthefollowingmembers.
Fields Name Description
CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.(InheritedfromCinemachineVirtualCameraBase
m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_LookAt Theobjectthatthecameraislookingat.
m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbers
![Page 798: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/798.jpg)
havegreaterpriority.(InheritedfromCinemachineVirtualCameraBase
OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
Top
SeeAlsoReferenceCinemachineExternalCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 799: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/799.jpg)
Cinemachine
![Page 800: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/800.jpg)
CinemachineExternalCameram_LookAtField
Theobjectthatthecameraislookingat.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Transform
SeeAlsoReferenceCinemachineExternalCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theobjectthatthecameraislookingat.Settingthiswillimprovethequalityoftheblendstoandfromthiscamera")]
[NoSaveDuringPlayAttribute]
publicTransformm_LookAt
CopyC# JavaScript
![Page 801: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/801.jpg)
Cinemachine
![Page 802: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/802.jpg)
CinemachineFollowZoomClass
Anadd-onmoduleforCinemachineVirtualCamerathatadjuststheFOVofthelenstokeepthetargetobjectataconstantsizeonthescreen,regardlessofcameraandtargetposition.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineExtensionCinemachineCinemachineFollowZoom
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineFollowZoomtypeexposesthefollowingmembers.
Constructors Name Description
[DocumentationSortingAttribute(16f,DocumentationSortingAttribute
[ExecuteInEditMode]
[AddComponentMenu("")]
[SaveDuringPlayAttribute]
publicclassCinemachineFollowZoom:CinemachineExtension
CopyC# JavaScript
![Page 803: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/803.jpg)
CinemachineFollowZoom
Top
Properties Name Description
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineExtension.)
Top
Methods Name Description
Awake Connecttovirtualcamerapipeline.implementation(InheritedfromCinemachineExtension
GetAllExtraStatesT Ineffeicientmethodtogetallextrastateinforforallvcams.only,notruntime!(InheritedfromCinemachineExtension
GetExtraStateT Becauseextensionscanbeplacedonmanagercamsandwillinthatforallthevcamchildren,vcam-specificstateinformationdefineaclasstoholdyourstateinfo(InheritedfromCinemachineExtension
OnDestroy Disconnectfromvirtualcamerapipeline.baseimplementation(InheritedfromCinemachineExtension
PostPipelineStageCallback Callbacktopreformthezoomadjustment(OverridesCinemachineExtensionPostPipelineStageCallback(CinemachineVirtualCameraBase,
![Page 804: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/804.jpg)
CinemachineCoreStage,CameraState
Top
Fields Name Description
m_Damping Increasethisvaluetosoftentheaggressivenessofthefollow-zoom.Smallnumbersaremoreresponsive,largernumbersgiveamoreheavyslowlyrespondingcamera.
m_MaxFOV WillnotgenerateanFOVlargetthanthis.
m_MinFOV WillnotgenerateanFOVsmallerthanthis.
m_Width Theshotwidthtomaintain,inworldunits,attargetdistance.FOVwillbeadustedasfaraspossibletomaintainthiswidthatthetargetdistancefromthecamera.
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 805: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/805.jpg)
Cinemachine
![Page 806: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/806.jpg)
CinemachineFollowZoomConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineFollowZoom.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineFollowZoomClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineFollowZoom()
CopyC# JavaScript
![Page 807: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/807.jpg)
Cinemachine
![Page 808: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/808.jpg)
CinemachineFollowZoomProperties
TheCinemachineFollowZoomtypeexposesthefollowingmembers.
Properties Name Description
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineExtension.)
Top
SeeAlsoReferenceCinemachineFollowZoomClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 809: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/809.jpg)
Cinemachine
![Page 810: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/810.jpg)
CinemachineFollowZoomMethods
TheCinemachineFollowZoomtypeexposesthefollowingmembers.
Methods Name Description
Awake Connecttovirtualcamerapipeline.implementation(InheritedfromCinemachineExtension
GetAllExtraStatesT Ineffeicientmethodtogetallextrastateinforforallvcams.only,notruntime!(InheritedfromCinemachineExtension
GetExtraStateT Becauseextensionscanbeplacedonmanagercamsandwillinthatforallthevcamchildren,vcam-specificstateinformationdefineaclasstoholdyourstateinfo(InheritedfromCinemachineExtension
OnDestroy Disconnectfromvirtualcamerapipeline.baseimplementation(InheritedfromCinemachineExtension
PostPipelineStageCallback Callbacktopreformthezoomadjustment(OverridesCinemachineExtensionPostPipelineStageCallback(CinemachineVirtualCameraBase,CinemachineCoreStage,CameraState
Top
SeeAlso
![Page 811: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/811.jpg)
ReferenceCinemachineFollowZoomClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 812: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/812.jpg)
Cinemachine
![Page 813: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/813.jpg)
CinemachineFollowZoomPostPipelineStageCallbackMethod
Callbacktopreformthezoomadjustment
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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)"]
protectedoverridevoidPostPipelineStageCallback(
CinemachineVirtualCameraBasevcam,
CinemachineCoreStagestage,
refCameraStatestate,
floatdeltaTime
)
CopyC# JavaScript
![Page 814: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/814.jpg)
deltaTimeType:SystemSingle[Missing<paramname="deltaTime"/>documentationfor"M:Cinemachine.CinemachineFollowZoom.PostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]
SeeAlsoReferenceCinemachineFollowZoomClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 815: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/815.jpg)
Cinemachine
![Page 816: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/816.jpg)
CinemachineFollowZoomFields
TheCinemachineFollowZoomtypeexposesthefollowingmembers.
Fields Name Description
m_Damping Increasethisvaluetosoftentheaggressivenessofthefollow-zoom.Smallnumbersaremoreresponsive,largernumbersgiveamoreheavyslowlyrespondingcamera.
m_MaxFOV WillnotgenerateanFOVlargetthanthis.
m_MinFOV WillnotgenerateanFOVsmallerthanthis.
m_Width Theshotwidthtomaintain,inworldunits,attargetdistance.FOVwillbeadustedasfaraspossibletomaintainthiswidthatthetargetdistancefromthecamera.
Top
SeeAlsoReferenceCinemachineFollowZoomClassCinemachineNamespace
![Page 817: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/817.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 818: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/818.jpg)
Cinemachine
![Page 819: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/819.jpg)
CinemachineFollowZoomm_DampingField
Increasethisvaluetosoftentheaggressivenessofthefollow-zoom.Smallnumbersaremoreresponsive,largernumbersgiveamoreheavyslowlyrespondingcamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFollowZoomClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("Increasethisvaluetosoftentheaggressivenessofthefollow-zoom.Smallnumbersaremoreresponsive,largernumbersgiveamoreheavyslowlyrespondingcamera.")]
publicfloatm_Damping
CopyC# JavaScript
![Page 820: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/820.jpg)
Cinemachine
![Page 821: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/821.jpg)
CinemachineFollowZoomm_MaxFOVField
WillnotgenerateanFOVlargetthanthis.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFollowZoomClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(1f,179f)]
[TooltipAttribute("UpperlimitfortheFOVthatthisbehaviourwillgenerate.")]
publicfloatm_MaxFOV
CopyC# JavaScript
![Page 822: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/822.jpg)
Cinemachine
![Page 823: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/823.jpg)
CinemachineFollowZoomm_MinFOVField
WillnotgenerateanFOVsmallerthanthis.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFollowZoomClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(1f,179f)]
[TooltipAttribute("LowerlimitfortheFOVthatthisbehaviourwillgenerate.")]
publicfloatm_MinFOV
CopyC# JavaScript
![Page 824: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/824.jpg)
Cinemachine
![Page 825: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/825.jpg)
CinemachineFollowZoomm_WidthField
Theshotwidthtomaintain,inworldunits,attargetdistance.FOVwillbeadustedasfaraspossibletomaintainthiswidthatthetargetdistancefromthecamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFollowZoomClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theshotwidthtomaintain,inworldunits,attargetdistance.")]
publicfloatm_Width
CopyC# JavaScript
![Page 826: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/826.jpg)
Cinemachine
![Page 827: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/827.jpg)
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
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
SyntaxCopy
![Page 828: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/828.jpg)
TheCinemachineFramingTransposertypeexposesthefollowingmembers.
Constructors Name Description
CinemachineFramingTransposer
Top
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
HardGuideRect InternalAPIfortheinspectoreditor
IsValid TrueifcomponentisenabledandhasavalidFollowtarget(OverridesCinemachineComponentBaseIsValid.)
LookAtTarget Returnstheownervcam'sLookAttarget.(Inheritedfrom
[DocumentationSortingAttribute(5.5f,DocumentationSortingAttribute
[ExecuteInEditMode]
[AddComponentMenu("")]
[RequireComponent(typeof(CinemachinePipeline
[SaveDuringPlayAttribute]
publicclassCinemachineFramingTransposer
CopyC# JavaScript
![Page 829: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/829.jpg)
CinemachineComponentBase.)
m_LastBounds Foreditorvisulaizationofthecalculatedboundingboxofthegroup
m_lastBoundsMatrix Foreditorvisualizationofthecalculatedboundingboxofthegroup
SoftGuideRect InternalAPIfortheinspectoreditor
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage(OverridesCinemachineComponentBaseStage.)
TargetGroup GetFollowtargetasCinemachineTargetGroup,ornulliftargetisnotagroup
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)
Top
Methods Name Description
MutateCameraState Positionsthevirtualcameraaccordingtothetransposerrules.(OverridesCinemachineComponentBaseMutateCameraState(CameraState
![Page 830: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/830.jpg)
Single).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.classimplementationdoesnothing.(InheritedfromCinemachineComponentBase
Top
Fields Name Description
m_AdjustmentMode Howtoadjustthecameratogetthedesiredframing
m_BiasX Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone
m_BiasY Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone
m_CameraDistance ThedistancealongthecameraaxisthatwillbemaintainedfromtheFollowtarget
m_DeadZoneDepth Thecamerawillnotmovealongitsz-axisiftheFollowtargetiswithinthisdistanceofthespecifiedcameradistance
m_DeadZoneHeight Camerawillnotmove
![Page 831: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/831.jpg)
verticallyifthetargetiswithinthisrangeoftheposition
m_DeadZoneWidth Camerawillnotmovehorizontallyifthetargetiswithinthisrangeoftheposition
m_GroupFramingMode Whatscreendimensionstoconsiderwhenframing
m_GroupFramingSize Howmuchofthescreentofillwiththeboundingboxofthetargets.
m_LookaheadSmoothing Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag
m_LookaheadTime Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,
![Page 832: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/832.jpg)
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
![Page 833: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/833.jpg)
m_MinimumOrthoSize IfadjustingOrthographicSize,willnotsetitlowerthanthis
m_ScreenX Horizontalscreenpositionfortarget.Thecamerawillmovetopositionthetrackedobjecthere
m_ScreenY Verticalscreenpositionfortarget,Thecamerawillmovetotopositionthetrackedobjecthere
m_SoftZoneHeight Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed
m_SoftZoneWidth Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed
m_UnlimitedSoftZone
m_XDamping HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersaremore
![Page 834: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/834.jpg)
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
![Page 835: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/835.jpg)
heavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
OnGUICallback UsedbytheInspectorEditortodisplayon-screenguides.
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 836: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/836.jpg)
Cinemachine
![Page 837: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/837.jpg)
CinemachineFramingTransposerConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineFramingTransposer.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineFramingTransposer()
CopyC# JavaScript
![Page 838: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/838.jpg)
Cinemachine
![Page 839: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/839.jpg)
CinemachineFramingTransposerProperties
TheCinemachineFramingTransposertypeexposesthefollowingmembers.
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
HardGuideRect InternalAPIfortheinspectoreditor
IsValid TrueifcomponentisenabledandhasavalidFollowtarget(OverridesCinemachineComponentBaseIsValid.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
m_LastBounds Foreditorvisulaizationofthecalculatedboundingboxofthegroup
m_lastBoundsMatrix Foreditorvisualizationofthecalculatedboundingboxofthegroup
SoftGuideRect InternalAPIfortheinspectoreditor
![Page 840: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/840.jpg)
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage(OverridesCinemachineComponentBaseStage.)
TargetGroup GetFollowtargetasCinemachineTargetGroup,ornulliftargetisnotagroup
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)
Top
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 841: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/841.jpg)
Cinemachine
![Page 842: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/842.jpg)
CinemachineFramingTransposerHardGuideRectProperty
InternalAPIfortheinspectoreditor
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Rect
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicRectHardGuideRect{get;set;}
CopyC# JavaScript
![Page 843: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/843.jpg)
Cinemachine
![Page 844: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/844.jpg)
CinemachineFramingTransposerIsValidProperty
TrueifcomponentisenabledandhasavalidFollowtarget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideboolIsValid{get;}
CopyC# JavaScript
![Page 845: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/845.jpg)
Cinemachine
![Page 846: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/846.jpg)
CinemachineFramingTransposerm_LastBoundsProperty
Foreditorvisulaizationofthecalculatedboundingboxofthegroup
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Bounds
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicBoundsm_LastBounds{get;}
CopyC# JavaScript
![Page 847: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/847.jpg)
Cinemachine
![Page 848: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/848.jpg)
CinemachineFramingTransposerm_lastBoundsMatrixProperty
Foreditorvisualizationofthecalculatedboundingboxofthegroup
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Matrix4x4
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicMatrix4x4m_lastBoundsMatrix{get;}
CopyC# JavaScript
![Page 849: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/849.jpg)
Cinemachine
![Page 850: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/850.jpg)
CinemachineFramingTransposerSoftGuideRectProperty
InternalAPIfortheinspectoreditor
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Rect
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicRectSoftGuideRect{get;set;}
CopyC# JavaScript
![Page 851: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/851.jpg)
Cinemachine
![Page 852: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/852.jpg)
CinemachineFramingTransposerStageProperty
GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineCoreStage
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideCinemachineCoreStageStage{get;}
CopyC# JavaScript
![Page 853: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/853.jpg)
Cinemachine
![Page 854: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/854.jpg)
CinemachineFramingTransposerTargetGroupProperty
GetFollowtargetasCinemachineTargetGroup,ornulliftargetisnotagroup
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineTargetGroup
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineTargetGroupTargetGroup{get;}
CopyC# JavaScript
![Page 855: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/855.jpg)
Cinemachine
![Page 856: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/856.jpg)
CinemachineFramingTransposerMethods
TheCinemachineFramingTransposertypeexposesthefollowingmembers.
Methods Name Description
MutateCameraState Positionsthevirtualcameraaccordingtothetransposerrules.(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.classimplementationdoesnothing.(InheritedfromCinemachineComponentBase
Top
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 857: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/857.jpg)
Cinemachine
![Page 858: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/858.jpg)
CinemachineFramingTransposerMutateCameraStateMethod
Positionsthevirtualcameraaccordingtothetransposerrules.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
curStateType:CinemachineCameraStateThecurrentcamerastate
deltaTimeType:SystemSingleUsedfordamping.Iflessthan0,nodampingisdone.
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridevoidMutateCameraState(
refCameraStatecurState,
floatdeltaTime
)
CopyC# JavaScript
![Page 859: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/859.jpg)
![Page 860: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/860.jpg)
Cinemachine
![Page 861: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/861.jpg)
CinemachineFramingTransposerFields
TheCinemachineFramingTransposertypeexposesthefollowingmembers.
Fields Name Description
m_AdjustmentMode Howtoadjustthecameratogetthedesiredframing
m_BiasX Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone
m_BiasY Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone
m_CameraDistance ThedistancealongthecameraaxisthatwillbemaintainedfromtheFollowtarget
m_DeadZoneDepth Thecamerawillnotmovealongitsz-axisiftheFollowtargetiswithinthisdistanceofthespecifiedcameradistance
![Page 862: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/862.jpg)
m_DeadZoneHeight Camerawillnotmoveverticallyifthetargetiswithinthisrangeoftheposition
m_DeadZoneWidth Camerawillnotmovehorizontallyifthetargetiswithinthisrangeoftheposition
m_GroupFramingMode Whatscreendimensionstoconsiderwhenframing
m_GroupFramingSize Howmuchofthescreentofillwiththeboundingboxofthetargets.
m_LookaheadSmoothing Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag
m_LookaheadTime Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitiveto
![Page 863: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/863.jpg)
noisyanimation,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
![Page 864: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/864.jpg)
m_MinimumOrthoSize IfadjustingOrthographicSize,willnotsetitlowerthanthis
m_ScreenX Horizontalscreenpositionfortarget.Thecamerawillmovetopositionthetrackedobjecthere
m_ScreenY Verticalscreenpositionfortarget,Thecamerawillmovetotopositionthetrackedobjecthere
m_SoftZoneHeight Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed
m_SoftZoneWidth Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed
m_UnlimitedSoftZone
m_XDamping HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersaremore
![Page 865: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/865.jpg)
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
![Page 866: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/866.jpg)
heavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
OnGUICallback UsedbytheInspectorEditortodisplayon-screenguides.
Top
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 867: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/867.jpg)
Cinemachine
![Page 868: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/868.jpg)
CinemachineFramingTransposerm_AdjustmentModeField
Howtoadjustthecameratogetthedesiredframing
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineFramingTransposerAdjustmentMode
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Howtoadjustthecameratogetthedesiredframing.Youcanzoom,dollyin/out,ordoboth.")]
publicCinemachineFramingTransposerAdjustmentModem_AdjustmentMode
CopyC# JavaScript
![Page 869: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/869.jpg)
Cinemachine
![Page 870: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/870.jpg)
CinemachineFramingTransposerm_BiasXField
Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(-0.5f,0.5f)]
[TooltipAttribute("Anon-zerobiaswillmovethetargetpositionhorizontallyawayfromthecenterofthesoftzone.")]
publicfloatm_BiasX
CopyC# JavaScript
![Page 871: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/871.jpg)
Cinemachine
![Page 872: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/872.jpg)
CinemachineFramingTransposerm_BiasYField
Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(-0.5f,0.5f)]
[TooltipAttribute("Anon-zerobiaswillmovethetargetpositionverticallyawayfromthecenterofthesoftzone.")]
publicfloatm_BiasY
CopyC# JavaScript
![Page 873: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/873.jpg)
Cinemachine
![Page 874: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/874.jpg)
CinemachineFramingTransposerm_CameraDistanceField
ThedistancealongthecameraaxisthatwillbemaintainedfromtheFollowtarget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("ThedistancealongthecameraaxisthatwillbemaintainedfromtheFollowtarget")]
publicfloatm_CameraDistance
CopyC# JavaScript
![Page 875: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/875.jpg)
Cinemachine
![Page 876: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/876.jpg)
CinemachineFramingTransposerm_DeadZoneDepthField
Thecamerawillnotmovealongitsz-axisiftheFollowtargetiswithinthisdistanceofthespecifiedcameradistance
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thecamerawillnotmovealongitsz-axisiftheFollowtargetiswithinthisdistanceofthespecifiedcameradistance")]
[FormerlySerializedAsAttribute("m_DistanceDeadZoneSize")]
publicfloatm_DeadZoneDepth
CopyC# JavaScript
![Page 877: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/877.jpg)
Cinemachine
![Page 878: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/878.jpg)
CinemachineFramingTransposerm_DeadZoneHeightField
Camerawillnotmoveverticallyifthetargetiswithinthisrangeoftheposition
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,1f)]
[TooltipAttribute("Camerawillnotmoveverticallyifthetargetiswithinthisrangeoftheposition.")]
publicfloatm_DeadZoneHeight
CopyC# JavaScript
![Page 879: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/879.jpg)
Cinemachine
![Page 880: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/880.jpg)
CinemachineFramingTransposerm_DeadZoneWidthField
Camerawillnotmovehorizontallyifthetargetiswithinthisrangeoftheposition
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[SpaceAttribute]
[RangeAttribute(0f,1f)]
[TooltipAttribute("Camerawillnotmovehorizontallyifthetargetiswithinthisrangeoftheposition.")]
publicfloatm_DeadZoneWidth
CopyC# JavaScript
![Page 881: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/881.jpg)
Cinemachine
![Page 882: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/882.jpg)
CinemachineFramingTransposerm_GroupFramingModeField
Whatscreendimensionstoconsiderwhenframing
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineFramingTransposerFramingMode
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[SpaceAttribute]
[TooltipAttribute("Whatscreendimensionstoconsiderwhenframing.CanbeHorizontal,Vertical,orboth")]
[FormerlySerializedAsAttribute("m_FramingMode")]
publicCinemachineFramingTransposerFramingModem_GroupFramingMode
CopyC# JavaScript
![Page 883: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/883.jpg)
Cinemachine
![Page 884: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/884.jpg)
CinemachineFramingTransposerm_GroupFramingSizeField
Howmuchofthescreentofillwiththeboundingboxofthetargets.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theboundingboxofthetargetsshouldoccupythisamountofthescreenspace.1meansfillthewholescreen.0.5meansfillhalfthescreen,etc.")]
publicfloatm_GroupFramingSize
CopyC# JavaScript
![Page 885: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/885.jpg)
Cinemachine
![Page 886: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/886.jpg)
CinemachineFramingTransposerm_LookaheadSmoothingField
Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag")]
[RangeAttribute(3f,30f)]
publicfloatm_LookaheadSmoothing
CopyC# JavaScript
![Page 887: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/887.jpg)
Cinemachine
![Page 888: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/888.jpg)
CinemachineFramingTransposerm_LookaheadTimeField
Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.")]
[RangeAttribute(0f,1f)]
publicfloatm_LookaheadTime
CopyC# JavaScript
![Page 889: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/889.jpg)
![Page 890: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/890.jpg)
Cinemachine
![Page 891: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/891.jpg)
CinemachineFramingTransposerm_MaxDollyInField
Howmuchclosertothetargetcanthecamerago?
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Themaximumdistancetowardthetargetthatthisbehaviourisallowedtomovethecamera.")]
publicfloatm_MaxDollyIn
CopyC# JavaScript
![Page 892: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/892.jpg)
Cinemachine
![Page 893: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/893.jpg)
CinemachineFramingTransposerm_MaxDollyOutField
Howmuchfartherfromthetargetcanthecamerago?
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Themaximumdistanceawaythetargetthatthisbehaviourisallowedtomovethecamera.")]
publicfloatm_MaxDollyOut
CopyC# JavaScript
![Page 894: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/894.jpg)
Cinemachine
![Page 895: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/895.jpg)
CinemachineFramingTransposerm_MaximumDistanceField
Setthistolimithowfarfromthetaregtthecameracanget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Setthistolimithowfarfromthetargetthecameracanget.")]
publicfloatm_MaximumDistance
CopyC# JavaScript
![Page 896: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/896.jpg)
Cinemachine
![Page 897: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/897.jpg)
CinemachineFramingTransposerm_MaximumFOVField
IfadjustingFOV,willnotsettheFOVhigherthanthis
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(1f,179f)]
[TooltipAttribute("IfadjustingFOV,willnotsettheFOVhigherthanthis.")]
publicfloatm_MaximumFOV
CopyC# JavaScript
![Page 898: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/898.jpg)
Cinemachine
![Page 899: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/899.jpg)
CinemachineFramingTransposerm_MaximumOrthoSizeField
IfadjustingOrthographicSize,willnotsetithigherthanthis
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("IfadjustingOrthographicSize,willnotsetithigherthanthis.")]
publicfloatm_MaximumOrthoSize
CopyC# JavaScript
![Page 900: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/900.jpg)
Cinemachine
![Page 901: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/901.jpg)
CinemachineFramingTransposerm_MinimumDistanceField
Setthistolimithowclosetothetargetthecameracanget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Setthistolimithowclosetothetargetthecameracanget.")]
publicfloatm_MinimumDistance
CopyC# JavaScript
![Page 902: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/902.jpg)
Cinemachine
![Page 903: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/903.jpg)
CinemachineFramingTransposerm_MinimumFOVField
IfadjustingFOV,willnotsettheFOVlowerthanthis
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(1f,179f)]
[TooltipAttribute("IfadjustingFOV,willnotsettheFOVlowerthanthis.")]
publicfloatm_MinimumFOV
CopyC# JavaScript
![Page 904: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/904.jpg)
Cinemachine
![Page 905: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/905.jpg)
CinemachineFramingTransposerm_MinimumOrthoSizeField
IfadjustingOrthographicSize,willnotsetitlowerthanthis
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("IfadjustingOrthographicSize,willnotsetitlowerthanthis.")]
publicfloatm_MinimumOrthoSize
CopyC# JavaScript
![Page 906: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/906.jpg)
Cinemachine
![Page 907: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/907.jpg)
CinemachineFramingTransposerm_ScreenXField
Horizontalscreenpositionfortarget.Thecamerawillmovetopositionthetrackedobjecthere
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[SpaceAttribute]
[RangeAttribute(0f,1f)]
[TooltipAttribute("Horizontalscreenpositionfortarget.Thecamerawillmovetopositionthetrackedobjecthere.")]
publicfloatm_ScreenX
CopyC# JavaScript
![Page 908: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/908.jpg)
Cinemachine
![Page 909: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/909.jpg)
CinemachineFramingTransposerm_ScreenYField
Verticalscreenpositionfortarget,Thecamerawillmovetotopositionthetrackedobjecthere
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,1f)]
[TooltipAttribute("Verticalscreenpositionfortarget,Thecamerawillmovetopositionthetrackedobjecthere.")]
publicfloatm_ScreenY
CopyC# JavaScript
![Page 910: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/910.jpg)
Cinemachine
![Page 911: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/911.jpg)
CinemachineFramingTransposerm_SoftZoneHeightField
Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,2f)]
[TooltipAttribute("Whentargetiswithinthisregion,camerawillgraduallymoveverticallytore-aligntowardsthedesiredposition,dependingonthedampingspeed.")]
publicfloatm_SoftZoneHeight
CopyC# JavaScript
![Page 912: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/912.jpg)
Cinemachine
![Page 913: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/913.jpg)
CinemachineFramingTransposerm_SoftZoneWidthField
Whentargetiswithinthisregion,camerawillgraduallymovetore-aligntowardsthedesiredposition,dependingonmthedampingspeed
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,2f)]
[TooltipAttribute("Whentargetiswithinthisregion,camerawillgraduallymovehorizontallytore-aligntowardsthedesiredposition,dependingonthedampingspeed.")]
publicfloatm_SoftZoneWidth
CopyC# JavaScript
![Page 914: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/914.jpg)
Cinemachine
![Page 915: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/915.jpg)
CinemachineFramingTransposerm_UnlimitedSoftZoneField
[Missing<summary>documentationfor"F:Cinemachine.CinemachineFramingTransposer.m_UnlimitedSoftZone"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[SpaceAttribute]
[TooltipAttribute("Ifchecked,thenthensoftzonewillbeunlimitedinsize.")]
publicboolm_UnlimitedSoftZone
CopyC# JavaScript
![Page 916: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/916.jpg)
Cinemachine
![Page 917: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/917.jpg)
CinemachineFramingTransposerm_XDampingField
HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]
publicfloatm_XDamping
CopyC# JavaScript
![Page 918: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/918.jpg)
Cinemachine
![Page 919: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/919.jpg)
CinemachineFramingTransposerm_YDampingField
HowaggressivelythecameratriestomaintaintheoffsetintheY-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("HowaggressivelythecameratriestomaintaintheoffsetintheY-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]
publicfloatm_YDamping
CopyC# JavaScript
![Page 920: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/920.jpg)
Cinemachine
![Page 921: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/921.jpg)
CinemachineFramingTransposerm_ZDampingField
HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]
publicfloatm_ZDamping
CopyC# JavaScript
![Page 922: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/922.jpg)
Cinemachine
![Page 923: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/923.jpg)
CinemachineFramingTransposerOnGUICallbackField
UsedbytheInspectorEditortodisplayon-screenguides.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Action
SeeAlsoReferenceCinemachineFramingTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[NoSaveDuringPlayAttribute]
[HideInInspector]
publicActionOnGUICallback
CopyC# JavaScript
![Page 924: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/924.jpg)
Cinemachine
![Page 925: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/925.jpg)
CinemachineFramingTransposerAdjustmentModeEnumeration
Howtoadjustthecameratogetthedesiredframing
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members Membername Value Description
ZoomOnly 0 Donotmovethecamera,onlyadjusttheFOV.
DollyOnly 1 Justmovethecamera,don'tchangetheFOV.
DollyThenZoom 2 Movethecameraasmuchaspermittedbytheranges,thenadjusttheFOVifnecessarytomaketheshot.
publicenumAdjustmentMode
CopyC# JavaScript
![Page 926: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/926.jpg)
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 927: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/927.jpg)
Cinemachine
![Page 928: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/928.jpg)
CinemachineFramingTransposerFramingModeEnumeration
Whatscreendimensionstoconsiderwhenframing
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members Membername Value Description
Horizontal 0 Consideronlythehorizontaldimension.Verticalframingisignored.
Vertical 1 Consideronlytheverticaldimension.Horizontalframingisignored.
HorizontalAndVertical 2 Thelargerofthe
[DocumentationSortingAttribute(4.01f,DocumentationSortingAttribute
publicenumFramingMode
CopyC# JavaScript
![Page 929: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/929.jpg)
horizontalandverticaldimensionswilldominate,togetthebestfit.
None 3 Don'tdoanyframingadjustment
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 930: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/930.jpg)
Cinemachine
![Page 931: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/931.jpg)
CinemachineFreeLookClass
ACinemachineCameragearedtowardsa3rdpersoncameraexperience.Thecameraorbitsarounditssubjectwiththreeseparatecamerarigsdefiningringsaroundthetarget.Eachrighasitsownradius,heightoffset,composer,andlenssettings.Dependingonthecamera'spositionalongthesplineconnectingthesethreerigs,thesesettingsareinterpolatedtogivethefinalcamerapositionandstate.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineFreeLook
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineFreeLooktypeexposesthefollowingmembers.
Constructors
[DocumentationSortingAttribute(11f,DocumentationSortingAttribute
[ExecuteInEditMode]
[DisallowMultipleComponent]
[AddComponentMenu("Cinemachine/CinemachineFreeLook")]
publicclassCinemachineFreeLook:CinemachineVirtualCameraBase
CopyC# JavaScript
![Page 932: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/932.jpg)
Name Description
CinemachineFreeLook
Top
Properties Name Description
Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo(InheritedfromCinemachineVirtualCameraBase
Follow GetthecurrentFollowtarget.Returnsparent'sFollowifparentisnon-nullandnospecificFollowdefinedforthiscamera(OverridesCinemachineVirtualCameraBase
LiveChildOrSelf Returnstherigwiththegreatestweight(OverridesCinemachineVirtualCameraBase
LookAt GetthecurrentLookAttarget.LookAtifparentisnon-nullandnospecificLookAtdefinedforthiscamera(OverridesCinemachineVirtualCameraBase
Name GetthenameoftheVirtualCamera.implementationreturnstheownerGameObject'sname.(InheritedfromCinemachineVirtualCameraBase
ParentCamera Supportformeta-virtual-cameras.situationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.Thismethodgets
![Page 933: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/933.jpg)
theVirtualCameraowner,ifany.areimplementedasTransformchildrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase
PreviousStateIsValid SetthistoforcethenextupdatetoignoredeltaTimeandresetitself(InheritedfromCinemachineVirtualCameraBase
Priority GetthePriorityofthevirtualcamera.determinesitsplacementintheCinemachineCore'squeueofeligibleshots.(InheritedfromCinemachineVirtualCameraBase
RigNames Namesofthe3childrigs
State Thecacmerastate,whichwillbeablendofthechildrigstates(OverridesCinemachineVirtualCameraBase
ValidatingStreamVersion Versionthatwaslaststreamed,forupgradinglegacy(InheritedfromCinemachineVirtualCameraBase
VirtualCameraGameObject TheGameObjectowneroftheVirtualCamerabehaviour.(InheritedfromCinemachineVirtualCameraBase
Top
Methods Name Description
AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.pipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
![Page 934: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/934.jpg)
GetLocalPositionForCameraFromInput Returnsthelocalpositionofthecameraalongthesplineusedtoconnectthecurrentheadingofthe
GetRig Getachildrig
InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforall(InheritedfromCinemachineVirtualCameraBase
IsLiveChild Checkwhetherthevcamalivechildofthiscamera.(OverridesCinemachineVirtualCameraBase
MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereisLivecameraifitsharesthehighestpriorityinthequeuewithitspeers.themostrecentonegoestothetopoftheprioritysubqueue.anditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.(InheritedfromCinemachineVirtualCameraBase
OnDestroy Makessurethatthechildrigsgetdestroyedinanundo-firndlymanner.(OverridesCinemachineVirtualCameraBase
OnDisable Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase
OnEnable Updatesthechildrigcache(OverridesCinemachineVirtualCameraBase
OnTransformParentChanged Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase
OnTransitionFromCamera IfwearetransitioningfromanotherFreeLook,grabtheaxisvaluesfromit.(OverridesCinemachineVirtualCameraBase
OnValidate Enforceboundsforfields,whenchangedininspector.(OverridesCinemachineVirtualCameraBase
PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,areupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledLateUpdate.Thisimplementationpushestheaxisvaluestotherigs.(OverridesCinemachineVirtualCameraBase
![Page 935: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/935.jpg)
RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.(OverridesCinemachineVirtualCameraBase
ResolveFollow Returnsthisvcam'sFollowtarget,orifthatisnull,willretrun(InheritedfromCinemachineVirtualCameraBase
ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretrun(InheritedfromCinemachineVirtualCameraBase
Start Baseclassimplementationdoesnothing.(InheritedfromCinemachineVirtualCameraBase
Update Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase
UpdateCameraState CalledbyCinemachineCoreatdesignatedupdatetimeupdated,andablendcalculated,dependingonthevalueoftheYaxis.(OverridesCinemachineVirtualCameraBase
Top
Fields Name Description
CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.(InheritedfromCinemachineVirtualCameraBase
CreateRigOverride Overridecomponentpipelinecreation.ThisneedstobedonebytheeditortosupportUndo.TheoverridemustdoexactlythesamethingastheCreatePipelinemethodinthisclass.
![Page 936: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/936.jpg)
DestroyRigOverride Overridecomponentpipelinedestruction.ThisneedstobedonebytheeditortosupportUndo.
m_BindingMode Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget
m_CommonLens Ifenabled,thislenssettingwillapplytoallthreechildrigs,otherwisethechildriglenssettingswillbeused
m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_Follow Objectforthecamerachildrenwantstomovewith(thebodytarget)
m_Heading ThedefinitionofForward.Camerawillfollowbehind
m_Lens SpecifiesthelenspropertiesofthisVirtualCamera.ThisgenerallymirrorstheUnityCamera'slenssettings,andwillbeusedtodrivetheUnitycamerawhenthevcamisactive
m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
![Page 937: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/937.jpg)
m_LookAt Objectforthecamerachildrentolookat(theaimtarget)
m_Orbits Theradiusandheightofthethreeorbitingrigs
m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase
m_RecenterToTargetHeading ControlshowautomaticrecenteringoftheXaxisisaccomplished
m_SplineCurvature
m_XAxis TheHorizontalaxis.Valueis0..359.Thisispassedontotherigs'OrbitalTransposercomponent
m_YAxis TheVerticalaxis.Valueis0..1.Chooseshowtoblendthechildrigs
OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
![Page 938: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/938.jpg)
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 939: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/939.jpg)
Cinemachine
![Page 940: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/940.jpg)
CinemachineFreeLookConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineFreeLook.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineFreeLook()
CopyC# JavaScript
![Page 941: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/941.jpg)
Cinemachine
![Page 942: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/942.jpg)
CinemachineFreeLookProperties
TheCinemachineFreeLooktypeexposesthefollowingmembers.
Properties Name Description
Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo(InheritedfromCinemachineVirtualCameraBase
Follow GetthecurrentFollowtarget.Returnsparent'sFollowifparentisnon-nullandnospecificFollowdefinedforthiscamera(OverridesCinemachineVirtualCameraBase
LiveChildOrSelf Returnstherigwiththegreatestweight(OverridesCinemachineVirtualCameraBase
LookAt GetthecurrentLookAttarget.LookAtifparentisnon-nullandnospecificLookAtdefinedforthiscamera(OverridesCinemachineVirtualCameraBase
Name GetthenameoftheVirtualCamera.implementationreturnstheownerGameObject'sname.(InheritedfromCinemachineVirtualCameraBase
ParentCamera Supportformeta-virtual-cameras.
![Page 943: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/943.jpg)
situationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.areimplementedasTransformchildrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase
PreviousStateIsValid SetthistoforcethenextupdatetoignoredeltaTimeandresetitself(InheritedfromCinemachineVirtualCameraBase
Priority GetthePriorityofthevirtualcamera.determinesitsplacementintheCinemachineCore'squeueofeligibleshots.(InheritedfromCinemachineVirtualCameraBase
RigNames Namesofthe3childrigs
State Thecacmerastate,whichwillbeablendofthechildrigstates(OverridesCinemachineVirtualCameraBase
ValidatingStreamVersion Versionthatwaslaststreamed,forupgradinglegacy(InheritedfromCinemachineVirtualCameraBase
VirtualCameraGameObject TheGameObjectowneroftheVirtualCamerabehaviour.(InheritedfromCinemachineVirtualCameraBase
Top
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
![Page 944: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/944.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 945: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/945.jpg)
Cinemachine
![Page 946: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/946.jpg)
CinemachineFreeLookFollowProperty
GetthecurrentFollowtarget.Returnsparent'sFollowifparentisnon-nullandnospecificFollowdefinedforthiscamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:TransformImplementsICinemachineCameraFollow
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideTransformFollow{get;set;}
CopyC# JavaScript
![Page 947: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/947.jpg)
Cinemachine
![Page 948: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/948.jpg)
CinemachineFreeLookLiveChildOrSelfProperty
Returnstherigwiththegreatestweight
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ICinemachineCameraImplementsICinemachineCameraLiveChildOrSelf
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideICinemachineCameraLiveChildOrSelf{
CopyC# JavaScript
![Page 949: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/949.jpg)
Cinemachine
![Page 950: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/950.jpg)
CinemachineFreeLookLookAtProperty
GetthecurrentLookAttarget.Returnsparent'sLookAtifparentisnon-nullandnospecificLookAtdefinedforthiscamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:TransformImplementsICinemachineCameraLookAt
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideTransformLookAt{get;set;}
CopyC# JavaScript
![Page 951: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/951.jpg)
Cinemachine
![Page 952: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/952.jpg)
CinemachineFreeLookRigNamesProperty
Namesofthe3childrigs
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:String
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticstring[]RigNames{get;}
CopyC# JavaScript
![Page 953: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/953.jpg)
Cinemachine
![Page 954: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/954.jpg)
CinemachineFreeLookStateProperty
Thecacmerastate,whichwillbeablendofthechildrigstates
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CameraStateImplementsICinemachineCameraState
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideCameraStateState{get;}
CopyC# JavaScript
![Page 955: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/955.jpg)
Cinemachine
![Page 956: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/956.jpg)
CinemachineFreeLookMethods
TheCinemachineFreeLooktypeexposesthefollowingmembers.
Methods Name Description
AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.pipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
GetLocalPositionForCameraFromInput Returnsthelocalpositionofthecameraalongthesplineusedtoconnectthecurrentheadingofthe
GetRig Getachildrig
InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforall(InheritedfromCinemachineVirtualCameraBase
IsLiveChild Checkwhetherthevcamalivechildofthiscamera.(OverridesCinemachineVirtualCameraBase
MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereisLivecameraifitsharesthehighestpriorityinthequeuewithitspeers.themostrecentonegoestothetopoftheprioritysubqueue.anditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.(InheritedfromCinemachineVirtualCameraBase
OnDestroy Makessurethatthechildrigsgetdestroyedinanundo-firndlymanner.(OverridesCinemachineVirtualCameraBase
OnDisable Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase
OnEnable Updatesthechildrigcache
![Page 957: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/957.jpg)
(OverridesCinemachineVirtualCameraBase
OnTransformParentChanged Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase
OnTransitionFromCamera IfwearetransitioningfromanotherFreeLook,grabtheaxisvaluesfromit.(OverridesCinemachineVirtualCameraBase
OnValidate Enforceboundsforfields,whenchangedininspector.(OverridesCinemachineVirtualCameraBase
PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,areupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledLateUpdate.Thisimplementationpushestheaxisvaluestotherigs.(OverridesCinemachineVirtualCameraBase
RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.(OverridesCinemachineVirtualCameraBase
ResolveFollow Returnsthisvcam'sFollowtarget,orifthatisnull,willretrun(InheritedfromCinemachineVirtualCameraBase
ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretrun(InheritedfromCinemachineVirtualCameraBase
Start Baseclassimplementationdoesnothing.(InheritedfromCinemachineVirtualCameraBase
Update Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase
UpdateCameraState CalledbyCinemachineCoreatdesignatedupdatetimeupdated,andablendcalculated,dependingonthevalueoftheYaxis.(OverridesCinemachineVirtualCameraBase
Top
SeeAlso
![Page 958: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/958.jpg)
ReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 959: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/959.jpg)
Cinemachine
![Page 960: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/960.jpg)
CinemachineFreeLookGetLocalPositionForCameraFromInputMethod
Returnsthelocalpositionofthecameraalongthesplineusedtoconnectthethreecamerarigs.Doesnottakeintoaccountthecurrentheadingofthecamera(oritstarget)
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
tType:SystemSingleThet-valueforthecameraonitsspline.Internallyclampedtothevalue[0,1]
ReturnValueType:Vector3Thelocaloffset(back+up)ofthecameraWRTitstargetbasedonthesuppliedt-value
SeeAlsoReference
publicVector3GetLocalPositionForCameraFromInput(
floatt
)
CopyC# JavaScript
![Page 961: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/961.jpg)
CinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 962: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/962.jpg)
Cinemachine
![Page 963: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/963.jpg)
CinemachineFreeLookGetRigMethod
Getachildrig
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
iType:SystemInt32Rigindex.Canbe0,1,or2
ReturnValueType:CinemachineVirtualCameraTherig,ornullifindexisbad.
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineVirtualCameraGetRig(
inti
)
CopyC# JavaScript
![Page 964: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/964.jpg)
![Page 965: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/965.jpg)
Cinemachine
![Page 966: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/966.jpg)
CinemachineFreeLookIsLiveChildMethod
Checkwhetherthevcamalivechildofthiscamera.Returnstrueifthechildiscurrentlycontributingactivelytothecamerastate.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineICinemachineCameraTheVirtualCameratocheck
ReturnValueType:BooleanTrueifthevcamiscurrentlyactivelyinfluencingthestateofthisvcamImplementsICinemachineCameraIsLiveChild(ICinemachineCamera)
SeeAlsoReferenceCinemachineFreeLookClass
publicoverrideboolIsLiveChild(
ICinemachineCameravcam
)
CopyC# JavaScript
![Page 967: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/967.jpg)
CinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 968: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/968.jpg)
Cinemachine
![Page 969: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/969.jpg)
CinemachineFreeLookOnDestroyMethod
Makessurethatthechildrigsgetdestroyedinanundo-firndlymanner.Invalidatestherigcache.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedoverridevoidOnDestroy()
CopyC# JavaScript
![Page 970: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/970.jpg)
Cinemachine
![Page 971: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/971.jpg)
CinemachineFreeLookOnEnableMethod
Updatesthechildrigcache
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedoverridevoidOnEnable()
CopyC# JavaScript
![Page 972: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/972.jpg)
Cinemachine
![Page 973: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/973.jpg)
CinemachineFreeLookOnTransitionFromCameraMethod
IfwearetransitioningfromanotherFreeLook,grabtheaxisvaluesfromit.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
fromCamType:CinemachineICinemachineCameraThecamerabeingdeactivated.Maybenull.
ImplementsICinemachineCameraOnTransitionFromCamera(ICinemachineCamera)
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridevoidOnTransitionFromCamera(
ICinemachineCamerafromCam
)
CopyC# JavaScript
![Page 974: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/974.jpg)
![Page 975: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/975.jpg)
Cinemachine
![Page 976: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/976.jpg)
CinemachineFreeLookOnValidateMethod
Enforceboundsforfields,whenchangedininspector.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedoverridevoidOnValidate()
CopyC# JavaScript
![Page 977: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/977.jpg)
Cinemachine
![Page 978: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/978.jpg)
CinemachineFreeLookPreUpdateChildCamerasMethod
Thisiscalledpriortotheupdatingofthevcam'schildcameras,inordertoallowtheparenttoprepareitschildren.IfthechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledpriortoeveryFixedUpdate,butmightbecalledonLateUpdate.Thisimplementationpushestheaxisvaluestotherigs.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
worldUpType:Vector3DefaultworldUp,setbytheCinemachineBrain
deltaTimeType:SystemSingleDeltatimefortime-basedeffects(ignoreiflessthan0)
ImplementsICinemachineCameraPreUpdateChildCameras(Vector3,Single)
SeeAlso
publicoverridevoidPreUpdateChildCameras(
Vector3worldUp,
floatdeltaTime
)
CopyC# JavaScript
![Page 979: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/979.jpg)
ReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 980: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/980.jpg)
Cinemachine
![Page 981: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/981.jpg)
CinemachineFreeLookRemovePostPipelineStageHookMethod
RemoveaPipelinestagehookcallback.Makesureitisremovedfromallthechildren.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
dType:CinemachineCinemachineVirtualCameraBaseOnPostPipelineStageDelegateThedelegatetoremove.
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridevoidRemovePostPipelineStageHook(
CinemachineVirtualCameraBaseOnPostPipelineStageDelegate
)
CopyC# JavaScript
![Page 982: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/982.jpg)
Cinemachine
![Page 983: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/983.jpg)
CinemachineFreeLookUpdateCameraStateMethod
CalledbyCinemachineCoreatdesignatedupdatetimesothevcamcanpositionitselfandtrackitstargets.All3childrigsareupdated,andablendcalculated,dependingonthevalueoftheYaxis.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
worldUpType:Vector3DefaultworldUp,setbytheCinemachineBrain
deltaTimeType:SystemSingleDeltatimefortime-basedeffects(ignoreiflessthan0)
ImplementsICinemachineCameraUpdateCameraState(Vector3,Single)
SeeAlsoReference
publicoverridevoidUpdateCameraState(
Vector3worldUp,
floatdeltaTime
)
CopyC# JavaScript
![Page 984: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/984.jpg)
CinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 985: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/985.jpg)
Cinemachine
![Page 986: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/986.jpg)
CinemachineFreeLookFields
TheCinemachineFreeLooktypeexposesthefollowingmembers.
Fields Name Description
CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.(InheritedfromCinemachineVirtualCameraBase
CreateRigOverride Overridecomponentpipelinecreation.ThisneedstobedonebytheeditortosupportUndo.TheoverridemustdoexactlythesamethingastheCreatePipelinemethodinthisclass.
DestroyRigOverride Overridecomponentpipelinedestruction.ThisneedstobedonebytheeditortosupportUndo.
m_BindingMode Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget
m_CommonLens Ifenabled,thislenssettingwillapplytoallthreechildrigs,otherwisethechildriglenssettingswillbeused
![Page 987: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/987.jpg)
m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_Follow Objectforthecamerachildrenwantstomovewith(thebodytarget)
m_Heading ThedefinitionofForward.Camerawillfollowbehind
m_Lens SpecifiesthelenspropertiesofthisVirtualCamera.ThisgenerallymirrorstheUnityCamera'slenssettings,andwillbeusedtodrivetheUnitycamerawhenthevcamisactive
m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_LookAt Objectforthecamerachildrentolookat(theaimtarget)
m_Orbits Theradiusandheightofthethreeorbitingrigs
m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase
![Page 988: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/988.jpg)
m_RecenterToTargetHeading ControlshowautomaticrecenteringoftheXaxisisaccomplished
m_SplineCurvature
m_XAxis TheHorizontalaxis.Valueis0..359.Thisispassedontotherigs'OrbitalTransposercomponent
m_YAxis TheVerticalaxis.Valueis0..1.Chooseshowtoblendthechildrigs
OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
Top
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 989: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/989.jpg)
Cinemachine
![Page 990: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/990.jpg)
CinemachineFreeLookCreateRigOverrideField
Overridecomponentpipelinecreation.ThisneedstobedonebytheeditortosupportUndo.TheoverridemustdoexactlythesamethingastheCreatePipelinemethodinthisclass.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineFreeLookCreateRigDelegate
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticCinemachineFreeLookCreateRigDelegate
CopyC# JavaScript
![Page 991: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/991.jpg)
Cinemachine
![Page 992: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/992.jpg)
CinemachineFreeLookDestroyRigOverrideField
Overridecomponentpipelinedestruction.ThisneedstobedonebytheeditortosupportUndo.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineFreeLookDestroyRigDelegate
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticCinemachineFreeLookDestroyRigDelegate
CopyC# JavaScript
![Page 993: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/993.jpg)
Cinemachine
![Page 994: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/994.jpg)
CinemachineFreeLookm_BindingModeField
Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineTransposerBindingMode
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[HeaderAttribute("Orbits")]
[TooltipAttribute("Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget.Thisisalsousedtosetthecamera'sUpvector,whichwillbemaintainedwhenaimingthecamera.")]
publicCinemachineTransposerBindingModem_BindingMode
CopyC# JavaScript
![Page 995: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/995.jpg)
Cinemachine
![Page 996: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/996.jpg)
CinemachineFreeLookm_CommonLensField
Ifenabled,thislenssettingwillapplytoallthreechildrigs,otherwisethechildriglenssettingswillbeused
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Ifenabled,thislenssettingwillapplytoallthreechildrigs,otherwisethechildriglenssettingswillbeused")]
[FormerlySerializedAsAttribute("m_UseCommonLensSetting")]
publicboolm_CommonLens
CopyC# JavaScript
![Page 997: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/997.jpg)
Cinemachine
![Page 998: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/998.jpg)
CinemachineFreeLookm_FollowField
Objectforthecamerachildrenwantstomovewith(thebodytarget)
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Transform
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Objectforthecamerachildrenwantstomovewith(thebodytarget).")]
[NoSaveDuringPlayAttribute]
publicTransformm_Follow
CopyC# JavaScript
![Page 999: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/999.jpg)
Cinemachine
![Page 1000: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1000.jpg)
CinemachineFreeLookm_HeadingField
ThedefinitionofForward.Camerawillfollowbehind
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineOrbitalTransposerHeading
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("ThedefinitionofForward.Camerawillfollowbehind.")]
publicCinemachineOrbitalTransposerHeadingm_Heading
CopyC# JavaScript
![Page 1001: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1001.jpg)
Cinemachine
![Page 1002: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1002.jpg)
CinemachineFreeLookm_LensField
SpecifiesthelenspropertiesofthisVirtualCamera.ThisgenerallymirrorstheUnityCamera'slenssettings,andwillbeusedtodrivetheUnitycamerawhenthevcamisactive
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:LensSettings
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[FormerlySerializedAsAttribute("m_LensAttributes")]
[TooltipAttribute("SpecifiesthelenspropertiesofthisVirtualCamera.ThisgenerallymirrorstheUnityCamera'slenssettings,andwillbeusedtodrivetheUnitycamerawhenthevcamisactive")]
[LensSettingsPropertyAttribute]
publicLensSettingsm_Lens
CopyC# JavaScript
![Page 1003: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1003.jpg)
Cinemachine
![Page 1004: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1004.jpg)
CinemachineFreeLookm_LookAtField
Objectforthecamerachildrentolookat(theaimtarget)
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Transform
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Objectforthecamerachildrentolookat(theaimtarget).")]
[NoSaveDuringPlayAttribute]
publicTransformm_LookAt
CopyC# JavaScript
![Page 1005: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1005.jpg)
Cinemachine
![Page 1006: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1006.jpg)
CinemachineFreeLookm_OrbitsField
Theradiusandheightofthethreeorbitingrigs
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineFreeLookOrbit
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theradiusandheightofthethreeorbitingrigs.")]
publicCinemachineFreeLookOrbit[]m_Orbits
CopyC# JavaScript
![Page 1007: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1007.jpg)
Cinemachine
![Page 1008: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1008.jpg)
CinemachineFreeLookm_RecenterToTargetHeadingField
ControlshowautomaticrecenteringoftheXaxisisaccomplished
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineOrbitalTransposerRecentering
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("ControlshowautomaticrecenteringoftheXaxisisaccomplished")]
publicCinemachineOrbitalTransposerRecenteringm_RecenterToTargetHeading
CopyC# JavaScript
![Page 1009: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1009.jpg)
Cinemachine
![Page 1010: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1010.jpg)
CinemachineFreeLookm_SplineCurvatureField
[Missing<summary>documentationfor"F:Cinemachine.CinemachineFreeLook.m_SplineCurvature"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Controlshowtautisthelinethatconnectstherigs'orbits,whichdeterminesfinalplacementontheYaxis")]
[RangeAttribute(0f,1f)]
[FormerlySerializedAsAttribute("m_SplineTension")]
publicfloatm_SplineCurvature
CopyC# JavaScript
![Page 1011: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1011.jpg)
Cinemachine
![Page 1012: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1012.jpg)
CinemachineFreeLookm_XAxisField
TheHorizontalaxis.Valueis0..359.Thisispassedontotherigs'OrbitalTransposercomponent
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:AxisState
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("TheHorizontalaxis.Valueis0..359.Thisispassedontotherigs'OrbitalTransposercomponent")]
publicAxisStatem_XAxis
CopyC# JavaScript
![Page 1013: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1013.jpg)
Cinemachine
![Page 1014: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1014.jpg)
CinemachineFreeLookm_YAxisField
TheVerticalaxis.Valueis0..1.Chooseshowtoblendthechildrigs
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:AxisState
SeeAlsoReferenceCinemachineFreeLookClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[HeaderAttribute("AxisControl")]
[TooltipAttribute("TheVerticalaxis.Valueis0..1.Chooseshowtoblendthechildrigs")]
publicAxisStatem_YAxis
CopyC# JavaScript
![Page 1015: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1015.jpg)
Cinemachine
![Page 1016: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1016.jpg)
CinemachineFreeLookCreateRigDelegateDelegate
Overridecomponentpipelinecreation.ThisneedstobedonebytheeditortosupportUndo.TheoverridemustdoexactlythesamethingastheCreatePipelinemethodinthisclass.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineCinemachineFreeLook
nameType:SystemString
copyFromType:CinemachineCinemachineVirtualCamera
ReturnValueType:CinemachineVirtualCamera
SeeAlso
publicdelegateCinemachineVirtualCameraCreateRigDelegate
CinemachineFreeLookvcam,
stringname,
CinemachineVirtualCameracopyFrom
)
CopyC# JavaScript
![Page 1017: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1017.jpg)
ReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1018: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1018.jpg)
Cinemachine
![Page 1019: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1019.jpg)
CinemachineFreeLookDestroyRigDelegateDelegate
Overridecomponentpipelinedestruction.ThisneedstobedonebytheeditortosupportUndo.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
rigType:GameObject
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicdelegatevoidDestroyRigDelegate(
GameObjectrig
)
CopyC# JavaScript
![Page 1020: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1020.jpg)
Cinemachine
![Page 1021: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1021.jpg)
CinemachineFreeLookOrbitStructure
DefinestheheightandradiusoftheRigorbit
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineFreeLookOrbittypeexposesthefollowingmembers.
Constructors Name Description
CinemachineFreeLookOrbit Constructorwithspecificvalues
Top
Fields Name Description
m_Height Heightrelativetotarget
m_Radius Radiusoforbit
[SerializableAttribute]
publicstructOrbit
CopyC# JavaScript
![Page 1022: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1022.jpg)
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1023: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1023.jpg)
Cinemachine
![Page 1024: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1024.jpg)
CinemachineFreeLookOrbitConstructor
Constructorwithspecificvalues
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 1025: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1025.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1026: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1026.jpg)
Cinemachine
![Page 1027: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1027.jpg)
OrbitFields
TheCinemachineFreeLookOrbittypeexposesthefollowingmembers.
Fields Name Description
m_Height Heightrelativetotarget
m_Radius Radiusoforbit
Top
SeeAlsoReferenceCinemachineFreeLookOrbitStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1028: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1028.jpg)
Cinemachine
![Page 1029: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1029.jpg)
CinemachineFreeLookOrbitm_HeightField
Heightrelativetotarget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFreeLookOrbitStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicfloatm_Height
CopyC# JavaScript
![Page 1030: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1030.jpg)
Cinemachine
![Page 1031: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1031.jpg)
CinemachineFreeLookOrbitm_RadiusField
Radiusoforbit
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineFreeLookOrbitStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicfloatm_Radius
CopyC# JavaScript
![Page 1032: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1032.jpg)
Cinemachine
![Page 1033: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1033.jpg)
CinemachineGroupComposerClass
ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.Itsjobistoaimthecameraatatargetobject,withconfigurableoffsets,damping,andcompositionrules.Inaddition,ifthetargetisaCinemachineTargetGroup,thebehaviourwilladjusttheFOVandthecameradistancetoensurethattheentiregroupoftargetsisframedproperly.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineComposerCinemachineCinemachineGroupComposer
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
[DocumentationSortingAttribute(4f,DocumentationSortingAttribute
[ExecuteInEditMode]
[AddComponentMenu("")]
[RequireComponent(typeof(CinemachinePipeline))]
[SaveDuringPlayAttribute]
publicclassCinemachineGroupComposer:CinemachineComposer
CopyC# JavaScript
![Page 1034: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1034.jpg)
TheCinemachineGroupComposertypeexposesthefollowingmembers.
Constructors Name Description
CinemachineGroupComposer
Top
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
HardGuideRect InternalAPIfortheinspectoreditor(InheritedfromCinemachineComposer.)
IsValid TrueifcomponentisenabledandhasaLookAtdefined(InheritedfromCinemachineComposer.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
m_LastBounds Foreditorvisulaizationofthecalculatedboundingboxofthegroup
![Page 1035: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1035.jpg)
m_lastBoundsMatrix Foreditorvisualizationofthecalculatedboundingboxofthegroup
SoftGuideRect InternalAPIfortheinspectoreditor(InheritedfromCinemachineComposer.)
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage(InheritedfromCinemachineComposer.)
TargetGroup GetLookAttargetasCinemachineTargetGroup,ornulliftargetisnotagroup
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)
Top
Methods Name Description
GetTrackedPoint Applythetargetoffsetstothetargetlocation.(InheritedfromCinemachineComposer
![Page 1036: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1036.jpg)
MutateCameraState Appliesthecomposerrulesandorientsthecameraaccordingly(OverridesCinemachineComposerMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.Baseclassimplementationdoesnothing.(InheritedfromCinemachineComponentBase
Top
Fields Name Description
m_AdjustmentMode Howtoadjustthecameratogetthedesiredframing
m_BiasX Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone(InheritedfromCinemachineComposer.)
m_BiasY Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone(InheritedfromCinemachineComposer.)
m_DeadZoneHeight Camerawillnotrotateverticallyifthetargetiswithinthisrangeoftheposition(Inheritedfrom
![Page 1037: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1037.jpg)
CinemachineComposer.)
m_DeadZoneWidth Camerawillnotrotatehorizontallyifthetargetiswithinthisrangeoftheposition(InheritedfromCinemachineComposer.)
m_FrameDamping Howaggressivelythecameratriestoframethegroup.Smallnumbersaremoreresponsive
m_FramingMode Whatscreendimensionstoconsiderwhenframing
m_GroupFramingSize Howmuchofthescreentofillwiththeboundingboxofthetargets.
m_HorizontalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-horizontaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.
![Page 1038: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1038.jpg)
(InheritedfromCinemachineComposer.)
m_LookaheadSmoothing Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag(InheritedfromCinemachineComposer.)
m_LookaheadTime Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.(InheritedfromCinemachineComposer.)
m_MaxDollyIn Howmuchclosertothetargetcanthecamerago?
![Page 1039: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1039.jpg)
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.Thecamerawillrotatetothepositionthetrackedobjecthere(InheritedfromCinemachineComposer.)
m_ScreenY Verticalscreenpositionfortarget,Thecamerawillrotatetotoposition
![Page 1040: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1040.jpg)
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-
![Page 1041: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1041.jpg)
verticaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.(InheritedfromCinemachineComposer.)
OnGUICallback UsedbytheInspectorEditortodisplayon-screenguides.(InheritedfromCinemachineComposer.)
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1042: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1042.jpg)
Cinemachine
![Page 1043: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1043.jpg)
CinemachineGroupComposerConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineGroupComposer.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineGroupComposer()
CopyC# JavaScript
![Page 1044: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1044.jpg)
Cinemachine
![Page 1045: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1045.jpg)
CinemachineGroupComposerProperties
TheCinemachineGroupComposertypeexposesthefollowingmembers.
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
HardGuideRect InternalAPIfortheinspectoreditor(InheritedfromCinemachineComposer.)
IsValid TrueifcomponentisenabledandhasaLookAtdefined(InheritedfromCinemachineComposer.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
m_LastBounds Foreditorvisulaizationofthecalculatedboundingboxofthegroup
m_lastBoundsMatrix Foreditorvisualizationofthe
![Page 1046: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1046.jpg)
calculatedboundingboxofthegroup
SoftGuideRect InternalAPIfortheinspectoreditor(InheritedfromCinemachineComposer.)
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage(InheritedfromCinemachineComposer.)
TargetGroup GetLookAttargetasCinemachineTargetGroup,ornulliftargetisnotagroup
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)
Top
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1047: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1047.jpg)
![Page 1048: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1048.jpg)
Cinemachine
![Page 1049: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1049.jpg)
CinemachineGroupComposerm_LastBoundsProperty
Foreditorvisulaizationofthecalculatedboundingboxofthegroup
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Bounds
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicBoundsm_LastBounds{get;}
CopyC# JavaScript
![Page 1050: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1050.jpg)
Cinemachine
![Page 1051: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1051.jpg)
CinemachineGroupComposerm_lastBoundsMatrixProperty
Foreditorvisualizationofthecalculatedboundingboxofthegroup
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Matrix4x4
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicMatrix4x4m_lastBoundsMatrix{get;}
CopyC# JavaScript
![Page 1052: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1052.jpg)
Cinemachine
![Page 1053: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1053.jpg)
CinemachineGroupComposerTargetGroupProperty
GetLookAttargetasCinemachineTargetGroup,ornulliftargetisnotagroup
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineTargetGroup
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineTargetGroupTargetGroup{get;}
CopyC# JavaScript
![Page 1054: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1054.jpg)
Cinemachine
![Page 1055: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1055.jpg)
CinemachineGroupComposerMethods
TheCinemachineGroupComposertypeexposesthefollowingmembers.
Methods Name Description
GetTrackedPoint Applythetargetoffsetstothetargetlocation.(InheritedfromCinemachineComposer
MutateCameraState Appliesthecomposerrulesandorientsthecameraaccordingly(OverridesCinemachineComposerMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.Baseclassimplementationdoesnothing.(InheritedfromCinemachineComponentBase
Top
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1056: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1056.jpg)
Cinemachine
![Page 1057: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1057.jpg)
CinemachineGroupComposerMutateCameraStateMethod
Appliesthecomposerrulesandorientsthecameraaccordingly
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
curStateType:CinemachineCameraState[Missing<paramname="curState"/>documentationfor"M:Cinemachine.CinemachineGroupComposer.MutateCameraState(Cinemachine.CameraState@,System.Single)"]
deltaTimeType:SystemSingleUsedforcalculatingdamping.Iflessthanzero,thentargetwillsnaptothecenterofthedeadzone.
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
publicoverridevoidMutateCameraState(
refCameraStatecurState,
floatdeltaTime
)
CopyC# JavaScript
![Page 1058: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1058.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1059: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1059.jpg)
Cinemachine
![Page 1060: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1060.jpg)
CinemachineGroupComposerFields
TheCinemachineGroupComposertypeexposesthefollowingmembers.
Fields Name Description
m_AdjustmentMode Howtoadjustthecameratogetthedesiredframing
m_BiasX Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone(InheritedfromCinemachineComposer.)
m_BiasY Anon-zerobiaswillmovethetargtpositionawayfromthecenterofthesoftzone(InheritedfromCinemachineComposer.)
m_DeadZoneHeight Camerawillnotrotateverticallyifthetargetiswithinthisrangeoftheposition(InheritedfromCinemachineComposer.)
![Page 1061: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1061.jpg)
m_DeadZoneWidth Camerawillnotrotatehorizontallyifthetargetiswithinthisrangeoftheposition(InheritedfromCinemachineComposer.)
m_FrameDamping Howaggressivelythecameratriestoframethegroup.Smallnumbersaremoreresponsive
m_FramingMode Whatscreendimensionstoconsiderwhenframing
m_GroupFramingSize Howmuchofthescreentofillwiththeboundingboxofthetargets.
m_HorizontalDamping Howaggressivelythecameratriestofollowthetargetinthescreen-horizontaldirection.Smallnumbersaremoreresponsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.(InheritedfromCinemachineComposer.)
![Page 1062: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1062.jpg)
m_LookaheadSmoothing Controlsthesmoothnessofthelookaheadalgorithm.Largervaluessmoothoutjitterypredictionsandalsoincreasepredictionlag(InheritedfromCinemachineComposer.)
m_LookaheadTime Thissettingwillinstructthecomposertoadjustitstargetoffsetbasedonthemotionofthetarget.Thecomposerwilllookatapointwhereitestimatesthetargetwillbethismanysecondsintothefuture.Notethatthissettingissensitivetonoisyanimation,andcanamplifythenoise,resultinginundesirablecamerajitter.Ifthecamerajittersunacceptablywhenthetargetisinmotion,turndownthissetting,oranimatethetargetmoresmoothly.(InheritedfromCinemachineComposer.)
m_MaxDollyIn Howmuchclosertothetargetcanthecamerago?
m_MaxDollyOut Howmuchfartherfromthetargetcanthe
![Page 1063: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1063.jpg)
camerago?
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.Thecamerawillrotatetothepositionthetrackedobjecthere(InheritedfromCinemachineComposer.)
m_ScreenY Verticalscreenpositionfortarget,Thecamerawillrotatetotopositionthetrackedobjecthere(Inheritedfrom
![Page 1064: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1064.jpg)
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
![Page 1065: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1065.jpg)
responsive,rapidlyorientingthecameratokeepthetargetinthedeadzone.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentverticalandhorizontalsettingscanyieldawiderangeofcamerabehaviors.(InheritedfromCinemachineComposer.)
OnGUICallback UsedbytheInspectorEditortodisplayon-screenguides.(InheritedfromCinemachineComposer.)
Top
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1066: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1066.jpg)
Cinemachine
![Page 1067: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1067.jpg)
CinemachineGroupComposerm_AdjustmentModeField
Howtoadjustthecameratogetthedesiredframing
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineGroupComposerAdjustmentMode
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Howtoadjustthecameratogetthedesiredframing.Youcanzoom,dollyin/out,ordoboth.")]
publicCinemachineGroupComposerAdjustmentModem_AdjustmentMode
CopyC# JavaScript
![Page 1068: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1068.jpg)
Cinemachine
![Page 1069: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1069.jpg)
CinemachineGroupComposerm_FrameDampingField
Howaggressivelythecameratriestoframethegroup.Smallnumbersaremoreresponsive
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("Howaggressivelythecameratriestoframethegroup.Smallnumbersaremoreresponsive,rapidlyadjustingthecameratokeepthegroupintheframe.Largernumbersgiveamoreheavyslowlyrespondingcamera.")]
publicfloatm_FrameDamping
CopyC# JavaScript
![Page 1070: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1070.jpg)
Cinemachine
![Page 1071: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1071.jpg)
CinemachineGroupComposerm_FramingModeField
Whatscreendimensionstoconsiderwhenframing
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineGroupComposerFramingMode
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Whatscreendimensionstoconsiderwhenframing.CanbeHorizontal,Vertical,orboth")]
publicCinemachineGroupComposerFramingModem_FramingMode
CopyC# JavaScript
![Page 1072: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1072.jpg)
Cinemachine
![Page 1073: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1073.jpg)
CinemachineGroupComposerm_GroupFramingSizeField
Howmuchofthescreentofillwiththeboundingboxofthetargets.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[SpaceAttribute]
[TooltipAttribute("Theboundingboxofthetargetsshouldoccupythisamountofthescreenspace.1meansfillthewholescreen.0.5meansfillhalfthescreen,etc.")]
publicfloatm_GroupFramingSize
CopyC# JavaScript
![Page 1074: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1074.jpg)
Cinemachine
![Page 1075: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1075.jpg)
CinemachineGroupComposerm_MaxDollyInField
Howmuchclosertothetargetcanthecamerago?
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Themaximumdistancetowardthetargetthatthisbehaviourisallowedtomovethecamera.")]
publicfloatm_MaxDollyIn
CopyC# JavaScript
![Page 1076: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1076.jpg)
Cinemachine
![Page 1077: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1077.jpg)
CinemachineGroupComposerm_MaxDollyOutField
Howmuchfartherfromthetargetcanthecamerago?
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Themaximumdistanceawaythetargetthatthisbehaviourisallowedtomovethecamera.")]
publicfloatm_MaxDollyOut
CopyC# JavaScript
![Page 1078: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1078.jpg)
Cinemachine
![Page 1079: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1079.jpg)
CinemachineGroupComposerm_MaximumDistanceField
Setthistolimithowfarfromthetaregtthecameracanget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Setthistolimithowfarfromthetargetthecameracanget.")]
publicfloatm_MaximumDistance
CopyC# JavaScript
![Page 1080: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1080.jpg)
Cinemachine
![Page 1081: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1081.jpg)
CinemachineGroupComposerm_MaximumFOVField
IfadjustingFOV,willnotsettheFOVhigherthanthis
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(1f,179f)]
[TooltipAttribute("IfadjustingFOV,willnotsettheFOVhigherthanthis.")]
publicfloatm_MaximumFOV
CopyC# JavaScript
![Page 1082: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1082.jpg)
Cinemachine
![Page 1083: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1083.jpg)
CinemachineGroupComposerm_MaximumOrthoSizeField
IfadjustingOrthographicSize,willnotsetithigherthanthis
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("IfadjustingOrthographicSize,willnotsetithigherthanthis.")]
publicfloatm_MaximumOrthoSize
CopyC# JavaScript
![Page 1084: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1084.jpg)
Cinemachine
![Page 1085: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1085.jpg)
CinemachineGroupComposerm_MinimumDistanceField
Setthistolimithowclosetothetargetthecameracanget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Setthistolimithowclosetothetargetthecameracanget.")]
publicfloatm_MinimumDistance
CopyC# JavaScript
![Page 1086: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1086.jpg)
Cinemachine
![Page 1087: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1087.jpg)
CinemachineGroupComposerm_MinimumFOVField
IfadjustingFOV,willnotsettheFOVlowerthanthis
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(1f,179f)]
[TooltipAttribute("IfadjustingFOV,willnotsettheFOVlowerthanthis.")]
publicfloatm_MinimumFOV
CopyC# JavaScript
![Page 1088: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1088.jpg)
Cinemachine
![Page 1089: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1089.jpg)
CinemachineGroupComposerm_MinimumOrthoSizeField
IfadjustingOrthographicSize,willnotsetitlowerthanthis
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineGroupComposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("IfadjustingOrthographicSize,willnotsetitlowerthanthis.")]
publicfloatm_MinimumOrthoSize
CopyC# JavaScript
![Page 1090: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1090.jpg)
Cinemachine
![Page 1091: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1091.jpg)
CinemachineGroupComposerAdjustmentModeEnumeration
Howtoadjustthecameratogetthedesiredframing
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members Membername Value Description
ZoomOnly 0 Donotmovethecamera,onlyadjusttheFOV.
DollyOnly 1 Justmovethecamera,don'tchangetheFOV.
DollyThenZoom 2 Movethecameraasmuchaspermittedbytheranges,thenadjusttheFOVifnecessarytomaketheshot.
publicenumAdjustmentMode
CopyC# JavaScript
![Page 1092: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1092.jpg)
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1093: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1093.jpg)
Cinemachine
![Page 1094: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1094.jpg)
CinemachineGroupComposerFramingModeEnumeration
Whatscreendimensionstoconsiderwhenframing
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members Membername Value Description
Horizontal 0 Consideronlythehorizontaldimension.Verticalframingisignored.
Vertical 1 Consideronlytheverticaldimension.Horizontalframingisignored.
HorizontalAndVertical 2 Thelargerofthe
[DocumentationSortingAttribute(4.01f,DocumentationSortingAttribute
publicenumFramingMode
CopyC# JavaScript
![Page 1095: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1095.jpg)
horizontalandverticaldimensionswilldominate,togetthebestfit.
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1096: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1096.jpg)
Cinemachine
![Page 1097: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1097.jpg)
CinemachineHardLockToTargetClass
ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.ItsjobistoplacethecameraontheFollowTarget.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineHardLockToTarget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineHardLockToTargettypeexposesthefollowingmembers.
Constructors
[DocumentationSortingAttribute(23f,DocumentationSortingAttribute
[AddComponentMenu("")]
[RequireComponent(typeof(CinemachinePipeline))]
[SaveDuringPlayAttribute]
publicclassCinemachineHardLockToTarget:CinemachineComponentBase
CopyC# JavaScript
![Page 1098: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1098.jpg)
Name Description
CinemachineHardLockToTarget
Top
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
IsValid TrueifcomponentisenabledandhasaLookAtdefined(OverridesCinemachineComponentBaseIsValid.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage(OverridesCinemachineComponentBaseStage.)
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(Inheritedfrom
![Page 1099: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1099.jpg)
CinemachineComponentBase.)
Top
Methods Name Description
MutateCameraState Appliesthecomposerrulesandorientsthecameraaccordingly(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.classimplementationdoesnothing.(InheritedfromCinemachineComponentBase
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1100: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1100.jpg)
Cinemachine
![Page 1101: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1101.jpg)
CinemachineHardLockToTargetConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineHardLockToTarget.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineHardLockToTargetClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineHardLockToTarget()
CopyC# JavaScript
![Page 1102: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1102.jpg)
Cinemachine
![Page 1103: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1103.jpg)
CinemachineHardLockToTargetProperties
TheCinemachineHardLockToTargettypeexposesthefollowingmembers.
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
IsValid TrueifcomponentisenabledandhasaLookAtdefined(OverridesCinemachineComponentBaseIsValid.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage(OverridesCinemachineComponentBaseStage.)
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
![Page 1104: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1104.jpg)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)
Top
SeeAlsoReferenceCinemachineHardLockToTargetClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1105: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1105.jpg)
Cinemachine
![Page 1106: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1106.jpg)
CinemachineHardLockToTargetIsValidProperty
TrueifcomponentisenabledandhasaLookAtdefined
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineHardLockToTargetClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideboolIsValid{get;}
CopyC# JavaScript
![Page 1107: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1107.jpg)
Cinemachine
![Page 1108: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1108.jpg)
CinemachineHardLockToTargetStageProperty
GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineCoreStage
SeeAlsoReferenceCinemachineHardLockToTargetClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideCinemachineCoreStageStage{get;}
CopyC# JavaScript
![Page 1109: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1109.jpg)
Cinemachine
![Page 1110: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1110.jpg)
CinemachineHardLockToTargetMethods
TheCinemachineHardLockToTargettypeexposesthefollowingmembers.
Methods Name Description
MutateCameraState Appliesthecomposerrulesandorientsthecameraaccordingly(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.classimplementationdoesnothing.(InheritedfromCinemachineComponentBase
Top
SeeAlsoReferenceCinemachineHardLockToTargetClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1111: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1111.jpg)
Cinemachine
![Page 1112: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1112.jpg)
CinemachineHardLockToTargetMutateCameraStateMethod
Appliesthecomposerrulesandorientsthecameraaccordingly
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
curStateType:CinemachineCameraStateThecurrentcamerastate
deltaTimeType:SystemSingleUsedforcalculatingdamping.Iflessthanzero,thentargetwillsnaptothecenterofthedeadzone.
SeeAlsoReferenceCinemachineHardLockToTargetClassCinemachineNamespace
VisittheCinemachineForum
publicoverridevoidMutateCameraState(
refCameraStatecurState,
floatdeltaTime
)
CopyC# JavaScript
![Page 1114: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1114.jpg)
Cinemachine
![Page 1115: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1115.jpg)
CinemachineHardLookAtClass
ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.ItsjobistoaimthecamerahardattheLookAttarget.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineHardLookAt
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineHardLookAttypeexposesthefollowingmembers.
Constructors Name Description
CinemachineHardLookAt
[DocumentationSortingAttribute(23f,DocumentationSortingAttribute
[AddComponentMenu("")]
[RequireComponent(typeof(CinemachinePipeline))]
[SaveDuringPlayAttribute]
publicclassCinemachineHardLookAt:CinemachineComponentBase
CopyC# JavaScript
![Page 1116: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1116.jpg)
Top
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
IsValid TrueifcomponentisenabledandhasaLookAtdefined(OverridesCinemachineComponentBaseIsValid.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage(OverridesCinemachineComponentBaseStage.)
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)
Top
![Page 1117: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1117.jpg)
Methods Name Description
MutateCameraState Appliesthecomposerrulesandorientsthecameraaccordingly(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.classimplementationdoesnothing.(InheritedfromCinemachineComponentBase
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1118: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1118.jpg)
Cinemachine
![Page 1119: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1119.jpg)
CinemachineHardLookAtConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineHardLookAt.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineHardLookAtClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineHardLookAt()
CopyC# JavaScript
![Page 1120: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1120.jpg)
Cinemachine
![Page 1121: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1121.jpg)
CinemachineHardLookAtProperties
TheCinemachineHardLookAttypeexposesthefollowingmembers.
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
IsValid TrueifcomponentisenabledandhasaLookAtdefined(OverridesCinemachineComponentBaseIsValid.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage(OverridesCinemachineComponentBaseStage.)
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
![Page 1122: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1122.jpg)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)
Top
SeeAlsoReferenceCinemachineHardLookAtClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1123: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1123.jpg)
Cinemachine
![Page 1124: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1124.jpg)
CinemachineHardLookAtIsValidProperty
TrueifcomponentisenabledandhasaLookAtdefined
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineHardLookAtClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideboolIsValid{get;}
CopyC# JavaScript
![Page 1125: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1125.jpg)
Cinemachine
![Page 1126: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1126.jpg)
CinemachineHardLookAtStageProperty
GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineCoreStage
SeeAlsoReferenceCinemachineHardLookAtClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideCinemachineCoreStageStage{get;}
CopyC# JavaScript
![Page 1127: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1127.jpg)
Cinemachine
![Page 1128: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1128.jpg)
CinemachineHardLookAtMethods
TheCinemachineHardLookAttypeexposesthefollowingmembers.
Methods Name Description
MutateCameraState Appliesthecomposerrulesandorientsthecameraaccordingly(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.classimplementationdoesnothing.(InheritedfromCinemachineComponentBase
Top
SeeAlsoReferenceCinemachineHardLookAtClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1129: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1129.jpg)
Cinemachine
![Page 1130: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1130.jpg)
CinemachineHardLookAtMutateCameraStateMethod
Appliesthecomposerrulesandorientsthecameraaccordingly
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
curStateType:CinemachineCameraStateThecurrentcamerastate
deltaTimeType:SystemSingleUsedforcalculatingdamping.Iflessthanzero,thentargetwillsnaptothecenterofthedeadzone.
SeeAlsoReferenceCinemachineHardLookAtClassCinemachineNamespace
VisittheCinemachineForum
publicoverridevoidMutateCameraState(
refCameraStatecurState,
floatdeltaTime
)
CopyC# JavaScript
![Page 1132: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1132.jpg)
Cinemachine
![Page 1133: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1133.jpg)
CinemachineMixingCameraClass
CinemachineMixingCameraisa"managercamera"thattakesonthestateoftheweightedaverageofthestatesofitschildvirtualcameras.Afixednumberofslotsaremadeavailableforcameras,ratherthanadynamicarray.WedoitthiswayinordertosupportweightanimationfromtheTimeline.Timelinecannotanimatearrayelements.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineMixingCamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineMixingCameratypeexposesthefollowingmembers.
[DocumentationSortingAttribute(20f,DocumentationSortingAttribute
[ExecuteInEditMode]
[DisallowMultipleComponent]
[AddComponentMenu("Cinemachine/CinemachineMixingCamera")]
publicclassCinemachineMixingCamera:CinemachineVirtualCameraBase
CopyC# JavaScript
![Page 1134: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1134.jpg)
Constructors Name Description
CinemachineMixingCamera
Top
Properties Name Description
ChildCameras Getthecachedlistofchildcameras.justtheimmediatechildreninthehierarchy.onlythefirstentriesofthislistparticipateinthefinalblend,uptoMaxCameras
Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo(InheritedfromCinemachineVirtualCameraBase
Follow Notused(OverridesCinemachineVirtualCameraBase
LiveChildOrSelf Returnthelivechild.(OverridesCinemachineVirtualCameraBase
LookAt Notused(OverridesCinemachineVirtualCameraBase
Name GetthenameoftheVirtualCamera.implementationreturnstheownerGameObject'sname.(InheritedfromCinemachineVirtualCameraBase
![Page 1135: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1135.jpg)
ParentCamera Supportformeta-virtual-cameras.situationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.areimplementedasTransformchildrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase
PreviousStateIsValid SetthistoforcethenextupdatetoignoredeltaTimeandresetitself(InheritedfromCinemachineVirtualCameraBase
Priority GetthePriorityofthevirtualcamera.determinesitsplacementintheCinemachineCore'squeueofeligibleshots.(InheritedfromCinemachineVirtualCameraBase
State TheblendedCameraState(OverridesCinemachineVirtualCameraBase
ValidatingStreamVersion Versionthatwaslaststreamed,forupgradinglegacy(InheritedfromCinemachineVirtualCameraBase
VirtualCameraGameObject TheGameObjectowneroftheVirtualCamerabehaviour.(InheritedfromCinemachineVirtualCameraBase
Top
Methods Name Description
AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.pipeline.SeeCinemachineCore.Stage.(Inheritedfrom
![Page 1136: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1136.jpg)
GetWeight(Int32) Gettheweightofthechildatanindex.
GetWeight(CinemachineVirtualCameraBase) GettheweightofthechildCinemachineVirtualCameraBase.
InvalidateListOfChildren Invalidatethecachedlistofchildcameras.
InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforall(Inheritedfrom
IsLiveChild Checkwhetherthevcamalivechildofthiscamera.(OverridesCinemachineVirtualCameraBase
MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereisLivecameraifthemostrecentonegoestothetopoftheprioritysubqueue.anditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.(Inheritedfrom
OnDestroy Baseclassimplementationremovesthevirtualcamerafromthepriorityqueue.(Inheritedfrom
OnDisable Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(Inheritedfrom
OnEnable Makessuretheinternalchildcacheisuptodate(OverridesCinemachineVirtualCameraBase
OnTransformChildrenChanged Makessuretheinternalchildcacheisuptodate
OnTransformParentChanged Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(Inheritedfrom
OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.(Inheritedfrom
OnValidate Makessuretheweightsarenon-negative(OverridesCinemachineVirtualCameraBase
PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,
![Page 1137: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1137.jpg)
areupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledLateUpdateinstead.(Inheritedfrom
RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.(OverridesCinemachineVirtualCameraBase
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
Fields Name Description
CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removed
![Page 1138: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1138.jpg)
CinemachineDebuggerintheEditor.(InheritedfromCinemachineVirtualCameraBase
m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase
m_Weight0 Weightofthefirsttrackedcamera
m_Weight1 Weightofthesecondtrackedcamera
m_Weight2 Weightofthethirdtrackedcamera
m_Weight3 Weightofthefourthtrackedcamera
m_Weight4 Weightofthefifthtrackedcamera
m_Weight5 Weightofthesixthtrackedcamera
![Page 1139: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1139.jpg)
m_Weight6 Weightoftheseventhtrackedcamera
m_Weight7 Weightoftheeighthtrackedcamera
MaxCameras Themaximumnumberoftrackedcameras.Ifyouwanttoaddcameras,doithereinthesourcecode,andbesuretoaddtheextramembervariablesandtomaketheappropriatechangesinGetWeight()andSetWeight().Theinspectorwillfigureitselfoutbasedonthisvalue.
OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1140: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1140.jpg)
Cinemachine
![Page 1141: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1141.jpg)
CinemachineMixingCameraConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineMixingCamera.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineMixingCamera()
CopyC# JavaScript
![Page 1142: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1142.jpg)
Cinemachine
![Page 1143: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1143.jpg)
CinemachineMixingCameraProperties
TheCinemachineMixingCameratypeexposesthefollowingmembers.
Properties Name Description
ChildCameras Getthecachedlistofchildcameras.justtheimmediatechildreninthehierarchy.onlythefirstentriesofthislistparticipateinthefinalblend,uptoMaxCameras
Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo(InheritedfromCinemachineVirtualCameraBase
Follow Notused(OverridesCinemachineVirtualCameraBase
LiveChildOrSelf Returnthelivechild.(OverridesCinemachineVirtualCameraBase
LookAt Notused(OverridesCinemachineVirtualCameraBase
Name GetthenameoftheVirtualCamera.implementationreturnstheownerGameObject'sname.(InheritedfromCinemachineVirtualCameraBase
![Page 1144: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1144.jpg)
ParentCamera Supportformeta-virtual-cameras.situationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.areimplementedasTransformchildrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase
PreviousStateIsValid SetthistoforcethenextupdatetoignoredeltaTimeandresetitself(InheritedfromCinemachineVirtualCameraBase
Priority GetthePriorityofthevirtualcamera.determinesitsplacementintheCinemachineCore'squeueofeligibleshots.(InheritedfromCinemachineVirtualCameraBase
State TheblendedCameraState(OverridesCinemachineVirtualCameraBase
ValidatingStreamVersion Versionthatwaslaststreamed,forupgradinglegacy(InheritedfromCinemachineVirtualCameraBase
VirtualCameraGameObject TheGameObjectowneroftheVirtualCamerabehaviour.(InheritedfromCinemachineVirtualCameraBase
Top
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForum
![Page 1146: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1146.jpg)
Cinemachine
![Page 1147: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1147.jpg)
CinemachineMixingCameraChildCamerasProperty
Getthecachedlistofchildcameras.Thesearejusttheimmediatechildreninthehierarchy.Note:onlythefirstentriesofthislistparticipateinthefinalblend,uptoMaxCameras
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineVirtualCameraBase
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineVirtualCameraBase[]ChildCameras{
CopyC# JavaScript
![Page 1148: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1148.jpg)
Cinemachine
![Page 1149: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1149.jpg)
CinemachineMixingCameraFollowProperty
Notused
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:TransformImplementsICinemachineCameraFollow
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideTransformFollow{get;set;}
CopyC# JavaScript
![Page 1150: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1150.jpg)
Cinemachine
![Page 1151: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1151.jpg)
CinemachineMixingCameraLiveChildOrSelfProperty
Returnthelivechild.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ICinemachineCameraImplementsICinemachineCameraLiveChildOrSelf
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideICinemachineCameraLiveChildOrSelf{
CopyC# JavaScript
![Page 1152: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1152.jpg)
Cinemachine
![Page 1153: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1153.jpg)
CinemachineMixingCameraLookAtProperty
Notused
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:TransformImplementsICinemachineCameraLookAt
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideTransformLookAt{get;set;}
CopyC# JavaScript
![Page 1154: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1154.jpg)
Cinemachine
![Page 1155: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1155.jpg)
CinemachineMixingCameraStateProperty
TheblendedCameraState
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CameraStateImplementsICinemachineCameraState
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideCameraStateState{get;}
CopyC# JavaScript
![Page 1156: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1156.jpg)
Cinemachine
![Page 1157: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1157.jpg)
CinemachineMixingCameraMethods
TheCinemachineMixingCameratypeexposesthefollowingmembers.
Methods Name Description
AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.pipeline.SeeCinemachineCore.Stage.(Inheritedfrom
GetWeight(Int32) Gettheweightofthechildatanindex.
GetWeight(CinemachineVirtualCameraBase) GettheweightofthechildCinemachineVirtualCameraBase.
InvalidateListOfChildren Invalidatethecachedlistofchildcameras.
InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforall(Inheritedfrom
IsLiveChild Checkwhetherthevcamalivechildofthiscamera.(OverridesCinemachineVirtualCameraBase
MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereisLivecameraifthemostrecentonegoestothetopoftheprioritysubqueue.anditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.(Inheritedfrom
OnDestroy Baseclassimplementationremovesthevirtualcamerafromthepriorityqueue.(Inheritedfrom
OnDisable Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.
![Page 1158: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1158.jpg)
(Inheritedfrom
OnEnable Makessuretheinternalchildcacheisuptodate(OverridesCinemachineVirtualCameraBase
OnTransformChildrenChanged Makessuretheinternalchildcacheisuptodate
OnTransformParentChanged Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(Inheritedfrom
OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.(Inheritedfrom
OnValidate Makessuretheweightsarenon-negative(OverridesCinemachineVirtualCameraBase
PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,areupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledLateUpdateinstead.(Inheritedfrom
RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.(OverridesCinemachineVirtualCameraBase
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.
![Page 1159: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1159.jpg)
(Inheritedfrom
UpdateCameraState CalledbyCinemachineCoreatdesignatedupdatetimecomputesandcachestheweightedblendofthetrackedcameras.(OverridesCinemachineVirtualCameraBase
ValidateListOfChildren Rebuildthecachedlistofchildcameras.
Top
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1160: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1160.jpg)
Cinemachine
![Page 1161: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1161.jpg)
CinemachineMixingCameraGetWeightMethod
OverloadList Name Description
GetWeight(Int32) Gettheweightofthechildatanindex.
GetWeight(CinemachineVirtualCameraBase) GettheweightofthechildCinemachineVirtualCameraBase.
Top
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1162: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1162.jpg)
Cinemachine
![Page 1163: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1163.jpg)
CinemachineMixingCameraGetWeightMethod(Int32)
Gettheweightofthechildatanindex.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
indexType:SystemInt32Thechildindex.OnlyimmediateCinemachineVirtualCameraBasechildrenarecounted.
ReturnValueType:SingleTheweightofthecamera.Validonlyifcameraisactiveandenabled.
SeeAlsoReferenceCinemachineMixingCameraClassGetWeightOverloadCinemachineNamespace
publicfloatGetWeight(
intindex
)
CopyC# JavaScript
![Page 1164: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1164.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1165: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1165.jpg)
Cinemachine
![Page 1166: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1166.jpg)
CinemachineMixingCameraGetWeightMethod(CinemachineVirtualCameraBase)
GettheweightofthechildCinemachineVirtualCameraBase.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineCinemachineVirtualCameraBaseThechildcamera.
ReturnValueType:SingleTheweightofthecamera.Validonlyifcameraisactiveandenabled.
SeeAlsoReferenceCinemachineMixingCameraClassGetWeightOverloadCinemachineNamespace
publicfloatGetWeight(
CinemachineVirtualCameraBasevcam
)
CopyC# JavaScript
![Page 1167: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1167.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1168: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1168.jpg)
Cinemachine
![Page 1169: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1169.jpg)
CinemachineMixingCameraInvalidateListOfChildrenMethod
Invalidatethecachedlistofchildcameras.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedvoidInvalidateListOfChildren()
CopyC# JavaScript
![Page 1170: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1170.jpg)
Cinemachine
![Page 1171: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1171.jpg)
CinemachineMixingCameraIsLiveChildMethod
Checkwhetherthevcamalivechildofthiscamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineICinemachineCameraTheVirtualCameratocheck
ReturnValueType:BooleanTrueifthevcamiscurrentlyactivelyinfluencingthestateofthisvcamImplementsICinemachineCameraIsLiveChild(ICinemachineCamera)
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
publicoverrideboolIsLiveChild(
ICinemachineCameravcam
)
CopyC# JavaScript
![Page 1172: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1172.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1173: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1173.jpg)
Cinemachine
![Page 1174: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1174.jpg)
CinemachineMixingCameraOnEnableMethod
Makessuretheinternalchildcacheisuptodate
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedoverridevoidOnEnable()
CopyC# JavaScript
![Page 1175: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1175.jpg)
Cinemachine
![Page 1176: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1176.jpg)
CinemachineMixingCameraOnTransformChildrenChangedMethod
Makessuretheinternalchildcacheisuptodate
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidOnTransformChildrenChanged()
CopyC# JavaScript
![Page 1177: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1177.jpg)
Cinemachine
![Page 1178: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1178.jpg)
CinemachineMixingCameraOnValidateMethod
Makessuretheweightsarenon-negative
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedoverridevoidOnValidate()
CopyC# JavaScript
![Page 1179: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1179.jpg)
Cinemachine
![Page 1180: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1180.jpg)
CinemachineMixingCameraRemovePostPipelineStageHookMethod
RemoveaPipelinestagehookcallback.Makesureitisremovedfromallthechildren.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
dType:CinemachineCinemachineVirtualCameraBaseOnPostPipelineStageDelegateThedelegatetoremove.
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridevoidRemovePostPipelineStageHook(
CinemachineVirtualCameraBaseOnPostPipelineStageDelegate
)
CopyC# JavaScript
![Page 1181: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1181.jpg)
Cinemachine
![Page 1182: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1182.jpg)
CinemachineMixingCameraSetWeightMethod
OverloadList Name Description
SetWeight(Int32,Single) Settheweightofthechildatanindex.
SetWeight(CinemachineVirtualCameraBase,Single)
SettheweightofthechildCinemachineVirtualCameraBase.
Top
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1183: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1183.jpg)
Cinemachine
![Page 1184: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1184.jpg)
CinemachineMixingCameraSetWeightMethod(Int32,Single)
Settheweightofthechildatanindex.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
indexType:SystemInt32Thechildindex.OnlyimmediateCinemachineVirtualCameraBasechildrenarecounted.
wType:SystemSingleTheweighttoset.Canbeanynon-negativenumber.
SeeAlsoReferenceCinemachineMixingCameraClassSetWeightOverloadCinemachineNamespace
publicvoidSetWeight(
intindex,
floatw
)
CopyC# JavaScript
![Page 1185: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1185.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1186: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1186.jpg)
Cinemachine
![Page 1187: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1187.jpg)
CinemachineMixingCameraSetWeightMethod(CinemachineVirtualCameraBase,Single)
SettheweightofthechildCinemachineVirtualCameraBase.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineCinemachineVirtualCameraBaseThechildcamera.
wType:SystemSingleTheweighttoset.Canbeanynon-negativenumber.
SeeAlsoReferenceCinemachineMixingCameraClass
publicvoidSetWeight(
CinemachineVirtualCameraBasevcam,
floatw
)
CopyC# JavaScript
![Page 1188: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1188.jpg)
SetWeightOverloadCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1189: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1189.jpg)
Cinemachine
![Page 1190: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1190.jpg)
CinemachineMixingCameraUpdateCameraStateMethod
CalledbyCinemachineCoreatdesignatedupdatetimesothevcamcanpositionitselfandtrackitstargets.Thisimplementationcomputesandcachestheweightedblendofthetrackedcameras.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
worldUpType:Vector3DefaultworldUp,setbytheCinemachineBrain
deltaTimeType:SystemSingleDeltatimefortime-basedeffects(ignoreiflessthan0)
ImplementsICinemachineCameraUpdateCameraState(Vector3,Single)
SeeAlsoReference
publicoverridevoidUpdateCameraState(
Vector3worldUp,
floatdeltaTime
)
CopyC# JavaScript
![Page 1191: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1191.jpg)
CinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1192: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1192.jpg)
Cinemachine
![Page 1193: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1193.jpg)
CinemachineMixingCameraValidateListOfChildrenMethod
Rebuildthecachedlistofchildcameras.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedvoidValidateListOfChildren()
CopyC# JavaScript
![Page 1194: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1194.jpg)
Cinemachine
![Page 1195: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1195.jpg)
CinemachineMixingCameraFields
TheCinemachineMixingCameratypeexposesthefollowingmembers.
Fields Name Description
CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.(InheritedfromCinemachineVirtualCameraBase
m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase
![Page 1196: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1196.jpg)
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.
![Page 1197: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1197.jpg)
(InheritedfromCinemachineVirtualCameraBase
Top
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1198: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1198.jpg)
Cinemachine
![Page 1199: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1199.jpg)
CinemachineMixingCameram_Weight0Field
Weightofthefirsttrackedcamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theweightofthefirsttrackedcamera")]
publicfloatm_Weight0
CopyC# JavaScript
![Page 1200: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1200.jpg)
Cinemachine
![Page 1201: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1201.jpg)
CinemachineMixingCameram_Weight1Field
Weightofthesecondtrackedcamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theweightofthesecondtrackedcamera")]
publicfloatm_Weight1
CopyC# JavaScript
![Page 1202: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1202.jpg)
Cinemachine
![Page 1203: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1203.jpg)
CinemachineMixingCameram_Weight2Field
Weightofthethirdtrackedcamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theweightofthethirdtrackedcamera")]
publicfloatm_Weight2
CopyC# JavaScript
![Page 1204: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1204.jpg)
Cinemachine
![Page 1205: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1205.jpg)
CinemachineMixingCameram_Weight3Field
Weightofthefourthtrackedcamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theweightofthefourthtrackedcamera")]
publicfloatm_Weight3
CopyC# JavaScript
![Page 1206: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1206.jpg)
Cinemachine
![Page 1207: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1207.jpg)
CinemachineMixingCameram_Weight4Field
Weightofthefifthtrackedcamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theweightofthefifthtrackedcamera")]
publicfloatm_Weight4
CopyC# JavaScript
![Page 1208: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1208.jpg)
Cinemachine
![Page 1209: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1209.jpg)
CinemachineMixingCameram_Weight5Field
Weightofthesixthtrackedcamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theweightofthesixthtrackedcamera")]
publicfloatm_Weight5
CopyC# JavaScript
![Page 1210: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1210.jpg)
Cinemachine
![Page 1211: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1211.jpg)
CinemachineMixingCameram_Weight6Field
Weightoftheseventhtrackedcamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theweightoftheseventhtrackedcamera")]
publicfloatm_Weight6
CopyC# JavaScript
![Page 1212: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1212.jpg)
Cinemachine
![Page 1213: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1213.jpg)
CinemachineMixingCameram_Weight7Field
Weightoftheeighthtrackedcamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theweightoftheeighthtrackedcamera")]
publicfloatm_Weight7
CopyC# JavaScript
![Page 1214: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1214.jpg)
Cinemachine
![Page 1215: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1215.jpg)
CinemachineMixingCameraMaxCamerasField
Themaximumnumberoftrackedcameras.Ifyouwanttoaddmorecameras,doithereinthesourcecode,andbesuretoaddtheextramembervariablesandtomaketheappropriatechangesinGetWeight()andSetWeight().Theinspectorwillfigureitselfoutbasedonthisvalue.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Int32
SeeAlsoReferenceCinemachineMixingCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicconstintMaxCameras=8
CopyC# JavaScript
![Page 1216: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1216.jpg)
Cinemachine
![Page 1217: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1217.jpg)
CinemachineOrbitalTransposerClass
ThisisaCinemachineComponentinthetheBodysectionofthecomponentpipeline.Itsjobistopositionthecamerainavariablerelationshiptoathevcam'sFollowtargetobject,withoffsetsanddamping.Thiscomponentistypicallyusedtoimplementacamerathatfollowsitstarget.Itcanacceptplayerinputfromaninputdevice,whichallowstheplayertodynamicallycontroltherelationshipbetweenthecameraandthetarget,forexamplewithajoystick.TheOrbitalTransposerintroducestheconceptof__Heading__,whichisthedirectioninwhichthetargetismoving,andtheOrbitalTransposerwillattempttopositionthecamerainrelationshiptotheheading,whichisbydefaultdirectlybehindthetarget.YoucancontrolthedefaultrelationshipbyadjustingtheHeadingBiassetting.IfyouattachaninputcontrollertotheOrbitalTransposer,thentheplayercanalsocontrolthewaythecamerapositionsitselfinrelationtothetargetheading.Thisallowsthecameratomovetoanyspotonanorbitaroundthetarget.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineTransposerCinemachineCinemachineOrbitalTransposer
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
![Page 1218: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1218.jpg)
TheCinemachineOrbitalTransposertypeexposesthefollowingmembers.
Properties Name Description
AngularDamping Dampingspeedsforeachofthe3axesofthetarget'srotation(InheritedfromCinemachineTransposer.)
Damping Dampingspeedsforeachofthe3axesoftheoffsetfromtarget(InheritedfromCinemachineTransposer.)
EffectiveOffset Getthetargetoffset,withsanitization(InheritedfromCinemachineTransposer.)
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
IsValid TrueifcomponentisenabledandhasavalidFollowtarget(Inheritedfrom
[DocumentationSortingAttribute(6f,DocumentationSortingAttribute
[AddComponentMenu("")]
[RequireComponent(typeof(CinemachinePipeline))]
[SaveDuringPlayAttribute]
publicclassCinemachineOrbitalTransposer:CinemachineTransposer
CopyC# JavaScript
![Page 1219: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1219.jpg)
CinemachineTransposer.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage(InheritedfromCinemachineTransposer.)
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)
Top
Methods Name Description
GeTargetCameraPosition InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget(InheritedfromCinemachineTransposer
GetReferenceOrientation InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget(InheritedfromCinemachineTransposer
InitPrevFrameStateInfo Initializesthestateforpreviousframeifappropriate.
![Page 1220: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1220.jpg)
(InheritedfromCinemachineTransposer
MutateCameraState Positionsthevirtualcameraaccordingtothetransposerrules.(OverridesCinemachineTransposerMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.Thisimplementationaddsthedeltatothefollowoffset,afterzeroingoutlocalx.(OverridesCinemachineTransposerOnPositionDragged(Vector3)
OnValidate (OverridesCinemachineTransposer
TrackTarget Positionsthevirtualcameraaccordingtothetransposerrules.(InheritedfromCinemachineTransposer
UpdateHeading Wheninslavemode,thisshouldbecalledonceandonlyonceeveryhrametoupdatetheheading.slavemode,thisiscalledautomatically.
Top
Fields Name Description
m_BindingMode Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget(InheritedfromCinemachineTransposer.)
m_FollowOffset Thedistancewhichthetransposerwillattempttomaintainfromthe
![Page 1221: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1221.jpg)
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.)
![Page 1222: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1222.jpg)
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
![Page 1223: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1223.jpg)
translatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors(InheritedfromCinemachineTransposer.)
m_ZDamping HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors(InheritedfromCinemachineTransposer.)
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1224: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1224.jpg)
![Page 1225: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1225.jpg)
Cinemachine
![Page 1226: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1226.jpg)
CinemachineOrbitalTransposerProperties
TheCinemachineOrbitalTransposertypeexposesthefollowingmembers.
Properties Name Description
AngularDamping Dampingspeedsforeachofthe3axesofthetarget'srotation(InheritedfromCinemachineTransposer.)
Damping Dampingspeedsforeachofthe3axesoftheoffsetfromtarget(InheritedfromCinemachineTransposer.)
EffectiveOffset Getthetargetoffset,withsanitization(InheritedfromCinemachineTransposer.)
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
IsValid TrueifcomponentisenabledandhasavalidFollowtarget(InheritedfromCinemachineTransposer.)
![Page 1227: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1227.jpg)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage(InheritedfromCinemachineTransposer.)
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)
Top
SeeAlsoReferenceCinemachineOrbitalTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1228: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1228.jpg)
Cinemachine
![Page 1229: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1229.jpg)
CinemachineOrbitalTransposerMethods
TheCinemachineOrbitalTransposertypeexposesthefollowingmembers.
Methods Name Description
GeTargetCameraPosition InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget(InheritedfromCinemachineTransposer
GetReferenceOrientation InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget(InheritedfromCinemachineTransposer
InitPrevFrameStateInfo Initializesthestateforpreviousframeifappropriate.(InheritedfromCinemachineTransposer
MutateCameraState Positionsthevirtualcameraaccordingtothetransposerrules.(OverridesCinemachineTransposerMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.Thisimplementationaddsthedeltatothefollowoffset,afterzeroingoutlocalx.(OverridesCinemachineTransposerOnPositionDragged(Vector3)
OnValidate (OverridesCinemachineTransposer
![Page 1230: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1230.jpg)
TrackTarget Positionsthevirtualcameraaccordingtothetransposerrules.(InheritedfromCinemachineTransposer
UpdateHeading Wheninslavemode,thisshouldbecalledonceandonlyonceeveryhrametoupdatetheheading.slavemode,thisiscalledautomatically.
Top
SeeAlsoReferenceCinemachineOrbitalTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1231: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1231.jpg)
Cinemachine
![Page 1232: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1232.jpg)
CinemachineOrbitalTransposerMutateCameraStateMethod
Positionsthevirtualcameraaccordingtothetransposerrules.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
curStateType:CinemachineCameraStateThecurrentcamerastate
deltaTimeType:SystemSingleUsedfordamping.Iflessthan0,nodampingisdone.
SeeAlsoReferenceCinemachineOrbitalTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridevoidMutateCameraState(
refCameraStatecurState,
floatdeltaTime
)
CopyC# JavaScript
![Page 1233: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1233.jpg)
![Page 1234: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1234.jpg)
Cinemachine
![Page 1235: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1235.jpg)
CinemachineOrbitalTransposerOnPositionDraggedMethod
APIfortheeditor,toprocessapositiondragfromtheuser.Thisimplementationaddsthedeltatothefollowoffset,afterzeroingoutlocalx.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
deltaType:Vector3Theamountdraggedthisframe
SeeAlsoReferenceCinemachineOrbitalTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridevoidOnPositionDragged(
Vector3delta
)
CopyC# JavaScript
![Page 1236: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1236.jpg)
Cinemachine
![Page 1237: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1237.jpg)
CinemachineOrbitalTransposerOnValidateMethod
[Missing<summary>documentationfor"M:Cinemachine.CinemachineOrbitalTransposer.OnValidate"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineOrbitalTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedoverridevoidOnValidate()
CopyC# JavaScript
![Page 1238: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1238.jpg)
Cinemachine
![Page 1239: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1239.jpg)
CinemachineOrbitalTransposerUpdateHeadingMethod
Wheninslavemode,thisshouldbecalledonceandonlyonceeveryhrametoupdatetheheading.Whennotinslavemode,thisiscalledautomatically.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 1240: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1240.jpg)
CinemachineOrbitalTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1241: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1241.jpg)
Cinemachine
![Page 1242: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1242.jpg)
CinemachineOrbitalTransposerFields
TheCinemachineOrbitalTransposertypeexposesthefollowingmembers.
Fields Name Description
m_BindingMode Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget(InheritedfromCinemachineTransposer.)
m_FollowOffset Thedistancewhichthetransposerwillattempttomaintainfromthetransposersubject(InheritedfromCinemachineTransposer.)
m_Heading ThedefinitionofForward.Camerawillfollowbehind.
m_HeadingIsSlave Drivethex-axissettingprogrammatically.Automaticheadingupdatingwillbedisabled.
m_PitchDamping Howaggressivelythecameratriestotrackthetargetrotation'sXangle.
![Page 1243: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1243.jpg)
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.
![Page 1244: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1244.jpg)
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
![Page 1245: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1245.jpg)
responsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors(InheritedfromCinemachineTransposer.)
Top
SeeAlsoReferenceCinemachineOrbitalTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1246: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1246.jpg)
Cinemachine
![Page 1247: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1247.jpg)
CinemachineOrbitalTransposerm_HeadingField
ThedefinitionofForward.Camerawillfollowbehind.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineOrbitalTransposerHeading
SeeAlsoReferenceCinemachineOrbitalTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[SpaceAttribute]
[TooltipAttribute("ThedefinitionofForward.Camerawillfollowbehind.")]
publicCinemachineOrbitalTransposerHeadingm_Heading
CopyC# JavaScript
![Page 1248: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1248.jpg)
Cinemachine
![Page 1249: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1249.jpg)
CinemachineOrbitalTransposerm_HeadingIsSlaveField
Drivethex-axissettingprogrammatically.Automaticheadingupdatingwillbedisabled.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineOrbitalTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[HideInInspector]
[NoSaveDuringPlayAttribute]
publicboolm_HeadingIsSlave
CopyC# JavaScript
![Page 1250: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1250.jpg)
Cinemachine
![Page 1251: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1251.jpg)
CinemachineOrbitalTransposerm_RecenterToTargetHeadingField
ParametersthatcontrolAutomatingHeadingRecentering
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineOrbitalTransposerRecentering
SeeAlsoReferenceCinemachineOrbitalTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Automaticheadingrecentering.Thesettingsheredefineshowthecamerawillrepositionitselfintheabsenceofplayerinput.")]
publicCinemachineOrbitalTransposerRecenteringm_RecenterToTargetHeading
CopyC# JavaScript
![Page 1252: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1252.jpg)
Cinemachine
![Page 1253: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1253.jpg)
CinemachineOrbitalTransposerm_XAxisField
Axisrepresentingthecurrentheading.Valueisindegreesandrepresentsarotationabouttheupvector
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:AxisState
SeeAlsoReferenceCinemachineOrbitalTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("HeadingControl.Thesettingsherecontrolthebehaviourofthecamerainresponsetotheplayer'sinput.")]
publicAxisStatem_XAxis
CopyC# JavaScript
![Page 1254: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1254.jpg)
Cinemachine
![Page 1255: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1255.jpg)
CinemachineOrbitalTransposerHeadingStructure
Howthe"forward"directionisdefined.Orbitaloffsetisinrelationtotheforwarddirection.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineOrbitalTransposerHeadingtypeexposesthefollowingmembers.
Constructors Name Description
CinemachineOrbitalTransposerHeading Constructor
Top
Fields Name Description
m_HeadingBias AdditionalYrotation
[SerializableAttribute]
[DocumentationSortingAttribute(6.2f,DocumentationSortingAttribute
publicstructHeading
CopyC# JavaScript
![Page 1256: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1256.jpg)
appliedtothetargetheading.Whenthisvalueis0,thecamerawillbeplacedbehindthetarget
m_HeadingDefinition Themethodbywhichthe'defaultheading'iscalculatedifrecenteringtotargetheadingisenabled
m_VelocityFilterStrength Sizeofthevelocitysamplingwindowfortargetheadingfilter.Usedonlyifderivingheadingfromtarget'smovement
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1257: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1257.jpg)
Cinemachine
![Page 1258: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1258.jpg)
CinemachineOrbitalTransposerHeadingConstructor
Constructor
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 1259: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1259.jpg)
SeeAlsoReferenceCinemachineOrbitalTransposerHeadingStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1260: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1260.jpg)
Cinemachine
![Page 1261: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1261.jpg)
HeadingFields
TheCinemachineOrbitalTransposerHeadingtypeexposesthefollowingmembers.
Fields Name Description
m_HeadingBias AdditionalYrotationappliedtothetargetheading.Whenthisvalueis0,thecamerawillbeplacedbehindthetarget
m_HeadingDefinition Themethodbywhichthe'defaultheading'iscalculatedifrecenteringtotargetheadingisenabled
m_VelocityFilterStrength Sizeofthevelocitysamplingwindowfortargetheadingfilter.Usedonlyifderivingheadingfromtarget'smovement
Top
SeeAlsoReferenceCinemachineOrbitalTransposerHeadingStructureCinemachineNamespace
![Page 1262: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1262.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1263: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1263.jpg)
Cinemachine
![Page 1264: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1264.jpg)
CinemachineOrbitalTransposerHeadingField
AdditionalYrotationappliedtothetargetheading.Whenthisvalueis0,thecamerawillbeplacedbehindthetarget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineOrbitalTransposerHeadingStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(-180f,180f)]
[TooltipAttribute("WherethecameraisplacedwhentheX-axisvalueiszero.ThisisarotationindegreesaroundtheYaxis.Whenthisvalueis0,thecamerawillbeplacedbehindthetarget.Nonzerooffsetswillrotatethezeropositionaroundthetarget.")]
publicfloatm_HeadingBias
CopyC# JavaScript
![Page 1265: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1265.jpg)
Cinemachine
![Page 1266: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1266.jpg)
CinemachineOrbitalTransposerHeadingField
Themethodbywhichthe'defaultheading'iscalculatedifrecenteringtotargetheadingisenabled
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineOrbitalTransposerHeadingHeadingDefinition
SeeAlsoReferenceCinemachineOrbitalTransposerHeadingStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("How'forward'isdefined.Thecamerawillbeplacedbydefaultbehindthetarget.PositionDeltawillconsider'forward'tobethedirectioninwhichthetargetismoving.")]
publicCinemachineOrbitalTransposerHeadingHeadingDefinition
CopyC# JavaScript
![Page 1267: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1267.jpg)
Cinemachine
![Page 1268: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1268.jpg)
CinemachineOrbitalTransposerHeadingField
Sizeofthevelocitysamplingwindowfortargetheadingfilter.Usedonlyifderivingheadingfromtarget'smovement
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Int32
SeeAlsoReferenceCinemachineOrbitalTransposerHeadingStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,10f)]
[TooltipAttribute("Sizeofthevelocitysamplingwindowfortargetheadingfilter.Thisfiltersoutirregularitiesinthetarget'smovement.Usedonlyifderivingheadingfromtarget'smovement(PositionDeltaorVelocity)")]
publicintm_VelocityFilterStrength
CopyC# JavaScript
![Page 1269: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1269.jpg)
Cinemachine
![Page 1270: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1270.jpg)
CinemachineOrbitalTransposerHeadingEnumeration
Setsthealgorithmfordeterminingthetarget'sheadingforpurposesofre-centeringthecamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members
Membername Value Description
PositionDelta 0 Targetheadingcalculatedfromthedifferencebetweenitspositiononlastupdateandcurrentframe.
Velocity 1 TargetheadingcalculatedfromitsRigidbody'svelocity.IfnoRigidbodyexists,itwillfallbacktoHeadingDerivationMode.PositionDelta
TargetForward 2 TargetheadingcalculatedfromtheTargetTransform'seulerYangle
[DocumentationSortingAttribute(6.21f,DocumentationSortingAttribute
publicenumHeadingDefinition
CopyC# JavaScript
![Page 1271: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1271.jpg)
WorldForward 3 Defaultheadingisaconstantworldspaceheading.
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1272: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1272.jpg)
Cinemachine
![Page 1273: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1273.jpg)
CinemachineOrbitalTransposerRecenteringStructure
Controlshowautomaticorbitrecenteringoccurs
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineOrbitalTransposerRecenteringtypeexposesthefollowingmembers.
Methods Name Description
Validate CallthisfromOnValidate()
Top
Fields Name Description
m_enabled Ifchecked,willenableautomaticrecenteringof
[SerializableAttribute]
[DocumentationSortingAttribute(6.5f,DocumentationSortingAttribute
publicstructRecentering
CopyC# JavaScript
![Page 1274: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1274.jpg)
thecamerabasedontheheadingcalculationmode.IfFALSE,recentingisdisabled.
m_RecenteringTime Maximumangularspeedofrecentering.Willaccelerateintoanddecelerateoutofthis
m_RecenterWaitTime Ifnoinputhasbeendetected,thecamerawillwaitthislonginsecondsbeforemovingitsheadingtothedefaultheading.
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1275: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1275.jpg)
Cinemachine
![Page 1276: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1276.jpg)
RecenteringMethods
TheCinemachineOrbitalTransposerRecenteringtypeexposesthefollowingmembers.
Methods Name Description
Validate CallthisfromOnValidate()
Top
SeeAlsoReferenceCinemachineOrbitalTransposerRecenteringStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1277: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1277.jpg)
Cinemachine
![Page 1278: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1278.jpg)
CinemachineOrbitalTransposerRecenteringMethod
CallthisfromOnValidate()
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineOrbitalTransposerRecenteringStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidValidate()
CopyC# JavaScript
![Page 1279: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1279.jpg)
Cinemachine
![Page 1280: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1280.jpg)
RecenteringFields
TheCinemachineOrbitalTransposerRecenteringtypeexposesthefollowingmembers.
Fields Name Description
m_enabled Ifchecked,willenableautomaticrecenteringofthecamerabasedontheheadingcalculationmode.IfFALSE,recentingisdisabled.
m_RecenteringTime Maximumangularspeedofrecentering.Willaccelerateintoanddecelerateoutofthis
m_RecenterWaitTime Ifnoinputhasbeendetected,thecamerawillwaitthislonginsecondsbeforemovingitsheadingtothedefaultheading.
Top
SeeAlsoReferenceCinemachineOrbitalTransposerRecenteringStructureCinemachineNamespace
![Page 1281: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1281.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1282: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1282.jpg)
Cinemachine
![Page 1283: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1283.jpg)
CinemachineOrbitalTransposerRecenteringField
Ifchecked,willenableautomaticrecenteringofthecamerabasedontheheadingcalculationmode.IfFALSE,recentingisdisabled.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineOrbitalTransposerRecenteringStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Ifchecked,willenableautomaticrecenteringofthecamerabasedontheheadingdefinition.Ifunchecked,recentingisdisabled.")]
publicboolm_enabled
CopyC# JavaScript
![Page 1284: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1284.jpg)
Cinemachine
![Page 1285: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1285.jpg)
CinemachineOrbitalTransposerRecenteringField
Maximumangularspeedofrecentering.Willaccelerateintoanddecelerateoutofthis
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineOrbitalTransposerRecenteringStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Maximumangularspeedofrecentering.Willaccelerateintoanddecelerateoutofthis.")]
publicfloatm_RecenteringTime
CopyC# JavaScript
![Page 1286: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1286.jpg)
Cinemachine
![Page 1287: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1287.jpg)
CinemachineOrbitalTransposerRecenteringField
Ifnoinputhasbeendetected,thecamerawillwaitthislonginsecondsbeforemovingitsheadingtothedefaultheading.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineOrbitalTransposerRecenteringStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Ifnoinputhasbeendetected,thecamerawillwaitthislonginsecondsbeforemovingitsheadingtothezeroposition.")]
publicfloatm_RecenterWaitTime
CopyC# JavaScript
![Page 1288: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1288.jpg)
Cinemachine
![Page 1289: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1289.jpg)
CinemachinePathClass
Definesaworld-spacepath,consistingofanarrayofwaypoints,eachofwhichhasposition,tangent,androllsettings.Bezierinterpolationisperformedbetweenthewaypoints,togetasmoothandcontinuouspath.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachinePathBaseCinemachineCinemachinePath
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachinePathtypeexposesthefollowingmembers.
Constructors Name Description
[DocumentationSortingAttribute(18f,DocumentationSortingAttribute
[AddComponentMenu("Cinemachine/CinemachinePath")]
[SaveDuringPlayAttribute]
publicclassCinemachinePath:CinemachinePathBase
CopyC# JavaScript
![Page 1290: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1290.jpg)
CinemachinePath
Top
Properties Name Description
DistanceCacheSampleStepsPerSegment Whencalculatingthedistancecache,samplethepaththismanytimesbetweenpoints(OverridesCinemachinePathBase
Looped Trueifthepathendsarejoinedtoformacontinuousloop(OverridesCinemachinePathBase
MaxPos Themaximumvalueforthepathposition(OverridesCinemachinePathBase
MinPos Theminimumvalueforthepathposition(OverridesCinemachinePathBase
PathLength Getthelengthofthepathindistanceunits.isnotvalid,thencallingthiswillregenerationofthepathdistancecache(InheritedfromCinemachinePathBase
Top
Methods Name Description
DistanceCacheIsValid Seewhetherthedistancecacheisvalid.valid,thenanycalltoGetPathLength()orGetPathPositionFromDistance()willpotentiallycostlyregenerationofthepathdistancecache(InheritedfromCinemachinePathBase
![Page 1291: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1291.jpg)
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
![Page 1292: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1292.jpg)
(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
Fields Name Description
m_Appearance Thesettingsthatcontrolhowthepathwillappearintheeditorsceneview.(InheritedfromCinemachinePathBase.)
m_Looped Ifchecked,thenthepathends
![Page 1293: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1293.jpg)
arejoinedtoformacontinuousloop
m_Resolution Pathsamplesperwaypoint(InheritedfromCinemachinePathBase.)
m_Waypoints Thewaypointsthatdefinethepath.Theywillbeinterpolatedusingabeziercurve
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1294: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1294.jpg)
Cinemachine
![Page 1295: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1295.jpg)
CinemachinePathConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachinePath.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachinePathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachinePath()
CopyC# JavaScript
![Page 1296: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1296.jpg)
Cinemachine
![Page 1297: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1297.jpg)
CinemachinePathProperties
TheCinemachinePathtypeexposesthefollowingmembers.
Properties Name Description
DistanceCacheSampleStepsPerSegment Whencalculatingthedistancecache,samplethepaththismanytimesbetweenpoints(OverridesCinemachinePathBase
Looped Trueifthepathendsarejoinedtoformacontinuousloop(OverridesCinemachinePathBase
MaxPos Themaximumvalueforthepathposition(OverridesCinemachinePathBase
MinPos Theminimumvalueforthepathposition(OverridesCinemachinePathBase
PathLength Getthelengthofthepathindistanceunits.isnotvalid,thencallingthiswillregenerationofthepathdistancecache(InheritedfromCinemachinePathBase
Top
SeeAlsoReferenceCinemachinePathClassCinemachineNamespace
![Page 1298: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1298.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1299: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1299.jpg)
Cinemachine
![Page 1300: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1300.jpg)
CinemachinePathDistanceCacheSampleStepsPerSegmentProperty
Whencalculatingthedistancecache,samplethepaththismanytimesbetweenpoints
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Int32
SeeAlsoReferenceCinemachinePathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideintDistanceCacheSampleStepsPerSegment
CopyC# JavaScript
![Page 1301: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1301.jpg)
Cinemachine
![Page 1302: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1302.jpg)
CinemachinePathLoopedProperty
Trueifthepathendsarejoinedtoformacontinuousloop
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachinePathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideboolLooped{get;}
CopyC# JavaScript
![Page 1303: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1303.jpg)
Cinemachine
![Page 1304: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1304.jpg)
CinemachinePathMaxPosProperty
Themaximumvalueforthepathposition
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Single
SeeAlsoReferenceCinemachinePathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridefloatMaxPos{get;}
CopyC# JavaScript
![Page 1305: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1305.jpg)
Cinemachine
![Page 1306: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1306.jpg)
CinemachinePathMinPosProperty
Theminimumvalueforthepathposition
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Single
SeeAlsoReferenceCinemachinePathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridefloatMinPos{get;}
CopyC# JavaScript
![Page 1307: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1307.jpg)
Cinemachine
![Page 1308: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1308.jpg)
CinemachinePathMethods
TheCinemachinePathtypeexposesthefollowingmembers.
Methods Name Description
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)
![Page 1309: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1309.jpg)
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
![Page 1310: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1310.jpg)
NormalizeUnit Normalizetheunit,sothatitliesbetweenMinUmitandMaxUnit(InheritedfromCinemachinePathBase
Top
SeeAlsoReferenceCinemachinePathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1311: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1311.jpg)
Cinemachine
![Page 1312: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1312.jpg)
CinemachinePathEvaluateOrientationMethod
Gettheorientationthecurveatapointalongthepath.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
posType:SystemSinglePostionalongthepath.Neednotbenormalized.
ReturnValueType:QuaternionWorld-spaceorientationofthepath,asdefinedbytangent,up,androll.
SeeAlsoReferenceCinemachinePathClassCinemachineNamespace
VisittheCinemachineForum
publicoverrideQuaternionEvaluateOrientation(
floatpos
)
CopyC# JavaScript
![Page 1314: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1314.jpg)
Cinemachine
![Page 1315: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1315.jpg)
CinemachinePathEvaluatePositionMethod
Getaworldspacepositionofapointalongthepath
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
posType:SystemSinglePostionalongthepath.Neednotbenormalized.
ReturnValueType:Vector3World-spacepositionofthepointalongatpathatpos
SeeAlsoReferenceCinemachinePathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideVector3EvaluatePosition(
floatpos
)
CopyC# JavaScript
![Page 1316: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1316.jpg)
![Page 1317: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1317.jpg)
Cinemachine
![Page 1318: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1318.jpg)
CinemachinePathEvaluateTangentMethod
Getthetangentofthecurveatapointalongthepath.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
posType:SystemSinglePostionalongthepath.Neednotbenormalized.
ReturnValueType:Vector3World-spacedirectionofthepathtangent.Lengthofthevectorrepresentsthetangentstrength
SeeAlsoReferenceCinemachinePathClassCinemachineNamespace
VisittheCinemachineForum
publicoverrideVector3EvaluateTangent(
floatpos
)
CopyC# JavaScript
![Page 1320: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1320.jpg)
Cinemachine
![Page 1321: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1321.jpg)
CinemachinePathFields
TheCinemachinePathtypeexposesthefollowingmembers.
Fields Name Description
m_Appearance Thesettingsthatcontrolhowthepathwillappearintheeditorsceneview.(InheritedfromCinemachinePathBase.)
m_Looped Ifchecked,thenthepathendsarejoinedtoformacontinuousloop
m_Resolution Pathsamplesperwaypoint(InheritedfromCinemachinePathBase.)
m_Waypoints Thewaypointsthatdefinethepath.Theywillbeinterpolatedusingabeziercurve
Top
SeeAlsoReferenceCinemachinePathClassCinemachineNamespace
VisittheCinemachineForum
![Page 1323: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1323.jpg)
Cinemachine
![Page 1324: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1324.jpg)
CinemachinePathm_LoopedField
Ifchecked,thenthepathendsarejoinedtoformacontinuousloop
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachinePathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Ifchecked,thenthepathendsarejoinedtoformacontinuousloop.")]
publicboolm_Looped
CopyC# JavaScript
![Page 1325: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1325.jpg)
Cinemachine
![Page 1326: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1326.jpg)
CinemachinePathm_WaypointsField
Thewaypointsthatdefinethepath.Theywillbeinterpolatedusingabeziercurve
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachinePathWaypoint
SeeAlsoReferenceCinemachinePathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thewaypointsthatdefinethepath.Theywillbeinterpolatedusingabeziercurve.")]
publicCinemachinePathWaypoint[]m_Waypoints
CopyC# JavaScript
![Page 1327: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1327.jpg)
Cinemachine
![Page 1328: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1328.jpg)
CinemachinePathWaypointStructure
Awaypointalongthepath
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachinePathWaypointtypeexposesthefollowingmembers.
Fields Name Description
position Positioninpath-localspace
roll Definestherollofthepathatthiswaypoint.Theotherorientationaxesareinferredfromthetangentandworldup.
tangent Offsetfromtheposition,whichdefinesthetangentofthecurveatthewaypoint.Thelengthofthetangentencodesthestrengthofthebezierhandle.Thesamehandleisusedsymmetricallyonboth
[SerializableAttribute]
[DocumentationSortingAttribute(18.2f,DocumentationSortingAttribute
publicstructWaypoint
CopyC# JavaScript
![Page 1329: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1329.jpg)
sidesofthewaypoint,toensuresmoothness.
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1330: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1330.jpg)
Cinemachine
![Page 1331: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1331.jpg)
WaypointFields
TheCinemachinePathWaypointtypeexposesthefollowingmembers.
Fields Name Description
position Positioninpath-localspace
roll Definestherollofthepathatthiswaypoint.Theotherorientationaxesareinferredfromthetangentandworldup.
tangent Offsetfromtheposition,whichdefinesthetangentofthecurveatthewaypoint.Thelengthofthetangentencodesthestrengthofthebezierhandle.Thesamehandleisusedsymmetricallyonbothsidesofthewaypoint,toensuresmoothness.
Top
SeeAlsoReferenceCinemachinePathWaypointStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1332: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1332.jpg)
Cinemachine
![Page 1333: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1333.jpg)
CinemachinePathWaypointpositionField
Positioninpath-localspace
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Vector3
SeeAlsoReferenceCinemachinePathWaypointStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Positioninpath-localspace")]
publicVector3position
CopyC# JavaScript
![Page 1334: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1334.jpg)
Cinemachine
![Page 1335: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1335.jpg)
CinemachinePathWaypointrollField
Definestherollofthepathatthiswaypoint.Theotherorientationaxesareinferredfromthetangentandworldup.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachinePathWaypointStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Definestherollofthepathatthiswaypoint.Theotherorientationaxesareinferredfromthetangentandworldup.")]
publicfloatroll
CopyC# JavaScript
![Page 1336: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1336.jpg)
Cinemachine
![Page 1337: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1337.jpg)
CinemachinePathWaypointtangentField
Offsetfromtheposition,whichdefinesthetangentofthecurveatthewaypoint.Thelengthofthetangentencodesthestrengthofthebezierhandle.Thesamehandleisusedsymmetricallyonbothsidesofthewaypoint,toensuresmoothness.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Vector3
SeeAlsoReferenceCinemachinePathWaypointStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Offsetfromtheposition,whichdefinesthetangentofthecurveatthewaypoint.Thelengthofthetangentencodesthestrengthofthebezierhandle.Thesamehandleisusedsymmetricallyonbothsidesofthewaypoint,toensuresmoothness.")]
publicVector3tangent
CopyC# JavaScript
![Page 1338: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1338.jpg)
Cinemachine
![Page 1339: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1339.jpg)
CinemachinePathBaseClass
Abstractbaseclassforaworld-spacepath,suitableforacameradollytrack.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachinePathBaseCinemachineCinemachinePathCinemachineCinemachineSmoothPath
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachinePathBasetypeexposesthefollowingmembers.
Constructors Name Description
CinemachinePathBase
Top
publicabstractclassCinemachinePathBase:MonoBehaviour
CopyC# JavaScript
![Page 1340: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1340.jpg)
Properties Name Description
DistanceCacheSampleStepsPerSegment Whencalculatingthedistancecache,samplethepaththismanytimesbetweenpoints
Looped Trueifthepathendsarejoinedtoformacontinuousloop
MaxPos Themaximumvalueforthepathposition
MinPos Theminimumvalueforthepathposition
PathLength Getthelengthofthepathindistanceunits.Ifthe
![Page 1341: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1341.jpg)
distancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache
Top
Methods Name Description
DistanceCacheIsValid Seewhetherthedistancecacheisvalid.Ifit'snotvalid,thenanycalltoGetPathLength()orGetPathPositionFromDistance()willtriggerapotentiallycostlyregenerationofthepathdistancecache
EvaluateOrientation Gettheorientationthecurveatapointalongthepath.
EvaluateOrientationAtUnit Gettheorientationthecurveatapointalongthepath.
EvaluatePosition Getaworldspacepositionofapointalongthepath
EvaluatePositionAtUnit Getaworldspacepositionofapointalongthepath
![Page 1342: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1342.jpg)
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.
![Page 1343: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1343.jpg)
Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache
NormalizePos Getanormalizedpathposition,takingspinsintoaccountiflooped
NormalizeUnit Normalizetheunit,sothatitliesbetweenMinUmitandMaxUnit
Top
Fields Name Description
m_Appearance Thesettingsthatcontrolhowthepathwillappearintheeditorsceneview.
m_Resolution Pathsamplesperwaypoint
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1344: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1344.jpg)
Cinemachine
![Page 1345: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1345.jpg)
CinemachinePathBaseConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachinePathBase.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedCinemachinePathBase()
CopyC# JavaScript
![Page 1346: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1346.jpg)
Cinemachine
![Page 1347: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1347.jpg)
CinemachinePathBaseProperties
TheCinemachinePathBasetypeexposesthefollowingmembers.
Properties Name Description
DistanceCacheSampleStepsPerSegment Whencalculatingthedistancecache,samplethepaththismanytimesbetweenpoints
Looped Trueifthepathendsarejoinedtoformacontinuousloop
MaxPos Themaximumvalueforthepathposition
MinPos Theminimumvalueforthe
![Page 1348: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1348.jpg)
pathposition
PathLength Getthelengthofthepathindistanceunits.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache
Top
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1349: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1349.jpg)
Cinemachine
![Page 1350: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1350.jpg)
CinemachinePathBaseDistanceCacheSampleStepsPerSegmentProperty
Whencalculatingthedistancecache,samplethepaththismanytimesbetweenpoints
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Int32
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicabstractintDistanceCacheSampleStepsPerSegment
CopyC# JavaScript
![Page 1351: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1351.jpg)
Cinemachine
![Page 1352: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1352.jpg)
CinemachinePathBaseLoopedProperty
Trueifthepathendsarejoinedtoformacontinuousloop
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicabstractboolLooped{get;}
CopyC# JavaScript
![Page 1353: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1353.jpg)
Cinemachine
![Page 1354: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1354.jpg)
CinemachinePathBaseMaxPosProperty
Themaximumvalueforthepathposition
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Single
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicabstractfloatMaxPos{get;}
CopyC# JavaScript
![Page 1355: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1355.jpg)
Cinemachine
![Page 1356: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1356.jpg)
CinemachinePathBaseMinPosProperty
Theminimumvalueforthepathposition
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Single
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicabstractfloatMinPos{get;}
CopyC# JavaScript
![Page 1357: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1357.jpg)
Cinemachine
![Page 1358: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1358.jpg)
CinemachinePathBasePathLengthProperty
Getthelengthofthepathindistanceunits.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
ReturnValueType:SingleThelengthofthepathindistanceunits,whensampledatthisrate
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicfloatPathLength{get;}
CopyC# JavaScript
![Page 1359: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1359.jpg)
Cinemachine
![Page 1360: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1360.jpg)
CinemachinePathBaseMethods
TheCinemachinePathBasetypeexposesthefollowingmembers.
Methods Name Description
DistanceCacheIsValid Seewhetherthedistancecacheisvalid.Ifit'snotvalid,thenanycalltoGetPathLength()orGetPathPositionFromDistance()willtriggerapotentiallycostlyregenerationofthepathdistancecache
EvaluateOrientation Gettheorientationthecurveatapointalongthepath.
EvaluateOrientationAtUnit Gettheorientationthecurveatapointalongthepath.
EvaluatePosition Getaworldspacepositionofapointalongthepath
EvaluatePositionAtUnit Getaworldspacepositionofapointalongthepath
EvaluateTangent Getthetangentofthecurveatapointalongthepath.
EvaluateTangentAtUnit Getthetangentofthecurveatapointalongthepath.
FindClosestPoint Findtheclosestpointonthe
![Page 1361: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1361.jpg)
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,
![Page 1362: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1362.jpg)
takingspinsintoaccountiflooped
NormalizeUnit Normalizetheunit,sothatitliesbetweenMinUmitandMaxUnit
Top
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1363: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1363.jpg)
Cinemachine
![Page 1364: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1364.jpg)
CinemachinePathBaseDistanceCacheIsValidMethod
Seewhetherthedistancecacheisvalid.Ifit'snotvalid,thenanycalltoGetPathLength()orGetPathPositionFromDistance()willtriggerapotentiallycostlyregenerationofthepathdistancecache
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
ReturnValueType:BooleanWhetherthecacheisvalidforthissamplingrate
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicboolDistanceCacheIsValid()
CopyC# JavaScript
![Page 1365: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1365.jpg)
Cinemachine
![Page 1366: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1366.jpg)
CinemachinePathBaseEvaluateOrientationMethod
Gettheorientationthecurveatapointalongthepath.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
posType:SystemSinglePostionalongthepath.Neednotbenormalized.
ReturnValueType:QuaternionWorld-spaceorientationofthepath
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicabstractQuaternionEvaluateOrientation(
floatpos
)
CopyC# JavaScript
![Page 1367: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1367.jpg)
![Page 1368: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1368.jpg)
Cinemachine
![Page 1369: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1369.jpg)
CinemachinePathBaseEvaluateOrientationAtUnitMethod
Gettheorientationthecurveatapointalongthepath.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
posType:SystemSinglePostionalongthepath.Neednotbenormalized.
unitsType:CinemachineCinemachinePathBasePositionUnitsTheunittousewheninterpretingthevalueofpos.
ReturnValueType:QuaternionWorld-spaceorientationofthepath
SeeAlsoReferenceCinemachinePathBaseClass
publicQuaternionEvaluateOrientationAtUnit(
floatpos,
CinemachinePathBasePositionUnitsunits
)
CopyC# JavaScript
![Page 1370: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1370.jpg)
CinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1371: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1371.jpg)
Cinemachine
![Page 1372: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1372.jpg)
CinemachinePathBaseEvaluatePositionMethod
Getaworldspacepositionofapointalongthepath
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
posType:SystemSinglePostionalongthepath.Neednotbenormalized.
ReturnValueType:Vector3World-spacepositionofthepointalongatpathatpos
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicabstractVector3EvaluatePosition(
floatpos
)
CopyC# JavaScript
![Page 1373: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1373.jpg)
![Page 1374: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1374.jpg)
Cinemachine
![Page 1375: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1375.jpg)
CinemachinePathBaseEvaluatePositionAtUnitMethod
Getaworldspacepositionofapointalongthepath
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
posType:SystemSinglePostionalongthepath.Neednotbenormalized.
unitsType:CinemachineCinemachinePathBasePositionUnitsTheunittousewheninterpretingthevalueofpos.
ReturnValueType:Vector3World-spacepositionofthepointalongatpathatpos
SeeAlsoReferenceCinemachinePathBaseClass
publicVector3EvaluatePositionAtUnit(
floatpos,
CinemachinePathBasePositionUnitsunits
)
CopyC# JavaScript
![Page 1376: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1376.jpg)
CinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1377: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1377.jpg)
Cinemachine
![Page 1378: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1378.jpg)
CinemachinePathBaseEvaluateTangentMethod
Getthetangentofthecurveatapointalongthepath.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
posType:SystemSinglePostionalongthepath.Neednotbenormalized.
ReturnValueType:Vector3World-spacedirectionofthepathtangent.Lengthofthevectorrepresentsthetangentstrength
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForum
publicabstractVector3EvaluateTangent(
floatpos
)
CopyC# JavaScript
![Page 1380: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1380.jpg)
Cinemachine
![Page 1381: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1381.jpg)
CinemachinePathBaseEvaluateTangentAtUnitMethod
Getthetangentofthecurveatapointalongthepath.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
posType:SystemSinglePostionalongthepath.Neednotbenormalized.
unitsType:CinemachineCinemachinePathBasePositionUnitsTheunittousewheninterpretingthevalueofpos.
ReturnValueType:Vector3World-spacedirectionofthepathtangent.Lengthofthevectorrepresentsthetangentstrength
SeeAlsoReference
publicVector3EvaluateTangentAtUnit(
floatpos,
CinemachinePathBasePositionUnitsunits
)
CopyC# JavaScript
![Page 1382: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1382.jpg)
CinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1383: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1383.jpg)
Cinemachine
![Page 1384: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1384.jpg)
CinemachinePathBaseFindClosestPointMethod
Findtheclosestpointonthepathtoagivenworldspacetargetpoint.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
pType:Vector3Worldspacetargetthatwewanttoapproach
startSegmentType:SystemInt32Inwhatsegmentofthepathtostartthesearch.ASegmentisasectionofpathbetween2waypoints.
searchRadiusType:SystemInt32HowmanysegmentsoneithersideofthestartSegmenttosearch.-1meansnolimit,i.e.searchtheentirepath
stepsPerSegmentType:SystemInt32
publicvirtualfloatFindClosestPoint(
Vector3p,
intstartSegment,
intsearchRadius,
intstepsPerSegment
)
CopyC# JavaScript
![Page 1385: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1385.jpg)
Wesearchasegmentbydividingitintothismanystraightpieces.Thehigherthenumber,themoreaccuratetheresult,butperformanceisproportionallyslowerforhighernumbers
ReturnValueType:SingleThepositionalongthepaththatisclosesttothetargetpoint.ThevalueisinPathUnits,notDistanceunits.
RemarksPerformancecouldbeimprovedbycheckingtheboundingpolygonofeachsegment,andonlyenteringthebestsegment(s)
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1386: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1386.jpg)
Cinemachine
![Page 1387: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1387.jpg)
CinemachinePathBaseGetPathDistanceFromPositionMethod
Getthepathposition(inpathunits)correspondingtothisdistancealongthepath.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
posType:SystemSingle[Missing<paramname="pos"/>documentationfor"M:Cinemachine.CinemachinePathBase.GetPathDistanceFromPosition(System.Single)"]
ReturnValueType:SingleThelengthofthepathindistanceunits,whensampledatthisrate
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
publicfloatGetPathDistanceFromPosition(
floatpos
)
CopyC# JavaScript
![Page 1388: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1388.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1389: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1389.jpg)
Cinemachine
![Page 1390: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1390.jpg)
CinemachinePathBaseGetPathPositionFromDistanceMethod
Getthepathposition(inpathunits)correspondingtothisdistancealongthepath.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
distanceType:SystemSingle[Missing<paramname="distance"/>documentationfor"M:Cinemachine.CinemachinePathBase.GetPathPositionFromDistance(System.Single)"]
ReturnValueType:SingleThelengthofthepathindistanceunits,whensampledatthisrate
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
publicfloatGetPathPositionFromDistance(
floatdistance
)
CopyC# JavaScript
![Page 1391: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1391.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1392: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1392.jpg)
Cinemachine
![Page 1393: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1393.jpg)
CinemachinePathBaseInvalidateDistanceCacheMethod
Callthisifthepathchangesinsuchawayastoaffectdistancesorothercachedpathelements
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvirtualvoidInvalidateDistanceCache()
CopyC# JavaScript
![Page 1394: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1394.jpg)
Cinemachine
![Page 1395: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1395.jpg)
CinemachinePathBaseMaxUnitMethod
Getthemaximumvalue,forthegivenunitytype
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
unitsType:CinemachineCinemachinePathBasePositionUnitsTheuniottype
ReturnValueType:SingleThemaximumallowablevalueforthispath
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicfloatMaxUnit(
CinemachinePathBasePositionUnitsunits
)
CopyC# JavaScript
![Page 1396: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1396.jpg)
![Page 1397: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1397.jpg)
Cinemachine
![Page 1398: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1398.jpg)
CinemachinePathBaseMinUnitMethod
Gettheminimumvalue,forthegivenunitytype
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
unitsType:CinemachineCinemachinePathBasePositionUnitsTheuniottype
ReturnValueType:SingleTheminimumallowablevalueforthispath
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicfloatMinUnit(
CinemachinePathBasePositionUnitsunits
)
CopyC# JavaScript
![Page 1399: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1399.jpg)
![Page 1400: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1400.jpg)
Cinemachine
![Page 1401: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1401.jpg)
CinemachinePathBaseNormalizePathDistanceMethod
Normalizeadistancealongthepathbasedonthepathlength.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
distanceType:SystemSingleThedistancetonormalize
ReturnValueType:SingleThenormalizeddistance,rangingfrom0topathlength
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
publicfloatNormalizePathDistance(
floatdistance
)
CopyC# JavaScript
![Page 1402: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1402.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1403: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1403.jpg)
Cinemachine
![Page 1404: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1404.jpg)
CinemachinePathBaseNormalizePosMethod
Getanormalizedpathposition,takingspinsintoaccountiflooped
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
posType:SystemSinglePositionalongthepath
ReturnValueType:SingleNormalizedposition,betweenMinPosandMaxPos
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvirtualfloatNormalizePos(
floatpos
)
CopyC# JavaScript
![Page 1405: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1405.jpg)
![Page 1406: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1406.jpg)
Cinemachine
![Page 1407: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1407.jpg)
CinemachinePathBaseNormalizeUnitMethod
Normalizetheunit,sothatitliesbetweenMinUmitandMaxUnit
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
posType:SystemSingleThevaluetobenormalized
unitsType:CinemachineCinemachinePathBasePositionUnitsTheunittype
ReturnValueType:SingleThenormalizedvalueofpos,betweenMinUnitandMaxUnit
SeeAlsoReferenceCinemachinePathBaseClass
publicvirtualfloatNormalizeUnit(
floatpos,
CinemachinePathBasePositionUnitsunits
)
CopyC# JavaScript
![Page 1408: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1408.jpg)
CinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1409: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1409.jpg)
Cinemachine
![Page 1410: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1410.jpg)
CinemachinePathBaseFields
TheCinemachinePathBasetypeexposesthefollowingmembers.
Fields Name Description
m_Appearance Thesettingsthatcontrolhowthepathwillappearintheeditorsceneview.
m_Resolution Pathsamplesperwaypoint
Top
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1411: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1411.jpg)
Cinemachine
![Page 1412: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1412.jpg)
CinemachinePathBasem_AppearanceField
Thesettingsthatcontrolhowthepathwillappearintheeditorsceneview.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachinePathBaseAppearance
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thesettingsthatcontrolhowthepathwillappearintheeditorsceneview.")]
publicCinemachinePathBaseAppearancem_Appearance
CopyC# JavaScript
![Page 1413: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1413.jpg)
Cinemachine
![Page 1414: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1414.jpg)
CinemachinePathBasem_ResolutionField
Pathsamplesperwaypoint
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Int32
SeeAlsoReferenceCinemachinePathBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Pathsamplesperwaypoint.Thisisusedforcalculatingpathdistances.")]
[RangeAttribute(1f,100f)]
publicintm_Resolution
CopyC# JavaScript
![Page 1415: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1415.jpg)
Cinemachine
![Page 1416: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1416.jpg)
CinemachinePathBaseAppearanceClass
Thisclassholdsthesettingsthatcontrolhowthepathwillappearintheeditorsceneview.Thepathisnotvisibleinthegameview
InheritanceHierarchySystemObjectCinemachineCinemachinePathBaseAppearance
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachinePathBaseAppearancetypeexposesthefollowingmembers.
Constructors Name Description
CinemachinePathBaseAppearance
Top
Fields
[SerializableAttribute]
[DocumentationSortingAttribute(18.1f,DocumentationSortingAttribute
publicclassAppearance
CopyC# JavaScript
![Page 1417: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1417.jpg)
Name Description
inactivePathColor
pathColor
width
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1418: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1418.jpg)
Cinemachine
![Page 1419: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1419.jpg)
CinemachinePathBaseAppearanceConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachinePathBase.Appearance.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachinePathBaseAppearanceClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicAppearance()
CopyC# JavaScript
![Page 1420: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1420.jpg)
Cinemachine
![Page 1421: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1421.jpg)
AppearanceFields
TheCinemachinePathBaseAppearancetypeexposesthefollowingmembers.
Fields Name Description
inactivePathColor
pathColor
width
Top
SeeAlsoReferenceCinemachinePathBaseAppearanceClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1422: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1422.jpg)
Cinemachine
![Page 1423: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1423.jpg)
CinemachinePathBaseAppearanceinactivePathColorField
[Missing<summary>documentationfor"F:Cinemachine.CinemachinePathBase.Appearance.inactivePathColor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Color
SeeAlsoReferenceCinemachinePathBaseAppearanceClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thecolorofthepathitselfwhenitisinactiveintheeditor")]
publicColorinactivePathColor
CopyC# JavaScript
![Page 1424: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1424.jpg)
Cinemachine
![Page 1425: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1425.jpg)
CinemachinePathBaseAppearancepathColorField
[Missing<summary>documentationfor"F:Cinemachine.CinemachinePathBase.Appearance.pathColor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Color
SeeAlsoReferenceCinemachinePathBaseAppearanceClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thecolorofthepathitselfwhenitisactiveintheeditor")]
publicColorpathColor
CopyC# JavaScript
![Page 1426: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1426.jpg)
Cinemachine
![Page 1427: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1427.jpg)
CinemachinePathBaseAppearancewidthField
[Missing<summary>documentationfor"F:Cinemachine.CinemachinePathBase.Appearance.width"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachinePathBaseAppearanceClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thewidthoftherailroad-tracksthataredrawntorepresentthepath")]
[RangeAttribute(0f,10f)]
publicfloatwidth
CopyC# JavaScript
![Page 1428: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1428.jpg)
Cinemachine
![Page 1429: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1429.jpg)
CinemachinePathBasePositionUnitsEnumeration
HowtointerpretthePathPosition
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members
Membername Value Description
PathUnits 0 UsePathPositionunits,where0isfirstwaypoint,1issecondwaypoint,etc
Distance 1 UseDistanceAlongPath.PathwillbesampledaccordingtoitsResolutionsetting,andadistancelookuptablewillbecachedinternally
SeeAlsoReference
publicenumPositionUnits
CopyC# JavaScript
![Page 1430: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1430.jpg)
CinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1431: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1431.jpg)
Cinemachine
![Page 1432: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1432.jpg)
CinemachinePipelineClass
InternalcontainerforCinemachineComponentBase.Doesnothingbutcontain.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachinePipeline
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachinePipelinetypeexposesthefollowingmembers.
Constructors Name Description
CinemachinePipeline
Top
SeeAlso
[AddComponentMenu("")]
publicsealedclassCinemachinePipeline:MonoBehaviour
CopyC# JavaScript
![Page 1433: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1433.jpg)
ReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1434: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1434.jpg)
Cinemachine
![Page 1435: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1435.jpg)
CinemachinePipelineConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachinePipeline.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachinePipelineClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachinePipeline()
CopyC# JavaScript
![Page 1436: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1436.jpg)
Cinemachine
![Page 1437: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1437.jpg)
CinemachinePOVClass
ThisisaCinemachineComponentintheAimsectionofthecomponentpipeline.Itsjobistoaimthecamerainresponsetotheuser'smouseorjoystickinput.Thecomposerdoesnotchangethecamera'sposition.Itwillonlypanandtiltthecamerawhereitis,inordertogetthedesiredframing.Tomovethecamera,youhavetousethevirtualcamera'sBodysection.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachinePOV
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachinePOVtypeexposesthefollowingmembers.
Constructors
[DocumentationSortingAttribute(23f,DocumentationSortingAttribute
[AddComponentMenu("")]
[RequireComponent(typeof(CinemachinePipeline))]
[SaveDuringPlayAttribute]
publicclassCinemachinePOV:CinemachineComponentBase
CopyC# JavaScript
![Page 1438: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1438.jpg)
Name Description
CinemachinePOV
Top
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
IsValid TrueifcomponentisenabledandhasaLookAtdefined(OverridesCinemachineComponentBaseIsValid.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage(OverridesCinemachineComponentBaseStage.)
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(Inheritedfrom
![Page 1439: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1439.jpg)
CinemachineComponentBase.)
Top
Methods Name Description
MutateCameraState Appliestheaxisvaluesandorientsthecameraaccordingly(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.classimplementationdoesnothing.(InheritedfromCinemachineComponentBase
Top
Fields Name Description
m_HorizontalAxis TheHorizontalaxis.Valueis-180..180.Controlsthehorizontalorientation
m_VerticalAxis TheVerticalaxis.Valueis-90..90.Controlstheverticalorientation
Top
SeeAlsoReferenceCinemachineNamespace
![Page 1440: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1440.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1441: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1441.jpg)
Cinemachine
![Page 1442: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1442.jpg)
CinemachinePOVConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachinePOV.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachinePOVClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachinePOV()
CopyC# JavaScript
![Page 1443: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1443.jpg)
Cinemachine
![Page 1444: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1444.jpg)
CinemachinePOVProperties
TheCinemachinePOVtypeexposesthefollowingmembers.
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
IsValid TrueifcomponentisenabledandhasaLookAtdefined(OverridesCinemachineComponentBaseIsValid.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage(OverridesCinemachineComponentBaseStage.)
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase
![Page 1445: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1445.jpg)
(InheritedfromCinemachineComponentBase.)
Top
SeeAlsoReferenceCinemachinePOVClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1446: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1446.jpg)
Cinemachine
![Page 1447: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1447.jpg)
CinemachinePOVIsValidProperty
TrueifcomponentisenabledandhasaLookAtdefined
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachinePOVClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideboolIsValid{get;}
CopyC# JavaScript
![Page 1448: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1448.jpg)
Cinemachine
![Page 1449: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1449.jpg)
CinemachinePOVStageProperty
GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheAimstage
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineCoreStage
SeeAlsoReferenceCinemachinePOVClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideCinemachineCoreStageStage{get;}
CopyC# JavaScript
![Page 1450: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1450.jpg)
Cinemachine
![Page 1451: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1451.jpg)
CinemachinePOVMethods
TheCinemachinePOVtypeexposesthefollowingmembers.
Methods Name Description
MutateCameraState Appliestheaxisvaluesandorientsthecameraaccordingly(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.classimplementationdoesnothing.(InheritedfromCinemachineComponentBase
Top
SeeAlsoReferenceCinemachinePOVClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1452: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1452.jpg)
Cinemachine
![Page 1453: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1453.jpg)
CinemachinePOVMutateCameraStateMethod
Appliestheaxisvaluesandorientsthecameraaccordingly
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
curStateType:CinemachineCameraStateThecurrentcamerastate
deltaTimeType:SystemSingleUsedforcalculatingdamping.Notused.
SeeAlsoReferenceCinemachinePOVClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridevoidMutateCameraState(
refCameraStatecurState,
floatdeltaTime
)
CopyC# JavaScript
![Page 1454: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1454.jpg)
![Page 1455: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1455.jpg)
Cinemachine
![Page 1456: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1456.jpg)
CinemachinePOVFields
TheCinemachinePOVtypeexposesthefollowingmembers.
Fields Name Description
m_HorizontalAxis TheHorizontalaxis.Valueis-180..180.Controlsthehorizontalorientation
m_VerticalAxis TheVerticalaxis.Valueis-90..90.Controlstheverticalorientation
Top
SeeAlsoReferenceCinemachinePOVClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1457: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1457.jpg)
Cinemachine
![Page 1458: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1458.jpg)
CinemachinePOVm_HorizontalAxisField
TheHorizontalaxis.Valueis-180..180.Controlsthehorizontalorientation
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:AxisState
SeeAlsoReferenceCinemachinePOVClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("TheHorizontalaxis.Valueis-180..180.Controlsthehorizontalorientation")]
publicAxisStatem_HorizontalAxis
CopyC# JavaScript
![Page 1459: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1459.jpg)
Cinemachine
![Page 1460: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1460.jpg)
CinemachinePOVm_VerticalAxisField
TheVerticalaxis.Valueis-90..90.Controlstheverticalorientation
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:AxisState
SeeAlsoReferenceCinemachinePOVClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("TheVerticalaxis.Valueis-90..90.Controlstheverticalorientation")]
publicAxisStatem_VerticalAxis
CopyC# JavaScript
![Page 1461: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1461.jpg)
Cinemachine
![Page 1462: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1462.jpg)
CinemachineSmoothPathClass
Definesaworld-spacepath,consistingofanarrayofwaypoints,eachofwhichhaspositionandrollsettings.Bezierinterpolationisperformedbetweenthewaypoints,togetasmoothandcontinuouspath.Thepathwillpassthroughallwaypoints,and(unlikeCinemachinePath)firstandsecondordercontinuityisguaranteed
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachinePathBaseCinemachineCinemachineSmoothPath
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineSmoothPathtypeexposesthefollowingmembers.
Constructors Name Description
[DocumentationSortingAttribute(18.5f,DocumentationSortingAttribute
[AddComponentMenu("Cinemachine/CinemachineSmoothPath")]
[SaveDuringPlayAttribute]
publicclassCinemachineSmoothPath:CinemachinePathBase
CopyC# JavaScript
![Page 1463: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1463.jpg)
CinemachineSmoothPath
Top
Properties Name Description
DistanceCacheSampleStepsPerSegment Whencalculatingthedistancecache,samplethepaththismanytimesbetweenpoints(OverridesCinemachinePathBase
Looped Trueifthepathendsarejoinedtoformacontinuousloop(OverridesCinemachinePathBase
MaxPos Themaximumvalueforthepathposition(OverridesCinemachinePathBase
MinPos Theminimumvalueforthepathposition(OverridesCinemachinePathBase
PathLength Getthelengthofthepathindistanceunits.isnotvalid,thencallingthiswillregenerationofthepathdistancecache(InheritedfromCinemachinePathBase
Top
Methods Name Description
DistanceCacheIsValid Seewhetherthedistancecacheisvalid.valid,thenanycalltoGetPathLength()orGetPathPositionFromDistance()willpotentiallycostlyregenerationofthepathdistancecache(InheritedfromCinemachinePathBase
![Page 1464: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1464.jpg)
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
![Page 1465: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1465.jpg)
(InheritedfromCinemachinePathBase
InvalidateDistanceCache Callthisifthepathchangesinsuchawayastoaffectdistancesorothercachedpathelements(OverridesCinemachinePathBaseInvalidateDistanceCache
MaxUnit Getthemaximumvalue,forthegivenunitytype(InheritedfromCinemachinePathBase
MinUnit Gettheminimumvalue,forthegivenunitytype(InheritedfromCinemachinePathBase
NormalizePathDistance Normalizeadistancealongthepathbasedonthepathlength.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache(InheritedfromCinemachinePathBase
NormalizePos Getanormalizedpathposition,takingspinsintoaccountiflooped(InheritedfromCinemachinePathBase
NormalizeUnit Normalizetheunit,sothatitliesbetweenMinUmitandMaxUnit(InheritedfromCinemachinePathBase
Top
Fields Name Description
m_Appearance Thesettingsthatcontrolhowthepathwillappearintheeditorsceneview.(InheritedfromCinemachinePathBase.)
![Page 1466: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1466.jpg)
m_Looped Ifchecked,thenthepathendsarejoinedtoformacontinuousloop
m_Resolution Pathsamplesperwaypoint(InheritedfromCinemachinePathBase.)
m_Waypoints Thewaypointsthatdefinethepath.Theywillbeinterpolatedusingabeziercurve
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1467: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1467.jpg)
Cinemachine
![Page 1468: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1468.jpg)
CinemachineSmoothPathConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineSmoothPath.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineSmoothPathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineSmoothPath()
CopyC# JavaScript
![Page 1469: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1469.jpg)
Cinemachine
![Page 1470: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1470.jpg)
CinemachineSmoothPathProperties
TheCinemachineSmoothPathtypeexposesthefollowingmembers.
Properties Name Description
DistanceCacheSampleStepsPerSegment Whencalculatingthedistancecache,samplethepaththismanytimesbetweenpoints(OverridesCinemachinePathBase
Looped Trueifthepathendsarejoinedtoformacontinuousloop(OverridesCinemachinePathBase
MaxPos Themaximumvalueforthepathposition(OverridesCinemachinePathBase
MinPos Theminimumvalueforthepathposition(OverridesCinemachinePathBase
PathLength Getthelengthofthepathindistanceunits.isnotvalid,thencallingthiswillregenerationofthepathdistancecache(InheritedfromCinemachinePathBase
Top
SeeAlsoReferenceCinemachineSmoothPathClass
![Page 1471: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1471.jpg)
CinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1472: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1472.jpg)
Cinemachine
![Page 1473: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1473.jpg)
CinemachineSmoothPathDistanceCacheSampleStepsPerSegmentProperty
Whencalculatingthedistancecache,samplethepaththismanytimesbetweenpoints
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Int32
SeeAlsoReferenceCinemachineSmoothPathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideintDistanceCacheSampleStepsPerSegment
CopyC# JavaScript
![Page 1474: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1474.jpg)
Cinemachine
![Page 1475: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1475.jpg)
CinemachineSmoothPathLoopedProperty
Trueifthepathendsarejoinedtoformacontinuousloop
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineSmoothPathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideboolLooped{get;}
CopyC# JavaScript
![Page 1476: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1476.jpg)
Cinemachine
![Page 1477: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1477.jpg)
CinemachineSmoothPathMaxPosProperty
Themaximumvalueforthepathposition
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Single
SeeAlsoReferenceCinemachineSmoothPathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridefloatMaxPos{get;}
CopyC# JavaScript
![Page 1478: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1478.jpg)
Cinemachine
![Page 1479: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1479.jpg)
CinemachineSmoothPathMinPosProperty
Theminimumvalueforthepathposition
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Single
SeeAlsoReferenceCinemachineSmoothPathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridefloatMinPos{get;}
CopyC# JavaScript
![Page 1480: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1480.jpg)
Cinemachine
![Page 1481: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1481.jpg)
CinemachineSmoothPathMethods
TheCinemachineSmoothPathtypeexposesthefollowingmembers.
Methods Name Description
DistanceCacheIsValid Seewhetherthedistancecacheisvalid.valid,thenanycalltoGetPathLength()orGetPathPositionFromDistance()willpotentiallycostlyregenerationofthepathdistancecache(InheritedfromCinemachinePathBase
EvaluateOrientation Gettheorientationthecurveatapointalongthepath.(OverridesCinemachinePathBaseEvaluateOrientation(Single)
EvaluateOrientationAtUnit Gettheorientationthecurveatapointalongthepath.(InheritedfromCinemachinePathBase
EvaluatePosition Getaworldspacepositionofapointalongthepath(OverridesCinemachinePathBaseEvaluatePosition(Single)
EvaluatePositionAtUnit Getaworldspacepositionofapointalongthepath(InheritedfromCinemachinePathBase
EvaluateTangent Getthetangentofthecurveatapointalongthepath.(Overrides
![Page 1482: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1482.jpg)
CinemachinePathBaseEvaluateTangent(Single)
EvaluateTangentAtUnit Getthetangentofthecurveatapointalongthepath.(InheritedfromCinemachinePathBase
FindClosestPoint Findtheclosestpointonthepathtoagivenworldspacetargetpoint.(InheritedfromCinemachinePathBase
GetPathDistanceFromPosition Getthepathposition(inpathunits)correspondingtothisdistancealongthepath.isnotvalid,thencallingthiswillcostlyregenerationofthepathdistancecache(InheritedfromCinemachinePathBase
GetPathPositionFromDistance Getthepathposition(inpathunits)correspondingtothisdistancealongthepath.isnotvalid,thencallingthiswillcostlyregenerationofthepathdistancecache(InheritedfromCinemachinePathBase
InvalidateDistanceCache Callthisifthepathchangesinsuchawayastoaffectdistancesorothercachedpathelements(OverridesCinemachinePathBaseInvalidateDistanceCache
MaxUnit Getthemaximumvalue,forthegivenunitytype(InheritedfromCinemachinePathBase
MinUnit Gettheminimumvalue,forthegivenunitytype(InheritedfromCinemachinePathBase
NormalizePathDistance Normalizeadistancealongthepathbasedonthepathlength.Ifthedistancecacheisnotvalid,thencallingthiswilltriggerapotentiallycostlyregenerationofthepathdistancecache(InheritedfromCinemachinePathBase
![Page 1483: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1483.jpg)
NormalizePos Getanormalizedpathposition,takingspinsintoaccountiflooped(InheritedfromCinemachinePathBase
NormalizeUnit Normalizetheunit,sothatitliesbetweenMinUmitandMaxUnit(InheritedfromCinemachinePathBase
Top
SeeAlsoReferenceCinemachineSmoothPathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1484: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1484.jpg)
Cinemachine
![Page 1485: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1485.jpg)
CinemachineSmoothPathEvaluateOrientationMethod
Gettheorientationthecurveatapointalongthepath.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
posType:SystemSinglePostionalongthepath.Neednotbenormalized.
ReturnValueType:QuaternionWorld-spaceorientationofthepath,asdefinedbytangent,up,androll.
SeeAlsoReferenceCinemachineSmoothPathClassCinemachineNamespace
VisittheCinemachineForum
publicoverrideQuaternionEvaluateOrientation(
floatpos
)
CopyC# JavaScript
![Page 1487: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1487.jpg)
Cinemachine
![Page 1488: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1488.jpg)
CinemachineSmoothPathEvaluatePositionMethod
Getaworldspacepositionofapointalongthepath
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
posType:SystemSinglePostionalongthepath.Neednotbenormalized.
ReturnValueType:Vector3World-spacepositionofthepointalongatpathatpos
SeeAlsoReferenceCinemachineSmoothPathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideVector3EvaluatePosition(
floatpos
)
CopyC# JavaScript
![Page 1489: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1489.jpg)
![Page 1490: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1490.jpg)
Cinemachine
![Page 1491: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1491.jpg)
CinemachineSmoothPathEvaluateTangentMethod
Getthetangentofthecurveatapointalongthepath.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
posType:SystemSinglePostionalongthepath.Neednotbenormalized.
ReturnValueType:Vector3World-spacedirectionofthepathtangent.Lengthofthevectorrepresentsthetangentstrength
SeeAlsoReferenceCinemachineSmoothPathClassCinemachineNamespace
VisittheCinemachineForum
publicoverrideVector3EvaluateTangent(
floatpos
)
CopyC# JavaScript
![Page 1493: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1493.jpg)
Cinemachine
![Page 1494: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1494.jpg)
CinemachineSmoothPathInvalidateDistanceCacheMethod
Callthisifthepathchangesinsuchawayastoaffectdistancesorothercachedpathelements
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineSmoothPathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridevoidInvalidateDistanceCache()
CopyC# JavaScript
![Page 1495: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1495.jpg)
Cinemachine
![Page 1496: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1496.jpg)
CinemachineSmoothPathFields
TheCinemachineSmoothPathtypeexposesthefollowingmembers.
Fields Name Description
m_Appearance Thesettingsthatcontrolhowthepathwillappearintheeditorsceneview.(InheritedfromCinemachinePathBase.)
m_Looped Ifchecked,thenthepathendsarejoinedtoformacontinuousloop
m_Resolution Pathsamplesperwaypoint(InheritedfromCinemachinePathBase.)
m_Waypoints Thewaypointsthatdefinethepath.Theywillbeinterpolatedusingabeziercurve
Top
SeeAlsoReferenceCinemachineSmoothPathClassCinemachineNamespace
VisittheCinemachineForum
![Page 1498: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1498.jpg)
Cinemachine
![Page 1499: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1499.jpg)
CinemachineSmoothPathm_LoopedField
Ifchecked,thenthepathendsarejoinedtoformacontinuousloop
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineSmoothPathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Ifchecked,thenthepathendsarejoinedtoformacontinuousloop.")]
publicboolm_Looped
CopyC# JavaScript
![Page 1500: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1500.jpg)
Cinemachine
![Page 1501: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1501.jpg)
CinemachineSmoothPathm_WaypointsField
Thewaypointsthatdefinethepath.Theywillbeinterpolatedusingabeziercurve
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineSmoothPathWaypoint
SeeAlsoReferenceCinemachineSmoothPathClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thewaypointsthatdefinethepath.Theywillbeinterpolatedusingabeziercurve.")]
publicCinemachineSmoothPathWaypoint[]m_Waypoints
CopyC# JavaScript
![Page 1502: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1502.jpg)
Cinemachine
![Page 1503: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1503.jpg)
CinemachineSmoothPathWaypointStructure
Awaypointalongthepath
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineSmoothPathWaypointtypeexposesthefollowingmembers.
Fields Name Description
position Positioninpath-localspace
roll Definestherollofthepathatthiswaypoint.Theotherorientationaxesareinferredfromthetangentandworldup.
Top
SeeAlso
[SerializableAttribute]
[DocumentationSortingAttribute(18.7f,DocumentationSortingAttribute
publicstructWaypoint
CopyC# JavaScript
![Page 1504: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1504.jpg)
ReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1505: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1505.jpg)
Cinemachine
![Page 1506: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1506.jpg)
WaypointFields
TheCinemachineSmoothPathWaypointtypeexposesthefollowingmembers.
Fields Name Description
position Positioninpath-localspace
roll Definestherollofthepathatthiswaypoint.Theotherorientationaxesareinferredfromthetangentandworldup.
Top
SeeAlsoReferenceCinemachineSmoothPathWaypointStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1507: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1507.jpg)
Cinemachine
![Page 1508: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1508.jpg)
CinemachineSmoothPathWaypointpositionField
Positioninpath-localspace
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Vector3
SeeAlsoReferenceCinemachineSmoothPathWaypointStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Positioninpath-localspace")]
publicVector3position
CopyC# JavaScript
![Page 1509: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1509.jpg)
Cinemachine
![Page 1510: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1510.jpg)
CinemachineSmoothPathWaypointrollField
Definestherollofthepathatthiswaypoint.Theotherorientationaxesareinferredfromthetangentandworldup.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineSmoothPathWaypointStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Definestherollofthepathatthiswaypoint.Theotherorientationaxesareinferredfromthetangentandworldup.")]
publicfloatroll
CopyC# JavaScript
![Page 1511: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1511.jpg)
Cinemachine
![Page 1512: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1512.jpg)
CinemachineStateDrivenCameraClass
Thisisavirtualcamera"manager"thatownsandmanagesacollectionofchildVirtualCameras.Thesechildvcamsaremappedtoindividualstatesinananimationstatemachine,allowingyoutoassociatespecificvcamstospecificanimationstates.Whenthatstateisactiveinthestatemachine,thentheassociatedcamerawillbeactivated.Youcandefinecustomblendsandtransitionsbetweenchildcameras.Inordertousethisbehaviour,youmusthaveananimatedtarget(i.e.anobjectanimatedwithastatemachine)todrivethebehaviour.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineStateDrivenCamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
[DocumentationSortingAttribute(13f,DocumentationSortingAttribute
[ExecuteInEditMode]
[DisallowMultipleComponent]
[AddComponentMenu("Cinemachine/CinemachineStateDrivenCamera")]
publicclassCinemachineStateDrivenCamera:CinemachineVirtualCameraBase
CopyC# JavaScript
![Page 1513: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1513.jpg)
TheCinemachineStateDrivenCameratypeexposesthefollowingmembers.
Properties Name Description
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-nullandnospecificLookAtdefinedforthiscamera(OverridesCinemachineVirtualCameraBase
Name GetthenameoftheVirtualCamera.implementationreturnstheownerGameObject's
![Page 1514: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1514.jpg)
name.(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
Methods Name Description
![Page 1515: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1515.jpg)
AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.pipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
CreateFakeHashName APIfortheinspectoreditor.implementnestedstate
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 Notificationthatthisvirtualcameraisgoinglive.(InheritedfromCinemachineVirtualCameraBase
OnValidate Enforceboundsforfields,whenchangedininspector.basemethodiscalled,ValidatingStreamVersionwillbevalid.(InheritedfromCinemachineVirtualCameraBase
![Page 1516: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1516.jpg)
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
Fields Name Description
CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.(InheritedfromCinemachineVirtualCameraBase
![Page 1517: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1517.jpg)
m_AnimatedTarget Thestatemachinewhosestatechangeswilldrivethiscamera'schoiceofactivechild
m_CustomBlends Thisistheassetwhichcontainscustomsettingsforspecificchildblends.
m_DefaultBlend Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCamerachildren.
m_EnableAllChildCameras Forceallchildcamerastobeenabled.ThisisusefulifanimatingtheminTimeline,butconsumesextraresources.
m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_Follow Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildrig.Maybeempty
m_Instructions Thesetofinstructionsassociatingvirtualcameraswithstates.Theseinstructionsareusedtochoosethelivechildatanygivenmoment
m_LayerIndex WhichlayerinthetargetFSMtoobserve
m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspector
![Page 1518: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1518.jpg)
UI.(InheritedfromCinemachineVirtualCameraBase
m_LookAt Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildrig.Maybeempty
m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase
m_ShowDebugText Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging
OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
Top
SeeAlsoReferenceCinemachineNamespace
![Page 1519: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1519.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1520: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1520.jpg)
Cinemachine
![Page 1521: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1521.jpg)
CinemachineStateDrivenCameraProperties
TheCinemachineStateDrivenCameratypeexposesthefollowingmembers.
Properties Name Description
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.
![Page 1522: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1522.jpg)
LookAtifparentisnon-nullandnospecificLookAtdefinedforthiscamera(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
![Page 1523: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1523.jpg)
Top
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1524: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1524.jpg)
Cinemachine
![Page 1525: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1525.jpg)
CinemachineStateDrivenCameraChildCamerasProperty
Thelistofchildcameras.Thesearejusttheimmediatechildreninthehierarchy.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineVirtualCameraBase
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineVirtualCameraBase[]ChildCameras{
CopyC# JavaScript
![Page 1526: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1526.jpg)
Cinemachine
![Page 1527: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1527.jpg)
CinemachineStateDrivenCameraDescriptionProperty
Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:StringImplementsICinemachineCameraDescription
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridestringDescription{get;}
CopyC# JavaScript
![Page 1528: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1528.jpg)
Cinemachine
![Page 1529: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1529.jpg)
CinemachineStateDrivenCameraFollowProperty
GetthecurrentFollowtarget.Returnsparent'sFollowifparentisnon-nullandnospecificFollowdefinedforthiscamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:TransformImplementsICinemachineCameraFollow
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideTransformFollow{get;set;}
CopyC# JavaScript
![Page 1530: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1530.jpg)
Cinemachine
![Page 1531: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1531.jpg)
CinemachineStateDrivenCameraIsBlendingProperty
Isthereablendinprogress?
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicboolIsBlending{get;}
CopyC# JavaScript
![Page 1532: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1532.jpg)
Cinemachine
![Page 1533: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1533.jpg)
CinemachineStateDrivenCameraLiveChildProperty
Getthecurrent"best"childvirtualcamera,thatwouldbechoseniftheStateDrivenCamerawereactive.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ICinemachineCamera
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicICinemachineCameraLiveChild{get;set;}
CopyC# JavaScript
![Page 1534: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1534.jpg)
Cinemachine
![Page 1535: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1535.jpg)
CinemachineStateDrivenCameraLiveChildOrSelfProperty
Returnthelivechild.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ICinemachineCameraImplementsICinemachineCameraLiveChildOrSelf
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideICinemachineCameraLiveChildOrSelf{
CopyC# JavaScript
![Page 1536: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1536.jpg)
Cinemachine
![Page 1537: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1537.jpg)
CinemachineStateDrivenCameraLookAtProperty
GetthecurrentLookAttarget.Returnsparent'sLookAtifparentisnon-nullandnospecificLookAtdefinedforthiscamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:TransformImplementsICinemachineCameraLookAt
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideTransformLookAt{get;set;}
CopyC# JavaScript
![Page 1538: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1538.jpg)
Cinemachine
![Page 1539: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1539.jpg)
CinemachineStateDrivenCameraStateProperty
TheStateofthecurrentlivechild
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CameraStateImplementsICinemachineCameraState
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideCameraStateState{get;}
CopyC# JavaScript
![Page 1540: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1540.jpg)
Cinemachine
![Page 1541: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1541.jpg)
CinemachineStateDrivenCameraMethods
TheCinemachineStateDrivenCameratypeexposesthefollowingmembers.
Methods Name Description
AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.pipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
CreateFakeHashName APIfortheinspectoreditor.implementnestedstate
InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforall(InheritedfromCinemachineVirtualCameraBase
IsLiveChild Checkwhetherthevcamalivechildofthiscamera.(OverridesCinemachineVirtualCameraBase
MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereisLivecameraifitsharesthehighestpriorityinthequeuewithitspeers.themostrecentonegoestothetopoftheprioritysubqueue.anditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.(InheritedfromCinemachineVirtualCameraBase
OnDestroy Baseclassimplementationremovesthevirtualcamerafromthepriorityqueue.(InheritedfromCinemachineVirtualCameraBase
OnDisable Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase
![Page 1542: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1542.jpg)
OnEnable Makessuretheinternalchildcacheisuptodate(OverridesCinemachineVirtualCameraBase
OnTransformChildrenChanged Makessuretheinternalchildcacheisuptodate
OnTransformParentChanged Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(InheritedfromCinemachineVirtualCameraBase
OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.(InheritedfromCinemachineVirtualCameraBase
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
![Page 1543: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1543.jpg)
ValidateInstructions InternalAPIfortheinspectoreditor.
Top
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1544: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1544.jpg)
Cinemachine
![Page 1545: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1545.jpg)
CinemachineStateDrivenCameraCreateFakeHashNameMethod
APIfortheinspectoreditor.Animationmoduledoesnothavehashesforstateparents,sowehavetoinventtheminordertoimplementnestedstatehandling
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 1546: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1546.jpg)
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1547: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1547.jpg)
Cinemachine
![Page 1548: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1548.jpg)
CinemachineStateDrivenCameraIsLiveChildMethod
Checkwhetherthevcamalivechildofthiscamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineICinemachineCameraTheVirtualCameratocheck
ReturnValueType:BooleanTrueifthevcamiscurrentlyactivelyinfluencingthestateofthisvcamImplementsICinemachineCameraIsLiveChild(ICinemachineCamera)
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
publicoverrideboolIsLiveChild(
ICinemachineCameravcam
)
CopyC# JavaScript
![Page 1549: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1549.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1550: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1550.jpg)
Cinemachine
![Page 1551: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1551.jpg)
CinemachineStateDrivenCameraOnEnableMethod
Makessuretheinternalchildcacheisuptodate
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedoverridevoidOnEnable()
CopyC# JavaScript
![Page 1552: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1552.jpg)
Cinemachine
![Page 1553: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1553.jpg)
CinemachineStateDrivenCameraOnTransformChildrenChangedMethod
Makessuretheinternalchildcacheisuptodate
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidOnTransformChildrenChanged()
CopyC# JavaScript
![Page 1554: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1554.jpg)
Cinemachine
![Page 1555: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1555.jpg)
CinemachineStateDrivenCameraRemovePostPipelineStageHookMethod
RemoveaPipelinestagehookcallback.Makesureitisremovedfromallthechildren.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
dType:CinemachineCinemachineVirtualCameraBaseOnPostPipelineStageDelegateThedelegatetoremove.
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridevoidRemovePostPipelineStageHook(
CinemachineVirtualCameraBaseOnPostPipelineStageDelegate
)
CopyC# JavaScript
![Page 1556: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1556.jpg)
Cinemachine
![Page 1557: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1557.jpg)
CinemachineStateDrivenCameraUpdateCameraStateMethod
CalledbyCinemachineCoreatdesignatedupdatetimesothevcamcanpositionitselfandtrackitstargets.Thisimplementationupdatesallthechildren,choosesthebestone,andimplementsanyrequiredblending.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
worldUpType:Vector3DefaultworldUp,setbytheCinemachineBrain
deltaTimeType:SystemSingleDeltatimefortime-basedeffects(ignoreiflessthanorequalto0)
ImplementsICinemachineCameraUpdateCameraState(Vector3,Single)
SeeAlso
publicoverridevoidUpdateCameraState(
Vector3worldUp,
floatdeltaTime
)
CopyC# JavaScript
![Page 1558: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1558.jpg)
ReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1559: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1559.jpg)
Cinemachine
![Page 1560: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1560.jpg)
CinemachineStateDrivenCameraValidateInstructionsMethod
InternalAPIfortheinspectoreditor.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidValidateInstructions()
CopyC# JavaScript
![Page 1561: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1561.jpg)
Cinemachine
![Page 1562: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1562.jpg)
CinemachineStateDrivenCameraFields
TheCinemachineStateDrivenCameratypeexposesthefollowingmembers.
Fields Name Description
CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.(InheritedfromCinemachineVirtualCameraBase
m_AnimatedTarget Thestatemachinewhosestatechangeswilldrivethiscamera'schoiceofactivechild
m_CustomBlends Thisistheassetwhichcontainscustomsettingsforspecificchildblends.
m_DefaultBlend Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCamerachildren.
m_EnableAllChildCameras Forceallchildcamerastobeenabled.ThisisusefulifanimatingtheminTimeline,butconsumesextraresources.
![Page 1563: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1563.jpg)
m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_Follow Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildrig.Maybeempty
m_Instructions Thesetofinstructionsassociatingvirtualcameraswithstates.Theseinstructionsareusedtochoosethelivechildatanygivenmoment
m_LayerIndex WhichlayerinthetargetFSMtoobserve
m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_LookAt Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildrig.Maybeempty
m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase
m_ShowDebugText Whenenabled,thecurrent
![Page 1564: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1564.jpg)
cameraandblendwillbeindicatedinthegamewindow,fordebugging
OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
Top
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1565: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1565.jpg)
Cinemachine
![Page 1566: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1566.jpg)
CinemachineStateDrivenCameram_AnimatedTargetField
Thestatemachinewhosestatechangeswilldrivethiscamera'schoiceofactivechild
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Animator
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[SpaceAttribute]
[TooltipAttribute("Thestatemachinewhosestatechangeswilldrivethiscamera'schoiceofactivechild")]
publicAnimatorm_AnimatedTarget
CopyC# JavaScript
![Page 1567: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1567.jpg)
Cinemachine
![Page 1568: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1568.jpg)
CinemachineStateDrivenCameram_CustomBlendsField
Thisistheassetwhichcontainscustomsettingsforspecificchildblends.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineBlenderSettings
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thisistheassetwhichcontainscustomsettingsforspecificchildblends")]
publicCinemachineBlenderSettingsm_CustomBlends
CopyC# JavaScript
![Page 1569: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1569.jpg)
Cinemachine
![Page 1570: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1570.jpg)
CinemachineStateDrivenCameram_DefaultBlendField
Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCamerachildren.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineBlendDefinition
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[CinemachineBlendDefinitionPropertyAttribute]
[TooltipAttribute("Theblendwhichisusedifyoudon'texplicitlydefineablendbetweentwoVirtualCamerachildren")]
publicCinemachineBlendDefinitionm_DefaultBlend
CopyC# JavaScript
![Page 1571: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1571.jpg)
Cinemachine
![Page 1572: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1572.jpg)
CinemachineStateDrivenCameram_EnableAllChildCamerasField
Forceallchildcamerastobeenabled.ThisisusefulifanimatingtheminTimeline,butconsumesextraresources.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Forceallchildcamerastobeenabled.ThisisusefulifanimatingtheminTimeline,butconsumesextraresources")]
publicboolm_EnableAllChildCameras
CopyC# JavaScript
![Page 1573: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1573.jpg)
Cinemachine
![Page 1574: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1574.jpg)
CinemachineStateDrivenCameram_FollowField
Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildrig.Maybeempty
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Transform
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Defaultobjectforthecamerachildrenwantstomovewith(thebodytarget),ifnotspecifiedinachildcamera.Maybeemptyifallofthechildrendefinetargetsoftheirown.")]
[NoSaveDuringPlayAttribute]
publicTransformm_Follow
CopyC# JavaScript
![Page 1575: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1575.jpg)
Cinemachine
![Page 1576: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1576.jpg)
CinemachineStateDrivenCameram_InstructionsField
Thesetofinstructionsassociatingvirtualcameraswithstates.Theseinstructionsareusedtochoosethelivechildatanygivenmoment
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineStateDrivenCameraInstruction
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thesetofinstructionsassociatingvirtualcameraswithstates.Theseinstructionsareusedtochoosethelivechildatanygivenmoment")]
publicCinemachineStateDrivenCameraInstruction[]m_Instructions
CopyC# JavaScript
![Page 1577: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1577.jpg)
Cinemachine
![Page 1578: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1578.jpg)
CinemachineStateDrivenCameram_LayerIndexField
WhichlayerinthetargetFSMtoobserve
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Int32
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Whichlayerinthetargetstatemachinetoobserve")]
publicintm_LayerIndex
CopyC# JavaScript
![Page 1579: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1579.jpg)
Cinemachine
![Page 1580: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1580.jpg)
CinemachineStateDrivenCameram_LookAtField
Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildrig.Maybeempty
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Transform
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Defaultobjectforthecamerachildrentolookat(theaimtarget),ifnotspecifiedinachildcamera.Maybeemptyifallofthechildrendefinetargetsoftheirown.")]
[NoSaveDuringPlayAttribute]
publicTransformm_LookAt
CopyC# JavaScript
![Page 1581: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1581.jpg)
Cinemachine
![Page 1582: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1582.jpg)
CinemachineStateDrivenCameram_ShowDebugTextField
Whenenabled,thecurrentcameraandblendwillbeindicatedinthegamewindow,fordebugging
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineStateDrivenCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Whenenabled,thecurrentchildcameraandblendwillbeindicatedinthegamewindow,fordebugging")]
publicboolm_ShowDebugText
CopyC# JavaScript
![Page 1583: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1583.jpg)
Cinemachine
![Page 1584: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1584.jpg)
CinemachineStateDrivenCameraInstructionStructure
ThisrepresentsasingleinstrunctiontotheStateDrivenCamera.ItassociatesanstatefromthestatemachinewithachildVirtualCamera,andalsoholdsactivationtuningparameters.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineStateDrivenCameraInstructiontypeexposesthefollowingmembers.
Fields Name Description
m_ActivateAfter Howlongtowait(inseconds)beforeactivatingthevirtualcamera.Thisfiltersoutveryshortstatedurations
m_FullHash Thefullhashoftheanimationstate
m_MinDuration Theminimumlengthoftime(inseconds)tokeepavirtual
[SerializableAttribute]
publicstructInstruction
CopyC# JavaScript
![Page 1585: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1585.jpg)
cameraactive
m_VirtualCamera Thevirtualcameratoactivatewhrntheanimationstatebecomesactive
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1586: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1586.jpg)
Cinemachine
![Page 1587: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1587.jpg)
InstructionFields
TheCinemachineStateDrivenCameraInstructiontypeexposesthefollowingmembers.
Fields Name Description
m_ActivateAfter Howlongtowait(inseconds)beforeactivatingthevirtualcamera.Thisfiltersoutveryshortstatedurations
m_FullHash Thefullhashoftheanimationstate
m_MinDuration Theminimumlengthoftime(inseconds)tokeepavirtualcameraactive
m_VirtualCamera Thevirtualcameratoactivatewhrntheanimationstatebecomesactive
Top
SeeAlsoReferenceCinemachineStateDrivenCameraInstructionStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1588: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1588.jpg)
Cinemachine
![Page 1589: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1589.jpg)
CinemachineStateDrivenCameraInstructionField
Howlongtowait(inseconds)beforeactivatingthevirtualcamera.Thisfiltersoutveryshortstatedurations
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineStateDrivenCameraInstructionStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Howlongtowait(inseconds)beforeactivatingthevirtualcamera.Thisfiltersoutveryshortstatedurations")]
publicfloatm_ActivateAfter
CopyC# JavaScript
![Page 1590: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1590.jpg)
Cinemachine
![Page 1591: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1591.jpg)
CinemachineStateDrivenCameraInstructionField
Thefullhashoftheanimationstate
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Int32
SeeAlsoReferenceCinemachineStateDrivenCameraInstructionStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thefullhashoftheanimationstate")]
publicintm_FullHash
CopyC# JavaScript
![Page 1592: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1592.jpg)
Cinemachine
![Page 1593: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1593.jpg)
CinemachineStateDrivenCameraInstructionField
Theminimumlengthoftime(inseconds)tokeepavirtualcameraactive
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineStateDrivenCameraInstructionStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theminimumlengthoftime(inseconds)tokeepavirtualcameraactive")]
publicfloatm_MinDuration
CopyC# JavaScript
![Page 1594: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1594.jpg)
Cinemachine
![Page 1595: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1595.jpg)
CinemachineStateDrivenCameraInstructionField
Thevirtualcameratoactivatewhrntheanimationstatebecomesactive
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineVirtualCameraBase
SeeAlsoReferenceCinemachineStateDrivenCameraInstructionStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thevirtualcameratoactivatewhrntheanimationstatebecomesactive")]
publicCinemachineVirtualCameraBasem_VirtualCamera
CopyC# JavaScript
![Page 1596: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1596.jpg)
Cinemachine
![Page 1597: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1597.jpg)
CinemachineTargetGroupClass
Definesagroupoftargetobjects,eachwitharadiusandaweight.Theweightisusedwhencalculatingtheaveragepositionofthetargetgroup.Higher-weightedmembersofthegroupwillcountmore.Theboundingboxiscalculatedbytakingthememberpositions,weight,andradiiintoaccount.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineTargetGroup
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineTargetGrouptypeexposesthefollowingmembers.
Constructors Name Description
[DocumentationSortingAttribute(19f,DocumentationSortingAttribute
[AddComponentMenu("Cinemachine/CinemachineTargetGroup")]
[SaveDuringPlayAttribute]
[ExecuteInEditMode]
publicclassCinemachineTargetGroup:MonoBehaviour
CopyC# JavaScript
![Page 1598: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1598.jpg)
CinemachineTargetGroup
Top
Properties Name Description
BoundingBox Theaxis-alignedboundingboxofthegroup,computedusingthetargetspositionsandradii
IsEmpty Returntrueiftherearenomemberswithweight>0
Top
Methods Name Description
GetViewSpaceBoundingBox Theaxis-alignedboundingboxofthegroup,inaspecificreferenceframe
Top
Fields Name Description
m_PositionMode Howthegroup'spositioniscalculated
m_RotationMode Howthegroup'sorientationiscalculated
m_Targets Thetargetobjects,together
![Page 1599: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1599.jpg)
withtheirweightsandradii,thatwillcontributetothegroup'saverageposition,orientation,andsize
m_UpdateMethod Whentoupdatethegroup'stransformbasedonthepositionofthegroupmembers
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1600: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1600.jpg)
Cinemachine
![Page 1601: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1601.jpg)
CinemachineTargetGroupConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineTargetGroup.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineTargetGroupClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineTargetGroup()
CopyC# JavaScript
![Page 1602: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1602.jpg)
Cinemachine
![Page 1603: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1603.jpg)
CinemachineTargetGroupProperties
TheCinemachineTargetGrouptypeexposesthefollowingmembers.
Properties Name Description
BoundingBox Theaxis-alignedboundingboxofthegroup,computedusingthetargetspositionsandradii
IsEmpty Returntrueiftherearenomemberswithweight>0
Top
SeeAlsoReferenceCinemachineTargetGroupClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1604: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1604.jpg)
Cinemachine
![Page 1605: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1605.jpg)
CinemachineTargetGroupBoundingBoxProperty
Theaxis-alignedboundingboxofthegroup,computedusingthetargetspositionsandradii
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Bounds
SeeAlsoReferenceCinemachineTargetGroupClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicBoundsBoundingBox{get;}
CopyC# JavaScript
![Page 1606: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1606.jpg)
Cinemachine
![Page 1607: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1607.jpg)
CinemachineTargetGroupIsEmptyProperty
Returntrueiftherearenomemberswithweight>0
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineTargetGroupClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicboolIsEmpty{get;}
CopyC# JavaScript
![Page 1608: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1608.jpg)
Cinemachine
![Page 1609: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1609.jpg)
CinemachineTargetGroupMethods
TheCinemachineTargetGrouptypeexposesthefollowingmembers.
Methods Name Description
GetViewSpaceBoundingBox Theaxis-alignedboundingboxofthegroup,inaspecificreferenceframe
Top
SeeAlsoReferenceCinemachineTargetGroupClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1610: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1610.jpg)
Cinemachine
![Page 1611: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1611.jpg)
CinemachineTargetGroupGetViewSpaceBoundingBoxMethod
Theaxis-alignedboundingboxofthegroup,inaspecificreferenceframe
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
mViewType:Matrix4x4Theframeofreferenceinwhichtocomputetheboundingbox
ReturnValueType:BoundsTheaxis-alignedboundingboxofthegroup,inthedesiredframeofreference
SeeAlsoReferenceCinemachineTargetGroupClassCinemachineNamespace
publicBoundsGetViewSpaceBoundingBox(
Matrix4x4mView
)
CopyC# JavaScript
![Page 1612: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1612.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1613: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1613.jpg)
Cinemachine
![Page 1614: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1614.jpg)
CinemachineTargetGroupFields
TheCinemachineTargetGrouptypeexposesthefollowingmembers.
Fields Name Description
m_PositionMode Howthegroup'spositioniscalculated
m_RotationMode Howthegroup'sorientationiscalculated
m_Targets Thetargetobjects,togetherwiththeirweightsandradii,thatwillcontributetothegroup'saverageposition,orientation,andsize
m_UpdateMethod Whentoupdatethegroup'stransformbasedonthepositionofthegroupmembers
Top
SeeAlsoReferenceCinemachineTargetGroupClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1615: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1615.jpg)
Cinemachine
![Page 1616: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1616.jpg)
CinemachineTargetGroupm_PositionModeField
Howthegroup'spositioniscalculated
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineTargetGroupPositionMode
SeeAlsoReferenceCinemachineTargetGroupClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Howthegroup'spositioniscalculated.SelectGroupCenterforthecenteroftheboundingbox,andGroupAverageforaweightedaverageofthepositionsofthemembers.")]
publicCinemachineTargetGroupPositionModem_PositionMode
CopyC# JavaScript
![Page 1617: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1617.jpg)
Cinemachine
![Page 1618: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1618.jpg)
CinemachineTargetGroupm_RotationModeField
Howthegroup'sorientationiscalculated
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineTargetGroupRotationMode
SeeAlsoReferenceCinemachineTargetGroupClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Howthegroup'srotationiscalculated.SelectManualtousethevalueinthegroup'stransform,andGroupAverageforaweightedaverageoftheorientationsofthemembers.")]
publicCinemachineTargetGroupRotationModem_RotationMode
CopyC# JavaScript
![Page 1619: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1619.jpg)
Cinemachine
![Page 1620: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1620.jpg)
CinemachineTargetGroupm_TargetsField
Thetargetobjects,togetherwiththeirweightsandradii,thatwillcontributetothegroup'saverageposition,orientation,andsize
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineTargetGroupTarget
SeeAlsoReferenceCinemachineTargetGroupClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[NoSaveDuringPlayAttribute]
[TooltipAttribute("Thetargetobjects,togetherwiththeirweightsandradii,thatwillcontributetothegroup'saverageposition,orientation,andsize.")]
publicCinemachineTargetGroupTarget[]m_Targets
CopyC# JavaScript
![Page 1621: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1621.jpg)
Cinemachine
![Page 1622: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1622.jpg)
CinemachineTargetGroupm_UpdateMethodField
Whentoupdatethegroup'stransformbasedonthepositionofthegroupmembers
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineTargetGroupUpdateMethod
SeeAlsoReferenceCinemachineTargetGroupClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Whentoupdatethegroup'stransformbasedonthepositionofthegroupmembers")]
publicCinemachineTargetGroupUpdateMethodm_UpdateMethod
CopyC# JavaScript
![Page 1623: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1623.jpg)
Cinemachine
![Page 1624: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1624.jpg)
CinemachineTargetGroupPositionModeEnumeration
Howthegroup'spositioniscalculated
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members
Membername Value Description
GroupCenter 0 Grouppositionwillbethecenterofthegroup'saxis-alignedboundingbox
GroupAverage 1 Grouppositionwillbetheweightedaverageofthepositionsofthemembers
SeeAlsoReference
[DocumentationSortingAttribute(19.2f,DocumentationSortingAttribute
publicenumPositionMode
CopyC# JavaScript
![Page 1625: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1625.jpg)
CinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1626: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1626.jpg)
Cinemachine
![Page 1627: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1627.jpg)
CinemachineTargetGroupRotationModeEnumeration
Howthegroup'sorientationiscalculated
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members
Membername Value Description
Manual 0 Manuallysetinthegroup'stransform
GroupAverage 1 Weightedaverageoftheorientationofitsmembers.
SeeAlsoReferenceCinemachineNamespace
[DocumentationSortingAttribute(19.3f,DocumentationSortingAttribute
publicenumRotationMode
CopyC# JavaScript
![Page 1628: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1628.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1629: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1629.jpg)
Cinemachine
![Page 1630: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1630.jpg)
CinemachineTargetGroupTargetStructure
Holdstheinformationthatrepresentsamemberofthegroup
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineTargetGroupTargettypeexposesthefollowingmembers.
Fields Name Description
radius Theradiusofthetarget,usedforcalculatingtheboundingbox.Cannotbenegative
target Thetargetobjects.Thisobject'spositionandorientationwillcontributetothegroup'saveragepositionandorientation,inaccordancewithitsweight
weight Howmuchweighttogivethetarget
[SerializableAttribute]
[DocumentationSortingAttribute(19.1f,DocumentationSortingAttribute
publicstructTarget
CopyC# JavaScript
![Page 1631: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1631.jpg)
whenaveraging.Cannotbenegative
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1632: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1632.jpg)
Cinemachine
![Page 1633: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1633.jpg)
TargetFields
TheCinemachineTargetGroupTargettypeexposesthefollowingmembers.
Fields Name Description
radius Theradiusofthetarget,usedforcalculatingtheboundingbox.Cannotbenegative
target Thetargetobjects.Thisobject'spositionandorientationwillcontributetothegroup'saveragepositionandorientation,inaccordancewithitsweight
weight Howmuchweighttogivethetargetwhenaveraging.Cannotbenegative
Top
SeeAlsoReferenceCinemachineTargetGroupTargetStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1634: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1634.jpg)
Cinemachine
![Page 1635: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1635.jpg)
CinemachineTargetGroupTargetradiusField
Theradiusofthetarget,usedforcalculatingtheboundingbox.Cannotbenegative
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineTargetGroupTargetStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theradiusofthetarget,usedforcalculatingtheboundingbox.Cannotbenegative")]
publicfloatradius
CopyC# JavaScript
![Page 1636: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1636.jpg)
Cinemachine
![Page 1637: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1637.jpg)
CinemachineTargetGroupTargettargetField
Thetargetobjects.Thisobject'spositionandorientationwillcontributetothegroup'saveragepositionandorientation,inaccordancewithitsweight
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Transform
SeeAlsoReferenceCinemachineTargetGroupTargetStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thetargetobjects.Thisobject'spositionandorientationwillcontributetothegroup'saveragepositionandorientation,inaccordancewithitsweight")]
publicTransformtarget
CopyC# JavaScript
![Page 1638: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1638.jpg)
Cinemachine
![Page 1639: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1639.jpg)
CinemachineTargetGroupTargetweightField
Howmuchweighttogivethetargetwhenaveraging.Cannotbenegative
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineTargetGroupTargetStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Howmuchweighttogivethetargetwhenaveraging.Cannotbenegative")]
publicfloatweight
CopyC# JavaScript
![Page 1640: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1640.jpg)
Cinemachine
![Page 1641: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1641.jpg)
CinemachineTargetGroupUpdateMethodEnumeration
Thisenumdefinestheoptionsavailablefortheupdatemethod.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members
Membername Value Description
Update 0 UpdatedinnormalMonoBehaviourUpdate.
FixedUpdate 1 UpdatedinsyncwiththePhysicsmodule,inFixedUpdate
LateUpdate 2 UpdatedinMonoBehaviourLateUpdate.
SeeAlsoReference
publicenumUpdateMethod
CopyC# JavaScript
![Page 1642: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1642.jpg)
CinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1643: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1643.jpg)
Cinemachine
![Page 1644: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1644.jpg)
CinemachineTrackedDollyClass
ACinemachineVirtualCameraBodycomponentthatconstrainscameramotiontoaCinemachinePath.Thecameracanmovealongthepath.Thisbehaviourcanoperateintwomodes:manualpositioning,andAuto-Dollypositioning.InManualmode,thecamera'spositionisspecifiedbyanimatingthePathPositionfield.InAuto-Dollymode,thePathPositionfieldisanimatedautomaticallyeveryframebyfindingthepositiononthepaththat'sclosesttothevirtualcamera'sFollowtarget.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineTrackedDolly
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineTrackedDollytypeexposesthefollowingmembers.
[DocumentationSortingAttribute(7f,DocumentationSortingAttribute
[AddComponentMenu("")]
[RequireComponent(typeof(CinemachinePipeline))]
[SaveDuringPlayAttribute]
publicclassCinemachineTrackedDolly:CinemachineComponentBase
CopyC# JavaScript
![Page 1645: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1645.jpg)
Constructors Name Description
CinemachineTrackedDolly
Top
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
IsValid Trueifcomponentisenabledandhasapath(OverridesCinemachineComponentBaseIsValid.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage(OverridesCinemachineComponentBaseStage.)
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
![Page 1646: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1646.jpg)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)
Top
Methods Name Description
MutateCameraState Positionsthevirtualcameraaccordingtothetransposerrules.(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.implementationaddsthedeltatothefollowoffset.(OverridesCinemachineComponentBaseOnPositionDragged(Vector3)
Top
Fields Name Description
m_AutoDolly Controlshowautomaticdollyingoccurs
m_CameraUp Howtosetthevirtualcamera'sUpvector.Thiswillaffectthescreencomposition.
m_Path Thepathtowhichthecamerawillbeconstrained.Thismustbenon-null.
m_PathOffset Wheretoputthecamera
![Page 1647: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1647.jpg)
realtivetothepathpostion.Xisperpendiculartothepath,Yisup,andZisparalleltothepath.
m_PathPosition Thepositionalongthepathatwhichthecamerawillbeplaced.Thiscanbeanimateddirectly,orsetautomaticallybytheAuto-DollyfeaturetogetascloseaspossibletotheFollowtarget.
m_PitchDamping "Howaggressivelythecameratriestotrackthetargetrotation'sXangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
m_PositionUnits HowtointerpretthePathPosition
m_RollDamping Howaggressivelythecameratriestotrackthetargetrotation'sZangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
m_XDamping Howaggressivelythecameratriestomaintaintheoffsetperpendiculartothepath.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbers
![Page 1648: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1648.jpg)
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
![Page 1649: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1649.jpg)
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1650: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1650.jpg)
Cinemachine
![Page 1651: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1651.jpg)
CinemachineTrackedDollyConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineTrackedDolly.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineTrackedDolly()
CopyC# JavaScript
![Page 1652: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1652.jpg)
Cinemachine
![Page 1653: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1653.jpg)
CinemachineTrackedDollyProperties
TheCinemachineTrackedDollytypeexposesthefollowingmembers.
Properties Name Description
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
IsValid Trueifcomponentisenabledandhasapath(OverridesCinemachineComponentBaseIsValid.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage(OverridesCinemachineComponentBaseStage.)
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
![Page 1654: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1654.jpg)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)
Top
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1655: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1655.jpg)
Cinemachine
![Page 1656: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1656.jpg)
CinemachineTrackedDollyIsValidProperty
Trueifcomponentisenabledandhasapath
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideboolIsValid{get;}
CopyC# JavaScript
![Page 1657: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1657.jpg)
Cinemachine
![Page 1658: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1658.jpg)
CinemachineTrackedDollyStageProperty
GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineCoreStage
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideCinemachineCoreStageStage{get;}
CopyC# JavaScript
![Page 1659: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1659.jpg)
Cinemachine
![Page 1660: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1660.jpg)
CinemachineTrackedDollyMethods
TheCinemachineTrackedDollytypeexposesthefollowingmembers.
Methods Name Description
MutateCameraState Positionsthevirtualcameraaccordingtothetransposerrules.(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.implementationaddsthedeltatothefollowoffset.(OverridesCinemachineComponentBaseOnPositionDragged(Vector3)
Top
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1661: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1661.jpg)
Cinemachine
![Page 1662: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1662.jpg)
CinemachineTrackedDollyMutateCameraStateMethod
Positionsthevirtualcameraaccordingtothetransposerrules.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
curStateType:CinemachineCameraStateThecurrentcamerastate
deltaTimeType:SystemSingleUsedfordamping.Iflessthat0,nodampingisdone.
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridevoidMutateCameraState(
refCameraStatecurState,
floatdeltaTime
)
CopyC# JavaScript
![Page 1663: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1663.jpg)
![Page 1664: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1664.jpg)
Cinemachine
![Page 1665: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1665.jpg)
CinemachineTrackedDollyOnPositionDraggedMethod
APIfortheeditor,toprocessapositiondragfromtheuser.Thisimplementationaddsthedeltatothefollowoffset.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
deltaType:Vector3Theamountdraggedthisframe
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridevoidOnPositionDragged(
Vector3delta
)
CopyC# JavaScript
![Page 1666: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1666.jpg)
Cinemachine
![Page 1667: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1667.jpg)
CinemachineTrackedDollyFields
TheCinemachineTrackedDollytypeexposesthefollowingmembers.
Fields Name Description
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
![Page 1668: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1668.jpg)
numbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
m_PositionUnits HowtointerpretthePathPosition
m_RollDamping Howaggressivelythecameratriestotrackthetargetrotation'sZangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
m_XDamping Howaggressivelythecameratriestomaintaintheoffsetperpendiculartothepath.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
m_YawDamping Howaggressivelythecameratriestotrackthetargetrotation'sYangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
m_YDamping Howaggressivelythecameratriestomaintaintheoffsetin
![Page 1669: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1669.jpg)
thepath-localupdirection.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
m_ZDamping Howaggressivelythecameratriestomaintaintheoffsetparalleltothepath.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
Top
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1670: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1670.jpg)
Cinemachine
![Page 1671: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1671.jpg)
CinemachineTrackedDollym_AutoDollyField
Controlshowautomaticdollyingoccurs
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineTrackedDollyAutoDolly
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Controlshowautomaticdollyingoccurs.AFollowtargetisnecessarytousethisfeature.")]
publicCinemachineTrackedDollyAutoDollym_AutoDolly
CopyC# JavaScript
![Page 1672: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1672.jpg)
Cinemachine
![Page 1673: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1673.jpg)
CinemachineTrackedDollym_CameraUpField
Howtosetthevirtualcamera'sUpvector.Thiswillaffectthescreencomposition.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineTrackedDollyCameraUpMode
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Howtosetthevirtualcamera'sUpvector.Thiswillaffectthescreencomposition,becausethecameraAimbehaviourswillalwaystrytorespecttheUpdirection.")]
publicCinemachineTrackedDollyCameraUpModem_CameraUp
CopyC# JavaScript
![Page 1674: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1674.jpg)
Cinemachine
![Page 1675: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1675.jpg)
CinemachineTrackedDollym_PathField
Thepathtowhichthecamerawillbeconstrained.Thismustbenon-null.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachinePathBase
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thepathtowhichthecamerawillbeconstrained.Thismustbenon-null.")]
publicCinemachinePathBasem_Path
CopyC# JavaScript
![Page 1676: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1676.jpg)
Cinemachine
![Page 1677: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1677.jpg)
CinemachineTrackedDollym_PathOffsetField
Wheretoputthecamerarealtivetothepathpostion.Xisperpendiculartothepath,Yisup,andZisparalleltothepath.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Vector3
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Wheretoputthecamerarelativetothepathposition.Xisperpendiculartothepath,Yisup,andZisparalleltothepath.Thisallowsthecameratobeoffsetfromthepathitself(asifonatripod,forexample).")]
publicVector3m_PathOffset
CopyC# JavaScript
![Page 1678: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1678.jpg)
Cinemachine
![Page 1679: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1679.jpg)
CinemachineTrackedDollym_PathPositionField
Thepositionalongthepathatwhichthecamerawillbeplaced.Thiscanbeanimateddirectly,orsetautomaticallybytheAuto-DollyfeaturetogetascloseaspossibletotheFollowtarget.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thepositionalongthepathatwhichthecamerawillbeplaced.Thiscanbeanimateddirectly,orsetautomaticallybytheAuto-DollyfeaturetogetascloseaspossibletotheFollowtarget.ThevalueisinterpretedaccordingtothePositionUnitssetting.")]
publicfloatm_PathPosition
CopyC# JavaScript
![Page 1680: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1680.jpg)
Cinemachine
![Page 1681: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1681.jpg)
CinemachineTrackedDollym_PitchDampingField
"Howaggressivelythecameratriestotrackthetargetrotation'sXangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("Howaggressivelythecameratriestotrackthetargetrotation'sXangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.")]
publicfloatm_PitchDamping
CopyC# JavaScript
![Page 1682: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1682.jpg)
Cinemachine
![Page 1683: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1683.jpg)
CinemachineTrackedDollym_PositionUnitsField
HowtointerpretthePathPosition
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachinePathBasePositionUnits
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("HowtointerpretPathPosition.IfsettoPathUnits,valuesareasfollows:0representsthefirstwaypointonthepath,1isthesecond,andsoon.Valuesin-betweenarepointsonthepathinbetweenthewaypoints.IfsettoDistance,thenPathPositionrepresentsdistancealongthepath.")]
publicCinemachinePathBasePositionUnitsm_PositionUnits
CopyC# JavaScript
![Page 1684: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1684.jpg)
Cinemachine
![Page 1685: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1685.jpg)
CinemachineTrackedDollym_RollDampingField
Howaggressivelythecameratriestotrackthetargetrotation'sZangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("Howaggressivelythecameratriestotrackthetargetrotation'sZangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.")]
publicfloatm_RollDamping
CopyC# JavaScript
![Page 1686: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1686.jpg)
Cinemachine
![Page 1687: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1687.jpg)
CinemachineTrackedDollym_XDampingField
Howaggressivelythecameratriestomaintaintheoffsetperpendiculartothepath.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("Howaggressivelythecameratriestomaintainitspositioninadirectionperpendiculartothepath.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]
publicfloatm_XDamping
CopyC# JavaScript
![Page 1688: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1688.jpg)
Cinemachine
![Page 1689: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1689.jpg)
CinemachineTrackedDollym_YawDampingField
Howaggressivelythecameratriestotrackthetargetrotation'sYangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("Howaggressivelythecameratriestotrackthetargetrotation'sYangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.")]
publicfloatm_YawDamping
CopyC# JavaScript
![Page 1690: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1690.jpg)
Cinemachine
![Page 1691: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1691.jpg)
CinemachineTrackedDollym_YDampingField
Howaggressivelythecameratriestomaintaintheoffsetinthepath-localupdirection.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("Howaggressivelythecameratriestomaintainitspositioninthepath-localupdirection.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]
publicfloatm_YDamping
CopyC# JavaScript
![Page 1692: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1692.jpg)
Cinemachine
![Page 1693: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1693.jpg)
CinemachineTrackedDollym_ZDampingField
Howaggressivelythecameratriestomaintaintheoffsetparalleltothepath.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineTrackedDollyClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("Howaggressivelythecameratriestomaintainitspositioninadirectionparalleltothepath.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]
publicfloatm_ZDamping
CopyC# JavaScript
![Page 1694: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1694.jpg)
Cinemachine
![Page 1695: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1695.jpg)
CinemachineTrackedDollyAutoDollyStructure
Controlshowautomaticdollyingoccurs
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineTrackedDollyAutoDollytypeexposesthefollowingmembers.
Constructors Name Description
CinemachineTrackedDollyAutoDolly Constructorwithspecificfieldvalues
Top
Fields Name Description
[SerializableAttribute]
[DocumentationSortingAttribute(7.2f,DocumentationSortingAttribute
publicstructAutoDolly
CopyC# JavaScript
![Page 1696: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1696.jpg)
m_Enabled Ifchecked,willenableautomaticdolly,whichchoosesapathpositionthatisascloseaspossibletotheFollowtarget.
m_PositionOffset Offset,incurrentpositionunits,fromtheclosestpointonthepathtothefollowtarget.
m_SearchRadius Searchuptohowmanywaypointsoneithersideofthecurrentposition.Use0forEntirepath
m_SearchResolution Wesearchbetweenwaypointsbydividingthesegmentintothismanystraightpieces.Thehigherthenumber,themoreaccuratetheresult,butperformanceisproportionallyslowerforhighernumbers
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1697: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1697.jpg)
Cinemachine
![Page 1698: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1698.jpg)
CinemachineTrackedDollyAutoDollyConstructor
Constructorwithspecificfieldvalues
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 1699: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1699.jpg)
Type:SystemInt32[Missing<paramname="stepsPerSegment"/>documentationfor"M:Cinemachine.CinemachineTrackedDolly.AutoDolly.#ctor(System.Boolean,System.Single,System.Int32,System.Int32)"]
SeeAlsoReferenceCinemachineTrackedDollyAutoDollyStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1700: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1700.jpg)
Cinemachine
![Page 1701: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1701.jpg)
AutoDollyFields
TheCinemachineTrackedDollyAutoDollytypeexposesthefollowingmembers.
Fields Name Description
m_Enabled Ifchecked,willenableautomaticdolly,whichchoosesapathpositionthatisascloseaspossibletotheFollowtarget.
m_PositionOffset Offset,incurrentpositionunits,fromtheclosestpointonthepathtothefollowtarget.
m_SearchRadius Searchuptohowmanywaypointsoneithersideofthecurrentposition.Use0forEntirepath
m_SearchResolution Wesearchbetweenwaypointsbydividingthesegmentintothismanystraightpieces.Thehigherthenumber,themoreaccuratetheresult,butperformanceisproportionallyslowerforhighernumbers
Top
![Page 1702: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1702.jpg)
SeeAlsoReferenceCinemachineTrackedDollyAutoDollyStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1703: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1703.jpg)
Cinemachine
![Page 1704: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1704.jpg)
CinemachineTrackedDollyAutoDollym_EnabledField
Ifchecked,willenableautomaticdolly,whichchoosesapathpositionthatisascloseaspossibletotheFollowtarget.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Boolean
SeeAlsoReferenceCinemachineTrackedDollyAutoDollyStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Ifchecked,willenableautomaticdolly,whichchoosesapathpositionthatisascloseaspossibletotheFollowtarget.Note:thiscanhavesignificantperformanceimpact")]
publicboolm_Enabled
CopyC# JavaScript
![Page 1705: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1705.jpg)
Cinemachine
![Page 1706: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1706.jpg)
CinemachineTrackedDollyAutoDollym_PositionOffsetField
Offset,incurrentpositionunits,fromtheclosestpointonthepathtothefollowtarget.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineTrackedDollyAutoDollyStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Offset,incurrentpositionunits,fromtheclosestpointonthepathtothefollowtarget")]
publicfloatm_PositionOffset
CopyC# JavaScript
![Page 1707: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1707.jpg)
Cinemachine
![Page 1708: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1708.jpg)
CinemachineTrackedDollyAutoDollym_SearchRadiusField
Searchuptohowmanywaypointsoneithersideofthecurrentposition.Use0forEntirepath
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Int32
SeeAlsoReferenceCinemachineTrackedDollyAutoDollyStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Searchuptohowmanywaypointsoneithersideofthecurrentposition.Use0forEntirepath.")]
publicintm_SearchRadius
CopyC# JavaScript
![Page 1709: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1709.jpg)
Cinemachine
![Page 1710: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1710.jpg)
CinemachineTrackedDollyAutoDollym_SearchResolutionField
Wesearchbetweenwaypointsbydividingthesegmentintothismanystraightpieces.Thehigherthenumber,themoreaccuratetheresult,butperformanceisproportionallyslowerforhighernumbers
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Int32
SeeAlsoReferenceCinemachineTrackedDollyAutoDollyStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[FormerlySerializedAsAttribute("m_StepsPerSegment")]
[TooltipAttribute("Wesearchbetweenwaypointsbydividingthesegmentintothismanystraightpieces.Thehigherthenumber,themoreaccuratetheresult,butperformanceisproportionallyslowerforhighernumbers")]
publicintm_SearchResolution
CopyC# JavaScript
![Page 1711: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1711.jpg)
Cinemachine
![Page 1712: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1712.jpg)
CinemachineTrackedDollyCameraUpModeEnumeration
Differentwaystosetthecamera'supvector
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members Membername Value Description
Default 0 Leavethecamera'supvectoralone.ItwillbesetaccordingtotheBrain'sWorldUp.
Path 1 Taketheupvectorfromthepath'supvectoratthecurrentpoint
PathNoRoll 2 Taketheupvectorfromthepath'sup
[DocumentationSortingAttribute(7.1f,DocumentationSortingAttribute
publicenumCameraUpMode
CopyC# JavaScript
![Page 1713: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1713.jpg)
vectoratthecurrentpoint,butwiththerollzeroedout
FollowTarget 3 TaketheupvectorfromtheFollowtarget'supvector
FollowTargetNoRoll 4 TaketheupvectorfromtheFollowtarget'supvector,butwiththerollzeroedout
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1714: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1714.jpg)
Cinemachine
![Page 1715: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1715.jpg)
CinemachineTransposerClass
ThisisaCinemachineComponentintheBodysectionofthecomponentpipeline.Itsjobistopositionthecamerainafixedrelationshiptothevcam'sFollowtargetobject,withoffsetsanddamping.TheTansposerwillonlychangethecamera'spositioninspace.Itwillnotre-orientorotherwiseaimthecamera.Totothat,youneedtoinstructthevcamintheAimsectionofitspipeline.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineComponentBaseCinemachineCinemachineTransposerCinemachineCinemachineOrbitalTransposer
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineTransposertypeexposesthefollowingmembers.
[DocumentationSortingAttribute(5f,DocumentationSortingAttribute
[AddComponentMenu("")]
[RequireComponent(typeof(CinemachinePipeline))]
[SaveDuringPlayAttribute]
publicclassCinemachineTransposer:CinemachineComponentBase
CopyC# JavaScript
![Page 1716: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1716.jpg)
Constructors Name Description
CinemachineTransposer
Top
Properties Name Description
AngularDamping Dampingspeedsforeachofthe3axesofthetarget'srotation
Damping Dampingspeedsforeachofthe3axesoftheoffsetfromtarget
EffectiveOffset Getthetargetoffset,withsanitization
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
IsValid TrueifcomponentisenabledandhasavalidFollowtarget(OverridesCinemachineComponentBaseIsValid.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage
![Page 1717: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1717.jpg)
(OverridesCinemachineComponentBaseStage.)
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)
Top
Methods Name Description
GeTargetCameraPosition InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget
GetReferenceOrientation InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget
InitPrevFrameStateInfo Initializesthestateforpreviousframeifappropriate.
MutateCameraState Positionsthevirtualcameraaccordingtothetransposerrules.(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.implementationaddsthedeltatothefollowoffset.(OverridesCinemachineComponentBaseOnPositionDragged(Vector3)
OnValidate
![Page 1718: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1718.jpg)
TrackTarget Positionsthevirtualcameraaccordingtothetransposerrules.
Top
Fields Name Description
m_BindingMode Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget
m_FollowOffset Thedistancewhichthetransposerwillattempttomaintainfromthetransposersubject
m_PitchDamping Howaggressivelythecameratriestotrackthetargetrotation'sXangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
m_RollDamping Howaggressivelythecameratriestotrackthetargetrotation'sZangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
m_XDamping HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.
![Page 1719: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1719.jpg)
Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
m_YawDamping Howaggressivelythecameratriestotrackthetargetrotation'sYangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
m_YDamping HowaggressivelythecameratriestomaintaintheoffsetintheY-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
m_ZDamping HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamera
![Page 1720: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1720.jpg)
behaviors
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1721: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1721.jpg)
Cinemachine
![Page 1722: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1722.jpg)
CinemachineTransposerConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineTransposer.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineTransposer()
CopyC# JavaScript
![Page 1723: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1723.jpg)
Cinemachine
![Page 1724: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1724.jpg)
CinemachineTransposerProperties
TheCinemachineTransposertypeexposesthefollowingmembers.
Properties Name Description
AngularDamping Dampingspeedsforeachofthe3axesofthetarget'srotation
Damping Dampingspeedsforeachofthe3axesoftheoffsetfromtarget
EffectiveOffset Getthetargetoffset,withsanitization
FollowTarget Returnstheownervcam'sFollowtarget.(InheritedfromCinemachineComponentBase.)
IsValid TrueifcomponentisenabledandhasavalidFollowtarget(OverridesCinemachineComponentBaseIsValid.)
LookAtTarget Returnstheownervcam'sLookAttarget.(InheritedfromCinemachineComponentBase.)
Stage GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage
![Page 1725: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1725.jpg)
(OverridesCinemachineComponentBaseStage.)
VcamState Returnstheownervcam'sCameraState.(InheritedfromCinemachineComponentBase.)
VirtualCamera GettheassociatedCinemachineVirtualCameraBase(InheritedfromCinemachineComponentBase.)
Top
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1726: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1726.jpg)
Cinemachine
![Page 1727: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1727.jpg)
CinemachineTransposerAngularDampingProperty
Dampingspeedsforeachofthe3axesofthetarget'srotation
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Vector3
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedVector3AngularDamping{get;}
CopyC# JavaScript
![Page 1728: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1728.jpg)
Cinemachine
![Page 1729: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1729.jpg)
CinemachineTransposerDampingProperty
Dampingspeedsforeachofthe3axesoftheoffsetfromtarget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Vector3
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedVector3Damping{get;}
CopyC# JavaScript
![Page 1730: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1730.jpg)
Cinemachine
![Page 1731: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1731.jpg)
CinemachineTransposerEffectiveOffsetProperty
Getthetargetoffset,withsanitization
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Vector3
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedVector3EffectiveOffset{get;}
CopyC# JavaScript
![Page 1732: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1732.jpg)
Cinemachine
![Page 1733: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1733.jpg)
CinemachineTransposerIsValidProperty
TrueifcomponentisenabledandhasavalidFollowtarget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideboolIsValid{get;}
CopyC# JavaScript
![Page 1734: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1734.jpg)
Cinemachine
![Page 1735: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1735.jpg)
CinemachineTransposerStageProperty
GettheCinemachinePipelinestagethatthiscomponentimplements.AlwaysreturnstheBodystage
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CinemachineCoreStage
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideCinemachineCoreStageStage{get;}
CopyC# JavaScript
![Page 1736: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1736.jpg)
Cinemachine
![Page 1737: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1737.jpg)
CinemachineTransposerMethods
TheCinemachineTransposertypeexposesthefollowingmembers.
Methods Name Description
GeTargetCameraPosition InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget
GetReferenceOrientation InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget
InitPrevFrameStateInfo Initializesthestateforpreviousframeifappropriate.
MutateCameraState Positionsthevirtualcameraaccordingtothetransposerrules.(OverridesCinemachineComponentBaseMutateCameraState(CameraStateSingle).)
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.implementationaddsthedeltatothefollowoffset.(OverridesCinemachineComponentBaseOnPositionDragged(Vector3)
OnValidate
TrackTarget Positionsthevirtualcameraaccordingtothetransposerrules.
Top
SeeAlso
![Page 1738: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1738.jpg)
ReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1739: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1739.jpg)
Cinemachine
![Page 1740: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1740.jpg)
CinemachineTransposerGeTargetCameraPositionMethod
InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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)"]
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
publicVector3GeTargetCameraPosition(
Vector3worldUp
)
CopyC# JavaScript
![Page 1741: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1741.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1742: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1742.jpg)
Cinemachine
![Page 1743: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1743.jpg)
CinemachineTransposerGetReferenceOrientationMethod
InternalAPIfortheInspectorEditor,soitcandrawamarkeratthetarget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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)"]
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
publicQuaternionGetReferenceOrientation(
Vector3worldUp
)
CopyC# JavaScript
![Page 1744: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1744.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1745: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1745.jpg)
Cinemachine
![Page 1746: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1746.jpg)
CinemachineTransposerInitPrevFrameStateInfoMethod
Initializesthestateforpreviousframeifappropriate.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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)"]
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
protectedvoidInitPrevFrameStateInfo(
refCameraStatecurState,
floatdeltaTime
)
CopyC# JavaScript
![Page 1747: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1747.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1748: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1748.jpg)
Cinemachine
![Page 1749: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1749.jpg)
CinemachineTransposerMutateCameraStateMethod
Positionsthevirtualcameraaccordingtothetransposerrules.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
curStateType:CinemachineCameraStateThecurrentcamerastate
deltaTimeType:SystemSingleUsedfordamping.Iflessthan0,nodampingisdone.
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridevoidMutateCameraState(
refCameraStatecurState,
floatdeltaTime
)
CopyC# JavaScript
![Page 1750: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1750.jpg)
![Page 1751: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1751.jpg)
Cinemachine
![Page 1752: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1752.jpg)
CinemachineTransposerOnPositionDraggedMethod
APIfortheeditor,toprocessapositiondragfromtheuser.Thisimplementationaddsthedeltatothefollowoffset.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
deltaType:Vector3Theamountdraggedthisframe
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverridevoidOnPositionDragged(
Vector3delta
)
CopyC# JavaScript
![Page 1753: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1753.jpg)
Cinemachine
![Page 1754: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1754.jpg)
CinemachineTransposerOnValidateMethod
[Missing<summary>documentationfor"M:Cinemachine.CinemachineTransposer.OnValidate"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedvirtualvoidOnValidate()
CopyC# JavaScript
![Page 1755: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1755.jpg)
Cinemachine
![Page 1756: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1756.jpg)
CinemachineTransposerTrackTargetMethod
Positionsthevirtualcameraaccordingtothetransposerrules.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
deltaTimeType:SystemSingleUsedfordamping.Iflessthan0,nodampingisdone.
upType:Vector3Currentcameraup
desiredCameraOffsetType:Vector3Wherewewanttoputthecamerarelativetothefollowtarget
outTargetPositionType:Vector3Resultingcameraposition
protectedvoidTrackTarget(
floatdeltaTime,
Vector3up,
Vector3desiredCameraOffset,
outVector3outTargetPosition,
outQuaternionoutTargetOrient
)
CopyC# JavaScript
![Page 1757: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1757.jpg)
outTargetOrientType:QuaternionDampedtargetorientation
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1758: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1758.jpg)
Cinemachine
![Page 1759: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1759.jpg)
CinemachineTransposerFields
TheCinemachineTransposertypeexposesthefollowingmembers.
Fields Name Description
m_BindingMode Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget
m_FollowOffset Thedistancewhichthetransposerwillattempttomaintainfromthetransposersubject
m_PitchDamping Howaggressivelythecameratriestotrackthetargetrotation'sXangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
m_RollDamping Howaggressivelythecameratriestotrackthetargetrotation'sZangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
m_XDamping HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersare
![Page 1760: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1760.jpg)
moreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
m_YawDamping Howaggressivelythecameratriestotrackthetargetrotation'sYangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
m_YDamping HowaggressivelythecameratriestomaintaintheoffsetintheY-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
m_ZDamping HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyresponding
![Page 1761: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1761.jpg)
camera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
Top
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1762: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1762.jpg)
Cinemachine
![Page 1763: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1763.jpg)
CinemachineTransposerm_BindingModeField
Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineTransposerBindingMode
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget.Thisisalsousedtosetthecamera'sUpvector,whichwillbemaintainedwhenaimingthecamera.")]
publicCinemachineTransposerBindingModem_BindingMode
CopyC# JavaScript
![Page 1764: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1764.jpg)
Cinemachine
![Page 1765: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1765.jpg)
CinemachineTransposerm_FollowOffsetField
Thedistancewhichthetransposerwillattempttomaintainfromthetransposersubject
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Vector3
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("ThedistancevectorthatthetransposerwillattempttomaintainfromtheFollowtarget")]
publicVector3m_FollowOffset
CopyC# JavaScript
![Page 1766: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1766.jpg)
Cinemachine
![Page 1767: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1767.jpg)
CinemachineTransposerm_PitchDampingField
Howaggressivelythecameratriestotrackthetargetrotation'sXangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("Howaggressivelythecameratriestotrackthetargetrotation'sXangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.")]
publicfloatm_PitchDamping
CopyC# JavaScript
![Page 1768: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1768.jpg)
Cinemachine
![Page 1769: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1769.jpg)
CinemachineTransposerm_RollDampingField
Howaggressivelythecameratriestotrackthetargetrotation'sZangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("Howaggressivelythecameratriestotrackthetargetrotation'sZangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.")]
publicfloatm_RollDamping
CopyC# JavaScript
![Page 1770: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1770.jpg)
Cinemachine
![Page 1771: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1771.jpg)
CinemachineTransposerm_XDampingField
HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("HowaggressivelythecameratriestomaintaintheoffsetintheX-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sx-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]
publicfloatm_XDamping
CopyC# JavaScript
![Page 1772: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1772.jpg)
Cinemachine
![Page 1773: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1773.jpg)
CinemachineTransposerm_YawDampingField
Howaggressivelythecameratriestotrackthetargetrotation'sYangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("Howaggressivelythecameratriestotrackthetargetrotation'sYangle.Smallnumbersaremoreresponsive.Largernumbersgiveamoreheavyslowlyrespondingcamera.")]
publicfloatm_YawDamping
CopyC# JavaScript
![Page 1774: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1774.jpg)
Cinemachine
![Page 1775: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1775.jpg)
CinemachineTransposerm_YDampingField
HowaggressivelythecameratriestomaintaintheoffsetintheY-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("HowaggressivelythecameratriestomaintaintheoffsetintheY-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sy-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]
publicfloatm_YDamping
CopyC# JavaScript
![Page 1776: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1776.jpg)
Cinemachine
![Page 1777: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1777.jpg)
CinemachineTransposerm_ZDampingField
HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceCinemachineTransposerClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(0f,20f)]
[TooltipAttribute("HowaggressivelythecameratriestomaintaintheoffsetintheZ-axis.Smallnumbersaremoreresponsive,rapidlytranslatingthecameratokeepthetarget'sz-axisoffset.Largernumbersgiveamoreheavyslowlyrespondingcamera.Usingdifferentsettingsperaxiscanyieldawiderangeofcamerabehaviors.")]
publicfloatm_ZDamping
CopyC# JavaScript
![Page 1778: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1778.jpg)
Cinemachine
![Page 1779: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1779.jpg)
CinemachineTransposerBindingModeEnumeration
Thecoordinatespacetousewheninterpretingtheoffsetfromthetarget
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members Membername Value Description
LockToTargetOnAssign 0 CamerawillbeboundtotheFollowtargetusingaframeofreferenceconsistingofthetarget'slocalframeatthemomentwhenthe
[DocumentationSortingAttribute(5.01f,DocumentationSortingAttribute
publicenumBindingMode
CopyC# JavaScript
![Page 1780: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1780.jpg)
virtualcamerawasenabled,orwhenthetargetwasassigned.
LockToTargetWithWorldUp 1 CamerawillbeboundtotheFollowtargetusingaframeofreferenceconsistingofthetarget'slocalframe,withthetiltandrollzeroedout.
LockToTargetNoRoll 2 CamerawillbeboundtotheFollowtargetusingaframeofreferenceconsistingofthetarget'slocalframe,withtherollzeroedout.
LockToTarget 3 CamerawillbeboundtotheFollowtargetusingthetarget's
![Page 1781: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1781.jpg)
localframe.
WorldSpace 4 CamerawillbeboundtotheFollowtargetusingaworldspaceoffset.
SimpleFollowWithWorldUp 5 Offsetswillbecalculatedrelativetothetarget,usingCamera-localaxes
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1782: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1782.jpg)
Cinemachine
![Page 1783: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1783.jpg)
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.
![Page 1784: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1784.jpg)
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineVirtualCamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineVirtualCameratypeexposesthefollowingmembers.
Constructors Name Description
CinemachineVirtualCamera
Top
Properties Name Description
[DocumentationSortingAttribute(1f,DocumentationSortingAttribute
[ExecuteInEditMode]
[DisallowMultipleComponent]
[AddComponentMenu("Cinemachine/CinemachineVirtualCamera")]
publicclassCinemachineVirtualCamera:CinemachineVirtualCameraBase
CopyC# JavaScript
![Page 1785: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1785.jpg)
Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo(InheritedfromCinemachineVirtualCameraBase
Follow GettheFollowtargetfortheBodycomponentintheCinemachinePipeline.Ifthisvcamisapartofameta-cameracollection,thentheowner'stargetusedifthelocaltargetisnull.(OverridesCinemachineVirtualCameraBase
LiveChildOrSelf Justreturnsself.(InheritedfromCinemachineVirtualCameraBase
LookAt GettheLookAttargetfortheAimcomponentintheCinemachinePipeline.Ifthisvcamisapartofameta-cameracollection,thentheowner'stargetusedifthelocaltargetisnull.(OverridesCinemachineVirtualCameraBase
Name GetthenameoftheVirtualCamera.BaseimplementationreturnstheownerGameObject'sname.(InheritedfromCinemachineVirtualCameraBase
ParentCamera Supportformeta-virtual-cameras.thesituationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.PrivatearmiesareimplementedasTransform
![Page 1786: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1786.jpg)
childrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase
PreviousStateIsValid SetthistoforcethenextupdatetoignoredeltaTimeandresetitself(InheritedfromCinemachineVirtualCameraBase
Priority GetthePriorityofthevirtualcamera.ThisdeterminesitsplacementCinemachineCore'squeueofeligibleshots.(InheritedfromCinemachineVirtualCameraBase
State TheCameraStateobjectholdsalloftheinformationnecessarytopositiontheUnitycamera.Itistheoutputofthisclass.(OverridesCinemachineVirtualCameraBase
UserIsDragging APIfortheeditor,tomakethedraggingofpositionhandlesbehavebetter.
ValidatingStreamVersion Versionthatwaslaststreamed,forupgradinglegacy(InheritedfromCinemachineVirtualCameraBase
VirtualCameraGameObject TheGameObjectowneroftheVirtualCamerabehaviour.(InheritedfromCinemachineVirtualCameraBase
Top
Methods
![Page 1787: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1787.jpg)
Name Description
AddCinemachineComponentT Addacomponenttothecinemachinepipeline.
AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.becalledaftereachpipelinestage,toallowotherstohookintothepipeline.(Inheritedfrom
DestroyCinemachineComponentT Removeacomponentfromthecinemachinepipeline.
GetCinemachineComponent(CinemachineCoreStage) Getthecomponentsetforaspecificstage.
GetCinemachineComponentT Getanexistingcomponentofaspecifictypefromthecinemachinepipeline.
GetComponentOwner GetthehiddenCinemachinePipelinechildobject.
GetComponentPipeline Getthecomponentpipelineownedbythehiddenchildpiplinecontainer.GetCinemachineComponentmethod.
InvalidateComponentPipeline EditorAPI:Callthiswhenchangingthepipelinefromtheeditor.
InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforall(Inheritedfrom
IsLiveChild Checkwhetherthevcamalivechildofthiscamera.classimplementationalwaysreturnsfalse.(Inheritedfrom
MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereissometimestheneedtopushonetothetop,makingitthecurrentLivecameraifqueuewithitspeers.vcamisenabled:themostrecentonegoestothetopoftheprioritysubqueue.ofitsprioritypeers.
![Page 1788: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1788.jpg)
thenthisvcamwillbecomeLive.(Inheritedfrom
OnDestroy CallstheDestroyPipelineDelegatefordestroyingthehiddenchildobject,tosupportundo.(Overrides
OnDisable Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(Inheritedfrom
OnEnable Makesurethatthepipelinecacheisup-to-date.(Overrides
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.
OnTransformParentChanged Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(Inheritedfrom
OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.implementationmustbecalledbyanyoverriddenmethod.(Inheritedfrom
OnValidate Enforceboundsforfields,whenchangedininspector.(Overrides
PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,thechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledbecalledonLateUpdateinstead.doesnothing.(Inheritedfrom
RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.(Inheritedfrom
ResolveFollow Returnsthisvcam'sFollowtarget,orifthatisnull,willretruntheparentvcam'sFollowtarget.
![Page 1789: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1789.jpg)
(Inheritedfrom
ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretruntheparentvcam'sLookAttarget.(Inheritedfrom
Start Baseclassimplementationdoesnothing.(Inheritedfrom
Update Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(Inheritedfrom
UpdateCameraState CalledbyCinemachineCoreatLateUpdatetimecanpositionitselfandtrackitstargets.itspipelineandgenerateaCameraStateforthisframe.(OverridesCinemachineVirtualCameraBaseSingle)
Top
Fields Name Description
CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.(InheritedfromCinemachineVirtualCameraBase
CreatePipelineOverride Overridecomponentpipelinecreation.ThisneedstobedonebytheeditortosupportUndo.TheoverridemustdoexactlythesamethingastheCreatePipelinemethodinthisclass.
![Page 1790: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1790.jpg)
DestroyPipelineOverride Overridecomponentpipelinedestruction.ThisneedstobedonebytheeditortosupportUndo.
m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_Follow Theobjectthatthecamerawantstomovewith(theBodytarget).TheBodycomponentoftheCinemachineComponentpipelinewillrefertothistargetandpositionthevcaminaccordancewithrulesandsettingsthatareprovidedtoit.Ifthisisnull,thenthevcam'sTransformpositionwillbeused.
m_Lens SpecifiestheLensSettingsofthisVirtualCamera.ThesesettingswillbetransferredtotheUnitycamerawhenthevcamislive.
m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_LookAt Theobjectthatthecamerawantstolookat(theAimtarget).AimcomponentoftheCinemachineComponentpipelinewillrefertothistargetandorientthevcaminaccordancewithrulesandsettingsthatareprovidedto
![Page 1791: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1791.jpg)
it.Ifthisisnull,thenthevcam'sTransformorientationwillbeused.
m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase
OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
PipelineName ThisisthenameofthehiddenGameObjectthatwillbecreatedasachildobjectofthevirtualcamera.ThishiddengameobjectactsasacontainerforthepolymorphicCinemachineComponentpipeline.TheInspectorUIfortheVirtualCameraprovidesaccesstothispipleline,asdotheCinemachineComponent-familyofpublicmethodsinthisclass.lifecycleofthepipelineGameObjectismanagedautomatically.
Top
![Page 1792: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1792.jpg)
SeeAlsoReferenceCinemachineNamespaceCinemachineCinemachineVirtualCameraBaseCinemachineLensSettingsCinemachineCinemachineComposerCinemachineCinemachineTransposerCinemachineCinemachineBasicMultiChannelPerlin
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1793: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1793.jpg)
Cinemachine
![Page 1794: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1794.jpg)
CinemachineVirtualCameraConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineVirtualCamera.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineVirtualCamera()
CopyC# JavaScript
![Page 1795: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1795.jpg)
Cinemachine
![Page 1796: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1796.jpg)
CinemachineVirtualCameraProperties
TheCinemachineVirtualCameratypeexposesthefollowingmembers.
Properties Name Description
Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo(InheritedfromCinemachineVirtualCameraBase
Follow GettheFollowtargetfortheBodycomponentintheCinemachinePipeline.Ifthisvcamisapartofameta-cameracollection,thentheowner'stargetusedifthelocaltargetisnull.(OverridesCinemachineVirtualCameraBase
LiveChildOrSelf Justreturnsself.(InheritedfromCinemachineVirtualCameraBase
LookAt GettheLookAttargetfortheAimcomponentintheCinemachinePipeline.Ifthisvcamisapartofameta-cameracollection,thentheowner'stargetusedifthelocaltargetisnull.(OverridesCinemachineVirtualCameraBase
![Page 1797: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1797.jpg)
Name GetthenameoftheVirtualCamera.BaseimplementationreturnstheownerGameObject'sname.(InheritedfromCinemachineVirtualCameraBase
ParentCamera Supportformeta-virtual-cameras.thesituationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.PrivatearmiesareimplementedasTransformchildrenoftheparentvcam.(InheritedfromCinemachineVirtualCameraBase
PreviousStateIsValid SetthistoforcethenextupdatetoignoredeltaTimeandresetitself(InheritedfromCinemachineVirtualCameraBase
Priority GetthePriorityofthevirtualcamera.ThisdeterminesitsplacementCinemachineCore'squeueofeligibleshots.(InheritedfromCinemachineVirtualCameraBase
State TheCameraStateobjectholdsalloftheinformationnecessarytopositiontheUnitycamera.Itistheoutputofthisclass.(OverridesCinemachineVirtualCameraBase
UserIsDragging APIfortheeditor,tomakethedraggingofpositionhandlesbehavebetter.
![Page 1798: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1798.jpg)
ValidatingStreamVersion Versionthatwaslaststreamed,forupgradinglegacy(InheritedfromCinemachineVirtualCameraBase
VirtualCameraGameObject TheGameObjectowneroftheVirtualCamerabehaviour.(InheritedfromCinemachineVirtualCameraBase
Top
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1799: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1799.jpg)
Cinemachine
![Page 1800: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1800.jpg)
CinemachineVirtualCameraFollowProperty
GettheFollowtargetfortheBodycomponentintheCinemachinePipeline.Ifthisvcamisapartofameta-cameracollection,thentheowner'stargetwillbeusedifthelocaltargetisnull.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:TransformImplementsICinemachineCameraFollow
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideTransformFollow{get;set;}
CopyC# JavaScript
![Page 1801: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1801.jpg)
Cinemachine
![Page 1802: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1802.jpg)
CinemachineVirtualCameraLookAtProperty
GettheLookAttargetfortheAimcomponentintheCinemachinePipeline.Ifthisvcamisapartofameta-cameracollection,thentheowner'stargetwillbeusedifthelocaltargetisnull.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:TransformImplementsICinemachineCameraLookAt
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideTransformLookAt{get;set;}
CopyC# JavaScript
![Page 1803: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1803.jpg)
Cinemachine
![Page 1804: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1804.jpg)
CinemachineVirtualCameraStateProperty
TheCameraStateobjectholdsalloftheinformationnecessarytopositiontheUnitycamera.Itistheoutputofthisclass.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CameraStateImplementsICinemachineCameraState
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicoverrideCameraStateState{get;}
CopyC# JavaScript
![Page 1805: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1805.jpg)
Cinemachine
![Page 1806: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1806.jpg)
CinemachineVirtualCameraUserIsDraggingProperty
APIfortheeditor,tomakethedraggingofpositionhandlesbehavebetter.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicboolUserIsDragging{get;set;}
CopyC# JavaScript
![Page 1807: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1807.jpg)
Cinemachine
![Page 1808: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1808.jpg)
CinemachineVirtualCameraMethods
TheCinemachineVirtualCameratypeexposesthefollowingmembers.
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.
InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforall(Inheritedfrom
![Page 1809: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1809.jpg)
IsLiveChild Checkwhetherthevcamalivechildofthiscamera.classimplementationalwaysreturnsfalse.(Inheritedfrom
MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereissometimestheneedtopushonetothetop,makingitthecurrentLivecameraifqueuewithitspeers.vcamisenabled:themostrecentonegoestothetopoftheprioritysubqueue.ofitsprioritypeers.thenthisvcamwillbecomeLive.(Inheritedfrom
OnDestroy CallstheDestroyPipelineDelegatefordestroyingthehiddenchildobject,tosupportundo.(Overrides
OnDisable Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(Inheritedfrom
OnEnable Makesurethatthepipelinecacheisup-to-date.(Overrides
OnPositionDragged APIfortheeditor,toprocessapositiondragfromtheuser.
OnTransformParentChanged Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(Inheritedfrom
OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.implementationmustbecalledbyanyoverriddenmethod.(Inheritedfrom
OnValidate Enforceboundsforfields,whenchangedininspector.(Overrides
PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schild
![Page 1810: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1810.jpg)
cameras,thechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledbecalledonLateUpdateinstead.doesnothing.(Inheritedfrom
RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.(Inheritedfrom
ResolveFollow Returnsthisvcam'sFollowtarget,orifthatisnull,willretruntheparentvcam'sFollowtarget.(Inheritedfrom
ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretruntheparentvcam'sLookAttarget.(Inheritedfrom
Start Baseclassimplementationdoesnothing.(Inheritedfrom
Update Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.(Inheritedfrom
UpdateCameraState CalledbyCinemachineCoreatLateUpdatetimecanpositionitselfandtrackitstargets.itspipelineandgenerateaCameraStateforthisframe.(OverridesCinemachineVirtualCameraBaseSingle)
Top
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
![Page 1811: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1811.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1812: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1812.jpg)
Cinemachine
![Page 1813: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1813.jpg)
CinemachineVirtualCameraAddCinemachineComponentMethod
Addacomponenttothecinemachinepipeline.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TypeParameters
T
ReturnValueType:T[Missing<returns>documentationfor"M:Cinemachine.CinemachineVirtualCamera.AddCinemachineComponent``1"]
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicTAddCinemachineComponent<T>()
whereT:CinemachineComponentBase
CopyC# JavaScript
![Page 1814: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1814.jpg)
Cinemachine
![Page 1815: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1815.jpg)
CinemachineVirtualCameraDestroyCinemachineComponentMethod
Removeacomponentfromthecinemachinepipeline.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TypeParameters
T
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidDestroyCinemachineComponent<T>()
whereT:CinemachineComponentBase
CopyC# JavaScript
![Page 1816: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1816.jpg)
Cinemachine
![Page 1817: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1817.jpg)
CinemachineVirtualCameraGetCinemachineComponentMethod
OverloadList Name Description
GetCinemachineComponentT Getanexistingcomponentofaspecifictypefromthecinemachinepipeline.
GetCinemachineComponent(CinemachineCoreStage) Getthecomponentsetforaspecificstage.
Top
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1818: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1818.jpg)
Cinemachine
![Page 1819: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1819.jpg)
CinemachineVirtualCameraGetCinemachineComponentMethod
Getanexistingcomponentofaspecifictypefromthecinemachinepipeline.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TypeParameters
T
ReturnValueType:T[Missing<returns>documentationfor"M:Cinemachine.CinemachineVirtualCamera.GetCinemachineComponent``1"]
SeeAlsoReferenceCinemachineVirtualCameraClassGetCinemachineComponentOverloadCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicTGetCinemachineComponent<T>()
whereT:CinemachineComponentBase
CopyC# JavaScript
![Page 1820: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1820.jpg)
![Page 1821: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1821.jpg)
Cinemachine
![Page 1822: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1822.jpg)
CinemachineVirtualCameraGetCinemachineComponentMethod(CinemachineCoreStage)
Getthecomponentsetforaspecificstage.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
stageType:CinemachineCinemachineCoreStageThestageforwhichwewantthecomponent
ReturnValueType:CinemachineComponentBaseTheCinemachinecomponentforthatstage,ornullifnotdefined
SeeAlsoReferenceCinemachineVirtualCameraClassGetCinemachineComponentOverloadCinemachineNamespace
publicCinemachineComponentBaseGetCinemachineComponent
CinemachineCoreStagestage
)
CopyC# JavaScript
![Page 1823: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1823.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1824: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1824.jpg)
Cinemachine
![Page 1825: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1825.jpg)
CinemachineVirtualCameraGetComponentOwnerMethod
GetthehiddenCinemachinePipelinechildobject.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
ReturnValueType:Transform[Missing<returns>documentationfor"M:Cinemachine.CinemachineVirtualCamera.GetComponentOwner"]
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicTransformGetComponentOwner()
CopyC# JavaScript
![Page 1826: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1826.jpg)
Cinemachine
![Page 1827: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1827.jpg)
CinemachineVirtualCameraGetComponentPipelineMethod
Getthecomponentpipelineownedbythehiddenchildpiplinecontainer.Formostpurposes,itispreferabletousetheGetCinemachineComponentmethod.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
ReturnValueType:CinemachineComponentBase[Missing<returns>documentationfor"M:Cinemachine.CinemachineVirtualCamera.GetComponentPipeline"]
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineComponentBase[]GetComponentPipeline
CopyC# JavaScript
![Page 1828: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1828.jpg)
Cinemachine
![Page 1829: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1829.jpg)
CinemachineVirtualCameraInvalidateComponentPipelineMethod
EditorAPI:Callthiswhenchangingthepipelinefromtheeditor.Willforcearebuildofthepipelinecache.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidInvalidateComponentPipeline()
CopyC# JavaScript
![Page 1830: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1830.jpg)
Cinemachine
![Page 1831: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1831.jpg)
CinemachineVirtualCameraOnDestroyMethod
CallstheDestroyPipelineDelegatefordestroyingthehiddenchildobject,tosupportundo.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedoverridevoidOnDestroy()
CopyC# JavaScript
![Page 1832: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1832.jpg)
Cinemachine
![Page 1833: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1833.jpg)
CinemachineVirtualCameraOnEnableMethod
Makesurethatthepipelinecacheisup-to-date.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedoverridevoidOnEnable()
CopyC# JavaScript
![Page 1834: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1834.jpg)
Cinemachine
![Page 1835: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1835.jpg)
CinemachineVirtualCameraOnPositionDraggedMethod
APIfortheeditor,toprocessapositiondragfromtheuser.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
deltaType:Vector3[Missing<paramname="delta"/>documentationfor"M:Cinemachine.CinemachineVirtualCamera.OnPositionDragged(UnityEngine.Vector3)"]
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidOnPositionDragged(
Vector3delta
)
CopyC# JavaScript
![Page 1836: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1836.jpg)
Cinemachine
![Page 1837: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1837.jpg)
CinemachineVirtualCameraOnValidateMethod
Enforceboundsforfields,whenchangedininspector.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedoverridevoidOnValidate()
CopyC# JavaScript
![Page 1838: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1838.jpg)
Cinemachine
![Page 1839: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1839.jpg)
CinemachineVirtualCameraUpdateCameraStateMethod
CalledbyCinemachineCoreatLateUpdatetimesothevcamcanpositionitselfandtrackitstargets.ThisclasswillinvokeitspipelineandgenerateaCameraStateforthisframe.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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)"]
ImplementsICinemachineCameraUpdateCameraState(Vector3,Single)
publicoverridevoidUpdateCameraState(
Vector3worldUp,
floatdeltaTime
)
CopyC# JavaScript
![Page 1840: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1840.jpg)
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1841: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1841.jpg)
Cinemachine
![Page 1842: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1842.jpg)
CinemachineVirtualCameraFields
TheCinemachineVirtualCameratypeexposesthefollowingmembers.
Fields Name Description
CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.(InheritedfromCinemachineVirtualCameraBase
CreatePipelineOverride Overridecomponentpipelinecreation.ThisneedstobedonebytheeditortosupportUndo.TheoverridemustdoexactlythesamethingastheCreatePipelinemethodinthisclass.
DestroyPipelineOverride Overridecomponentpipelinedestruction.ThisneedstobedonebytheeditortosupportUndo.
m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_Follow Theobjectthatthecamerawantstomovewith(theBodytarget).
![Page 1843: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1843.jpg)
TheBodycomponentoftheCinemachineComponentpipelinewillrefertothistargetandpositionthevcaminaccordancewithrulesandsettingsthatareprovidedtoit.Ifthisisnull,thenthevcam'sTransformpositionwillbeused.
m_Lens SpecifiestheLensSettingsofthisVirtualCamera.ThesesettingswillbetransferredtotheUnitycamerawhenthevcamislive.
m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.(InheritedfromCinemachineVirtualCameraBase
m_LookAt Theobjectthatthecamerawantstolookat(theAimtarget).AimcomponentoftheCinemachineComponentpipelinewillrefertothistargetandorientthevcaminaccordancewithrulesandsettingsthatareprovidedtoit.Ifthisisnull,thenthevcam'sTransformorientationwillbeused.
m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.(InheritedfromCinemachineVirtualCameraBase
![Page 1844: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1844.jpg)
OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.(InheritedfromCinemachineVirtualCameraBase
PipelineName ThisisthenameofthehiddenGameObjectthatwillbecreatedasachildobjectofthevirtualcamera.ThishiddengameobjectactsasacontainerforthepolymorphicCinemachineComponentpipeline.TheInspectorUIfortheVirtualCameraprovidesaccesstothispipleline,asdotheCinemachineComponent-familyofpublicmethodsinthisclass.lifecycleofthepipelineGameObjectismanagedautomatically.
Top
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1845: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1845.jpg)
Cinemachine
![Page 1846: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1846.jpg)
CinemachineVirtualCameraCreatePipelineOverrideField
Overridecomponentpipelinecreation.ThisneedstobedonebytheeditortosupportUndo.TheoverridemustdoexactlythesamethingastheCreatePipelinemethodinthisclass.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineVirtualCameraCreatePipelineDelegate
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticCinemachineVirtualCameraCreatePipelineDelegate
CopyC# JavaScript
![Page 1847: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1847.jpg)
Cinemachine
![Page 1848: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1848.jpg)
CinemachineVirtualCameraDestroyPipelineOverrideField
Overridecomponentpipelinedestruction.ThisneedstobedonebytheeditortosupportUndo.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineVirtualCameraDestroyPipelineDelegate
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticCinemachineVirtualCameraDestroyPipelineDelegate
CopyC# JavaScript
![Page 1849: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1849.jpg)
Cinemachine
![Page 1850: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1850.jpg)
CinemachineVirtualCameram_FollowField
Theobjectthatthecamerawantstomovewith(theBodytarget).TheBodycomponentoftheCinemachineComponentpipelinewillrefertothistargetandpositionthevcaminaccordancewithrulesandsettingsthatareprovidedtoit.Ifthisisnull,thenthevcam'sTransformpositionwillbeused.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Transform
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theobjectthatthecamerawantstomovewith(theBodytarget).Ifthisisnull,thenthevcam'sTransformpositionwilldefinethecamera'sposition.")]
[NoSaveDuringPlayAttribute]
publicTransformm_Follow
CopyC# JavaScript
![Page 1851: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1851.jpg)
Cinemachine
![Page 1852: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1852.jpg)
CinemachineVirtualCameram_LensField
SpecifiestheLensSettingsofthisVirtualCamera.ThesesettingswillbetransferredtotheUnitycamerawhenthevcamislive.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:LensSettings
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[FormerlySerializedAsAttribute("m_LensAttributes")]
[TooltipAttribute("SpecifiesthelenspropertiesofthisVirtualCamera.ThisgenerallymirrorstheUnityCamera'slenssettings,andwillbeusedtodrivetheUnitycamerawhenthevcamisactive.")]
[LensSettingsPropertyAttribute]
publicLensSettingsm_Lens
CopyC# JavaScript
![Page 1853: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1853.jpg)
Cinemachine
![Page 1854: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1854.jpg)
CinemachineVirtualCameram_LookAtField
Theobjectthatthecamerawantstolookat(theAimtarget).TheAimcomponentoftheCinemachineComponentpipelinewillrefertothistargetandorientthevcaminaccordancewithrulesandsettingsthatareprovidedtoit.Ifthisisnull,thenthevcam'sTransformorientationwillbeused.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Transform
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theobjectthatthecamerawantstolookat(theAimtarget).Ifthisisnull,thenthevcam'sTransformorientationwilldefinethecamera'sorientation.")]
[NoSaveDuringPlayAttribute]
publicTransformm_LookAt
CopyC# JavaScript
![Page 1855: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1855.jpg)
Cinemachine
![Page 1856: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1856.jpg)
CinemachineVirtualCameraPipelineNameField
ThisisthenameofthehiddenGameObjectthatwillbecreatedasachildobjectofthevirtualcamera.ThishiddengameobjectactsasacontainerforthepolymorphicCinemachineComponentpipeline.TheInspectorUIfortheVirtualCameraprovidesaccesstothispipleline,asdotheCinemachineComponent-familyofpublicmethodsinthisclass.ThelifecycleofthepipelineGameObjectismanagedautomatically.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:String
SeeAlsoReferenceCinemachineVirtualCameraClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicconststringPipelineName="cm"
CopyC# JavaScript
![Page 1857: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1857.jpg)
Cinemachine
![Page 1858: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1858.jpg)
CinemachineVirtualCameraCreatePipelineDelegateDelegate
Overridecomponentpipelinecreation.ThisneedstobedonebytheeditortosupportUndo.TheoverridemustdoexactlythesamethingastheCreatePipelinemethodintheCinemachineVirtualCameraclass.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineCinemachineVirtualCamera
nameType:SystemString
copyFromType:CinemachineCinemachineComponentBase
ReturnValueType:Transform
SeeAlso
publicdelegateTransformCreatePipelineDelegate(
CinemachineVirtualCameravcam,
stringname,
CinemachineComponentBase[]copyFrom
)
CopyC# JavaScript
![Page 1859: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1859.jpg)
ReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1860: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1860.jpg)
Cinemachine
![Page 1861: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1861.jpg)
CinemachineVirtualCameraDestroyPipelineDelegateDelegate
Overridecomponentpipelinedestruction.ThisneedstobedonebytheeditortosupportUndo.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
pipelineType:GameObject
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicdelegatevoidDestroyPipelineDelegate(
GameObjectpipeline
)
CopyC# JavaScript
![Page 1862: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1862.jpg)
Cinemachine
![Page 1863: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1863.jpg)
CinemachineVirtualCameraBaseClass
BaseclassforaMonobehaviourthatrepresentsaVirtualCamerawithintheUnityscene.ThisisintendedtobeattachedtoanemptyTransformGameObject.InheritedclassescanbeeitherstandalonevirtualcamerassuchasCinemachineVirtualCamera,ormeta-camerassuchasCinemachineClearShotorCinemachineFreeLook.ACinemachineVirtualCameraBaseexposesaPriorityproperty.Whenthebehaviourisenabledinthegame,theVirtualCameraisautomaticallyplacedinaqueuemaintainedbythestaticCinemachineCoresingleton.Thequeueissortedbypriority.WhenaUnitycameraisequippedwithaCinemachineBrainbehaviour,thebrainwillchoosethecameraattheheadofthequeue.IfyouhavemultipleUnitycameraswithCinemachineBrainbehaviours(sayinasplit-screencontext),thenyoucanfilterthequeuebysettingthecullingflagsonthevirtualcameras.ThecullingmaskoftheUnityCamerawillthenactasafilterforthebrain.Apartfromthis,thereisnothingthatpreventsavirtualcamerafromcontrollingmultipleUnitycamerassimultaneously.
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseMore...
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
SyntaxCopy
![Page 1864: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1864.jpg)
TheCinemachineVirtualCameraBasetypeexposesthefollowingmembers.
Constructors Name Description
CinemachineVirtualCameraBase
Top
Properties Name Description
Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo
Follow GettheFollowtargetfortheBodycomponentintheCinemachinePipeline.
LiveChildOrSelf Justreturnsself.
LookAt GettheLookAttargetfortheAimcomponentintheCinemachinePipeline.
[SaveDuringPlayAttribute]
publicabstractclassCinemachineVirtualCameraBase
ICinemachineCamera
CopyC# JavaScript
![Page 1865: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1865.jpg)
Name GetthenameoftheVirtualCamera.BaseimplementationreturnstheownerGameObject'sname.
ParentCamera Supportformeta-virtual-cameras.Thisisthesituationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.PrivatearmiesareimplementedasTransformchildrenoftheparentvcam.
PreviousStateIsValid SetthistoforcethenextupdatetoignoredeltaTimeandresetitself
Priority GetthePriorityofthevirtualcamera.ThisdeterminesitsplacementintheCinemachineCore'squeueofeligibleshots.
State TheCameraStateobjectholdsalloftheinformationnecessarytoposition
![Page 1866: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1866.jpg)
theUnitycamera.Itistheoutputofthisclass.
ValidatingStreamVersion Versionthatwaslaststreamed,forupgradinglegacy
VirtualCameraGameObject TheGameObjectowneroftheVirtualCamerabehaviour.
Top
Methods Name Description
AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.Thiswillbecalledaftereachpipelinestage,toallowotherstohookintothepipeline.SeeCinemachineCore.Stage.
InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforallparentcameras(ifany).
IsLiveChild Checkwhetherthevcamalivechildofthiscamera.Thisbaseclassimplementationalwaysreturnsfalse.
MoveToTopOfPrioritySubqueue Whenmultiplevirtual
![Page 1867: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1867.jpg)
camerashavethehighestpriority,thereissometimestheneedtopushonetothetop,makingitthecurrentLivecameraifitsharesthehighestpriorityinthequeuewithitspeers.Thishappensautomaticallywhenanewvcamisenabled:themostrecentonegoestothetopoftheprioritysubqueue.Usethismethodtopushavcamtothetopofitsprioritypeers.Ifitanditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.
OnDestroy Baseclassimplementationremovesthevirtualcamerafromthepriorityqueue.
OnDisable Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.
OnEnable Baseclassimplementationaddsthevirtualcamerafromthepriorityqueue.
OnTransformParentChanged Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.
OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.Baseclassimplementationmustbecalledbyanyoverriddenmethod.
![Page 1868: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1868.jpg)
OnValidate Enforceboundsforfields,whenchangedininspector.Callbaseclassimplementationatthebeginningofoverriddenmethod.Afterbasemethodiscalled,ValidatingStreamVersionwillbevalid.
PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,inordertoallowtheparenttoprepareitschildren.IfthechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledpriortoeveryFixedUpdate,butitmightbecalledonLateUpdateinstead.Baseclassimplementationdoesnothing.
RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.
ResolveFollow Returnsthisvcam'sFollowtarget,orifthatisnull,willretruntheparentvcam'sFollowtarget.
ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretruntheparentvcam'sLookAttarget.
Start Baseclassimplementationdoesnothing.
![Page 1869: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1869.jpg)
Update Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.
UpdateCameraState CalledbyCinemachineCoreatdesignatedupdatetimethevcamcanpositionitselfandtrackitstargets.Donotcallthismethod.Lettheframeworkdoitattheappropriatetime
Top
Fields Name Description
CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.
m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.
m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.
m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthis
![Page 1870: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1870.jpg)
camera.Highernumbershavegreaterpriority.
OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.
Top
SeeAlsoReferenceCinemachineNamespace
InheritanceHierarchySystemObjectObjectComponentBehaviourMonoBehaviourCinemachineCinemachineVirtualCameraBaseCinemachineCinemachineBlendListCameraCinemachineCinemachineClearShotCinemachineCinemachineExternalCameraCinemachineCinemachineFreeLookCinemachineCinemachineMixingCameraCinemachineCinemachineStateDrivenCameraCinemachineCinemachineVirtualCamera
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1871: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1871.jpg)
![Page 1872: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1872.jpg)
Cinemachine
![Page 1873: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1873.jpg)
CinemachineVirtualCameraBaseConstructor
[Missing<summary>documentationfor"M:Cinemachine.CinemachineVirtualCameraBase.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedCinemachineVirtualCameraBase()
CopyC# JavaScript
![Page 1874: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1874.jpg)
Cinemachine
![Page 1875: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1875.jpg)
CinemachineVirtualCameraBaseProperties
TheCinemachineVirtualCameraBasetypeexposesthefollowingmembers.
Properties Name Description
Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo
Follow GettheFollowtargetfortheBodycomponentintheCinemachinePipeline.
LiveChildOrSelf Justreturnsself.
LookAt GettheLookAttargetfortheAimcomponentintheCinemachinePipeline.
Name GetthenameoftheVirtualCamera.BaseimplementationreturnstheownerGameObject'sname.
ParentCamera Supportformeta-
![Page 1876: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1876.jpg)
virtual-cameras.Thisisthesituationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.PrivatearmiesareimplementedasTransformchildrenoftheparentvcam.
PreviousStateIsValid SetthistoforcethenextupdatetoignoredeltaTimeandresetitself
Priority GetthePriorityofthevirtualcamera.ThisdeterminesitsplacementintheCinemachineCore'squeueofeligibleshots.
State TheCameraStateobjectholdsalloftheinformationnecessarytopositiontheUnitycamera.Itistheoutputofthisclass.
ValidatingStreamVersion Versionthatwaslaststreamed,forupgradinglegacy
![Page 1877: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1877.jpg)
VirtualCameraGameObject TheGameObjectowneroftheVirtualCamerabehaviour.
Top
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1878: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1878.jpg)
Cinemachine
![Page 1879: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1879.jpg)
CinemachineVirtualCameraBaseDescriptionProperty
Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:StringImplementsICinemachineCameraDescription
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvirtualstringDescription{get;}
CopyC# JavaScript
![Page 1880: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1880.jpg)
Cinemachine
![Page 1881: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1881.jpg)
CinemachineVirtualCameraBaseFollowProperty
GettheFollowtargetfortheBodycomponentintheCinemachinePipeline.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:TransformImplementsICinemachineCameraFollow
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicabstractTransformFollow{get;set;}
CopyC# JavaScript
![Page 1882: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1882.jpg)
Cinemachine
![Page 1883: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1883.jpg)
CinemachineVirtualCameraBaseLiveChildOrSelfProperty
Justreturnsself.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ICinemachineCameraImplementsICinemachineCameraLiveChildOrSelf
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvirtualICinemachineCameraLiveChildOrSelf{
CopyC# JavaScript
![Page 1884: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1884.jpg)
Cinemachine
![Page 1885: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1885.jpg)
CinemachineVirtualCameraBaseLookAtProperty
GettheLookAttargetfortheAimcomponentintheCinemachinePipeline.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:TransformImplementsICinemachineCameraLookAt
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicabstractTransformLookAt{get;set;}
CopyC# JavaScript
![Page 1886: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1886.jpg)
Cinemachine
![Page 1887: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1887.jpg)
CinemachineVirtualCameraBaseNameProperty
GetthenameoftheVirtualCamera.BaseimplementationreturnstheownerGameObject'sname.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:StringImplementsICinemachineCameraName
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstringName{get;}
CopyC# JavaScript
![Page 1888: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1888.jpg)
Cinemachine
![Page 1889: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1889.jpg)
CinemachineVirtualCameraBaseParentCameraProperty
Supportformeta-virtual-cameras.Thisisthesituationwhereavirtualcameraisinfactthepublicfaceofaprivatearmyofvirtualcameras,whichitmanagesonitsown.ThismethodgetstheVirtualCameraowner,ifany.PrivatearmiesareimplementedasTransformchildrenoftheparentvcam.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ICinemachineCameraImplementsICinemachineCameraParentCamera
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicICinemachineCameraParentCamera{get;}
CopyC# JavaScript
![Page 1890: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1890.jpg)
Cinemachine
![Page 1891: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1891.jpg)
CinemachineVirtualCameraBasePreviousStateIsValidProperty
SetthistoforcethenextupdatetoignoredeltaTimeandresetitself
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Boolean
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicboolPreviousStateIsValid{get;set;}
CopyC# JavaScript
![Page 1892: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1892.jpg)
Cinemachine
![Page 1893: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1893.jpg)
CinemachineVirtualCameraBasePriorityProperty
GetthePriorityofthevirtualcamera.ThisdeterminesitsplacementintheCinemachineCore'squeueofeligibleshots.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Int32ImplementsICinemachineCameraPriority
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicintPriority{get;set;}
CopyC# JavaScript
![Page 1894: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1894.jpg)
Cinemachine
![Page 1895: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1895.jpg)
CinemachineVirtualCameraBaseStateProperty
TheCameraStateobjectholdsalloftheinformationnecessarytopositiontheUnitycamera.Itistheoutputofthisclass.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CameraStateImplementsICinemachineCameraState
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicabstractCameraStateState{get;}
CopyC# JavaScript
![Page 1896: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1896.jpg)
Cinemachine
![Page 1897: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1897.jpg)
CinemachineVirtualCameraBaseValidatingStreamVersionProperty
Versionthatwaslaststreamed,forupgradinglegacy
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Int32
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicintValidatingStreamVersion{get;}
CopyC# JavaScript
![Page 1898: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1898.jpg)
Cinemachine
![Page 1899: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1899.jpg)
CinemachineVirtualCameraBaseVirtualCameraGameObjectProperty
TheGameObjectowneroftheVirtualCamerabehaviour.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:GameObjectImplementsICinemachineCameraVirtualCameraGameObject
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicGameObjectVirtualCameraGameObject{get;}
CopyC# JavaScript
![Page 1900: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1900.jpg)
Cinemachine
![Page 1901: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1901.jpg)
CinemachineVirtualCameraBaseMethods
TheCinemachineVirtualCameraBasetypeexposesthefollowingmembers.
Methods Name Description
AddPostPipelineStageHook Adelegatetohookintothestatecalculationpipeline.Thiswillbecalledaftereachpipelinestage,toallowotherstohookintothepipeline.SeeCinemachineCore.Stage.
InvokePostPipelineStageCallback InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforallparentcameras(ifany).
IsLiveChild Checkwhetherthevcamalivechildofthiscamera.Thisbaseclassimplementationalwaysreturnsfalse.
MoveToTopOfPrioritySubqueue Whenmultiplevirtualcamerashavethehighestpriority,thereissometimestheneedtopushonetothetop,makingitthecurrent
![Page 1902: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1902.jpg)
Livecameraifitsharesthehighestpriorityinthequeuewithitspeers.Thishappensautomaticallywhenanewvcamisenabled:themostrecentonegoestothetopoftheprioritysubqueue.Usethismethodtopushavcamtothetopofitsprioritypeers.Ifitanditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.
OnDestroy Baseclassimplementationremovesthevirtualcamerafromthepriorityqueue.
OnDisable Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.
OnEnable Baseclassimplementationaddsthevirtualcamerafromthepriorityqueue.
OnTransformParentChanged Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.
OnTransitionFromCamera Notificationthatthisvirtualcameraisgoinglive.Baseclassimplementationmustbecalledbyanyoverriddenmethod.
OnValidate Enforceboundsforfields,whenchangedininspector.Callbaseclass
![Page 1903: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1903.jpg)
implementationatthebeginningofoverriddenmethod.Afterbasemethodiscalled,ValidatingStreamVersionwillbevalid.
PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,inordertoallowtheparenttoprepareitschildren.IfthechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledpriortoeveryFixedUpdate,butitmightbecalledonLateUpdateinstead.Baseclassimplementationdoesnothing.
RemovePostPipelineStageHook RemoveaPipelinestagehookcallback.
ResolveFollow Returnsthisvcam'sFollowtarget,orifthatisnull,willretruntheparentvcam'sFollowtarget.
ResolveLookAt Returnsthisvcam'sLookAttarget,orifthatisnull,willretruntheparentvcam'sLookAttarget.
Start Baseclassimplementationdoesnothing.
Update Baseclassimplementationmakessurethepriority
![Page 1904: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1904.jpg)
queueremainsup-to-date.
UpdateCameraState CalledbyCinemachineCoreatdesignatedupdatetimethevcamcanpositionitselfandtrackitstargets.Donotcallthismethod.Lettheframeworkdoitattheappropriatetime
Top
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1905: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1905.jpg)
Cinemachine
![Page 1906: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1906.jpg)
CinemachineVirtualCameraBaseAddPostPipelineStageHookMethod
Adelegatetohookintothestatecalculationpipeline.Thiswillbecalledaftereachpipelinestage,toallowotherstohookintothepipeline.SeeCinemachineCore.Stage.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
dType:CinemachineCinemachineVirtualCameraBaseOnPostPipelineStageDelegateThedelegatetocall.
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvirtualvoidAddPostPipelineStageHook(
CinemachineVirtualCameraBaseOnPostPipelineStageDelegate
)
CopyC# JavaScript
![Page 1907: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1907.jpg)
Cinemachine
![Page 1908: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1908.jpg)
CinemachineVirtualCameraBaseInvokePostPipelineStageCallbackMethod
InvokesthePostPipelineStageDelegateforthiscamera,andupthehierarchyforallparentcameras(ifany).
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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(
CinemachineVirtualCameraBasevcam,
CinemachineCoreStagestage,
refCameraStatenewState,
floatdeltaTime
)
CopyC# JavaScript
![Page 1909: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1909.jpg)
deltaTimeType:SystemSingle[Missing<paramname="deltaTime"/>documentationfor"M:Cinemachine.CinemachineVirtualCameraBase.InvokePostPipelineStageCallback(Cinemachine.CinemachineVirtualCameraBase,Cinemachine.CinemachineCore.Stage,Cinemachine.CameraState@,System.Single)"]
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1910: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1910.jpg)
Cinemachine
![Page 1911: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1911.jpg)
CinemachineVirtualCameraBaseIsLiveChildMethod
Checkwhetherthevcamalivechildofthiscamera.Thisbaseclassimplementationalwaysreturnsfalse.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineICinemachineCameraTheVirtualCameratocheck
ReturnValueType:BooleanTrueifthevcamiscurrentlyactivelyinfluencingthestateofthisvcamImplementsICinemachineCameraIsLiveChild(ICinemachineCamera)
SeeAlsoReferenceCinemachineVirtualCameraBaseClass
publicvirtualboolIsLiveChild(
ICinemachineCameravcam
)
CopyC# JavaScript
![Page 1912: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1912.jpg)
CinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1913: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1913.jpg)
Cinemachine
![Page 1914: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1914.jpg)
CinemachineVirtualCameraBaseMoveToTopOfPrioritySubqueueMethod
Whenmultiplevirtualcamerashavethehighestpriority,thereissometimestheneedtopushonetothetop,makingitthecurrentLivecameraifitsharesthehighestpriorityinthequeuewithitspeers.Thishappensautomaticallywhenanewvcamisenabled:themostrecentonegoestothetopoftheprioritysubqueue.Usethismethodtopushavcamtothetopofitsprioritypeers.Ifitanditspeerssharethehighestpriority,thenthisvcamwillbecomeLive.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidMoveToTopOfPrioritySubqueue()
CopyC# JavaScript
![Page 1915: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1915.jpg)
Cinemachine
![Page 1916: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1916.jpg)
CinemachineVirtualCameraBaseOnDestroyMethod
Baseclassimplementationremovesthevirtualcamerafromthepriorityqueue.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedvirtualvoidOnDestroy()
CopyC# JavaScript
![Page 1917: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1917.jpg)
Cinemachine
![Page 1918: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1918.jpg)
CinemachineVirtualCameraBaseOnDisableMethod
Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedvirtualvoidOnDisable()
CopyC# JavaScript
![Page 1919: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1919.jpg)
Cinemachine
![Page 1920: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1920.jpg)
CinemachineVirtualCameraBaseOnEnableMethod
Baseclassimplementationaddsthevirtualcamerafromthepriorityqueue.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedvirtualvoidOnEnable()
CopyC# JavaScript
![Page 1921: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1921.jpg)
Cinemachine
![Page 1922: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1922.jpg)
CinemachineVirtualCameraBaseOnTransformParentChangedMethod
Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedvirtualvoidOnTransformParentChanged()
CopyC# JavaScript
![Page 1923: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1923.jpg)
Cinemachine
![Page 1924: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1924.jpg)
CinemachineVirtualCameraBaseOnTransitionFromCameraMethod
Notificationthatthisvirtualcameraisgoinglive.Baseclassimplementationmustbecalledbyanyoverriddenmethod.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
fromCamType:CinemachineICinemachineCameraThecamerabeingdeactivated.Maybenull.
ImplementsICinemachineCameraOnTransitionFromCamera(ICinemachineCamera)
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvirtualvoidOnTransitionFromCamera(
ICinemachineCamerafromCam
)
CopyC# JavaScript
![Page 1925: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1925.jpg)
![Page 1926: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1926.jpg)
Cinemachine
![Page 1927: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1927.jpg)
CinemachineVirtualCameraBaseOnValidateMethod
Enforceboundsforfields,whenchangedininspector.Callbaseclassimplementationatthebeginningofoverriddenmethod.Afterbasemethodiscalled,ValidatingStreamVersionwillbevalid.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedvirtualvoidOnValidate()
CopyC# JavaScript
![Page 1928: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1928.jpg)
Cinemachine
![Page 1929: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1929.jpg)
CinemachineVirtualCameraBasePreUpdateChildCamerasMethod
Thisiscalledpriortotheupdatingofthevcam'schildcameras,inordertoallowtheparenttoprepareitschildren.IfthechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledpriortoeveryFixedUpdate,butitmightbecalledonLateUpdateinstead.Baseclassimplementationdoesnothing.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
worldUpType:Vector3DefaultworldUp,setbytheCinemachineBrain
deltaTimeType:SystemSingleDeltatimefortime-basedeffects(ignoreiflessthan0)
ImplementsICinemachineCameraPreUpdateChildCameras(Vector3,Single)
SeeAlso
publicvirtualvoidPreUpdateChildCameras(
Vector3worldUp,
floatdeltaTime
)
CopyC# JavaScript
![Page 1930: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1930.jpg)
ReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1931: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1931.jpg)
Cinemachine
![Page 1932: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1932.jpg)
CinemachineVirtualCameraBaseRemovePostPipelineStageHookMethod
RemoveaPipelinestagehookcallback.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
dType:CinemachineCinemachineVirtualCameraBaseOnPostPipelineStageDelegateThedelegatetoremove.
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvirtualvoidRemovePostPipelineStageHook(
CinemachineVirtualCameraBaseOnPostPipelineStageDelegate
)
CopyC# JavaScript
![Page 1933: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1933.jpg)
Cinemachine
![Page 1934: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1934.jpg)
CinemachineVirtualCameraBaseResolveFollowMethod
Returnsthisvcam'sFollowtarget,orifthatisnull,willretruntheparentvcam'sFollowtarget.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
localFollowType:TransformThisvcam'sFollowvalue.
ReturnValueType:TransformThesamevalue,ortheparent'sifnullandaparentexists.
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForum
protectedTransformResolveFollow(
TransformlocalFollow
)
CopyC# JavaScript
![Page 1936: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1936.jpg)
Cinemachine
![Page 1937: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1937.jpg)
CinemachineVirtualCameraBaseResolveLookAtMethod
Returnsthisvcam'sLookAttarget,orifthatisnull,willretruntheparentvcam'sLookAttarget.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
localLookAtType:TransformThisvcam'sLookAtvalue.
ReturnValueType:TransformThesamevalue,ortheparent'sifnullandaparentexists.
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForum
protectedTransformResolveLookAt(
TransformlocalLookAt
)
CopyC# JavaScript
![Page 1939: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1939.jpg)
Cinemachine
![Page 1940: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1940.jpg)
CinemachineVirtualCameraBaseStartMethod
Baseclassimplementationdoesnothing.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedvirtualvoidStart()
CopyC# JavaScript
![Page 1941: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1941.jpg)
Cinemachine
![Page 1942: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1942.jpg)
CinemachineVirtualCameraBaseUpdateMethod
Baseclassimplementationmakessurethepriorityqueueremainsup-to-date.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedvirtualvoidUpdate()
CopyC# JavaScript
![Page 1943: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1943.jpg)
Cinemachine
![Page 1944: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1944.jpg)
CinemachineVirtualCameraBaseUpdateCameraStateMethod
CalledbyCinemachineCoreatdesignatedupdatetimesothevcamcanpositionitselfandtrackitstargets.Donotcallthismethod.Lettheframeworkdoitattheappropriatetime
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
worldUpType:Vector3DefaultworldUp,setbytheCinemachineBrain
deltaTimeType:SystemSingleDeltatimefortime-basedeffects(ignoreiflessthan0)
ImplementsICinemachineCameraUpdateCameraState(Vector3,Single)
SeeAlsoReference
publicabstractvoidUpdateCameraState(
Vector3worldUp,
floatdeltaTime
)
CopyC# JavaScript
![Page 1945: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1945.jpg)
CinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1946: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1946.jpg)
Cinemachine
![Page 1947: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1947.jpg)
CinemachineVirtualCameraBaseFields
TheCinemachineVirtualCameraBasetypeexposesthefollowingmembers.
Fields Name Description
CinemachineGUIDebuggerCallback Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.
m_ExcludedPropertiesInInspector Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.
m_LockStageInInspector Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.
m_Priority Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.
OnPostPipelineStage Adelegatetohookintothestatecalculationpipeline.Implementaion
![Page 1948: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1948.jpg)
mustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.
Top
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1949: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1949.jpg)
Cinemachine
![Page 1950: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1950.jpg)
CinemachineVirtualCameraBaseCinemachineGUIDebuggerCallbackField
Thisisdeprecated.Itisheretosupportthesoon-to-be-removedCinemachineDebuggerintheEditor.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Action
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[HideInInspector]
[NoSaveDuringPlayAttribute]
publicActionCinemachineGUIDebuggerCallback
CopyC# JavaScript
![Page 1951: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1951.jpg)
Cinemachine
![Page 1952: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1952.jpg)
CinemachineVirtualCameraBasem_ExcludedPropertiesInInspectorField
Inspectorcontrol-UseforhidingsectionsoftheInspectorUI.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:String
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[HideInInspector]
[SerializeField]
[NoSaveDuringPlayAttribute]
publicstring[]m_ExcludedPropertiesInInspector
CopyC# JavaScript
![Page 1953: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1953.jpg)
Cinemachine
![Page 1954: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1954.jpg)
CinemachineVirtualCameraBasem_LockStageInInspectorField
Inspectorcontrol-UseforenablingsectionsoftheInspectorUI.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineCoreStage
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[HideInInspector]
[SerializeField]
[NoSaveDuringPlayAttribute]
publicCinemachineCoreStage[]m_LockStageInInspector
CopyC# JavaScript
![Page 1955: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1955.jpg)
Cinemachine
![Page 1956: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1956.jpg)
CinemachineVirtualCameraBasem_PriorityField
Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Int32
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[NoSaveDuringPlayAttribute]
[TooltipAttribute("Theprioritywilldeterminewhichcamerabecomesactivebasedonthestateofothercamerasandthiscamera.Highernumbershavegreaterpriority.")]
publicintm_Priority
CopyC# JavaScript
![Page 1957: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1957.jpg)
Cinemachine
![Page 1958: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1958.jpg)
CinemachineVirtualCameraBaseOnPostPipelineStageField
Adelegatetohookintothestatecalculationpipeline.Implementaionmustbesuretocallthisaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:CinemachineVirtualCameraBaseOnPostPipelineStageDelegate
SeeAlsoReferenceCinemachineVirtualCameraBaseClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
protectedCinemachineVirtualCameraBaseOnPostPipelineStageDelegate
CopyC# JavaScript
![Page 1959: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1959.jpg)
Cinemachine
![Page 1960: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1960.jpg)
CinemachineVirtualCameraBaseOnPostPipelineStageDelegateDelegate
Adelegatetohookintothestatecalculationpipeline.Thiswillbecalledaftereachpipelinestage,toallowotherservicestohookintothepipeline.SeeCinemachineCore.Stage.Parameters:*CinemachineVirtualCameraBasevcam:thevirtualcamerabeingupdated*CinemachineCore.Stagestage:whatstageinthepipelinehasjustbeenupdated*refCameraStatenewState:thecurrentstateofthevcam*floatdeltaTime:theframetimestep.Lessthan0means"don'tconsiderthepreviousframe"
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineCinemachineVirtualCameraBase
stageType:CinemachineCinemachineCoreStage
newState
publicdelegatevoidOnPostPipelineStageDelegate(
CinemachineVirtualCameraBasevcam,
CinemachineCoreStagestage,
refCameraStatenewState,
floatdeltaTime
)
CopyC# JavaScript
![Page 1961: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1961.jpg)
Type:CinemachineCameraStatedeltaTime
Type:SystemSingle
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1962: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1962.jpg)
Cinemachine
![Page 1963: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1963.jpg)
DocumentationSortingAttributeClass
Atrtributetocontroltheautomaticgenerationofdocumentation.
InheritanceHierarchySystemObjectSystemAttributeCinemachineDocumentationSortingAttribute
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheDocumentationSortingAttributetypeexposesthefollowingmembers.
Constructors Name Description
DocumentationSortingAttribute Contructorwithspecificvalues
Top
Properties
[DocumentationSortingAttribute(0f,DocumentationSortingAttribute
publicsealedclassDocumentationSortingAttribute:
CopyC# JavaScript
![Page 1964: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1964.jpg)
Name Description
Category Refinementlevelofthedocumentation.Themorerefined,themoreisexcluded.
SortOrder Wherethistypeappearsinthemanual.Smallernumbersortearlier.
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1965: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1965.jpg)
Cinemachine
![Page 1966: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1966.jpg)
DocumentationSortingAttributeConstructor
Contructorwithspecificvalues
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 1967: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1967.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1968: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1968.jpg)
Cinemachine
![Page 1969: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1969.jpg)
DocumentationSortingAttributeProperties
TheDocumentationSortingAttributetypeexposesthefollowingmembers.
Properties Name Description
Category Refinementlevelofthedocumentation.Themorerefined,themoreisexcluded.
SortOrder Wherethistypeappearsinthemanual.Smallernumbersortearlier.
Top
SeeAlsoReferenceDocumentationSortingAttributeClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1970: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1970.jpg)
Cinemachine
![Page 1971: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1971.jpg)
DocumentationSortingAttributeCategoryProperty
Refinementlevelofthedocumentation.Themorerefined,themoreisexcluded.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:DocumentationSortingAttributeLevel
SeeAlsoReferenceDocumentationSortingAttributeClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicDocumentationSortingAttributeLevelCategory{
CopyC# JavaScript
![Page 1972: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1972.jpg)
Cinemachine
![Page 1973: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1973.jpg)
DocumentationSortingAttributeSortOrderProperty
Wherethistypeappearsinthemanual.Smallernumbersortearlier.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Single
SeeAlsoReferenceDocumentationSortingAttributeClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicfloatSortOrder{get;}
CopyC# JavaScript
![Page 1974: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1974.jpg)
Cinemachine
![Page 1975: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1975.jpg)
DocumentationSortingAttributeLevelEnumeration
Refinementlevelofthedocumentation
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Members
Membername Value Description
Undoc 0 Typeisexcludedfromdocumentation
API 1 TypeisdocumentedintheAPIreference
UserRef 2 Typeisdocumentedinthehighly-refinedUserManual
SeeAlsoReferenceCinemachineNamespace
publicenumLevel
CopyC# JavaScript
![Page 1976: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1976.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1977: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1977.jpg)
Cinemachine
![Page 1978: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1978.jpg)
ICinemachineCameraInterface
AnabstractrepresentationofavirtualcamerawhichliveswithintheUnityscene
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheICinemachineCameratypeexposesthefollowingmembers.
Properties Name Description
Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo
Follow Thethingthecamerawantstofollow(movingcamera).Maybenull.
LiveChildOrSelf Forcamerasthatimplementchildcameras,returnthelivechild,otherwise,justreturnsself.
publicinterfaceICinemachineCamera
CopyC# JavaScript
![Page 1979: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1979.jpg)
LookAt Thethingthecamerawantstolookat(aim).Maybenull.
Name Getsthenameofthisvirtualcamera.Forusewhendecidinghowtoblendtoorfromthiscamera
ParentCamera Forcamerasthatimplementchildcameras,returnstheparentvcam,otherwisenull.
Priority GetsthepriorityofthisICinemachineCamera.Thevirtualcamerawillbeinsertedintotheglobalprioritystackbasedonthisvalue.
State Camerastateatthecurrenttime.
VirtualCameraGameObject Getsthevirtualcameragameattachedtothisclass.
Top
Methods Name Description
IsLiveChild Checkwhetherthevcamisalivechildofthiscamera.
OnTransitionFromCamera Notificationthatanewcameraisbeingactivated.
![Page 1980: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1980.jpg)
thecurrentlyactivecamera.Bothmaybeactivesimultaneouslyforawhile,ifblending.
PreUpdateChildCameras Thisiscalledpriortotheupdatingofthevcam'schildcameras,inordertoallowtheparenttoprepareitschildren.childrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledpriortoeveryFixedUpdate,butitmightbecalledonLateUpdateinstead.
UpdateCameraState UpdatesthisCinemachineCamera.Foranactivecamerathisshouldbecalledonceandonlyonceeachframe.this,youshouldnevercallthismethoddirectly.CinemachineCore.UpdateVirtualCamera(ICinemachineCamera,float),whichhasprotectionagainstmultiplecallsperframe.
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1981: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1981.jpg)
Cinemachine
![Page 1982: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1982.jpg)
ICinemachineCameraProperties
TheICinemachineCameratypeexposesthefollowingmembers.
Properties Name Description
Description Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo
Follow Thethingthecamerawantstofollow(movingcamera).Maybenull.
LiveChildOrSelf Forcamerasthatimplementchildcameras,returnthelivechild,otherwise,justreturnsself.
LookAt Thethingthecamerawantstolookat(aim).Maybenull.
Name Getsthenameofthisvirtualcamera.Forusewhendecidinghowtoblendtoorfromthiscamera
ParentCamera Forcamerasthatimplementchildcameras,returnsthe
![Page 1983: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1983.jpg)
parentvcam,otherwisenull.
Priority GetsthepriorityofthisICinemachineCamera.Thevirtualcamerawillbeinsertedintotheglobalprioritystackbasedonthisvalue.
State Camerastateatthecurrenttime.
VirtualCameraGameObject Getsthevirtualcameragameattachedtothisclass.
Top
SeeAlsoReferenceICinemachineCameraInterfaceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 1984: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1984.jpg)
Cinemachine
![Page 1985: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1985.jpg)
ICinemachineCameraDescriptionProperty
Getsabriefdebugdescriptionofthisvirtualcamera,forusewhendisplayiongdebuginfo
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:String
SeeAlsoReferenceICinemachineCameraInterfaceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
stringDescription{get;}
CopyC# JavaScript
![Page 1986: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1986.jpg)
Cinemachine
![Page 1987: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1987.jpg)
ICinemachineCameraFollowProperty
Thethingthecamerawantstofollow(movingcamera).Maybenull.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Transform
SeeAlsoReferenceICinemachineCameraInterfaceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
TransformFollow{get;set;}
CopyC# JavaScript
![Page 1988: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1988.jpg)
Cinemachine
![Page 1989: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1989.jpg)
ICinemachineCameraLiveChildOrSelfProperty
Forcamerasthatimplementchildcameras,returnthelivechild,otherwise,justreturnsself.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ICinemachineCamera
SeeAlsoReferenceICinemachineCameraInterfaceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
ICinemachineCameraLiveChildOrSelf{get;}
CopyC# JavaScript
![Page 1990: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1990.jpg)
Cinemachine
![Page 1991: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1991.jpg)
ICinemachineCameraLookAtProperty
Thethingthecamerawantstolookat(aim).Maybenull.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Transform
SeeAlsoReferenceICinemachineCameraInterfaceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
TransformLookAt{get;set;}
CopyC# JavaScript
![Page 1992: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1992.jpg)
Cinemachine
![Page 1993: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1993.jpg)
ICinemachineCameraNameProperty
Getsthenameofthisvirtualcamera.Forusewhendecidinghowtoblendtoorfromthiscamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:String
SeeAlsoReferenceICinemachineCameraInterfaceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
stringName{get;}
CopyC# JavaScript
![Page 1994: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1994.jpg)
Cinemachine
![Page 1995: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1995.jpg)
ICinemachineCameraParentCameraProperty
Forcamerasthatimplementchildcameras,returnstheparentvcam,otherwisenull.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:ICinemachineCamera
SeeAlsoReferenceICinemachineCameraInterfaceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
ICinemachineCameraParentCamera{get;}
CopyC# JavaScript
![Page 1996: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1996.jpg)
Cinemachine
![Page 1997: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1997.jpg)
ICinemachineCameraPriorityProperty
GetsthepriorityofthisICinemachineCamera.Thevirtualcamerawillbeinsertedintotheglobalprioritystackbasedonthisvalue.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:Int32
SeeAlsoReferenceICinemachineCameraInterfaceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
intPriority{get;set;}
CopyC# JavaScript
![Page 1998: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1998.jpg)
Cinemachine
![Page 1999: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/1999.jpg)
ICinemachineCameraStateProperty
Camerastateatthecurrenttime.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:CameraState
SeeAlsoReferenceICinemachineCameraInterfaceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
CameraStateState{get;}
CopyC# JavaScript
![Page 2000: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2000.jpg)
Cinemachine
![Page 2001: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2001.jpg)
ICinemachineCameraVirtualCameraGameObjectProperty
Getsthevirtualcameragameattachedtothisclass.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:GameObject
SeeAlsoReferenceICinemachineCameraInterfaceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
GameObjectVirtualCameraGameObject{get;}
CopyC# JavaScript
![Page 2002: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2002.jpg)
Cinemachine
![Page 2003: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2003.jpg)
ICinemachineCameraMethods
TheICinemachineCameratypeexposesthefollowingmembers.
Methods Name Description
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
SeeAlsoReferenceICinemachineCameraInterfaceCinemachineNamespace
VisittheCinemachineForum
![Page 2005: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2005.jpg)
Cinemachine
![Page 2006: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2006.jpg)
ICinemachineCameraIsLiveChildMethod
Checkwhetherthevcamisalivechildofthiscamera.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vcamType:CinemachineICinemachineCameraTheVirtualCameratocheck
ReturnValueType:BooleanTrueifthevcamiscurrentlyactivelyinfluencingthestateofthisvcam
SeeAlsoReferenceICinemachineCameraInterfaceCinemachineNamespace
VisittheCinemachineForum
boolIsLiveChild(
ICinemachineCameravcam
)
CopyC# JavaScript
![Page 2008: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2008.jpg)
Cinemachine
![Page 2009: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2009.jpg)
ICinemachineCameraOnTransitionFromCameraMethod
Notificationthatanewcameraisbeingactivated.Thisissenttothecurrentlyactivecamera.Bothmaybeactivesimultaneouslyforawhile,ifblending.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
fromCamType:CinemachineICinemachineCameraThecamerabeingdeactivated.Maybenull.
SeeAlsoReferenceICinemachineCameraInterfaceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
voidOnTransitionFromCamera(
ICinemachineCamerafromCam
)
CopyC# JavaScript
![Page 2010: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2010.jpg)
Cinemachine
![Page 2011: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2011.jpg)
ICinemachineCameraPreUpdateChildCamerasMethod
Thisiscalledpriortotheupdatingofthevcam'schildcameras,inordertoallowtheparenttoprepareitschildren.IfthechildrenareupdatingonFixedUpdate,thenthiswillnotnecessarilybecalledpriortoeveryFixedUpdate,butitmightbecalledonLateUpdateinstead.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
worldUpType:Vector3DefaultworldUp,setbytheCinemachineBrain
deltaTimeType:SystemSingleDeltatimefortime-basedeffects(ignoreiflessthan0)
SeeAlsoReferenceICinemachineCameraInterfaceCinemachineNamespace
voidPreUpdateChildCameras(
Vector3worldUp,
floatdeltaTime
)
CopyC# JavaScript
![Page 2012: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2012.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2013: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2013.jpg)
Cinemachine
![Page 2014: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2014.jpg)
ICinemachineCameraUpdateCameraStateMethod
UpdatesthisCinemachineCamera.Foranactivecamerathisshouldbecalledonceandonlyonceeachframe.Toguaranteethis,youshouldnevercallthismethoddirectly.AlwaysuseCinemachineCore.UpdateVirtualCamera(ICinemachineCamera,float),whichhasprotectionagainstmultiplecallsperframe.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
worldUpType:Vector3DefaultworldUp,setbytheCinemachineBrain
deltaTimeType:SystemSingleDeltatimefortime-basedeffects(ignoreiflessthan0)
SeeAlsoReferenceICinemachineCameraInterface
voidUpdateCameraState(
Vector3worldUp,
floatdeltaTime
)
CopyC# JavaScript
![Page 2015: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2015.jpg)
CinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2016: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2016.jpg)
Cinemachine
![Page 2017: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2017.jpg)
LensSettingsStructure
DescribestheFOVandclipplanesforacamera.ThisgenerallymirrorstheUnityCamera'slenssettings,andwillbeusedtodrivetheUnitycamerawhenthevcamisactive.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheLensSettingstypeexposesthefollowingmembers.
Constructors Name Description
LensSettings ExplicitconstructorforthisLensSettings
Top
Methods Name Description
FromCamera CreatesanewLensSettings,copyingthevaluesfromthe
[SerializableAttribute]
[DocumentationSortingAttribute(2f,DocumentationSortingAttribute
publicstructLensSettings
CopyC# JavaScript
![Page 2018: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2018.jpg)
suppliedCamera
Lerp LinearlyblendsthefieldsoftwoLensSettingsandreturnstheresult
Validate Makesurelenssettingsaresane.CallthisfromOnValidate().
Top
Fields Name Description
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
![Page 2019: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2019.jpg)
ReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2020: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2020.jpg)
Cinemachine
![Page 2021: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2021.jpg)
LensSettingsConstructor
ExplicitconstructorforthisLensSettings
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
fovType:SystemSingleTheVerticalfieldofview
orthographicSizeType:SystemSingleIforthographic,thisisthehalf-heightofthescreen
nearClipType:SystemSingleThenearclipplane
farClipType:SystemSingleThefarclipplane
publicLensSettings(
floatfov,
floatorthographicSize,
floatnearClip,
floatfarClip,
floatdutch,
boolortho,
floataspect
)
CopyC# JavaScript
![Page 2022: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2022.jpg)
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
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2023: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2023.jpg)
Cinemachine
![Page 2024: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2024.jpg)
LensSettingsMethods
TheLensSettingstypeexposesthefollowingmembers.
Methods Name Description
FromCamera CreatesanewLensSettings,copyingthevaluesfromthesuppliedCamera
Lerp LinearlyblendsthefieldsoftwoLensSettingsandreturnstheresult
Validate Makesurelenssettingsaresane.CallthisfromOnValidate().
Top
SeeAlsoReferenceLensSettingsStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2025: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2025.jpg)
Cinemachine
![Page 2026: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2026.jpg)
LensSettingsFromCameraMethod
CreatesanewLensSettings,copyingthevaluesfromthesuppliedCamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
fromCameraType:CameraTheCamerafromwhichtheFoV,nearandfarclipplaneswillbecopied.
ReturnValueType:LensSettings[Missing<returns>documentationfor"M:Cinemachine.LensSettings.FromCamera(UnityEngine.Camera)"]
SeeAlsoReferenceLensSettingsStructureCinemachineNamespace
publicstaticLensSettingsFromCamera(
CamerafromCamera
)
CopyC# JavaScript
![Page 2027: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2027.jpg)
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2028: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2028.jpg)
Cinemachine
![Page 2029: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2029.jpg)
LensSettingsLerpMethod
LinearlyblendsthefieldsoftwoLensSettingsandreturnstheresult
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
lensAType:CinemachineLensSettingsTheLensSettingstoblendfrom
lensBType:CinemachineLensSettingsTheLensSettingstoblendto
tType:SystemSingleTheinterpolationvalue.Internallyclampedtotherange[0,1]
ReturnValueType:LensSettingsInterpolatedsettings
SeeAlso
publicstaticLensSettingsLerp(
LensSettingslensA,
LensSettingslensB,
floatt
)
CopyC# JavaScript
![Page 2030: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2030.jpg)
ReferenceLensSettingsStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2031: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2031.jpg)
Cinemachine
![Page 2032: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2032.jpg)
LensSettingsValidateMethod
Makesurelenssettingsaresane.CallthisfromOnValidate().
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceLensSettingsStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicvoidValidate()
CopyC# JavaScript
![Page 2033: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2033.jpg)
Cinemachine
![Page 2034: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2034.jpg)
LensSettingsFields
TheLensSettingstypeexposesthefollowingmembers.
Fields Name Description
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
![Page 2035: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2035.jpg)
CinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2036: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2036.jpg)
Cinemachine
![Page 2037: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2037.jpg)
LensSettingsDefaultField
DefaultLensSettings
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:LensSettings
SeeAlsoReferenceLensSettingsStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticLensSettingsDefault
CopyC# JavaScript
![Page 2038: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2038.jpg)
Cinemachine
![Page 2039: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2039.jpg)
LensSettingsDutchField
Thedutch(tilt)tobeappliedtothecamera.Indegrees
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceLensSettingsStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(-180f,180f)]
[TooltipAttribute("CameraZroll,ortilt,indegrees.")]
publicfloatDutch
CopyC# JavaScript
![Page 2040: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2040.jpg)
Cinemachine
![Page 2041: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2041.jpg)
LensSettingsFarClipPlaneField
ThefarclipplaneforthisLensSettings
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceLensSettingsStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thisdefinesthefarregionoftherenderablerangeofthecamerafrustum.Typicallyyouwanttosetthisvalueaslowaspossiblewithoutcuttingoffdesireddistantobjects")]
publicfloatFarClipPlane
CopyC# JavaScript
![Page 2042: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2042.jpg)
Cinemachine
![Page 2043: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2043.jpg)
LensSettingsFieldOfViewField
Thisisthecameraviewinverticaldegrees.Forcinematicpeople,a50mmlensonasuper-35mmsensorwouldequala19.6degreeFOV
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceLensSettingsStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[RangeAttribute(1f,179f)]
[TooltipAttribute("Thisisthecameraviewinverticaldegrees.Forcinematicpeople,a50mmlensonasuper-35mmsensorwouldequala19.6degreeFOV")]
publicfloatFieldOfView
CopyC# JavaScript
![Page 2044: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2044.jpg)
Cinemachine
![Page 2045: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2045.jpg)
LensSettingsNearClipPlaneField
ThenearclipplaneforthisLensSettings
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceLensSettingsStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thisdefinesthenearregionintherenderablerangeofthecamerafrustum.Raisingthisvaluewillstopthegamefromdrawingthingsnearthecamera,whichcansometimescomeinhandy.Largervalueswillalsoincreaseyourshadowresolution.")]
publicfloatNearClipPlane
CopyC# JavaScript
![Page 2046: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2046.jpg)
Cinemachine
![Page 2047: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2047.jpg)
LensSettingsOrthographicSizeField
Whenusinganorthographiccamera,thisdefinestheheight,inworldco-ordinates,ofthecameraview.
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceLensSettingsStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Whenusinganorthographiccamera,thisdefinesthehalf-height,inworldcoordinates,ofthecameraview.")]
publicfloatOrthographicSize
CopyC# JavaScript
![Page 2048: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2048.jpg)
Cinemachine
![Page 2049: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2049.jpg)
LensSettingsPropertyAttributeClass
PropertyappliedtoLensSettings.Usedforcustomdrawingintheinspector.
InheritanceHierarchySystemObjectSystemAttributePropertyAttributeCinemachineLensSettingsPropertyAttribute
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheLensSettingsPropertyAttributetypeexposesthefollowingmembers.
Constructors Name Description
LensSettingsPropertyAttribute
Top
SeeAlso
publicsealedclassLensSettingsPropertyAttribute:
CopyC# JavaScript
![Page 2050: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2050.jpg)
ReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2051: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2051.jpg)
Cinemachine
![Page 2052: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2052.jpg)
LensSettingsPropertyAttributeConstructor
[Missing<summary>documentationfor"M:Cinemachine.LensSettingsPropertyAttribute.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceLensSettingsPropertyAttributeClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicLensSettingsPropertyAttribute()
CopyC# JavaScript
![Page 2053: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2053.jpg)
Cinemachine
![Page 2054: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2054.jpg)
NoiseSettingsClass
Thisisanassetthatdefinesanoiseprofile.Anoiseprofileistheshapeofthenoiseasafunctionoftime.Youcanbuildarbitrarilycomplexshapesbycombiningdifferentbaseperlinnoisefrequenciesatdifferentamplitudes.Thefrequenciesandamplitudesshouldbechosenwithcare,toensureaninterestingnoisequalitythatisnotobviouslyrepetitive.Asamathematicalside-note,anyarbitraryperiodiccurvecanbebrokendownintoaseriesoffixed-amplitudesine-wavesaddedtogether.Thisiscalledfourierdecomposition,andisthebasisofmuchsignalprocessing.Itdoesn'treallyhavemuchtodowiththisasset,butit'ssuperinteresting!
InheritanceHierarchySystemObjectObjectScriptableObjectCinemachineNoiseSettings
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheNoiseSettingstypeexposesthefollowingmembers.
Constructors Name Description
[DocumentationSortingAttribute(9f,DocumentationSortingAttribute
publicsealedclassNoiseSettings:ScriptableObject
CopyC# JavaScript
![Page 2055: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2055.jpg)
NoiseSettings
Top
Properties Name Description
OrientationNoise GetsthearrayoforientationnoisechannelsforthisNoiseSettings
PositionNoise GetsthearrayofpositionalnoisechannelsforthisNoiseSettings
Top
SeeAlsoReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2056: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2056.jpg)
Cinemachine
![Page 2057: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2057.jpg)
NoiseSettingsConstructor
[Missing<summary>documentationfor"M:Cinemachine.NoiseSettings.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceNoiseSettingsClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicNoiseSettings()
CopyC# JavaScript
![Page 2058: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2058.jpg)
Cinemachine
![Page 2059: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2059.jpg)
NoiseSettingsProperties
TheNoiseSettingstypeexposesthefollowingmembers.
Properties Name Description
OrientationNoise GetsthearrayoforientationnoisechannelsforthisNoiseSettings
PositionNoise GetsthearrayofpositionalnoisechannelsforthisNoiseSettings
Top
SeeAlsoReferenceNoiseSettingsClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2060: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2060.jpg)
Cinemachine
![Page 2061: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2061.jpg)
NoiseSettingsOrientationNoiseProperty
GetsthearrayoforientationnoisechannelsforthisNoiseSettings
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:NoiseSettingsTransformNoiseParams
SeeAlsoReferenceNoiseSettingsClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicNoiseSettingsTransformNoiseParams[]OrientationNoise
CopyC# JavaScript
![Page 2062: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2062.jpg)
Cinemachine
![Page 2063: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2063.jpg)
NoiseSettingsPositionNoiseProperty
GetsthearrayofpositionalnoisechannelsforthisNoiseSettings
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
PropertyValueType:NoiseSettingsTransformNoiseParams
SeeAlsoReferenceNoiseSettingsClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicNoiseSettingsTransformNoiseParams[]PositionNoise
CopyC# JavaScript
![Page 2064: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2064.jpg)
Cinemachine
![Page 2065: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2065.jpg)
NoiseSettingsNoiseParamsStructure
Describesthebehaviourforachannelofnoise
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheNoiseSettingsNoiseParamstypeexposesthefollowingmembers.
Fields Name Description
Amplitude Theamplitudeofthenoiseforthischannel.Largernumbersvibratehigher
Frequency Thefrequencyofnoiseforthischannel.Highermagnitudesvibratefaster
Top
SeeAlso
[SerializableAttribute]
[DocumentationSortingAttribute(9.1f,DocumentationSortingAttribute
publicstructNoiseParams
CopyC# JavaScript
![Page 2066: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2066.jpg)
ReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2067: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2067.jpg)
Cinemachine
![Page 2068: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2068.jpg)
NoiseParamsFields
TheNoiseSettingsNoiseParamstypeexposesthefollowingmembers.
Fields Name Description
Amplitude Theamplitudeofthenoiseforthischannel.Largernumbersvibratehigher
Frequency Thefrequencyofnoiseforthischannel.Highermagnitudesvibratefaster
Top
SeeAlsoReferenceNoiseSettingsNoiseParamsStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2069: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2069.jpg)
Cinemachine
![Page 2070: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2070.jpg)
NoiseSettingsNoiseParamsAmplitudeField
Theamplitudeofthenoiseforthischannel.Largernumbersvibratehigher
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceNoiseSettingsNoiseParamsStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Theamplitudeofthenoiseforthischannel.Largernumbersvibratehigher.")]
publicfloatAmplitude
CopyC# JavaScript
![Page 2071: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2071.jpg)
Cinemachine
![Page 2072: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2072.jpg)
NoiseSettingsNoiseParamsFrequencyField
Thefrequencyofnoiseforthischannel.Highermagnitudesvibratefaster
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceNoiseSettingsNoiseParamsStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("Thefrequencyofnoiseforthischannel.Highermagnitudesvibratefaster.")]
publicfloatFrequency
CopyC# JavaScript
![Page 2073: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2073.jpg)
Cinemachine
![Page 2074: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2074.jpg)
NoiseSettingsTransformNoiseParamsStructure
Containsthebehaviourofnoiseforthenoisemoduleforall3cardinalaxesofthecamera
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheNoiseSettingsTransformNoiseParamstypeexposesthefollowingmembers.
Fields Name Description
X NoisedefinitionforX-axis
Y NoisedefinitionforY-axis
Z NoisedefinitionforZ-axis
Top
SeeAlso
[SerializableAttribute]
[DocumentationSortingAttribute(9.2f,DocumentationSortingAttribute
publicstructTransformNoiseParams
CopyC# JavaScript
![Page 2075: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2075.jpg)
ReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2076: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2076.jpg)
Cinemachine
![Page 2077: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2077.jpg)
TransformNoiseParamsFields
TheNoiseSettingsTransformNoiseParamstypeexposesthefollowingmembers.
Fields Name Description
X NoisedefinitionforX-axis
Y NoisedefinitionforY-axis
Z NoisedefinitionforZ-axis
Top
SeeAlsoReferenceNoiseSettingsTransformNoiseParamsStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2078: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2078.jpg)
Cinemachine
![Page 2079: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2079.jpg)
NoiseSettingsTransformNoiseParamsField
NoisedefinitionforX-axis
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:NoiseSettingsNoiseParams
SeeAlsoReferenceNoiseSettingsTransformNoiseParamsStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("NoisedefinitionforX-axis")]
publicNoiseSettingsNoiseParamsX
CopyC# JavaScript
![Page 2080: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2080.jpg)
Cinemachine
![Page 2081: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2081.jpg)
NoiseSettingsTransformNoiseParamsField
NoisedefinitionforY-axis
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:NoiseSettingsNoiseParams
SeeAlsoReferenceNoiseSettingsTransformNoiseParamsStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("NoisedefinitionforY-axis")]
publicNoiseSettingsNoiseParamsY
CopyC# JavaScript
![Page 2082: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2082.jpg)
Cinemachine
![Page 2083: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2083.jpg)
NoiseSettingsTransformNoiseParamsField
NoisedefinitionforZ-axis
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:NoiseSettingsNoiseParams
SeeAlsoReferenceNoiseSettingsTransformNoiseParamsStructureCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
[TooltipAttribute("NoisedefinitionforZ-axis")]
publicNoiseSettingsNoiseParamsZ
CopyC# JavaScript
![Page 2084: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2084.jpg)
Cinemachine
![Page 2085: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2085.jpg)
NoSaveDuringPlayAttributeClass
Suppressesplay-mode-saveforafield.Useitifthecalseehas[SaveDuringPlay]attributebuttherearefieldsintheclassthatshouldn'tbesaved.
InheritanceHierarchySystemObjectSystemAttributePropertyAttributeCinemachineNoSaveDuringPlayAttribute
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheNoSaveDuringPlayAttributetypeexposesthefollowingmembers.
Constructors Name Description
NoSaveDuringPlayAttribute
Top
SeeAlso
publicsealedclassNoSaveDuringPlayAttribute:PropertyAttribute
CopyC# JavaScript
![Page 2086: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2086.jpg)
ReferenceCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2087: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2087.jpg)
Cinemachine
![Page 2088: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2088.jpg)
NoSaveDuringPlayAttributeConstructor
[Missing<summary>documentationfor"M:Cinemachine.NoSaveDuringPlayAttribute.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceNoSaveDuringPlayAttributeClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicNoSaveDuringPlayAttribute()
CopyC# JavaScript
![Page 2089: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2089.jpg)
Cinemachine
![Page 2090: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2090.jpg)
SaveDuringPlayAttributeClass
Invokeplay-mode-saveforaclass.Thisclass'sfieldswillbescanneduponexitingplaymode,anditspropertyvalueswillbeappliedtothesceneobject.ThisisastopgapmeasurethatwillbecomeobsoleteonceUnityimplementsplay-mode-saveinamoregeneralway.
InheritanceHierarchySystemObjectSystemAttributeCinemachineSaveDuringPlayAttribute
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheSaveDuringPlayAttributetypeexposesthefollowingmembers.
Constructors Name Description
SaveDuringPlayAttribute
Top
SeeAlsoReference
publicsealedclassSaveDuringPlayAttribute:Attribute
CopyC# JavaScript
![Page 2091: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2091.jpg)
CinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2092: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2092.jpg)
Cinemachine
![Page 2093: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2093.jpg)
SaveDuringPlayAttributeConstructor
[Missing<summary>documentationfor"M:Cinemachine.SaveDuringPlayAttribute.#ctor"]
Namespace:CinemachineAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceSaveDuringPlayAttributeClassCinemachineNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicSaveDuringPlayAttribute()
CopyC# JavaScript
![Page 2094: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2094.jpg)
Cinemachine
![Page 2095: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2095.jpg)
Cinemachine.UtilityNamespace
Cinemachinenon-domainutilitiesandUnityextensionsandhelpers
Classes Class Description
CinemachineGameWindowDebug ManagesonscreenpositionsforCinemachinedebuggingoutput
Damper UtilitytoperformrealisticdampingoffloatorVector3values.Thealgorithmisbasedonexponentiallydecayingthedeltauntilonlyanegligibleamountremains.
ReflectionHelpers Anad-hoccollectionofhelpersforreflection,usedby
![Page 2096: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2096.jpg)
Cinemachineoritseditortoolsinvariousplaces
UnityQuaternionExtensions ExtentionstotheQuaternionclass,useninvariousplacesbyCinemachine
UnityRectExtensions Ad-hocxxtentionstotheRectstructure,usedbyCinemachine
UnityVectorExtensions ExtensionstotheVector3class,usedbyCinemachine
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2097: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2097.jpg)
Cinemachine
![Page 2098: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2098.jpg)
CinemachineGameWindowDebugClass
ManagesonscreenpositionsforCinemachinedebuggingoutput
InheritanceHierarchySystemObjectCinemachine.UtilityCinemachineGameWindowDebug
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheCinemachineGameWindowDebugtypeexposesthefollowingmembers.
Constructors Name Description
CinemachineGameWindowDebug
Top
Methods Name Description
GetScreenPos Reserveanon-screen
publicclassCinemachineGameWindowDebug
CopyC# JavaScript
![Page 2099: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2099.jpg)
rectanglefordebuggingoutput.
ReleaseScreenPos ReleaseascreenrectanglepreviouslyobtainedthroughGetScreenPos()
Top
SeeAlsoReferenceCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2100: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2100.jpg)
Cinemachine
![Page 2101: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2101.jpg)
CinemachineGameWindowDebugConstructor
[Missing<summary>documentationfor"M:Cinemachine.Utility.CinemachineGameWindowDebug.#ctor"]
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
SeeAlsoReferenceCinemachineGameWindowDebugClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicCinemachineGameWindowDebug()
CopyC# JavaScript
![Page 2102: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2102.jpg)
Cinemachine
![Page 2103: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2103.jpg)
CinemachineGameWindowDebugMethods
TheCinemachineGameWindowDebugtypeexposesthefollowingmembers.
Methods Name Description
GetScreenPos Reserveanon-screenrectanglefordebuggingoutput.
ReleaseScreenPos ReleaseascreenrectanglepreviouslyobtainedthroughGetScreenPos()
Top
SeeAlsoReferenceCinemachineGameWindowDebugClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2104: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2104.jpg)
Cinemachine
![Page 2105: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2105.jpg)
CinemachineGameWindowDebugGetScreenPosMethod
Reserveanon-screenrectanglefordebuggingoutput.
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
clientType:ObjectTheclientcaller.Thisisusedasahandle.
textType:SystemStringSampletext,fordeterminingrectanglesize
styleType:GUIStyleWhatstylewillbeusedtodraw,usedherefordeterminingrectsize
ReturnValueType:RectAnareaonthegamescreenlargeenoughtoprintthetextinthe
publicstaticRectGetScreenPos(
Objectclient,
stringtext,
GUIStylestyle
)
CopyC# JavaScript
![Page 2106: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2106.jpg)
styleindicated
SeeAlsoReferenceCinemachineGameWindowDebugClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2107: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2107.jpg)
Cinemachine
![Page 2108: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2108.jpg)
CinemachineGameWindowDebugReleaseScreenPosMethod
ReleaseascreenrectanglepreviouslyobtainedthroughGetScreenPos()
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
clientType:ObjectTheclientcaller.Usedasahandle.
SeeAlsoReferenceCinemachineGameWindowDebugClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticvoidReleaseScreenPos(
Objectclient
)
CopyC# JavaScript
![Page 2109: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2109.jpg)
Cinemachine
![Page 2110: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2110.jpg)
DamperClass
UtilitytoperformrealisticdampingoffloatorVector3values.Thealgorithmisbasedonexponentiallydecayingthedeltauntilonlyanegligibleamountremains.
InheritanceHierarchySystemObjectCinemachine.UtilityDamper
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheDampertypeexposesthefollowingmembers.
Methods Name Description
Damp(Single,Single,Single)
Getadampedversionofaquantity.Thisistheportionofthequantitythatwilltakeeffectoverthegiventime.
Damp(Vector3,Single,Single)
Getadampedversionofaquantity.Thisistheportionofthequantitythatwilltakeeffectoverthegiventime.
publicstaticclassDamper
CopyC# JavaScript
![Page 2111: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2111.jpg)
Damp(Vector3,Vector3,Single)
Getadampedversionofaquantity.Thisistheportionofthequantitythatwilltakeeffectoverthegiventime.
Top
Fields Name Description
kNegligibleResidual Standardresidual
Top
SeeAlsoReferenceCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2112: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2112.jpg)
Cinemachine
![Page 2113: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2113.jpg)
DamperMethods
Methods Name Description
Damp(Single,Single,Single)
Getadampedversionofaquantity.Thisistheportionofthequantitythatwilltakeeffectoverthegiventime.
Damp(Vector3,Single,Single)
Getadampedversionofaquantity.Thisistheportionofthequantitythatwilltakeeffectoverthegiventime.
Damp(Vector3,Vector3,Single)
Getadampedversionofaquantity.Thisistheportionofthequantitythatwilltakeeffectoverthegiventime.
Top
SeeAlsoReferenceDamperClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2114: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2114.jpg)
Cinemachine
![Page 2115: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2115.jpg)
DamperDampMethod
OverloadList Name Description
Damp(Single,Single,Single)
Getadampedversionofaquantity.Thisistheportionofthequantitythatwilltakeeffectoverthegiventime.
Damp(Vector3,Single,Single)
Getadampedversionofaquantity.Thisistheportionofthequantitythatwilltakeeffectoverthegiventime.
Damp(Vector3,Vector3,Single)
Getadampedversionofaquantity.Thisistheportionofthequantitythatwilltakeeffectoverthegiventime.
Top
SeeAlsoReferenceDamperClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2116: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2116.jpg)
Cinemachine
![Page 2117: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2117.jpg)
DamperDampMethod(Single,Single,Single)
Getadampedversionofaquantity.Thisistheportionofthequantitythatwilltakeeffectoverthegiventime.
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
initialType:SystemSingleTheamountthatwillbedamped
dampTimeType:SystemSingleTherateofdamping.Thisisthetimeitwouldtaketoreducetheoriginalamounttoanegligiblepercentage
deltaTimeType:SystemSingleThetimeoverwhichtodamp
ReturnValueType:Single
publicstaticfloatDamp(
floatinitial,
floatdampTime,
floatdeltaTime
)
CopyC# JavaScript
![Page 2118: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2118.jpg)
Thedampedamount.Thiswillbetheoriginalamountscaledbyavaluebetween0and1.
SeeAlsoReferenceDamperClassDampOverloadCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2119: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2119.jpg)
Cinemachine
![Page 2120: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2120.jpg)
DamperDampMethod(Vector3,Single,Single)
Getadampedversionofaquantity.Thisistheportionofthequantitythatwilltakeeffectoverthegiventime.
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
initialType:Vector3Theamountthatwillbedamped
dampTimeType:SystemSingleTherateofdamping.Thisisthetimeitwouldtaketoreducetheoriginalamounttoanegligiblepercentage
deltaTimeType:SystemSingleThetimeoverwhichtodamp
ReturnValueType:Vector3
publicstaticVector3Damp(
Vector3initial,
floatdampTime,
floatdeltaTime
)
CopyC# JavaScript
![Page 2121: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2121.jpg)
Thedampedamount.Thiswillbetheoriginalamountscaledbyavaluebetween0and1.
SeeAlsoReferenceDamperClassDampOverloadCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2122: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2122.jpg)
Cinemachine
![Page 2123: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2123.jpg)
DamperDampMethod(Vector3,Vector3,Single)
Getadampedversionofaquantity.Thisistheportionofthequantitythatwilltakeeffectoverthegiventime.
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
initialType:Vector3Theamountthatwillbedamped
dampTimeType:Vector3Therateofdamping.Thisisthetimeitwouldtaketoreducetheoriginalamounttoanegligiblepercentage
deltaTimeType:SystemSingleThetimeoverwhichtodamp
ReturnValueType:Vector3
publicstaticVector3Damp(
Vector3initial,
Vector3dampTime,
floatdeltaTime
)
CopyC# JavaScript
![Page 2124: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2124.jpg)
Thedampedamount.Thiswillbetheoriginalamountscaledbyavaluebetween0and1.
SeeAlsoReferenceDamperClassDampOverloadCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2125: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2125.jpg)
Cinemachine
![Page 2126: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2126.jpg)
DamperFields
TheDampertypeexposesthefollowingmembers.
Fields Name Description
kNegligibleResidual Standardresidual
Top
SeeAlsoReferenceDamperClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2127: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2127.jpg)
Cinemachine
![Page 2128: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2128.jpg)
DamperkNegligibleResidualField
Standardresidual
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceDamperClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicconstfloatkNegligibleResidual=0.01f
CopyC# JavaScript
![Page 2129: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2129.jpg)
Cinemachine
![Page 2130: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2130.jpg)
ReflectionHelpersClass
Anad-hoccollectionofhelpersforreflection,usedbyCinemachineoritseditortoolsinvariousplaces
InheritanceHierarchySystemObjectCinemachine.UtilityReflectionHelpers
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheReflectionHelperstypeexposesthefollowingmembers.
Methods Name Description
AccessInternalFieldT Cheaterextensiontoaccessinternalfieldofanobject
CopyFields Copythefieldsfromoneobjecttoanother
GetFieldPathTType,TValue
Returnsastringpathfromanexpression-mostly
[DocumentationSortingAttribute(0f,DocumentationSortingAttribute
publicstaticclassReflectionHelpers
CopyC# JavaScript
![Page 2131: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2131.jpg)
usedtoretrieveserializedpropertieswithouthardcodingthefieldpath.Safer,andallowsforproperrefactoring.
GetParentObject Gettheobjectownerofafield.Thismethodprocessesthe'.'separatortogetfromtheobjectthatownsthecompoundfieldtotheobjectthatownstheleaffield
Top
SeeAlsoReferenceCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2132: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2132.jpg)
Cinemachine
![Page 2133: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2133.jpg)
ReflectionHelpersMethods
TheReflectionHelperstypeexposesthefollowingmembers.
Methods Name Description
AccessInternalFieldT Cheaterextensiontoaccessinternalfieldofanobject
CopyFields Copythefieldsfromoneobjecttoanother
GetFieldPathTType,TValue
Returnsastringpathfromanexpression-mostlyusedtoretrieveserializedpropertieswithouthardcodingthefieldpath.Safer,andallowsforproperrefactoring.
GetParentObject Gettheobjectownerofafield.Thismethodprocessesthe'.'separatortogetfromtheobjectthatownsthecompoundfieldtotheobjectthatownstheleaffield
Top
SeeAlso
![Page 2134: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2134.jpg)
ReferenceReflectionHelpersClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2135: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2135.jpg)
Cinemachine
![Page 2136: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2136.jpg)
ReflectionHelpersAccessInternalFieldMethod
Cheaterextensiontoaccessinternalfieldofanobject
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
typeType:SystemTypeThetypeofthefield
objType:SystemObjectTheobjecttoaccess
memberNameType:SystemStringThestringnameofthefieldtoaccess
TypeParameters
T
publicstaticTAccessInternalField<T>(
thisTypetype,
Objectobj,
stringmemberName
)
CopyC# JavaScript
![Page 2137: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2137.jpg)
ReturnValueType:TThevalueofthefieldintheobjectsUsageNoteInVisualBasicandC#,youcancallthismethodasaninstancemethodonanyobjectoftypeType.Whenyouuseinstancemethodsyntaxtocallthismethod,omitthefirstparameter.Formoreinformation,seeExtensionMethods(VisualBasic)orExtensionMethods(C#ProgrammingGuide).
SeeAlsoReferenceReflectionHelpersClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2138: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2138.jpg)
Cinemachine
![Page 2139: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2139.jpg)
ReflectionHelpersCopyFieldsMethod
Copythefieldsfromoneobjecttoanother
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
srcType:SystemObjectThesourceobjecttocopyfrom
dstType:SystemObjectThedestinationobjecttocopyto
bindingAttr(Optional)Type:System.ReflectionBindingFlagsThemasktofiltertheattributes.Onlythosefieldsthatgetcaughtinthefilterwillbecopied
SeeAlso
publicstaticvoidCopyFields(
Objectsrc,
Objectdst,
BindingFlagsbindingAttr=BindingFlags.Default|
)
CopyC# JavaScript
![Page 2140: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2140.jpg)
ReferenceReflectionHelpersClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2141: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2141.jpg)
Cinemachine
![Page 2142: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2142.jpg)
ReflectionHelpersGetFieldPathTTypeTValueMethod
Returnsastringpathfromanexpression-mostlyusedtoretrieveserializedpropertieswithouthardcodingthefieldpath.Safer,andallowsforproperrefactoring.
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 2143: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2143.jpg)
SeeAlsoReferenceReflectionHelpersClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2144: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2144.jpg)
Cinemachine
![Page 2145: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2145.jpg)
ReflectionHelpersGetParentObjectMethod
Gettheobjectownerofafield.Thismethodprocessesthe'.'separatortogetfromtheobjectthatownsthecompoundfieldtotheobjectthatownstheleaffield
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 2146: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2146.jpg)
SeeAlsoReferenceReflectionHelpersClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2147: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2147.jpg)
Cinemachine
![Page 2148: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2148.jpg)
UnityQuaternionExtensionsClass
ExtentionstotheQuaternionclass,useninvariousplacesbyCinemachine
InheritanceHierarchySystemObjectCinemachine.UtilityUnityQuaternionExtensions
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheUnityQuaternionExtensionstypeexposesthefollowingmembers.
Methods Name Description
ApplyCameraRotation Applyrotations,firstaboutworldup,thenabout(travelling)localright.rot.yisrotationaboutworldUp,androt.xissecondrotation,aboutlocalright.
publicstaticclassUnityQuaternionExtensions
CopyC# JavaScript
![Page 2149: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2149.jpg)
GetCameraRotationToTarget Gettherotations,firstaboutworldup,thenabout(travelling)localright,necessarytoalignthequaternion'sforwardwiththetargetdirection.Thisrepresentsthetripodheadmovementneededtolookatthetarget.Thisformulationmakesiteasytointerpolatewithoutintroducingspuriousroll.
Normalized Normalizeaquaternion
SlerpWithReferenceUp Thisisaslerpthatmimicsacameraoperator'smovementinthatitchoosesapaththatavoidsthelowerhemisphere,asdefinedbytheupparam
Top
SeeAlsoReference
![Page 2150: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2150.jpg)
Cinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2151: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2151.jpg)
Cinemachine
![Page 2152: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2152.jpg)
UnityQuaternionExtensionsMethods
TheUnityQuaternionExtensionstypeexposesthefollowingmembers.
Methods Name Description
ApplyCameraRotation Applyrotations,firstaboutworldup,thenabout(travelling)localright.rot.yisrotationaboutworldUp,androt.xissecondrotation,aboutlocalright.
GetCameraRotationToTarget Gettherotations,firstaboutworldup,thenabout(travelling)localright,necessarytoalignthequaternion'sforwardwiththetargetdirection.Thisrepresentsthetripodheadmovementneededtolookatthetarget.Thisformulationmakesiteasyto
![Page 2153: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2153.jpg)
interpolatewithoutintroducingspuriousroll.
Normalized Normalizeaquaternion
SlerpWithReferenceUp Thisisaslerpthatmimicsacameraoperator'smovementinthatitchoosesapaththatavoidsthelowerhemisphere,asdefinedbytheupparam
Top
SeeAlsoReferenceUnityQuaternionExtensionsClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2154: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2154.jpg)
Cinemachine
![Page 2155: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2155.jpg)
UnityQuaternionExtensionsApplyCameraRotationMethod
Applyrotations,firstaboutworldup,thenabout(travelling)localright.rot.yisrotationaboutworldUp,androt.xissecondrotation,aboutlocalright.
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 2156: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2156.jpg)
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).
SeeAlsoReferenceUnityQuaternionExtensionsClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2157: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2157.jpg)
Cinemachine
![Page 2158: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2158.jpg)
UnityQuaternionExtensionsGetCameraRotationToTargetMethod
Gettherotations,firstaboutworldup,thenabout(travelling)localright,necessarytoalignthequaternion'sforwardwiththetargetdirection.Thisrepresentsthetripodheadmovementneededtolookatthetarget.Thisformulationmakesiteasytointerpolatewithoutintroducingspuriousroll.
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 2159: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2159.jpg)
ReturnValueType:Vector2Vector2.yisrotationaboutworldUp,andVector2.xissecondrotation,aboutlocalright.UsageNoteInVisualBasicandC#,youcancallthismethodasaninstancemethodonanyobjectoftypeQuaternion.Whenyouuseinstancemethodsyntaxtocallthismethod,omitthefirstparameter.Formoreinformation,seeExtensionMethods(VisualBasic)orExtensionMethods(C#ProgrammingGuide).
SeeAlsoReferenceUnityQuaternionExtensionsClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2160: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2160.jpg)
Cinemachine
![Page 2161: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2161.jpg)
UnityQuaternionExtensionsNormalizedMethod
Normalizeaquaternion
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 2162: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2162.jpg)
SeeAlsoReferenceUnityQuaternionExtensionsClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2163: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2163.jpg)
Cinemachine
![Page 2164: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2164.jpg)
UnityQuaternionExtensionsSlerpWithReferenceUpMethod
Thisisaslerpthatmimicsacameraoperator'smovementinthatitchoosesapaththatavoidsthelowerhemisphere,asdefinedbytheupparam
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
qAType:QuaternionFirstdirection
qBType:QuaternionSeconddirection
tType:SystemSingleInterpolationamount
upType:Vector3
publicstaticQuaternionSlerpWithReferenceUp(
QuaternionqA,
QuaternionqB,
floatt,
Vector3up
)
CopyC# JavaScript
![Page 2165: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2165.jpg)
Definestheupdirection
ReturnValueType:Quaternion[Missing<returns>documentationfor"M:Cinemachine.Utility.UnityQuaternionExtensions.SlerpWithReferenceUp(UnityEngine.Quaternion,UnityEngine.Quaternion,System.Single,UnityEngine.Vector3)"]
SeeAlsoReferenceUnityQuaternionExtensionsClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2166: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2166.jpg)
Cinemachine
![Page 2167: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2167.jpg)
UnityRectExtensionsClass
Ad-hocxxtentionstotheRectstructure,usedbyCinemachine
InheritanceHierarchySystemObjectCinemachine.UtilityUnityRectExtensions
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheUnityRectExtensionstypeexposesthefollowingmembers.
Methods Name Description
Inflated Inflatearect
Top
SeeAlsoReferenceCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicstaticclassUnityRectExtensions
CopyC# JavaScript
![Page 2168: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2168.jpg)
Cinemachine
![Page 2169: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2169.jpg)
UnityRectExtensionsMethods
TheUnityRectExtensionstypeexposesthefollowingmembers.
Methods Name Description
Inflated Inflatearect
Top
SeeAlsoReferenceUnityRectExtensionsClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2170: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2170.jpg)
Cinemachine
![Page 2171: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2171.jpg)
UnityRectExtensionsInflatedMethod
Inflatearect
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 2172: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2172.jpg)
syntaxtocallthismethod,omitthefirstparameter.Formoreinformation,seeExtensionMethods(VisualBasic)orExtensionMethods(C#ProgrammingGuide).
SeeAlsoReferenceUnityRectExtensionsClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2173: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2173.jpg)
Cinemachine
![Page 2174: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2174.jpg)
UnityVectorExtensionsClass
ExtensionstotheVector3class,usedbyCinemachine
InheritanceHierarchySystemObjectCinemachine.UtilityUnityVectorExtensions
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
TheUnityVectorExtensionstypeexposesthefollowingmembers.
Methods Name Description
AlmostZero IsthevectorwithinEpsilonofzerolength?
ClosestPointOnSegment(Vector2,Vector2,Vector2)
Gettheclosestpointonalinesegment.
ClosestPointOnSegment(Vector3,Vector3,Vector3)
Gettheclosestpoint
publicstaticclassUnityVectorExtensions
CopyC# JavaScript
![Page 2175: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2175.jpg)
onalinesegment.
ProjectOntoPlane Returnsanon-normalizedprojectionofthesuppliedvectorontoaplaneasdescribedbyitsnormal
SignedAngle Getasignedanglebetweentwovectors
SlerpWithReferenceUp Thisisaslerpthatmimicsacameraoperator'smovementinthatitchoosesapaththatavoidsthelowerhemisphere,asdefinedbytheupparam
Top
Fields Name Description
Epsilon AusefulEpsilon
Top
![Page 2176: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2176.jpg)
SeeAlsoReferenceCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2177: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2177.jpg)
Cinemachine
![Page 2178: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2178.jpg)
UnityVectorExtensionsMethods
TheUnityVectorExtensionstypeexposesthefollowingmembers.
Methods Name Description
AlmostZero IsthevectorwithinEpsilonofzerolength?
ClosestPointOnSegment(Vector2,Vector2,Vector2)
Gettheclosestpointonalinesegment.
ClosestPointOnSegment(Vector3,Vector3,Vector3)
Gettheclosestpointonalinesegment.
ProjectOntoPlane Returnsanon-normalizedprojectionofthesuppliedvectorontoaplaneasdescribedbyitsnormal
SignedAngle Getasignedanglebetweentwovectors
![Page 2179: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2179.jpg)
SlerpWithReferenceUp Thisisaslerpthatmimicsacameraoperator'smovementinthatitchoosesapaththatavoidsthelowerhemisphere,asdefinedbytheupparam
Top
SeeAlsoReferenceUnityVectorExtensionsClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2180: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2180.jpg)
Cinemachine
![Page 2181: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2181.jpg)
UnityVectorExtensionsAlmostZeroMethod
IsthevectorwithinEpsilonofzerolength?
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 2182: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2182.jpg)
SeeAlsoReferenceUnityVectorExtensionsClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2183: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2183.jpg)
Cinemachine
![Page 2184: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2184.jpg)
UnityVectorExtensionsClosestPointOnSegmentMethod
OverloadList Name Description
ClosestPointOnSegment(Vector2,Vector2,Vector2)
Gettheclosestpointonalinesegment.
ClosestPointOnSegment(Vector3,Vector3,Vector3)
Gettheclosestpointonalinesegment.
Top
SeeAlsoReferenceUnityVectorExtensionsClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2185: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2185.jpg)
Cinemachine
![Page 2186: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2186.jpg)
UnityVectorExtensionsClosestPointOnSegmentMethod(Vector2,Vector2,Vector2)
Gettheclosestpointonalinesegment.
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
pType:Vector2Apointinspace
s0Type:Vector2Startoflinesegment
s1Type:Vector2Endoflinesegment
ReturnValueType:SingleTheinterpolationparameterrepresentingthepointonthesegment,with0==s0,and1==s1
publicstaticfloatClosestPointOnSegment(
thisVector2p,
Vector2s0,
Vector2s1
)
CopyC# JavaScript
![Page 2187: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2187.jpg)
UsageNoteInVisualBasicandC#,youcancallthismethodasaninstancemethodonanyobjectoftypeVector2.Whenyouuseinstancemethodsyntaxtocallthismethod,omitthefirstparameter.Formoreinformation,seeExtensionMethods(VisualBasic)orExtensionMethods(C#ProgrammingGuide).
SeeAlsoReferenceUnityVectorExtensionsClassClosestPointOnSegmentOverloadCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2188: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2188.jpg)
Cinemachine
![Page 2189: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2189.jpg)
UnityVectorExtensionsClosestPointOnSegmentMethod(Vector3,Vector3,Vector3)
Gettheclosestpointonalinesegment.
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
pType:Vector3Apointinspace
s0Type:Vector3Startoflinesegment
s1Type:Vector3Endoflinesegment
ReturnValueType:SingleTheinterpolationparameterrepresentingthepointonthesegment,with0==s0,and1==s1
publicstaticfloatClosestPointOnSegment(
thisVector3p,
Vector3s0,
Vector3s1
)
CopyC# JavaScript
![Page 2190: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2190.jpg)
UsageNoteInVisualBasicandC#,youcancallthismethodasaninstancemethodonanyobjectoftypeVector3.Whenyouuseinstancemethodsyntaxtocallthismethod,omitthefirstparameter.Formoreinformation,seeExtensionMethods(VisualBasic)orExtensionMethods(C#ProgrammingGuide).
SeeAlsoReferenceUnityVectorExtensionsClassClosestPointOnSegmentOverloadCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2191: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2191.jpg)
Cinemachine
![Page 2192: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2192.jpg)
UnityVectorExtensionsProjectOntoPlaneMethod
Returnsanon-normalizedprojectionofthesuppliedvectorontoaplaneasdescribedbyitsnormal
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
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
![Page 2193: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2193.jpg)
methodsyntaxtocallthismethod,omitthefirstparameter.Formoreinformation,seeExtensionMethods(VisualBasic)orExtensionMethods(C#ProgrammingGuide).
SeeAlsoReferenceUnityVectorExtensionsClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2194: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2194.jpg)
Cinemachine
![Page 2195: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2195.jpg)
UnityVectorExtensionsSignedAngleMethod
Getasignedanglebetweentwovectors
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
fromType:Vector3Startdirection
toType:Vector3Enddirection
refNormalType:Vector3Thisisneededinordertodeterminethesign.Forexample,iffromantolieontheXZplane,thenthiswouldbetheYunitvector,orindeedanyvectorwhich,whendottedwithYunitvector,wouldgiveapositiveresult.
ReturnValue
publicstaticfloatSignedAngle(
Vector3from,
Vector3to,
Vector3refNormal
)
CopyC# JavaScript
![Page 2196: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2196.jpg)
Type:SingleThesignedanglebetweenthevectors
SeeAlsoReferenceUnityVectorExtensionsClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2197: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2197.jpg)
Cinemachine
![Page 2198: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2198.jpg)
UnityVectorExtensionsSlerpWithReferenceUpMethod
Thisisaslerpthatmimicsacameraoperator'smovementinthatitchoosesapaththatavoidsthelowerhemisphere,asdefinedbytheupparam
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
Parameters
vAType:Vector3Firstdirection
vBType:Vector3Seconddirection
tType:SystemSingleInterpolationamount
upType:Vector3
publicstaticVector3SlerpWithReferenceUp(
Vector3vA,
Vector3vB,
floatt,
Vector3up
)
CopyC# JavaScript
![Page 2199: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2199.jpg)
Definestheupdirection
ReturnValueType:Vector3[Missing<returns>documentationfor"M:Cinemachine.Utility.UnityVectorExtensions.SlerpWithReferenceUp(UnityEngine.Vector3,UnityEngine.Vector3,System.Single,UnityEngine.Vector3)"]
SeeAlsoReferenceUnityVectorExtensionsClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2200: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2200.jpg)
Cinemachine
![Page 2201: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2201.jpg)
UnityVectorExtensionsFields
TheUnityVectorExtensionstypeexposesthefollowingmembers.
Fields Name Description
Epsilon AusefulEpsilon
Top
SeeAlsoReferenceUnityVectorExtensionsClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
![Page 2202: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2202.jpg)
Cinemachine
![Page 2203: Cinemachine - documentation.help · one cameraman smoothly passing the camera to another cameraman. You can specify the time over which to blend, as well as the blend curve shape](https://reader031.vdocuments.mx/reader031/viewer/2022013019/5e19a624f5259b7aab712a22/html5/thumbnails/2203.jpg)
UnityVectorExtensionsEpsilonField
AusefulEpsilon
Namespace:Cinemachine.UtilityAssembly:Cinemachine(inCinemachine.dll)Version:2.0.0.0(2.0.0.0)
Syntax
FieldValueType:Single
SeeAlsoReferenceUnityVectorExtensionsClassCinemachine.UtilityNamespace
VisittheCinemachineForumhttps://unity3d.com/legal/terms-of-service
publicconstfloatEpsilon=0.0001f
CopyC# JavaScript