SCR_BaseScreenEffect.c

Go to the documentation of this file.

class SCR_BaseScreenEffect : SCR_InfoDisplayExtended
{
    //------------------------------------------------------------------------------------------------
    override void DisplayStartDraw(IEntity owner)
    {
    }
 
    //------------------------------------------------------------------------------------------------
    void SettingsChanged()
    {
    }
 
    //------------------------------------------------------------------------------------------------
    override void DisplayControlledEntityChanged(IEntity from, IEntity to)
    {
    }
 
    //------------------------------------------------------------------------------------------------
    override event void DisplayUpdate(IEntity owner, float timeSlice)
    {
    }
 
    //------------------------------------------------------------------------------------------------
    void UpdateEffect(float timeSlice)
    {
    }
 
    //------------------------------------------------------------------------------------------------
    void ClearEffects()
    {
    }
 
    //------------------------------------------------------------------------------------------------
    protected void UpdateEffectVisibility(notnull ImageWidget effectWidget)
    {
        effectWidget.SetVisible(effectWidget.GetOpacity() != 0);
    }
 
    //------------------------------------------------------------------------------------------------
    protected void AnimateEffectVisibility(notnull ImageWidget effectWidget, float opacity, float alpha, float opacitySpeed = 1.0, float alphaSpeed = 1.0, bool updateVisibility = true)
    {
        AnimateWidget.Opacity(effectWidget, opacity, opacitySpeed, updateVisibility);
        AnimateWidget.AlphaMask(effectWidget, alpha, alphaSpeed);
    }
 
    //------------------------------------------------------------------------------------------------
    protected void ShowSingleEffect(notnull ImageWidget effectWidget)
    {
        effectWidget.SetOpacity(1);
        effectWidget.SetMaskProgress(1);
        effectWidget.SetVisible(true);
    }
 
    //------------------------------------------------------------------------------------------------
    protected void HideSingleEffect(notnull ImageWidget effectWidget)
    {
        AnimateWidget.StopAllAnimations(effectWidget);
        effectWidget.SetOpacity(0);
        effectWidget.SetMaskProgress(0);
        effectWidget.SetVisible(false);
    }
}