#include <AGUISlideshow.h>

Inheritance diagram for AGUISlideshow:

Classes
struct	Params

Public Types
enum	Flags_ : Flags { Flags_None = 0 , Flags_Skippable = ( 1U << ( 0 ) ) , Flags_Unk1 = ( 1U << ( 1 ) ) , Flags_InstaSkippable = ( 1U << ( 2 ) ) , Flags_HasFadeIn = ( 1U << ( 3 ) ) , Flags_HasFadeOut = ( 1U << ( 4 ) ) , Flags_Repeat = ( 1U << ( 5 ) ) , Flags_Ended = ( 1U << ( 6 ) ) }

using	ThisClass = AGUISlideshow

using	BaseClass = Toshi::TObject

using	Flags = TUINT32

Public Member Functions
virtual Toshi::TClass *	GetClass () override

	AGUISlideshow ()

TBOOL	Setup (AGameState::HUDParams *a_pHUDParams, const Params &a_rParams, TBOOL a_bShouldLocalise)

void	Update (TFLOAT a_fDeltaTime)

void	UpdateFadeOverlay ()

void	SwitchToNextSlide (TBOOL a_bUnused=true)

void	Activate ()

void	Deactivate ()

void	Reset ()

TBOOL	ProcessInput (const Toshi::TInputInterface::InputEvent *a_pEvent)

TBOOL	ProcessCommand (AInputCommand a_eCommand)

TBOOL	IsSlideshowOver ()

TBOOL	HasSlides () const

void	AddSlide (const Toshi::TPString8 &a_rName)

Static Public Member Functions
static Toshi::TObject *	CreateTObject ()

static Toshi::TObject *	CreateTObjectInPlace (void *a_pPtr)

static void	InitialiseClass ()

static void	DeinitialiseClass ()

static __forceinline Toshi::TClass *	GetClassStatic ()

static Toshi::TPString8 *	LocaliseBackgroundFileName (Toshi::TPString8 &a_rOutName, const Toshi::TPString8 &a_rName)

static void	LocaliseBackgroundFileName (Toshi::TPString8 &a_rOutName, const TCHAR *a_szName)

Static Public Attributes
static constexpr Toshi::TClass *	PARENTCLASS = & Toshi::TObject::ms_oClass

static Toshi::TClass	ms_oClass = Toshi::TClass( "AGUISlideshow", AGUISlideshow::PARENTCLASS, AGUISlideshow::CreateTObject, AGUISlideshow::CreateTObjectInPlace, AGUISlideshow::InitialiseClass, AGUISlideshow::DeinitialiseClass, 0, 1, sizeof( AGUISlideshow ), alignof( AGUISlideshow ) )

Protected Attributes
AGameState::HUDParams *	m_pHUDParams

Toshi::T2DynamicVector< Toshi::TPString8 >	m_Images

Toshi::T2DynamicVector< Toshi::TPString8 >::Iterator	m_ImageIterator

Flags	m_eFlags

TBOOL	m_bIsActive

TFLOAT	m_fCurrentSlideTime

TFLOAT	m_fUnk2

TFLOAT	m_fDuration

TFLOAT	m_fFadeInTime

TFLOAT	m_fFadeOutTime

TFLOAT	m_fUnk4

AGUI2Rectangle	m_FadeOverlay

TBOOL	m_bIsAppearing

TBOOL	m_bShouldLocalise

Detailed Description

Definition at line 8 of file AGUISlideshow.h.

Member Typedef Documentation

◆ BaseClass

using AGUISlideshow::BaseClass = Toshi::TObject

Definition at line 11 of file AGUISlideshow.h.

◆ Flags

using AGUISlideshow::Flags = TUINT32

Definition at line 13 of file AGUISlideshow.h.

◆ ThisClass

using AGUISlideshow::ThisClass = AGUISlideshow

Definition at line 11 of file AGUISlideshow.h.

Member Enumeration Documentation

◆ Flags_

enum AGUISlideshow::Flags_ : Flags

Enumerator
Flags_None
Flags_Skippable
Flags_Unk1
Flags_InstaSkippable
Flags_HasFadeIn
Flags_HasFadeOut
Flags_Repeat
Flags_Ended

