rendererappearanceeditor.cpp

/** @file rendererappearanceeditor.cpp
 *
 * @authors Copyright (c) 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
 *
 * @par License
 * GPL: http://www.gnu.org/licenses/gpl.html
 *
 * <small>This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version. This program is distributed in the hope that it
 * will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
 * Public License for more details. You should have received a copy of the GNU
 * General Public License along with this program; if not, see:
 * http://www.gnu.org/licenses</small>
 */

#include "ui/editors/rendererappearanceeditor.h"
#include "ui/dialogs/renderersettingsdialog.h"
#include "ui/widgets/profilepickerwidget.h"
#include "ui/widgets/cvarchoicewidget.h"
#include "ui/widgets/cvarsliderwidget.h"
#include "ui/widgets/cvartogglewidget.h"
#include "ui/clientwindow.h"
#include "clientapp.h"
#include "con_main.h"

#include <de/ButtonWidget>
#include <de/ScrollAreaWidget>
#include <de/FoldPanelWidget>
#include <de/DialogContentStylist>
#include <de/SequentialLayout>
#include <de/SignalAction>

using namespace de;
using namespace ui;

DENG_GUI_PIMPL(RendererAppearanceEditor),
DENG2_OBSERVES(SettingsRegister, ProfileChange),
DENG2_OBSERVES(App, GameChange)
{
    /**
     * Opens a popup menu for folding/unfolding all settings groups.
     */
    struct RightClickHandler : public GuiWidget::IEventHandler
    {
        Instance *d;

        RightClickHandler(Instance *inst) : d(inst) {}

        bool handleEvent(GuiWidget &widget, Event const &event)
        {
            switch(widget.handleMouseClick(event, MouseEvent::Right))
            {
            case MouseClickFinished: {
                PopupMenuWidget *pop = new PopupMenuWidget;
                pop->setDeleteAfterDismissed(true);
                d->self.add(pop);
                pop->setAnchorAndOpeningDirection(widget.rule(), ui::Left);
                pop->items()
                        << new ActionItem(tr("Fold All"),   new SignalAction(d->thisPublic, SLOT(foldAll())))
                        << new ActionItem(tr("Unfold All"), new SignalAction(d->thisPublic, SLOT(unfoldAll())));
                pop->open();
                return true; }

            case MouseClickUnrelated:
                return false;

            default:
                return true;
            }
        }
    };

    /**
     * Foldable group of settings.
     */
    class Group : public FoldPanelWidget
    {
        /// Action for reseting the group's settings to defaults.
        struct ResetAction : public Action {
            Group *group;
            ResetAction(Group *groupToReset) : group(groupToReset) {}
            void trigger() {
                Action::trigger();
                group->resetToDefaults();
            }
        };

    public:
        Group(RendererAppearanceEditor::Instance *inst, String const &titleText)
            : d(inst), _firstColumnWidth(0)
        {
            _group = new GuiWidget;
            setContent(_group);
            makeTitle(titleText);

            // Set up a context menu for right-clicking.
            title().addEventHandler(new RightClickHandler(d));

            // We want the first column of all groups to be aligned with each other.
            _layout.setColumnFixedWidth(0, *d->firstColumnWidth);

            _layout.setGridSize(2, 0);
            _layout.setColumnAlignment(0, AlignRight);
            _layout.setLeftTop(_group->rule().left(), _group->rule().top());

            // Button for reseting this group to defaults.
            _resetButton = new ButtonWidget;
            _resetButton->setText(tr("Reset"));
            _resetButton->setAction(new ResetAction(this));
            _resetButton->rule()
                    .setInput(Rule::Right,   d->container->contentRule().right())
                    .setInput(Rule::AnchorY, title().rule().top() + title().rule().height() / 2)
                    .setAnchorPoint(Vector2f(0, .5f));
            _resetButton->disable();

            d->container->add(&title());
            d->container->add(_resetButton);
            d->container->add(this);
        }

        ~Group()
        {
            releaseRef(_firstColumnWidth);
        }

        ButtonWidget &resetButton() { return *_resetButton; }

        void preparePanelForOpening()
        {
            FoldPanelWidget::preparePanelForOpening();
            if(!d->settings.isReadOnlyProfile(d->settings.currentProfile()))
            {
                _resetButton->enable();
            }
        }

        void panelClosing()
        {
            FoldPanelWidget::panelClosing();
            _resetButton->disable();
        }

        void addSpace()
        {
            _layout << Const(0);
        }

        void addLabel(String const &text)
        {
            _layout << *LabelWidget::newWithText(text, _group);
        }

        CVarToggleWidget *addToggle(char const *cvar, String const &label)
        {
            CVarToggleWidget *w = new CVarToggleWidget(cvar, label);
            _group->add(w);
            _layout << *w;
            return w;
        }

        CVarChoiceWidget *addChoice(char const *cvar, ui::Direction opening = ui::Up)
        {
            CVarChoiceWidget *w = new CVarChoiceWidget(cvar);
            w->setOpeningDirection(opening);
            _group->add(w);
            _layout << *w;
            return w;
        }

        CVarSliderWidget *addSlider(char const *cvar)
        {
            CVarSliderWidget *w = new CVarSliderWidget(cvar);
            _group->add(w);
            _layout << *w;
            return w;
        }

        CVarSliderWidget *addSlider(char const *cvar, Ranged const &range, double step, int precision)
        {
            CVarSliderWidget *w = addSlider(cvar);
            w->setRange(range, step);
            w->setPrecision(precision);
            return w;
        }

        void commit()
        {
            _group->rule().setSize(_layout.width(), _layout.height());

            // Extend the title all the way to the button.
            title().rule().setInput(Rule::Right, _resetButton->rule().left());

            // Calculate the maximum rule for the first column items.
            for(int i = 0; i < _layout.gridSize().y; ++i)
            {
                GuiWidget *w = _layout.at(Vector2i(0, i));
                if(w)
                {
                    changeRef(_firstColumnWidth, OperatorRule::maximum(w->rule().width(), _firstColumnWidth));
                }
            }
        }

        void fetch()
        {
            foreach(Widget *child, _group->childWidgets())
            {
                if(ICVarWidget *w = child->maybeAs<ICVarWidget>())
                {
                    w->updateFromCVar();
                }
            }
        }

        void resetToDefaults()
        {
            foreach(Widget *child, _group->childWidgets())
            {
                if(ICVarWidget *w = child->maybeAs<ICVarWidget>())
                {
                    d->settings.resetSettingToDefaults(w->cvarPath());
                    w->updateFromCVar();
                }
            }
        }

        Rule const &firstColumnWidth() const
        {
            return *_firstColumnWidth;
        }

    private:
        RendererAppearanceEditor::Instance *d;
        ButtonWidget *_resetButton;
        GuiWidget *_group;
        GridLayout _layout;
        Rule const *_firstColumnWidth;
    };

    SettingsRegister &settings;
    DialogContentStylist stylist;
    ScrollAreaWidget *container;
    IndirectRule *firstColumnWidth; ///< Shared by all groups.
    ButtonWidget *close;    
    ProfilePickerWidget *profile;

    Group *skyGroup;
    Group *shadowGroup;
    Group *lightGroup;
    Group *volLightGroup;
    Group *glowGroup;
    Group *haloGroup;
    Group *matGroup;
    Group *modelGroup;
    Group *spriteGroup;
    Group *objectGroup;
    Group *partGroup;

    Instance(Public *i)
        : Base(i),
          settings(ClientApp::renderSystem().appearanceSettings()),
          firstColumnWidth(new IndirectRule)
    {
        // The editor will close automatically when going to Ring Zero.
        App::app().audienceForGameChange() += this;

        settings.audienceForProfileChange += this;

        // The contents of the editor will scroll.
        container = new ScrollAreaWidget;
        container->enableIndicatorDraw(true);
        stylist.setContainer(*container);

        container->add(close   = new ButtonWidget);
        container->add(profile = new ProfilePickerWidget(settings, tr("appearance")));

        close->setText(tr("Close"));
        close->setAction(new SignalAction(thisPublic, SLOT(close())));

        // Sky settings.
        skyGroup = new Group(this, tr("Sky"));

        skyGroup->addLabel(tr("Sky Sphere Radius:"));
        skyGroup->addSlider("rend-sky-distance", Ranged(0, 8000), 10, 0);

        skyGroup->commit();

        // Shadow settings.
        shadowGroup = new Group(this, tr("Shadows"));

        shadowGroup->addSpace();
        shadowGroup->addToggle("rend-fakeradio", tr("Ambient Occlusion"));

        shadowGroup->addLabel(tr("Occlusion Darkness:"));
        shadowGroup->addSlider("rend-fakeradio-darkness");

        shadowGroup->addSpace();
        shadowGroup->addToggle("rend-shadow", tr("Objects Cast Shadows"));

        shadowGroup->addLabel(tr("Shadow Darkness:"));
        shadowGroup->addSlider("rend-shadow-darkness");

        shadowGroup->addLabel(tr("Max Visible Distance:"));
        shadowGroup->addSlider("rend-shadow-far", Ranged(0, 3000), 10, 0);

        shadowGroup->addLabel(tr("Maximum Radius:"));
        shadowGroup->addSlider("rend-shadow-radius-max", Ranged(1, 128), 1, 0);

        shadowGroup->commit();

        // Dynamic light settings.
        lightGroup = new Group(this, tr("Point Lighting"));

        lightGroup->addSpace();
        lightGroup->addToggle("rend-light", tr("Dynamic Lights"));

        lightGroup->addSpace();
        lightGroup->addToggle("rend-light-decor", tr("Light Decorations"));

        lightGroup->addLabel(tr("Blending Mode:"));
        lightGroup->addChoice("rend-light-blend")->items()
                << new ChoiceItem(tr("Multiply"), 0)
                << new ChoiceItem(tr("Add"), 1)
                << new ChoiceItem(tr("Process without drawing"), 2);

        lightGroup->addLabel(tr("Number of Lights:"));
        lightGroup->addSlider("rend-light-num", Ranged(0, 2000), 1, 0)->setMinLabel(tr("Max"));

        lightGroup->addLabel(tr("Brightness:"));
        lightGroup->addSlider("rend-light-bright");

        lightGroup->addLabel(tr("Brightness in Fog:"));
        lightGroup->addSlider("rend-light-fog-bright");

        lightGroup->addLabel(tr("Light Radius Factor:"));
        lightGroup->addSlider("rend-light-radius-scale");

        lightGroup->addLabel(tr("Light Max Radius:"));
        lightGroup->addSlider("rend-light-radius-max");

        lightGroup->commit();

        // Volume lighting group.
        volLightGroup = new Group(this, tr("Volume Lighting"));

        volLightGroup->addSpace();
        volLightGroup->addToggle("rend-light-sky-auto", tr("Apply Sky Color"));

        volLightGroup->addLabel(tr("Sky Color Factor:"));
        volLightGroup->addSlider("rend-light-sky");

        volLightGroup->addLabel(tr("Attenuation Distance:"));
        volLightGroup->addSlider("rend-light-attenuation", Ranged(0, 4000), 1, 0)->setMinLabel(tr("Off"));

        volLightGroup->addLabel(tr("Light Compression:"));
        volLightGroup->addSlider("rend-light-compression");

        volLightGroup->addLabel(tr("Ambient Light:"));
        volLightGroup->addSlider("rend-light-ambient");

        volLightGroup->addLabel(tr("Wall Angle Factor:"));
        volLightGroup->addSlider("rend-light-wall-angle", Ranged(0, 3), .01, 2);

        volLightGroup->addSpace();
        volLightGroup->addToggle("rend-light-wall-angle-smooth", tr("Smoothed Angle"));

        volLightGroup->commit();

        // Glow settings.
        glowGroup = new Group(this, tr("Surface Glow"));

        glowGroup->addLabel(tr("Material Glow:"));
        glowGroup->addSlider("rend-glow");

        glowGroup->addLabel(tr("Max Glow Height:"));
        glowGroup->addSlider("rend-glow-height");

        glowGroup->addLabel(tr("Glow Height Factor:"));
        glowGroup->addSlider("rend-glow-scale");

        glowGroup->addSpace();
        glowGroup->addToggle("rend-glow-wall", tr("Glow Visible on Walls"));

        glowGroup->commit();

        // Camera lens settings.
        haloGroup = new Group(this, tr("Camera Lens"));

        haloGroup->addSpace();
        haloGroup->addToggle("rend-vignette", tr("Vignetting"));

        haloGroup->addLabel(tr("Vignette Darkness:"));
        haloGroup->addSlider("rend-vignette-darkness", Ranged(0, 2), .01, 2);

        haloGroup->addLabel(tr("Vignette Width:"));
        haloGroup->addSlider("rend-vignette-width");

        haloGroup->addSpace();
        haloGroup->addToggle("rend-halo-realistic", tr("Realistic Halos"));

        haloGroup->addLabel(tr("Flares per Halo:"));
        haloGroup->addSlider("rend-halo")->setMinLabel(tr("None"));

        haloGroup->addLabel(tr("Halo Brightness:"));
        haloGroup->addSlider("rend-halo-bright", Ranged(0, 100), 1, 0);

        haloGroup->addLabel(tr("Halo Size Factor:"));
        haloGroup->addSlider("rend-halo-size");

        haloGroup->addLabel(tr("Occlusion Fading:"));
        haloGroup->addSlider("rend-halo-occlusion", Ranged(1, 256), 1, 0);

        haloGroup->addLabel(tr("Min Halo Radius:"));
        haloGroup->addSlider("rend-halo-radius-min", Ranged(1, 80), .1, 1);

        haloGroup->addLabel(tr("Min Halo Size:"));
        haloGroup->addSlider("rend-halo-secondary-limit", Ranged(0, 10), .1, 1);

        haloGroup->addLabel(tr("Halo Fading Start:"));
        haloGroup->addSlider("rend-halo-dim-near", Ranged(0, 200), .1, 1);

        haloGroup->addLabel(tr("Halo Fading End:"));
        haloGroup->addSlider("rend-halo-dim-far", Ranged(0, 200), .1, 1);

        haloGroup->addLabel(tr("Z-Mag Divisor:"));
        haloGroup->addSlider("rend-halo-zmag-div", Ranged(1, 100), .1, 1);

        haloGroup->commit();

        // Material settings.
        matGroup = new Group(this, tr("Materials"));

        matGroup->addSpace();
        matGroup->addToggle("rend-tex-shiny", tr("Shiny Surfaces"));

        matGroup->addSpace();
        matGroup->addToggle("rend-tex-anim-smooth", tr("Smooth Animation"));

        matGroup->addLabel(tr("Texture Quality:"));
        matGroup->addSlider("rend-tex-quality");

        matGroup->addLabel(tr("Texture Filtering:"));
        matGroup->addChoice("rend-tex-mipmap")->items()
                << new ChoiceItem(tr("None"),                       0)
                << new ChoiceItem(tr("Linear filter, no mip"),      1)
                << new ChoiceItem(tr("No filter, nearest mip"),     2)
                << new ChoiceItem(tr("Linear filter, nearest mip"), 3)
                << new ChoiceItem(tr("No filter, linear mip"),      4)
                << new ChoiceItem(tr("Linear filter, linear mip"),  5);

        matGroup->addSpace();
        matGroup->addToggle("rend-tex-filter-smart", tr("2x Smart Filtering"));

        matGroup->addLabel(tr("Bilinear Filtering:"));
        matGroup->addToggle("rend-tex-filter-sprite", tr("Sprites"));

        matGroup->addSpace();
        matGroup->addToggle("rend-tex-filter-mag", tr("World Surfaces"));

        matGroup->addSpace();
        matGroup->addToggle("rend-tex-filter-ui", tr("User Interface"));

        matGroup->addLabel(tr("Anisotropic Filter:"));
        matGroup->addChoice("rend-tex-filter-anisotropic")->items()
                << new ChoiceItem(tr("Best available"), -1)
                << new ChoiceItem(tr("Off"), 0)
                << new ChoiceItem(tr("2x"),  1)
                << new ChoiceItem(tr("4x"),  2)
                << new ChoiceItem(tr("8x"),  3)
                << new ChoiceItem(tr("16x"), 4);

        matGroup->addSpace();
        matGroup->addToggle("rend-tex-detail", tr("Detail Textures"));

        matGroup->addLabel(tr("Scaling Factor:"));
        matGroup->addSlider("rend-tex-detail-scale", Ranged(0, 16), .01, 2);

        matGroup->addLabel(tr("Contrast:"));
        matGroup->addSlider("rend-tex-detail-strength");

        matGroup->commit();

        // Model settings.
        modelGroup = new Group(this, tr("3D Models"));

        modelGroup->addSpace();
        modelGroup->addToggle("rend-model", tr("3D Models"));

        modelGroup->addSpace();
        modelGroup->addToggle("rend-model-inter", tr("Interpolate Frames"));

        modelGroup->addSpace();
        modelGroup->addToggle("rend-model-mirror-hud", tr("Mirror Player Weapon"));

        modelGroup->addLabel(tr("Max Visible Distance:"));
        modelGroup->addSlider("rend-model-distance", Ranged(0, 3000), 10, 0)->setMinLabel(tr("Inf"));

        modelGroup->addLabel(tr("LOD #0 Distance:"));
        modelGroup->addSlider("rend-model-lod", Ranged(0, 1000), 1, 0)->setMinLabel(tr("No LOD"));

        modelGroup->addLabel(tr("Number of Lights:"));
        modelGroup->addSlider("rend-model-lights");

        modelGroup->commit();

        // Sprite settings.
        spriteGroup = new Group(this, tr("Sprites"));

        spriteGroup->addSpace();
        spriteGroup->addToggle("rend-sprite-blend", tr("Additive Blending"));

        spriteGroup->addLabel(tr("Number of Lights:"));
        spriteGroup->addSlider("rend-sprite-lights")->setMinLabel(tr("Inf"));

        spriteGroup->addLabel(tr("Sprite Alignment:"));
        spriteGroup->addChoice("rend-sprite-align")->items()
                << new ChoiceItem(tr("Camera"), 0)
                << new ChoiceItem(tr("View plane"), 1)
                << new ChoiceItem(tr("Camera (limited)"), 2)
                << new ChoiceItem(tr("View plane (limited)"), 3);

        spriteGroup->addSpace();
        spriteGroup->addToggle("rend-sprite-mode", tr("Sharp Edges"));

        spriteGroup->addSpace();
        spriteGroup->addToggle("rend-sprite-noz", tr("Disable Z-Write"));

        spriteGroup->commit();

        // Object settings.
        objectGroup = new Group(this, tr("Objects"));

        objectGroup->addLabel(tr("Smooth Movement:"));
        objectGroup->addChoice("rend-mobj-smooth-move")->items()
                << new ChoiceItem(tr("Disabled"), 0)
                << new ChoiceItem(tr("Models only"), 1)
                << new ChoiceItem(tr("Models and sprites"), 2);

        objectGroup->addSpace();
        objectGroup->addToggle("rend-mobj-smooth-turn", tr("Smooth Turning"));

        objectGroup->commit();

        // Particle settings.
        partGroup = new Group(this, tr("Particle Effects"));

        partGroup->addSpace();
        partGroup->addToggle("rend-particle", tr("Particle Effects"));

        partGroup->addLabel(tr("Max Particles:"));
        partGroup->addSlider("rend-particle-max", Ranged(0, 10000), 100, 0)->setMinLabel(tr("Inf"));

        partGroup->addLabel(tr("Spawn Rate:"));
        partGroup->addSlider("rend-particle-rate");

        partGroup->addLabel(tr("Diffusion:"));
        partGroup->addSlider("rend-particle-diffuse", Ranged(0, 20), .01, 2);

        partGroup->addLabel(tr("Near Clip Distance:"));
        partGroup->addSlider("rend-particle-visible-near", Ranged(0, 1000), 1, 0)->setMinLabel(tr("None"));

        partGroup->commit();

        // Now we can define the first column width.
        firstColumnWidth->setSource(maximumOfAllGroupFirstColumns());
    }

    ~Instance()
    {
        App::app().audienceForGameChange() -= this;
        settings.audienceForProfileChange -= this;
        releaseRef(firstColumnWidth);
    }

    void currentGameChanged(game::Game const &newGame)
    {
        if(newGame.isNull())
        {
            // Entering Ring Zero -- persistent cvars are not available.
            self.close();
        }
    }

    void currentProfileChanged(String const &)
    {
        // Update with values from the new profile.
        fetch();
    }

    Rule const &maximumOfAllGroupFirstColumns()
    {
        Rule const *max = 0;
        foreach(Widget *child, container->childWidgets())
        {
            if(Group *g = child->maybeAs<Group>())
            {
                changeRef(max, OperatorRule::maximum(g->firstColumnWidth(), max));
            }
        }
        return *refless(max);
    }

    void fetch()
    {
        bool const isReadOnly = settings.isReadOnlyProfile(settings.currentProfile());

        foreach(Widget *child, container->childWidgets())
        {
            if(Group *g = child->maybeAs<Group>())
            {
                g->fetch();

                g->resetButton().enable(!isReadOnly && g->isOpen());

                // Enable or disable settings based on read-onlyness.
                foreach(Widget *w, g->content().childWidgets())
                {
                    if(GuiWidget *st = w->maybeAs<GuiWidget>())
                    {
                        st->enable(!isReadOnly);
                    }
                }
            }
        }
    }

    void foldAll(bool fold)
    {
        foreach(Widget *child, container->childWidgets())
        {
            if(Group *g = child->maybeAs<Group>())
            {
                if(fold)
                    g->close(0);
                else
                    g->open();
            }
        }
    }
};

