Abu.TutorialFadeImage Class Reference

Component which will render added holes in UI. More...

Inheritance diagram for Abu.TutorialFadeImage:

Public Member Functions
void	AddHole (TutorialHole hole)
	Each added tutorial hole will be rendered on this FadeImage. More...
void	RemoveHole (TutorialHole hole)
	Removed tutorial hole won't rendered on this FadeImage. More...
override bool	IsRaycastLocationValid (Vector2 eventPosition, Camera eventCamera)
	Used to pass events within holes and prevent other events. More...

Protected Member Functions
override void	OnDestroy ()
override void	OnDidApplyAnimationProperties ()

Properties
override Material	material [get]
	Material to render shader. More...
float	Smoothness [get, set]
	Hole edge smoothness (i.e. More...

Detailed Description

Component which will render added holes in UI.

Member Function Documentation

AddHole()

void Abu.TutorialFadeImage.AddHole

(

TutorialHole

hole

)

Each added tutorial hole will be rendered on this FadeImage.

Parameters

hole	The hole which will be rendered on fade image. Shouldn't be null.

IsRaycastLocationValid()

override bool Abu.TutorialFadeImage.IsRaycastLocationValid	(	Vector2	eventPosition,
		Camera	eventCamera
	)

Used to pass events within holes and prevent other events.

Parameters

eventPosition
eventCamera

Returns

OnDestroy()

override void Abu.TutorialFadeImage.OnDestroy ( )

protected

OnDidApplyAnimationProperties()

override void Abu.TutorialFadeImage.OnDidApplyAnimationProperties ( )

protected

RemoveHole()

void Abu.TutorialFadeImage.RemoveHole

(

TutorialHole

hole

)

Removed tutorial hole won't rendered on this FadeImage.

Parameters

hole	The hole which won't be rendered on this fade image.

Property Documentation

material

override Material Abu.TutorialFadeImage.material

get

Material to render shader.

Shader must support all parameters described above.

Smoothness

float Abu.TutorialFadeImage.Smoothness

getset

Hole edge smoothness (i.e.

size of the hole). Should be greater then 0

---

The documentation for this class was generated from the following file:

• /Users/amir/RiderProjects/UI Tutorial Fade/Assets/TutorialFadeImage/Scripts/TutorialFadeImage.cs