Struct AxisState.Recentering
Helper for automatic axis recentering
Inherited Members
Namespace: Cinemachine
Assembly: solution.dll
Syntax
[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
[Serializable]
public struct AxisState.Recentering
Constructors
| Name | Description |
|---|---|
| Recentering(bool, float, float) | Constructor with specific field values |
Fields
| Name | Description |
|---|---|
| m_RecenteringTime | How long it takes to reach destination once recentering has started |
| m_WaitTime | If no input has been detected, the camera will wait this long in seconds before moving its heading to the default heading. |
| m_enabled | If checked, will enable automatic recentering of the axis. If FALSE, recenting is disabled. |
Methods
| Name | Description |
|---|---|
| CancelRecentering() | Cancel any recenetering in progress. |
| CopyStateFrom(ref Recentering) | |
| DoRecentering(ref AxisState, float, float) | Bring the axis back to the centered state (only if enabled). |
| RecenterNow() | Skip the wait time and start recentering now (only if enabled). |
| Validate() | Call this from OnValidate() |