blob: d4a916e2677bfeb3e053690d6ff9aeeb90a241f1 (
plain)
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
|
/* SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once
/** \file
* \ingroup freestyle
* \brief Class defining StrokeShader
*/
#include <iostream>
#include <vector>
#ifdef WITH_CXX_GUARDEDALLOC
# include "MEM_guardedalloc.h"
#endif
using namespace std;
namespace Freestyle {
//
// StrokeShader base class
//
//////////////////////////////////////////////////////
class Stroke;
/** Base class for Stroke Shaders.
* Any Stroke Shader must inherit from this class and overload the shade() method.
* A StrokeShader is designed to modify any Stroke's attribute such as Thickness, Color,
* Geometry, Texture, Blending mode...
* The basic way to achieve this operation consists in iterating over the StrokeVertices of the
* Stroke and to modify each one's StrokeAttribute. Here is a python code example of such an
* iteration: \code it = ioStroke.strokeVerticesBegin() while not it.isEnd(): att =
* it.getObject().attribute()
* ## perform here any attribute modification
* it.increment()
* \endcode
* Here is a C++ code example of such an iteration:
* \code
* for (StrokeInternal::StrokeVertexIterator v = ioStroke.strokeVerticesBegin(), vend =
* ioStroke.strokeVerticesEnd(); v != vend;
* ++v)
* {
* StrokeAttribute& att = v->attribute();
* // perform any attribute modification here...
* }
* \endcode
*/
class StrokeShader {
public:
void *py_ss;
/** Default constructor. */
StrokeShader()
{
py_ss = 0;
}
/** Destructor. */
virtual ~StrokeShader()
{
}
/** Returns the string corresponding to the shader's name. */
virtual string getName() const
{
return "StrokeShader";
}
/** The shading method. This method must be overloaded by inherited classes.
* \param ioStroke:
* The stroke we wish to shade. this Stroke is modified by the Shader (which typically
* modifies the Stroke's attribute's values such as Color, Thickness, Geometry...)
*/
virtual int shade(Stroke &ioStroke) const;
#ifdef WITH_CXX_GUARDEDALLOC
MEM_CXX_CLASS_ALLOC_FUNCS("Freestyle:StrokeShader")
#endif
};
} /* namespace Freestyle */
|
