VolumeParameters.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2024, EPFL/Blue Brain Project
 *
 * The Blue Brain BioExplorer is a tool for scientists to extract and analyse
 * scientific data from visualization
 *
 * This file is part of Blue Brain BioExplorer <https://github.com/BlueBrain/BioExplorer>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3.0 as published
 * by the Free Software Foundation.
 *
 * This library 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 Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include "AbstractParameters.h"
 
SERIALIZATION_ACCESS(VolumeParameters)
 
namespace core
{
class VolumeParameters final : public AbstractParameters
{
public:
    VolumeParameters();
 
    void print() final;
 
    const Vector3ui& getDimensions() const { return _dimensions; }
    void setDimensions(const Vector3ui& dim) { _updateValue(_dimensions, dim); }
 
    const Vector3d& getElementSpacing() const { return _elementSpacing; }
    void setElementSpacing(const Vector3d& spacing) { _updateValue(_elementSpacing, spacing); }
 
    const Vector3d& getOffset() const { return _offset; }
 
    void setGradientShading(const bool enabled) { _updateValue(_gradientShading, enabled); }
    bool getGradientShading() const { return _gradientShading; }
 
    void setGradientOffset(const double value) { _updateValue(_gradientOffset, value); }
    double getGradientOffset() const { return _gradientOffset; }
 
    void setSingleShade(const bool enabled) { _updateValue(_singleShade, enabled); }
    bool getSingleShade() const { return _singleShade; }
 
    void setPreIntegration(const bool enabled) { _updateValue(_preIntegration, enabled); }
    bool getPreIntegration() const { return _preIntegration; }
 
    void setAdaptiveSampling(const bool enabled) { _updateValue(_adaptiveSampling, enabled); }
    bool getAdaptiveSampling() const { return _adaptiveSampling; }
 
    void setAdaptiveMaxSamplingRate(const double value) { _updateValue(_adaptiveMaxSamplingRate, value); }
    double getAdaptiveMaxSamplingRate() const { return _adaptiveMaxSamplingRate; }
 
    void setSamplingRate(const double value) { _updateValue(_samplingRate, value); }
    double getSamplingRate() const { return _samplingRate; }
 
    void setSpecular(const Vector3d& value) { _updateValue(_specular, value); }
    const Vector3d& getSpecular() const { return _specular; }
 
    void setUserParameters(const Vector3d& value) { _updateValue(_userParameters, value); }
    const Vector3d& getUserParameters() const { return _userParameters; }
 
    void setClipBox(const Boxd& value) { _updateValue(_clipBox, value); }
    const Boxd& getClipBox() const { return _clipBox; }
 
protected:
    void parse(const po::variables_map& vm) final;
 
    Vector3ui _dimensions;
    Vector3d _elementSpacing;
    Vector3d _offset;
 
    bool _gradientShading{false};
    double _gradientOffset{0.001};
    bool _singleShade{true};
    bool _preIntegration{false};
    double _adaptiveMaxSamplingRate{2.};
    bool _adaptiveSampling{true};
    double _samplingRate{0.125};
    Vector3d _specular{0.3, 0.3, 0.3};
    Boxd _clipBox;
    Vector3d _userParameters;
 
    SERIALIZATION_FRIEND(VolumeParameters)
};
} // namespace core