Zigurous.CameraSystem
Classes
AimPunch
Quickly "punches" the camera's rotation in one direction then resets to the resting position. This is often used to indicate the player was hit by an object or attack.
AimPunchProfile
A settings profile for an aim punch effect.
AimPunchSettings
Settings for an aim punch effect.
AnimatorMotion
Tracks the motion of the character's animator component and applies it as a modifier to the camera.
AnimatorMotionSettings
Settings for an animator motion modifier.
AutoFocus
Changes the depth of field based on where the camera is looking.
AutoFocusSettings
Settings for a depth of field effect.
CameraBehavior<T>
The base class for all camera behaviors which are enabled and disabled based on the settings of the behavior.
CameraBehaviorSettings
The base class for all camera behavior settings.
CameraBehaviorSettings<T>
The base class for camera behavior settings of a specified type.
CameraCollision
Adjusts the camera's position to avoid colliding with objects or occluding the tracking target.
CameraCollisionSettings
Settings for camera collision.
CameraContext
A context object that represents a camera's state.
CameraController
Controls and handles the behaviors of a camera.
CameraCursor
Changes the mouse cursor settings.
CameraCursorSettings
Settings for the camera cursor.
CameraEffect<T, U>
A simulated effect that is applied to the camera.
CameraEffectExtensions
Extension methods for ICameraEffect.
CameraEffectProfile
The base class for camera effect profiles.
CameraEffectSettings<T, U>
The base class for camera effect settings of a specified type.
CameraEffectSettings<T>
The base class for all camera effect settings.
CameraModifier<T>
A camera behavior that applies a transform modifier to the camera.
CameraModule
The base class for all camera modules which are registered to a camera controller and are updated every frame by the controller.
CameraModuleManager
Manages the camera modules for a camera controller.
CameraPresetExtensions
Extension methods for CameraPreset.
CameraProfile
The settings profile for a camera controller.
CameraSettings
The base class for all camera settings.
CameraShake
Rapidly changes the position and rotation of the camera to simulate the camera shaking.
CameraShakeProfile
A settings profile for a camera shake effect.
CameraShakeSettings
Settings for a camera shake effect.
CameraSightEvent
Invokes an event when the camera is within a certain distance of a target.
EyelineAdjustment
Adjusts the position of the camera to match the eyeline of the character.
EyelineAdjustmentSettings
Settings for an eyeline tracker modifier.
FOVKick
Animates a subtle change in the field of view of the camera. For example, increasing the field of view when the player sprints creates a better feel for the faster motion.
FOVKickProfile
A settings profile for a FOV "Kick" effect.
FOVKickSettings
Settings for a FOV "Kick" effect.
FOVKickTransition
Settings for a FOV "Kick" transition.
Follow
Moves and rotates the camera to follow a tracked object.
FollowSettings
Settings for a camera follow behavior.
FreeFly
Handles free fly camera movement.
FreeFlyInputSettings
Input settings for a camera free fly behavior.
FreeFlySettings
Settings for a camera free fly behavior.
FreeFlySpeedSettings
Speed settings for a camera free fly behavior.
FreeLook
Handles looking around while orbiting a pivot point.
FreeLookAxis
Settings for a look axis.
FreeLookInitialAngle
Settings for the initial angle of a look axis.
FreeLookSettings
Settings for a camera free look behavior.
HeadBob
Simulates the effect of a person's head moving very slightly when walking or running.
HeadBobSettings
Settings for a head bob modifier.
Noise
Applies a subtle motion to the camera using a noise function. This can be used to give the camera a more hand-held feel.
NoiseSettings
Settings for a noise modifier.
Panning
Pans the camera around on the XZ plane usually from mouse input.
PanningSettings
Settings for a camera panning behavior.
PlayerModelHider
Hides the player model based on the camera zoom distance. This is intended for games that are both 1st and 3rd person.
Raycasting
Extension methods for performing raycasts from the camera.
Recoil
Quickly changes the orientation of the camera to simulate recoil, such as when shooting a gun.
RecoilSettings
Settings for a recoil modifier.
ScreenFade
Fades the screen in and out.
ScreenFadeProfile
A settings profile for a screen fade effect.
ScreenFadeSettings
Settings for a screen fade effect.
ScreenFadeTransition
Settings for a fade transition.
ShoulderLean
Handles tilting the camera to the left or right to lean around corners.
ShoulderLeanInputSettings
Input settings for a shoulder lean modifier.
ShoulderLeanSettings
Settings for a shoulder lean modifier.
ShoulderSwap
Handles swapping the camera offset from one side of the character's shoulders to the other.
ShoulderSwapInputSettings
Input settings for a shoulder swap modifier.
ShoulderSwapSettings
Settings for a shoulder swap modifier.
Targeting
Allows the camera to track targetable objects.
TargetingLineOfSightModule
A camera targeting module that performs line of sight checks to determine if targets are visible.
TargetingLineOfSightSettings
Settings for a camera targeting module to indicate how the camera checks if a target is visible.
TargetingLocatingModule
A camera targeting module to locate targets within the camera's view.
TargetingLocatingSettings
Settings for a camera targeting module to indicate how the camera locates targets.
TargetingLookAtModule
A camera targeting module that rotates the camera to look at the target.
TargetingLookAtSettings
Settings for a camera targeting module to indicate how the camera looks at targeted objects.
TargetingModule<T>
The base class for all camera targeting modules.
TargetingRecenteringModule
A camera targeting module that resets the rotation of the camera to face the default forward direction when not targeting an object.
TargetingRecenteringSettings
Settings for a camera targeting module to indicate how the camera recenters back to a forward position.
TargetingSettings
Settings for a camera targeting behavior.
TargetingSwitchingModule
A camera targeting module that handles switching to new targets to the left or right of the current target. The module also marks new targets as "sticky" so they cannot be switched from too quickly on accident.
TargetingSwitchingSettings
Settings for a camera targeting module to indicate how the camera switches between targets.
TargetingUIModule
A camera targeting module that displays UI while targeting objects.
TargetingUISettings
Settings for a camera targeting module to indicate how the camera displays tracking UI.
Zoom
Changes the distance of the camera from the pivot point.
ZoomSettings
Settings for a camera zoom behavior.
Structs
CursorState
The cursor settings for a given state.
Interfaces
ICameraEffect
An interface for a simulated effect that is applied to the camera.
Enums
AutoFocusMode
A type of auto focus mode.
CameraPreset
A preset for a camera settings profile.
ScreenFadeInitialState
An initial screen fade state when the camera is first activated.
ShoulderSwapPosition
A shoulder swap position, i.e., right, left, or center.