Tutorial hole which calculates world rect based on Renderer.bounds. More...

Inheritance diagram for Abu.RendererTutorialHole:

Public Member Functions
	RendererTutorialHole (Renderer renderer, TutorialFadeImage fadeImage, bool isAutoUpdate=true)
	Creates RendererTutorialHole More...

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

override void	UpdateRect ()
	Updates WorldRect by provided Renderer and FadeImage. More...

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

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

Properties
Renderer	Renderer `[get]`
	Renderer which bounds will be used for world rect calculation. More...

TutorialFadeImage	FadeImage `[get]`
	Fade image which will be used for hole rendering. 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 which calculates world rect based on Renderer.bounds.

It's not recommended to use overlay canvas for this type of tutorial hole. For world rect calculation FadeImage should be attached to canvas with camera. If you're using canvas Overlay render mode you still should serialize camera via debug inspector.

Constructor & Destructor Documentation

◆ RendererTutorialHole()

Abu.RendererTutorialHole.RendererTutorialHole	(	Renderer	renderer,
		TutorialFadeImage	fadeImage,
		bool	isAutoUpdate = `true`
	)

Creates RendererTutorialHole

Parameters

renderer	Renderer which bounds will be used for world rect calculation.
fadeImage	Fade image which will be used for hole rendering. For world rect calculation FadeImage should be attached to canvas with camera. If you're using canvas Overlay render mode you still should serialize camera via debug inspector. However it's not recommended to use overlay canvas for this type of tutorial 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.RendererTutorialHole.GetWorldRect ( )

virtual

Returns current hole rect in world.

Returns: Will return Rect.zero if Renderer or FadeImage or FadeImage.canvas or FadeImage.canvas.worldCamera are null.

Implements Abu.TutorialHole.

◆ UpdateRect()

override void Abu.RendererTutorialHole.UpdateRect ( )

virtual

Updates WorldRect by provided Renderer and FadeImage.

Implements Abu.TutorialHole.

Property Documentation

◆ FadeImage

TutorialFadeImage Abu.RendererTutorialHole.FadeImage

get

Fade image which will be used for hole rendering.

For world rect calculation FadeImage should be attached to canvas with camera. If you're using canvas Overlay render mode you still should serialize camera via debug inspector.

◆ Renderer

Renderer Abu.RendererTutorialHole.Renderer

get

Renderer which bounds will be used for world rect calculation.

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

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

Public Member Functions

Properties

Additional Inherited Members