Definition at line 14 of file AGUISlideshow.h.

    {
        Flags_None           = 0,
        Flags_Skippable      = BITFLAG( 0 ),
        Flags_Unk1           = BITFLAG( 1 ),
        Flags_InstaSkippable = BITFLAG( 2 ),
        Flags_HasFadeIn      = BITFLAG( 3 ),
        Flags_HasFadeOut     = BITFLAG( 4 ),
        Flags_Repeat         = BITFLAG( 5 ),
        Flags_Ended          = BITFLAG( 6 ),
    };

Constructor & Destructor Documentation

◆ AGUISlideshow()

AGUISlideshow::AGUISlideshow ( )

Definition at line 15 of file AGUISlideshow.cpp.

    : m_Images( Toshi::GetGlobalAllocator(), 64, 64 )
{
    m_pHUDParams        = TNULL;
    m_eFlags            = Flags_None;
    m_bIsActive         = TFALSE;
    m_fCurrentSlideTime = 0.0f;
    m_fUnk2             = 0.0f;
    m_fDuration         = 1.0f;
    m_fFadeInTime       = 0.0f;
    m_fFadeOutTime      = 0.0f;
    m_fUnk4             = -1.0f;
    m_bIsAppearing      = TFALSE;
    m_bShouldLocalise   = TFALSE;
}

Member Function Documentation

◆ Activate()

void AGUISlideshow::Activate ( )

Definition at line 59 of file AGUISlideshow.cpp.

{
    TASSERT( m_Images.Size() > 0 );
 
    m_ImageIterator     = m_Images;
    m_fCurrentSlideTime = 0.0f;
    m_fUnk2             = 0.0f;
 
    if ( !m_bIsAppearing )
    {
        if ( !m_bShouldLocalise )
        {
            AGUISystem::GetSingleton()->SetPicture( m_Images[ 0 ] );
        }
        else
        {
            Toshi::TPString8 pictureName;
            LocaliseBackgroundFileName( pictureName, m_Images[ 0 ] );
            AGUISystem::GetSingleton()->SetPicture( pictureName );
        }
    }
 
    UpdateFadeOverlay();
    m_bIsActive = TTRUE;
}

◆ AddSlide()

void AGUISlideshow::AddSlide ( const Toshi::TPString8 & a_rName )

inline

Definition at line 63 of file AGUISlideshow.h.

    {
        m_Images.PushBack( a_rName );
    }

◆ CreateTObject()

Toshi::TObject * AGUISlideshow::CreateTObject ( )

static

Definition at line 13 of file AGUISlideshow.cpp.

◆ CreateTObjectInPlace()

Toshi::TObject * AGUISlideshow::CreateTObjectInPlace ( void * a_pPtr )

static

Definition at line 13 of file AGUISlideshow.cpp.

◆ Deactivate()

void AGUISlideshow::Deactivate ( )

Definition at line 196 of file AGUISlideshow.cpp.

{
    TASSERT( TTRUE == m_bIsActive );
 
    m_bIsActive = TFALSE;
    AGUISystem::GetSingleton()->SetPicture( Toshi::TPString8() );
    m_eFlags |= Flags_Ended;
}

◆ DeinitialiseClass()

void AGUISlideshow::DeinitialiseClass ( )

static

Definition at line 13 of file AGUISlideshow.cpp.

◆ GetClass()

Toshi::TClass * AGUISlideshow::GetClass ( )

overridevirtual

Definition at line 13 of file AGUISlideshow.cpp.

◆ GetClassStatic()

static __forceinline Toshi::TClass * AGUISlideshow::GetClassStatic ( )

inlinestatic

Definition at line 11 of file AGUISlideshow.h.

◆ HasSlides()

TBOOL AGUISlideshow::HasSlides ( ) const

inline

Definition at line 58 of file AGUISlideshow.h.

    {
        return m_Images.Size() != 0;
    }

◆ InitialiseClass()

void AGUISlideshow::InitialiseClass ( )

static

Definition at line 13 of file AGUISlideshow.cpp.

◆ IsSlideshowOver()

TBOOL AGUISlideshow::IsSlideshowOver ( )

Definition at line 161 of file AGUISlideshow.cpp.

{
    if ( !HASANYFLAG( m_eFlags, Flags_Repeat ) )
    {
        return !m_ImageIterator.IsValid();
    }
 
    if ( !HASANYFLAG( m_eFlags, Flags_Ended ) && ( m_fUnk4 <= 0.0f || m_fUnk2 <= m_fUnk4 ) )
    {
        return TFALSE;
    }
 
    return TTRUE;
}