RendererAppearanceEditor::RendererAppearanceEditor()
    : PanelWidget("rendererappearanceeditor"), d(new Instance(this))
{
    setSizePolicy(Fixed);
    setOpeningDirection(Left);
    set(Background(style().colors().colorf("background")).withSolidFillOpacity(1));

    d->profile->setOpeningDirection(Down);

    // Set up the editor UI.
    LabelWidget *title = LabelWidget::newWithText("Renderer Appearance", d->container);
    title->setFont("title");
    title->setTextColor("accent");

    LabelWidget *profLabel = LabelWidget::newWithText(tr("Profile:"), d->container);

    // Layout.
    RuleRectangle const &area = d->container->contentRule();
    title->rule()
            .setInput(Rule::Top,  area.top())
            .setInput(Rule::Left, area.left());
    d->close->rule()
            .setInput(Rule::Right,  area.right())
            .setInput(Rule::Top,    area.top());

    SequentialLayout layout(area.left(), title->rule().bottom(), Down);    

    layout.append(*profLabel, SequentialLayout::IgnoreMinorAxis);
    d->profile->rule()
            .setInput(Rule::Left, profLabel->rule().right())
            .setInput(Rule::Top,  profLabel->rule().top());

    layout << d->lightGroup->title()    << *d->lightGroup
           << d->volLightGroup->title() << *d->volLightGroup
           << d->glowGroup->title()     << *d->glowGroup
           << d->shadowGroup->title()   << *d->shadowGroup
           << d->haloGroup->title()     << *d->haloGroup
           << d->matGroup->title()      << *d->matGroup
           << d->objectGroup->title()   << *d->objectGroup
           << d->modelGroup->title()    << *d->modelGroup
           << d->spriteGroup->title()   << *d->spriteGroup
           << d->partGroup->title()     << *d->partGroup
           << d->skyGroup->title()      << *d->skyGroup;

    // Update container size.
    d->container->setContentSize(OperatorRule::maximum(layout.width(),
                                                       profLabel->rule().width() +
                                                       d->profile->rule().width() +
                                                       d->profile->button().rule().width(),
                                                       style().rules().rule("rendererappearance.width")),
                                 title->rule().height() + layout.height());
    d->container->rule().setSize(d->container->contentRule().width() +
                                 d->container->margins().width(),
                                 rule().height());
    setContent(d->container);

    d->fetch();

    // Install the editor.
    ClientWindow::main().setSidebar(ClientWindow::RightEdge, this);

    // Open the first group.
    d->lightGroup->open();
}

void RendererAppearanceEditor::foldAll()
{
    d->foldAll(true);
}

void RendererAppearanceEditor::unfoldAll()
{
    d->foldAll(false);
}

void RendererAppearanceEditor::preparePanelForOpening()
{
    PanelWidget::preparePanelForOpening();
}

void RendererAppearanceEditor::panelDismissed()
{
    PanelWidget::panelDismissed();

    ClientWindow::main().unsetSidebar(ClientWindow::RightEdge);
}