Class CinemachineFreeLookModifier.Modifier
Interface for an object that will modify some aspect of a FreeLook camera
based on the vertical axis value.
Inheritance
CinemachineFreeLookModifier.Modifier
Assembly: solution.dll
Syntax
[Serializable]
public abstract class CinemachineFreeLookModifier.Modifier
Properties
Name |
Description |
CachedComponentType
|
Type of the cached component (null if no cached component). If this modifier targets
specific components, this value indicates the type of that component.
The modifier should cache the component, for performance.
|
HasRequiredComponent
|
Return true if cached vcam component is present or not required
|
Methods
Name |
Description |
AfterPipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)
|
Called from extension's PostPipelineStageCallback(Finalize). Perform any necessary actions to state,
and restore any camera parameters changed in BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float).
|
BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)
|
Called from extension's PrePipelineMutateCameraState(). Perform any necessary actions to
modify relevant camera settings. Original camera settings should be restored in AfterPipeline(CinemachineVirtualCameraBase, ref CameraState, float, float).
|
RefreshCache(CinemachineVirtualCameraBase)
|
Called from OnEnable and from the inspector. Refresh any performance-sensitive stuff.
|
Reset(CinemachineVirtualCameraBase)
|
Called when the modifier is created. Initialize fields with appropriate values.
|
Validate(CinemachineVirtualCameraBase)
|
Called from OnValidate in the editor. Validate and sanitize the fields.
|
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.