◆ LocaliseBackgroundFileName() [1/2]

void AGUISlideshow::LocaliseBackgroundFileName	(	Toshi::TPString8 &	a_rOutName,
		const TCHAR *	a_szName )

static

Definition at line 37 of file AGUISlideshow.cpp.

{
    TCHAR szFormattedName[ 256 ];
    auto  eLang = ALocaleManager::GetSingleton()->GetLanguage();
 
    if ( eLang != ALocaleManager::Lang_English && eLang != ALocaleManager::Lang_EnglishUK )
    {
        TCHAR szLang[ 4 ];
        Toshi::TStringManager::String8Copy(
            szLang,
            ALocaleManager::Interface()->GetCurrentLanguageName(),
            sizeof( szLang )
        );
 
        szLang[ 1 ] = '\0';
        Toshi::TStringManager::String8Format( szFormattedName, sizeof( szFormattedName ), "%s%s", a_szName, szLang );
        a_szName = szFormattedName;
    }
 
    a_rOutName = Toshi::TPString8( a_szName );
}

◆ LocaliseBackgroundFileName() [2/2]

Toshi::TPString8 * AGUISlideshow::LocaliseBackgroundFileName	(	Toshi::TPString8 &	a_rOutName,
		const Toshi::TPString8 &	a_rName )

static

Definition at line 31 of file AGUISlideshow.cpp.

{
    LocaliseBackgroundFileName( a_rOutName, a_rName.GetString8().GetString() );
    return &a_rOutName;
}

◆ ProcessCommand()

TBOOL AGUISlideshow::ProcessCommand ( AInputCommand a_eCommand )

Definition at line 292 of file AGUISlideshow.cpp.

{
    if ( ( ( a_eCommand != AInputCommand_Back && a_eCommand != AInputCommand_Cancel && a_eCommand != AInputCommand_Quit ) || !HASANYFLAG( m_eFlags, Flags_Unk1 ) ) && !HASANYFLAG( m_eFlags, Flags_InstaSkippable ) )
    {
        if ( m_eFlags & Flags_Skippable )
        {
            SwitchToNextSlide();
            return TTRUE;
        }
 
        return TFALSE;
    }
 
    m_ImageIterator = m_Images.End();
    m_eFlags |= Flags_Ended;
    return TTRUE;
}

◆ ProcessInput()

TBOOL AGUISlideshow::ProcessInput ( const Toshi::TInputInterface::InputEvent * a_pEvent )

Definition at line 271 of file AGUISlideshow.cpp.

{
    if ( a_pEvent->GetEventType() == Toshi::TInputInterface::EVENT_TYPE_GONE_DOWN )
    {
        if ( m_eFlags & Flags_InstaSkippable )
        {
            m_ImageIterator = m_Images.End();
            m_eFlags |= Flags_Ended;
            return TTRUE;
        }
 
        if ( m_eFlags & Flags_Skippable )
        {
            SwitchToNextSlide();
            return TTRUE;
        }
    }
 
    return TFALSE;
}

◆ Reset()

void AGUISlideshow::Reset ( )

Definition at line 310 of file AGUISlideshow.cpp.

{
    m_ImageIterator     = m_Images;
    m_fCurrentSlideTime = 0.0f;
    m_fUnk2             = 0.0f;
}

◆ Setup()

TBOOL AGUISlideshow::Setup	(	AGameState::HUDParams *	a_pHUDParams,
		const Params &	a_rParams,
		TBOOL	a_bShouldLocalise )

Definition at line 205 of file AGUISlideshow.cpp.

