Flies the camera smoothly between two points with configurable speed and easing. More...
Public Types | |
| enum | EasingMode { Linear , EaseInOut , EaseIn , EaseOut } |
| enum | PlayMode { Once , Loop , PingPong } |
| enum | LookMode { InterpolateRotation , LookAtPath , LookAtTarget , LookAlongPath , LookAtEndPoint } |
Public Member Functions | |
| void | StartFly () |
| Starts the camera fly animation from start point to end point. | |
| void | StopFly () |
| Stops the camera fly animation. | |
| void | StopAndRestore () |
| Stops flying and restores the camera to its original position before flying started. | |
| void | FlyReverse () |
| Flies in reverse from the current position back to the start point. | |
| void | GoToStart () |
| Sets the camera immediately to the start point without animating. | |
| void | GoToEnd () |
| Sets the camera immediately to the end point without animating. | |
| void | SetStartFromCamera () |
| Sets the start point to the current camera position and rotation. | |
| void | SetEndFromCamera () |
| Sets the end point to the current camera position and rotation. | |
Public Attributes | |
| Transform | StartPoint |
| Starting position and rotation for the camera fly path. | |
| Transform | EndPoint |
| Ending position and rotation for the camera fly path. | |
| Vector3 | PositionOffset |
| Position offset relative to path direction. | |
| LookMode | RotationMode |
| Controls how camera rotation behaves during flight. | |
| Transform | LookAtTarget |
| Target transform to look at when using LookAtTarget mode. | |
| float | HorizontalAngle |
| Horizontal rotation offset applied to camera orientation. | |
| float | VerticalAngle |
| Vertical rotation offset applied to camera orientation. | |
| float | Duration |
| Duration in seconds for the camera to fly between points. | |
| EasingMode | Easing |
| Easing mode for smooth acceleration/deceleration. | |
| PlayMode | Mode |
| Determines if animation plays once, loops, or ping-pongs. | |
| bool | AutoStartOnEnable |
| Automatically start flying when enabled. | |
| float | StartDelay |
| Delay before starting the fly animation. | |
| PLCInputBool | SignalStart |
| PLC signal to trigger start (rising edge) | |
| PLCInputBool | SignalStop |
| PLC signal to stop the animation. | |
| PLCOutputBool | SignalIsFlying |
| Output signal indicating flight is active. | |
| PLCOutputBool | SignalReachedEnd |
| Output signal when end point is reached. | |
| bool | StartFlying |
| Public bool to trigger start. | |
| bool | StopFlying |
| Public bool to stop flying. | |
| bool | IsFlying |
| Current flying state (read only) | |
| float | Progress |
| Current progress 0-1 (read only) | |
| bool | StopOnMouseClick |
| Stop flight when user clicks. | |
| float | FollowLerpSpeed |
| Lerp speed for camera following. | |
| bool | SmoothStart |
| Enable smooth transition when starting to fly. | |
| int | GizmoIntermediateSteps |
| Number of intermediate camera positions shown in editor gizmos. | |
| float | GizmoFrustumSize |
| Size of the camera frustum visualization. | |
Detailed Description
Flies the camera smoothly between two points with configurable speed and easing.
Can be triggered by buttons, PLC signals, or automatically at start. Supports both one-shot and looping modes with optional ping-pong motion. Camera can be offset from the path and can look at a target or along the path direction.
Member Enumeration Documentation
◆ LookMode
◆ PlayMode
Member Function Documentation
◆ FlyReverse()
| void realvirtual.CameraFlyBetweenPoints.FlyReverse | ( | ) |
Flies in reverse from the current position back to the start point.
◆ GoToEnd()
| void realvirtual.CameraFlyBetweenPoints.GoToEnd | ( | ) |
Sets the camera immediately to the end point without animating.
◆ GoToStart()
| void realvirtual.CameraFlyBetweenPoints.GoToStart | ( | ) |
Sets the camera immediately to the start point without animating.
◆ SetEndFromCamera()
| void realvirtual.CameraFlyBetweenPoints.SetEndFromCamera | ( | ) |
Sets the end point to the current camera position and rotation.
Useful for setting up fly paths in the editor.
◆ SetStartFromCamera()
| void realvirtual.CameraFlyBetweenPoints.SetStartFromCamera | ( | ) |
Sets the start point to the current camera position and rotation.
Useful for setting up fly paths in the editor.
◆ StartFly()
| void realvirtual.CameraFlyBetweenPoints.StartFly | ( | ) |
Starts the camera fly animation from start point to end point.
Can be called from button OnClick events or via code.
◆ StopAndRestore()
| void realvirtual.CameraFlyBetweenPoints.StopAndRestore | ( | ) |
Stops flying and restores the camera to its original position before flying started.
◆ StopFly()
| void realvirtual.CameraFlyBetweenPoints.StopFly | ( | ) |
Stops the camera fly animation.
Camera remains at its current position.
Member Data Documentation
◆ AutoStartOnEnable
| bool realvirtual.CameraFlyBetweenPoints.AutoStartOnEnable |
Automatically start flying when enabled.
◆ Duration
| float realvirtual.CameraFlyBetweenPoints.Duration |
Duration in seconds for the camera to fly between points.
◆ Easing
| EasingMode realvirtual.CameraFlyBetweenPoints.Easing |
Easing mode for smooth acceleration/deceleration.
◆ EndPoint
| Transform realvirtual.CameraFlyBetweenPoints.EndPoint |
Ending position and rotation for the camera fly path.
◆ FollowLerpSpeed
| float realvirtual.CameraFlyBetweenPoints.FollowLerpSpeed |
Lerp speed for camera following.
◆ GizmoFrustumSize
| float realvirtual.CameraFlyBetweenPoints.GizmoFrustumSize |
Size of the camera frustum visualization.
◆ GizmoIntermediateSteps
| int realvirtual.CameraFlyBetweenPoints.GizmoIntermediateSteps |
Number of intermediate camera positions shown in editor gizmos.
◆ HorizontalAngle
| float realvirtual.CameraFlyBetweenPoints.HorizontalAngle |
Horizontal rotation offset applied to camera orientation.
◆ IsFlying
| bool realvirtual.CameraFlyBetweenPoints.IsFlying |
Current flying state (read only)
◆ LookAtTarget
| Transform realvirtual.CameraFlyBetweenPoints.LookAtTarget |
Target transform to look at when using LookAtTarget mode.
◆ Mode
| PlayMode realvirtual.CameraFlyBetweenPoints.Mode |
Determines if animation plays once, loops, or ping-pongs.
◆ PositionOffset
| Vector3 realvirtual.CameraFlyBetweenPoints.PositionOffset |
Position offset relative to path direction.
◆ Progress
| float realvirtual.CameraFlyBetweenPoints.Progress |
Current progress 0-1 (read only)
◆ RotationMode
| LookMode realvirtual.CameraFlyBetweenPoints.RotationMode |
Controls how camera rotation behaves during flight.
◆ SignalIsFlying
| PLCOutputBool realvirtual.CameraFlyBetweenPoints.SignalIsFlying |
Output signal indicating flight is active.
◆ SignalReachedEnd
| PLCOutputBool realvirtual.CameraFlyBetweenPoints.SignalReachedEnd |
Output signal when end point is reached.
◆ SignalStart
| PLCInputBool realvirtual.CameraFlyBetweenPoints.SignalStart |
PLC signal to trigger start (rising edge)
◆ SignalStop
| PLCInputBool realvirtual.CameraFlyBetweenPoints.SignalStop |
PLC signal to stop the animation.
◆ SmoothStart
| bool realvirtual.CameraFlyBetweenPoints.SmoothStart |
Enable smooth transition when starting to fly.
◆ StartDelay
| float realvirtual.CameraFlyBetweenPoints.StartDelay |
Delay before starting the fly animation.
◆ StartFlying
| bool realvirtual.CameraFlyBetweenPoints.StartFlying |
Public bool to trigger start.
◆ StartPoint
| Transform realvirtual.CameraFlyBetweenPoints.StartPoint |
Starting position and rotation for the camera fly path.
◆ StopFlying
| bool realvirtual.CameraFlyBetweenPoints.StopFlying |
Public bool to stop flying.
◆ StopOnMouseClick
| bool realvirtual.CameraFlyBetweenPoints.StopOnMouseClick |
Stop flight when user clicks.
◆ VerticalAngle
| float realvirtual.CameraFlyBetweenPoints.VerticalAngle |
Vertical rotation offset applied to camera orientation.