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