Cycles: svn merge -r41232:41266 ^/trunk/blender
[blender.git] / intern / cycles / render / attribute.h
1 /*
2  * Copyright 2011, Blender Foundation.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  */
18
19 #ifndef __ATTRIBUTE_H__
20 #define __ATTRIBUTE_H__
21
22 #include "kernel_types.h"
23
24 #include "util_list.h"
25 #include "util_param.h"
26 #include "util_types.h"
27 #include "util_vector.h"
28
29 CCL_NAMESPACE_BEGIN
30
31 class Attribute;
32 class AttributeSet;
33 class AttributeRequest;
34 class AttributeRequestSet;
35 class Mesh;
36
37 /* Attribute
38  *
39  * Arbitrary data layers on meshes.
40  * Supported types: Float, Color, Vector, Normal, Point */
41
42 class Attribute {
43 public:
44         enum Element {
45                 VERTEX,
46                 FACE,
47                 CORNER
48         };
49
50         enum Standard {
51                 STD_NONE = 0,
52                 STD_VERTEX_NORMAL,
53                 STD_FACE_NORMAL,
54                 STD_UV,
55                 STD_GENERATED,
56                 STD_POSITION_UNDEFORMED,
57                 STD_POSITION_UNDISPLACED,
58                 STD_NUM
59         };
60
61         ustring name;
62         Standard std;
63
64         TypeDesc type;
65         vector<char> buffer;
66         Element element;
67
68         Attribute() {}
69         void set(ustring name, TypeDesc type, Element element);
70         void reserve(int numverts, int numfaces);
71
72         size_t data_sizeof();
73         size_t element_size(int numverts, int numfaces);
74         size_t buffer_size(int numverts, int numfaces);
75
76         char *data() { return (buffer.size())? &buffer[0]: NULL; };
77         float3 *data_float3() { return (float3*)data(); }
78         float *data_float() { return (float*)data(); }
79
80         const char *data() const { return (buffer.size())? &buffer[0]: NULL; }
81         const float3 *data_float3() const { return (float3*)data(); }
82         const float *data_float() const { return (float*)data(); }
83
84         static bool same_storage(TypeDesc a, TypeDesc b);
85         static ustring standard_name(Attribute::Standard std);
86 };
87
88 /* Attribute Set
89  *
90  * Set of attributes on a mesh. */
91
92 class AttributeSet {
93 public:
94         Mesh *mesh;
95         list<Attribute> attributes;
96
97         AttributeSet(Mesh *mesh);
98         ~AttributeSet();
99
100         Attribute *add(ustring name, TypeDesc type, Attribute::Element element);
101         Attribute *find(ustring name);
102         void remove(ustring name);
103
104         Attribute *add(Attribute::Standard std, ustring name = ustring());
105         Attribute *find(Attribute::Standard std);
106         void remove(Attribute::Standard std);
107
108         Attribute *find(AttributeRequest& req);
109
110         void reserve(int numverts, int numfaces);
111         void clear();
112 };
113
114 /* AttributeRequest
115  *
116  * Request from a shader to use a certain attribute, so we can figure out
117  * which ones we need to export from the host app end store for the kernel.
118  * The attribute is found either by name or by standard. */
119
120 class AttributeRequest {
121 public:
122         ustring name;
123         Attribute::Standard std;
124
125         /* temporary variables used by MeshManager */
126         TypeDesc type;
127         AttributeElement element;
128         int offset;
129
130         AttributeRequest(ustring name_);
131         AttributeRequest(Attribute::Standard std);
132 };
133
134 /* AttributeRequestSet
135  *
136  * Set of attributes requested by a shader. */
137
138 class AttributeRequestSet {
139 public:
140         vector<AttributeRequest> requests;
141
142         AttributeRequestSet();
143         ~AttributeRequestSet();
144
145         void add(ustring name);
146         void add(Attribute::Standard std);
147         void add(AttributeRequestSet& reqs);
148
149         bool find(ustring name);
150         bool find(Attribute::Standard std);
151
152         size_t size();
153         void clear();
154
155         bool modified(const AttributeRequestSet& other);
156 };
157
158 CCL_NAMESPACE_END
159
160 #endif /* __ATTRIBUTE_H__ */
161