The base class for all tutorial holes. More...

Inheritance diagram for Abu.TutorialHole:

Public Member Functions
abstract void	UpdateRect ()
	Updates WorldRect. More...

abstract Rect	GetWorldRect ()
	Returns current hole rect in world. More...

Protected Member Functions
	TutorialHole (bool isAutoUpdate=true)
	Creates new tutorial hole. More...

void	InvokeRectChanged ()
	Invokes RectChanged event. More...

Properties
bool	IsAutoUpdateEnabled `[get, set]`
	Should world rect be auto updated every frame, or developer will manually update it to achieve better performance. More...

Events
Action	RectChanged
	Called when WorldRect changed. More...

Detailed Description

The base class for all tutorial holes.

Constructor & Destructor Documentation

◆ TutorialHole()

Abu.TutorialHole.TutorialHole ( bool isAutoUpdate = true )

protected

Creates new tutorial hole.

Parameters

isAutoUpdate Should world rect be auto updated every frame, or developer will manually update it to achieve better performance.

Member Function Documentation

◆ GetWorldRect()

abstract Rect Abu.TutorialHole.GetWorldRect ( )

pure virtual

Returns current hole rect in world.

Returns: Could return Rect.zero if some parameters was not provided

Implemented in Abu.RectTransformTutorialHole, Abu.RectTutorialHole, and Abu.RendererTutorialHole.

◆ InvokeRectChanged()

void Abu.TutorialHole.InvokeRectChanged ( )

protected

Invokes RectChanged event.

◆ UpdateRect()

abstract void Abu.TutorialHole.UpdateRect ( )

pure virtual

Updates WorldRect.

Implemented in Abu.RectTransformTutorialHole, Abu.RectTutorialHole, and Abu.RendererTutorialHole.

Property Documentation

◆ IsAutoUpdateEnabled

bool Abu.TutorialHole.IsAutoUpdateEnabled

getset

Should world rect be auto updated every frame, or developer will manually update it to achieve better performance.

Event Documentation

◆ RectChanged

Action Abu.TutorialHole.RectChanged

Called when WorldRect changed.

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

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

Public Member Functions

Protected Member Functions

Properties

Events