UI Tutorial Fade 1.0.0
https://assetstore.unity.com/packages/slug/230845
Public Member Functions | Properties | List of all members
Abu.RectTransformTutorialHole Class Reference

Tutorial hole that corresponds with rect transform provided by user. More...

Inheritance diagram for Abu.RectTransformTutorialHole:
Abu.TutorialHole

Public Member Functions

 RectTransformTutorialHole (RectTransform rectTransform, bool isAutoUpdate=true)
 Creates RectTransformTutorialHole More...
 
override Rect GetWorldRect ()
 Returns current hole rect in world. More...
 
override void UpdateRect ()
 Updates WorldRect by provided RectTransform. More...
 
abstract void UpdateRect ()
 Updates WorldRect. More...
 
abstract Rect GetWorldRect ()
 Returns current hole rect in world. More...
 

Properties

RectTransform RectTransform [get]
 RectTransform which will be highlighted. 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 corresponds with rect transform provided by user.

Constructor & Destructor Documentation

◆ RectTransformTutorialHole()

Abu.RectTransformTutorialHole.RectTransformTutorialHole ( RectTransform  rectTransform,
bool  isAutoUpdate = true 
)

Creates RectTransformTutorialHole

Parameters
rectTransformRectTransform which will be highlighted
isAutoUpdateShould world rect be auto updated every frame, or developer will manually update it to achieve better performance.

Member Function Documentation

◆ GetWorldRect()

override Rect Abu.RectTransformTutorialHole.GetWorldRect ( )
virtual

Returns current hole rect in world.

Returns
Will return Rect.zero if RectTransform is null

Implements Abu.TutorialHole.

◆ UpdateRect()

override void Abu.RectTransformTutorialHole.UpdateRect ( )
virtual

Updates WorldRect by provided RectTransform.

Implements Abu.TutorialHole.

Property Documentation

◆ RectTransform

RectTransform Abu.RectTransformTutorialHole.RectTransform
get

RectTransform which will be highlighted.

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