Fix for attribute lookup in OSL. This uses a map in the OSL globals instead of the...
[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         ustring name;
51         AttributeStandard std;
52
53         TypeDesc type;
54         vector<char> buffer;
55         Element element;
56
57         Attribute() {}
58         void set(ustring name, TypeDesc type, Element element);
59         void reserve(int numverts, int numfaces);
60
61         size_t data_sizeof();
62         size_t element_size(int numverts, int numfaces);
63         size_t buffer_size(int numverts, int numfaces);
64
65         char *data() { return (buffer.size())? &buffer[0]: NULL; };
66         float3 *data_float3() { return (float3*)data(); }
67         float *data_float() { return (float*)data(); }
68
69         const char *data() const { return (buffer.size())? &buffer[0]: NULL; }
70         const float3 *data_float3() const { return (float3*)data(); }
71         const float *data_float() const { return (float*)data(); }
72
73         static bool same_storage(TypeDesc a, TypeDesc b);
74 };
75
76 /* Attribute Set
77  *
78  * Set of attributes on a mesh. */
79
80 class AttributeSet {
81 public:
82         Mesh *mesh;
83         list<Attribute> attributes;
84
85         AttributeSet();
86         ~AttributeSet();
87
88         Attribute *add(ustring name, TypeDesc type, Attribute::Element element);
89         Attribute *find(ustring name);
90         void remove(ustring name);
91
92         Attribute *add(AttributeStandard std, ustring name = ustring());
93         Attribute *find(AttributeStandard std);
94         void remove(AttributeStandard std);
95
96         Attribute *find(AttributeRequest& req);
97
98         void reserve(int numverts, int numfaces);
99         void clear();
100 };
101
102 /* AttributeRequest
103  *
104  * Request from a shader to use a certain attribute, so we can figure out
105  * which ones we need to export from the host app end store for the kernel.
106  * The attribute is found either by name or by standard. */
107
108 class AttributeRequest {
109 public:
110         ustring name;
111         AttributeStandard std;
112
113         /* temporary variables used by MeshManager */
114         TypeDesc type;
115         AttributeElement element;
116         int offset;
117
118         AttributeRequest(ustring name_);
119         AttributeRequest(AttributeStandard std);
120 };
121
122 /* AttributeRequestSet
123  *
124  * Set of attributes requested by a shader. */
125
126 class AttributeRequestSet {
127 public:
128         vector<AttributeRequest> requests;
129
130         AttributeRequestSet();
131         ~AttributeRequestSet();
132
133         void add(ustring name);
134         void add(AttributeStandard std);
135         void add(AttributeRequestSet& reqs);
136
137         bool find(ustring name);
138         bool find(AttributeStandard std);
139
140         size_t size();
141         void clear();
142
143         bool modified(const AttributeRequestSet& other);
144 };
145
146 CCL_NAMESPACE_END
147
148 #endif /* __ATTRIBUTE_H__ */
149