File: Transformation.h

package info (click to toggle)
gpick 0.2.6-1.2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,800 kB
  • sloc: cpp: 27,983; python: 738; xml: 70; makefile: 37; sh: 10
file content (100 lines) | stat: -rw-r--r-- 3,699 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/*
 * Copyright (c) 2009-2016, Albertas Vyšniauskas
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 *     * Neither the name of the software author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef TRANSFORMATION_H_
#define TRANSFORMATION_H_
#include "Color.h"
#include "dynv/MapFwd.h"
#include <string>
#include <memory>

typedef struct _GtkWidget GtkWidget;
/** \file source/transformation/Transformation.h
 * \brief Color transformation struct.
 */
namespace transformation
{
/** \struct IConfiguration
 * \brief Transformation object configuration management interface.
 */
struct IConfiguration {
	virtual ~IConfiguration() = default;
	virtual GtkWidget* getWidget() = 0;
	virtual void apply(dynv::Map &options) = 0;
};
/** \struct Transformation
 * \brief Transformation object structure.
 */
struct Transformation {
	protected:
		std::string name; /**< System name */
		std::string readable_name; /**< Human readable name */

		/**
		 * Apply transformation to color.
		 * @param[in] input Source color in RGB color space.
		 * @param[out] output Destination color in RGB color space.
		 */
		virtual void apply(Color *input, Color *output);
	public:
		/**
		 * Transformation object constructor.
		 * @param[in] name Transformation object system name.
		 * @param[in] readable_name Transformation object human readable name.
		 */
		Transformation(const char *name, const char *readable_name);

		/**
		 * Transformation object destructor.
		 */
		virtual ~Transformation();

		/**
		 * Serialize settings into configuration system.
		 * @param[in,out] dynv Configuration system.
		 */
		virtual void serialize(dynv::Map &options);

		/**
		 * Deserialize settings from configuration system.
		 * @param[in] dynv Configuration system.
		 */
		virtual void deserialize(const dynv::Map &options);

		/**
		 * Get configuration for transformation object.
		 * @return Configuration for transformation object.
		 */
		virtual std::unique_ptr<IConfiguration> getConfiguration();

		/**
		 * Get transformation object system name.
		 * @return Transformation object system name.
		 */
		std::string getName() const;

		/**
		 * Get transformation object human readable name.
		 * @return Transformation object human readable name.
		 */
		std::string getReadableName() const;

	friend struct Chain;
};
}
#endif /* TRANSFORMATION_H_ */