Smart Gallery v1.1
 
Loading...
Searching...
No Matches
Module Class Referenceabstract

This class is used as a base for all modules in the SmartGallery. More...

Inheritance diagram for Module:
AnimatedModule ContentModule Transition ContinuousTransition Immediate Fade HorizontalFlip HorizontalSlide VerticalFlip VerticalSlide HorizontalSlideAndFade VerticalSlideAndFade

Public Member Functions

virtual void Initialize (Viewer viewer)
 Initializes the module with a given Viewer instance.
 

Protected Member Functions

virtual void OnDestroy ()
 Handles the destruction of the module.
 
virtual void OnFrameChangeComplete ()
 Handles the completion of the frame change.
 
virtual void OnFrameChanged (int index)
 Handles the FrameChanged event of the viewer's message system.
 
virtual void OnReload ()
 Method called when the list or contents of frames have been changed.
 
virtual void OnViewerInitialized ()
 Handles the Initialized event of the viewer.
 

Properties

MessageSystem messageSystem [get]
 Gets the MessageSystem instance from the Viewer.
 
virtual Property[] properties [get]
 Gets an array of Property objects associated with the module.
 
RectTransform rectTransform [get]
 Gets the RectTransform component of the module.
 
Viewer viewer [get]
 Gets the Viewer instance associated with the module.
 

Detailed Description

This class is used as a base for all modules in the SmartGallery.

Member Function Documentation

◆ Initialize()

virtual void Initialize ( Viewer viewer)
virtual

Initializes the module with a given Viewer instance.

Parameters
viewerThe Viewer instance.

Reimplemented in AnimatedModule, ContentModule, and Transition.

◆ OnFrameChanged()

virtual void OnFrameChanged ( int index)
protectedvirtual

Handles the FrameChanged event of the viewer's message system.

Parameters
indexThe index of the frame that has changed.