API reference

TunnelingEffect Class

Extends MonoBehaviour
This component draws a vignette at a cameara's near plane.
The direction of the vignette can be controller, it does not need to necesarily centered and can even point backwards to draw a solid circle.

Protected Fields

_started : bool
Signature
bool _started

Properties

AimingDirection : Vector3
[Get][Set]
Signature
Vector3 AimingDirection
AlphaStrength : float
[Get][Set]
Signature
float AlphaStrength
ExtraFeatheredFOV : float
[Get][Set]
Signature
float ExtraFeatheredFOV
MaskInnerColor : Color
[Get][Set]
Signature
Color MaskInnerColor
MaskOuterColor : Color
[Get][Set]
Signature
Color MaskOuterColor
PlaneDistance : float
[Get][Set]
Signature
float PlaneDistance
UseAimingTarget : bool
[Get][Set]
Signature
bool UseAimingTarget
UserFOV : float
[Get][Set]
Signature
float UserFOV

Protected Methods

OnDisable ()
Signature
virtual void OnDisable()
Returns
void
OnEnable ()
Signature
virtual void OnEnable()
Returns
void
Start ()
Signature
virtual void Start()
Returns
void

Methods

InjectAllTunnelingEffect ( leftEyeAnchor , rightEyeAnchor , centerEyeCamera , meshFilter )
Signature
void InjectAllTunnelingEffect(Transform leftEyeAnchor, Transform rightEyeAnchor, Camera centerEyeCamera, MeshFilter meshFilter)
Parameters
leftEyeAnchor: Transform
rightEyeAnchor: Transform
centerEyeCamera: Camera
meshFilter: MeshFilter
Returns
void
InjectCenterEyeCamera ( centerEyeCamera )
Signature
void InjectCenterEyeCamera(Camera centerEyeCamera)
Parameters
centerEyeCamera: Camera
Returns
void
InjectLeftEyeAnchor ( leftEyeAnchor )
Signature
void InjectLeftEyeAnchor(Transform leftEyeAnchor)
Parameters
leftEyeAnchor: Transform
Returns
void
InjectMeshFilter ( meshFilter )
Signature
void InjectMeshFilter(MeshFilter meshFilter)
Parameters
meshFilter: MeshFilter
Returns
void
InjectRightEyeAnchor ( rightEyeAnchor )
Signature
void InjectRightEyeAnchor(Transform rightEyeAnchor)
Parameters
rightEyeAnchor: Transform
Returns
void