/***********************************************************************************
 *                                                                                 *
 * Voreen - The Volume Rendering Engine                                            *
 *                                                                                 *
 * Copyright (C) 2005-2012 University of Muenster, Germany.                        *
 * Visualization and Computer Graphics Group <http://viscg.uni-muenster.de>        *
 * For a list of authors please refer to the file "CREDITS.txt".                   *
 *                                                                                 *
 * This file is part of the Voreen software package. Voreen is free software:      *
 * you can redistribute it and/or modify it under the terms of the GNU General     *
 * Public License version 2 as published by the Free Software Foundation.          *
 *                                                                                 *
 * Voreen 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 in the file   *
 * "LICENSE.txt" along with this file. If not, see <http://www.gnu.org/licenses/>. *
 *                                                                                 *
 * For non-commercial academic use see the license exception specified in the file *
 * "LICENSE-academic.txt". To get information about commercial licensing please    *
 * contact the authors.                                                            *
 *                                                                                 *
 ***********************************************************************************/

#ifndef VRN_SIMPLE_VOLUMECOLLECTIONMODALITYFILTER
#define VRN_SIMPLE_VOLUMECOLLECTIONMODALITYFILTER

#include "voreen/core/processors/processor.h"
#include "voreen/core/ports/allports.h"
#include "voreen/core/properties/optionproperty.h"
#include "voreen/core/datastructures/volume/volumecollection.h"

namespace voreen {

/**
 * Permits to select one specific modality among those of all VolumeHandles
 * within the incoming VolumeCollection. The filtered VolumeCollection contains
 * only VolumeHandles of the specified modality.
 */
class VolumeCollectionModalityFilter : public Processor {

public:
    VolumeCollectionModalityFilter();
    virtual Processor* create() const;

    virtual std::string getClassName() const { return "VolumeCollectionModalityFilter"; }
    virtual std::string getCategory() const  { return "Utility"; }
    virtual CodeState getCodeState() const   { return CODE_STATE_STABLE; }
    virtual bool isUtility() const { return true; }

    virtual void invalidate(int inv = INVALID_RESULT);

protected:
    virtual void setDescriptions() {
        setDescription("Permits to select one specific modality among those of all VolumeHandles within the incoming VolumeCollection. The filtered VolumeCollection contains only VolumeHandles of the specified modality.");
    }

    virtual void process();
    virtual void initialize() throw (tgt::Exception);
    virtual void deinitialize() throw (tgt::Exception);

    VolumeCollectionPort inport_;
    VolumeCollectionPort outport_;

    OptionProperty<Modality*> modalityProp_;
    Modality currentModality_;
    VolumeCollection filteredCollection_;

    static const std::string loggerCat_;

private:
    void adjustFilteredCollection();

};

}   // namespace voreen

#endif
