Tutorial hole that receives world rect, provided by user. More...

Inheritance diagram for Abu.RectTutorialHole:

Public Member Functions
	RectTutorialHole (Rect worldRect, bool isAutoUpdate=true)
	Creates RectTutorialHole More...

void	SetWorldRect (Rect worldRect)
	Sets rect in world. More...

override void	UpdateRect ()
	Does nothing. More...

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

abstract void	UpdateRect ()
	Updates WorldRect. More...

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

Properties
Rect	WorldRect `[get]`
	Rect in world More...

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

Additional Inherited Members
Protected Member Functions inherited from Abu.TutorialHole
	TutorialHole (bool isAutoUpdate=true)
	Creates new tutorial hole. More...

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

Events inherited from Abu.TutorialHole
Action	RectChanged
	Called when WorldRect changed. More...

Detailed Description

Tutorial hole that receives world rect, provided by user.

Constructor & Destructor Documentation

◆ RectTutorialHole()

Abu.RectTutorialHole.RectTutorialHole	(	Rect	worldRect,
		bool	isAutoUpdate = `true`
	)

Creates RectTutorialHole

Parameters

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

Member Function Documentation

◆ GetWorldRect()

override Rect Abu.RectTutorialHole.GetWorldRect ( )

virtual

Returns current hole rect in world.

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

Implements Abu.TutorialHole.

◆ SetWorldRect()

void Abu.RectTutorialHole.SetWorldRect ( Rect worldRect )

Sets rect in world.

Parameters

worldRect Rect in world coordinates.

◆ UpdateRect()

override void Abu.RectTutorialHole.UpdateRect ( )

virtual

Does nothing.

rect should be provided by user manually.

Implements Abu.TutorialHole.

Property Documentation

◆ WorldRect

Rect Abu.RectTutorialHole.WorldRect

get

Rect in world

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

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

Public Member Functions

Properties

Additional Inherited Members