CameraEffect<T, U>
Class in Zigurous.CameraSystem
Inherits from CameraModifier<T>
Implements ICameraEffect
Declaration
public abstract class CameraEffect<T, U> : CameraModifier<T>, ICameraEffect where T : CameraEffectSettings<U>, new()
where U : CameraEffectProfileDescription
A simulated effect that is applied to the camera.
Type Parameters
| T | The settings type to use for the effect. |
| U | The profile type to use for the effect. |
Properties
| profile | The active settings profile for the effect. |
| active | Whether the effect is currently active. |
Methods
| Activate | Activates the effect. |
| Deactivate | Deactivates the effect. |
| SetProfile | Sets the profile with the given name to be active. |
| OnEffectActivate | A callback invoked when the effect is activated. |
| OnEffectDeactivate | A callback invoked when the effect is deactivated. |
| OnEffectRestart | A callback invoked when the effect is restarted. |
Inherited
Properties
| settings | The settings for the behavior. |
| enabled | Enables or disables the behavior from being updated. |
| controller | The camera controller handling the module. |
| registered | Whether the module has been registered to a controller. |
| id | The unique identifier of the camera module. |