{
    if ( m_pHUDParams )
    {
        return TFALSE;
    }
 
    m_bShouldLocalise = a_bShouldLocalise;
    m_eFlags          = Flags_None;
 
    if ( a_rParams.iUnk1 != 0 )
    {
        return TFALSE;
    }
 
    m_pHUDParams = a_pHUDParams;
 
    if ( a_rParams.bSlideSkippable )
    {
        m_eFlags |= Flags_Skippable;
    }
 
    if ( a_rParams.bUnk2 )
    {
        m_eFlags |= Flags_Unk1;
    }
 
    if ( a_rParams.bInstaSkippable )
    {
        m_eFlags |= Flags_InstaSkippable;
    }
 
    if ( a_rParams.bHasFadeIn )
    {
        m_eFlags |= Flags_HasFadeIn;
        m_fFadeInTime = a_rParams.fFadeInTime;
    }
 
    if ( a_rParams.bHasFadeOut )
    {
        m_eFlags |= Flags_HasFadeOut;
        m_fFadeOutTime = a_rParams.fFadeOutTime;
    }
 
    if ( a_rParams.bRepeat )
    {
        m_eFlags |= Flags_Repeat;
    }
 
    m_fDuration = a_rParams.fDuration;
    m_fUnk4     = a_rParams.fUnk5;
 
    TFLOAT fWidth, fHeight;
    AGUI2::GetSingleton()->GetDimensions( fWidth, fHeight );
    m_FadeOverlay.SetDimensions( fWidth, fHeight );
    m_FadeOverlay.SetAttachment( AGUI2ATTACHMENT_TOPCENTER, AGUI2ATTACHMENT_TOPCENTER );
    m_FadeOverlay.Hide();
 
    if ( a_rParams.bDelayAppear )
    {
        m_bIsAppearing = TTRUE;
    }
 
    return TTRUE;
}

◆ SwitchToNextSlide()

void AGUISlideshow::SwitchToNextSlide ( TBOOL a_bUnused = true )

Definition at line 176 of file AGUISlideshow.cpp.

{
    if ( m_ImageIterator.IsValid() )
    {
        m_ImageIterator++;
    }
 
    if ( !m_ImageIterator.IsValid() )
    {
        if ( !HASANYFLAG( m_eFlags, Flags_Repeat ) ) return;
        m_ImageIterator = m_Images;
    }
 
    m_fCurrentSlideTime = 0.0f;
 
    Toshi::TPString8 pictureName;
    LocaliseBackgroundFileName( pictureName, *m_ImageIterator );
    AGUISystem::GetSingleton()->SetPicture( pictureName );
}

◆ Update()

void AGUISlideshow::Update ( TFLOAT a_fDeltaTime )

Definition at line 135 of file AGUISlideshow.cpp.

{
    if ( m_bIsActive && !IsSlideshowOver() )
    {
        m_fCurrentSlideTime += a_fDeltaTime;
 
        if ( m_bIsAppearing )
        {
            UpdateFadeOverlay();
            return;
        }
 
        m_fUnk2 += a_fDeltaTime;
 
        if ( m_fCurrentSlideTime >= m_fFadeOutTime + m_fFadeInTime + m_fDuration )
        {
            SwitchToNextSlide();
        }
 
        UpdateFadeOverlay();
        return;
    }
 
    m_FadeOverlay.Unlink();
}

◆ UpdateFadeOverlay()

void AGUISlideshow::UpdateFadeOverlay ( )

Definition at line 85 of file AGUISlideshow.cpp.

{
    TFLOAT fOpacity;
 
    if ( !m_bIsAppearing )
    {
        if ( m_fFadeInTime <= m_fCurrentSlideTime )
        {
            if ( m_fCurrentSlideTime <= m_fDuration + m_fFadeInTime )
            {
                fOpacity = 0.0f;
            }
            else
            {
                fOpacity = ( m_fCurrentSlideTime - m_fFadeInTime - m_fDuration ) / m_fFadeOutTime;
 
                if ( fOpacity > 1.0f )
                {
                    fOpacity = 1.0f;
                }
            }
        }
        else
        {
            fOpacity = 1.0f - m_fCurrentSlideTime / m_fFadeInTime;
        }
    }
    else
    {
        fOpacity = m_fCurrentSlideTime / m_fFadeInTime;
 
        if ( fOpacity >= 1.0f )
        {
            Toshi::TPString8 pictureName;
            LocaliseBackgroundFileName( pictureName, *m_ImageIterator );
            AGUISystem::GetSingleton()->SetPicture( pictureName );
 
            m_bIsAppearing      = TFALSE;
            m_fCurrentSlideTime = 0.0f;
            fOpacity            = 1.0f;
        }
    }
 
    TASSERT( fOpacity <= 1.0f );
    m_FadeOverlay.SetColour( TUINT32( fOpacity * 255 ) << 24 );
    m_FadeOverlay.Unlink();
    AGUI2::GetRootElement()->AddChildTail( m_FadeOverlay );
    m_FadeOverlay.Show();
}

Member Data Documentation

◆ m_bIsActive

TBOOL AGUISlideshow::m_bIsActive

protected

Definition at line 77 of file AGUISlideshow.h.

