AbstractColorMap.h

/*-----------------------------------------------------------------------
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"; you may not use this file except in compliance
with the License.  You may obtain a copy of the License at
 
http://www.apache.org/licenses/LICENSE-2.0
 
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-----------------------------------------------------------------------*/
#pragma once
 
#include "../common/AbstractObject.h"
 
namespace RESQML2_NS
{
    class AbstractColorMap : public COMMON_NS::AbstractObject
    {
    public:
        virtual ~AbstractColorMap() = default;
 
        virtual DLL_IMPORT_OR_EXPORT void setHsvColors(uint64_t colorCount,
            double const* hsvColors, double const* alphas = nullptr, double const* indices = nullptr,
            std::vector<std::string> const& colorTitles = std::vector<std::string>()) = 0;
 
        DLL_IMPORT_OR_EXPORT void setRgbColors(uint64_t colorCount,
            double const* rgbColors, double const* alphas = nullptr,
            double const* indices = nullptr, std::vector<std::string> const& colorTitles = std::vector<std::string>());
 
        DLL_IMPORT_OR_EXPORT void setRgbColors(uint64_t colorCount,
            uint8_t const* rgbColors, double const* alphas = nullptr,
            double const* indices = nullptr, std::vector<std::string> const& colorTitles = std::vector<std::string>());
 
        DLL_IMPORT_OR_EXPORT virtual uint64_t getColorCount() const = 0;
 
        DLL_IMPORT_OR_EXPORT double getHue(uint64_t colorIndex) const;
 
        DLL_IMPORT_OR_EXPORT double getSaturation(uint64_t colorIndex) const;
 
        DLL_IMPORT_OR_EXPORT double getValue(uint64_t colorIndex) const;
 
        DLL_IMPORT_OR_EXPORT double getAlpha(uint64_t colorIndex) const;
 
        DLL_IMPORT_OR_EXPORT void getRgbColor(uint64_t colorIndex, double& red, double& green, double& blue) const;
 
        DLL_IMPORT_OR_EXPORT void getRgbColor(uint64_t colorIndex, uint8_t& red, uint8_t& green, uint8_t& blue) const;
 
        DLL_IMPORT_OR_EXPORT bool hasColorTitle(uint64_t colorIndex) const;
 
        DLL_IMPORT_OR_EXPORT std::string getColorTitle(uint64_t colorIndex) const;
 
        DLL_IMPORT_OR_EXPORT void setNullHsvColor(double hue, double saturation, double value, double alpha = 1, std::string const& colorTitle = "");
 
        DLL_IMPORT_OR_EXPORT void setNullRgbColor(double red, double green, double blue, double alpha = 1, std::string const& colorTitle = "");
 
        DLL_IMPORT_OR_EXPORT void setNullRgbColor(uint8_t red, uint8_t green, uint8_t blue, double alpha = 1, std::string const& colorTitle = "");
 
        DLL_IMPORT_OR_EXPORT bool hasNullColor() const { return static_cast<gsoap_eml2_3::resqml22__ContinuousColorMap const*>(gsoapProxy2_3)->NullColor != nullptr; }
 
        DLL_IMPORT_OR_EXPORT double getNullHue() const;
 
        DLL_IMPORT_OR_EXPORT double getNullSaturation() const;
 
        DLL_IMPORT_OR_EXPORT double getNullValue() const;
 
        DLL_IMPORT_OR_EXPORT double getNullAlpha() const;
 
        DLL_IMPORT_OR_EXPORT void getNullRgbColor(double& red, double& green, double& blue) const;
 
        DLL_IMPORT_OR_EXPORT void getNullRgbColor(uint8_t& red, uint8_t& green, uint8_t& blue) const;
 
        void loadTargetRelationships() {};
 
    protected:
        DLL_IMPORT_OR_EXPORT AbstractColorMap(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : COMMON_NS::AbstractObject(partialObject) {}
 
        AbstractColorMap(gsoap_eml2_3::resqml22__AbstractColorMap* fromGsoap) : COMMON_NS::AbstractObject(fromGsoap) {}
 
        AbstractColorMap() {}
 
    private:
        virtual gsoap_eml2_3::resqml22__HsvColor* getColor(uint64_t colorIndex) const = 0;
    };
}