◆ m_bIsAppearing

TBOOL AGUISlideshow::m_bIsAppearing

protected

Definition at line 85 of file AGUISlideshow.h.

◆ m_bShouldLocalise

TBOOL AGUISlideshow::m_bShouldLocalise

protected

Definition at line 86 of file AGUISlideshow.h.

◆ m_eFlags

Flags AGUISlideshow::m_eFlags

protected

Definition at line 76 of file AGUISlideshow.h.

◆ m_FadeOverlay

AGUI2Rectangle AGUISlideshow::m_FadeOverlay

protected

Definition at line 84 of file AGUISlideshow.h.

◆ m_fCurrentSlideTime

TFLOAT AGUISlideshow::m_fCurrentSlideTime

protected

Definition at line 78 of file AGUISlideshow.h.

◆ m_fDuration

TFLOAT AGUISlideshow::m_fDuration

protected

Definition at line 80 of file AGUISlideshow.h.

◆ m_fFadeInTime

TFLOAT AGUISlideshow::m_fFadeInTime

protected

Definition at line 81 of file AGUISlideshow.h.

◆ m_fFadeOutTime

TFLOAT AGUISlideshow::m_fFadeOutTime

protected

Definition at line 82 of file AGUISlideshow.h.

◆ m_fUnk2

TFLOAT AGUISlideshow::m_fUnk2

protected

Definition at line 79 of file AGUISlideshow.h.

◆ m_fUnk4

TFLOAT AGUISlideshow::m_fUnk4

protected

Definition at line 83 of file AGUISlideshow.h.

◆ m_ImageIterator

Toshi::T2DynamicVector<Toshi::TPString8>::Iterator AGUISlideshow::m_ImageIterator

protected

Definition at line 75 of file AGUISlideshow.h.

◆ m_Images

Toshi::T2DynamicVector<Toshi::TPString8> AGUISlideshow::m_Images

protected

Definition at line 74 of file AGUISlideshow.h.

◆ m_pHUDParams

AGameState::HUDParams* AGUISlideshow::m_pHUDParams

protected

Definition at line 73 of file AGUISlideshow.h.

◆ ms_oClass

Toshi::TClass AGUISlideshow::ms_oClass = Toshi::TClass( "AGUISlideshow", AGUISlideshow::PARENTCLASS, AGUISlideshow::CreateTObject, AGUISlideshow::CreateTObjectInPlace, AGUISlideshow::InitialiseClass, AGUISlideshow::DeinitialiseClass, 0, 1, sizeof( AGUISlideshow ), alignof( AGUISlideshow ) )

static

Definition at line 11 of file AGUISlideshow.h.

◆ PARENTCLASS

Toshi::TClass* AGUISlideshow::PARENTCLASS = & Toshi::TObject::ms_oClass

staticconstexpr

Definition at line 11 of file AGUISlideshow.h.

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

D:/_dev/OpenBarnyard/Source/OpenBarnyard/Source/GUI/AGUISlideshow.h
D:/_dev/OpenBarnyard/Source/OpenBarnyard/Source/GUI/AGUISlideshow.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ Flags

◆ ThisClass

Member Enumeration Documentation

◆ Flags_

Constructor & Destructor Documentation

◆ AGUISlideshow()

Member Function Documentation

◆ Activate()

◆ AddSlide()

◆ CreateTObject()

◆ CreateTObjectInPlace()

◆ Deactivate()

◆ DeinitialiseClass()

◆ GetClass()

◆ GetClassStatic()

◆ HasSlides()

◆ InitialiseClass()

◆ IsSlideshowOver()

◆ LocaliseBackgroundFileName() [1/2]

◆ LocaliseBackgroundFileName() [2/2]

◆ ProcessCommand()

◆ ProcessInput()

◆ Reset()

◆ Setup()

◆ SwitchToNextSlide()

◆ Update()

◆ UpdateFadeOverlay()

Member Data Documentation

◆ m_bIsActive

◆ m_bIsAppearing

◆ m_bShouldLocalise

◆ m_eFlags

◆ m_FadeOverlay

◆ m_fCurrentSlideTime

◆ m_fDuration

◆ m_fFadeInTime

◆ m_fFadeOutTime

◆ m_fUnk2

◆ m_fUnk4

◆ m_ImageIterator

◆ m_Images

◆ m_pHUDParams

◆ ms_oClass

◆ PARENTCLASS