Panda3D

Loading...
Searching...
No Matches
geomVertexColumn.h
Go to the documentation of this file.
1/**
2 * PANDA 3D SOFTWARE
3 * Copyright (c) Carnegie Mellon University. All rights reserved.
4 *
5 * All use of this software is subject to the terms of the revised BSD
6 * license. You should have received a copy of this license along
7 * with this source code in a file named "LICENSE."
8 *
9 * @file geomVertexColumn.h
10 * @author drose
11 * @date 2005-03-06
12 */
13
14#ifndef GEOMVERTEXCOLUMN_H
15#define GEOMVERTEXCOLUMN_H
16
17#include "pandabase.h"
18#include "geomEnums.h"
19#include "internalName.h"
20#include "pointerTo.h"
21#include "luse.h"
22
23 class TypedWritable;
24 class BamWriter;
25 class BamReader;
26 class Datagram;
27 class DatagramIterator;
28
29 class GeomVertexReader;
30 class GeomVertexWriter;
31
32/**
33 * This defines how a single column is interleaved within a vertex array
34 * stored within a Geom. The GeomVertexArrayFormat class maintains a list of
35 * these to completely define a particular array structure.
36 */
37 class EXPCL_PANDA_GOBJ GeomVertexColumn : public GeomEnums {
38 private:
39 INLINE GeomVertexColumn();
40PUBLISHED:
41 INLINE explicit GeomVertexColumn(CPT_InternalName name, int num_components,
42 NumericType numeric_type, Contents contents,
43 int start, int column_alignment = 0,
44 int num_elements = 0, int element_stride = 0);
45 INLINE GeomVertexColumn(const GeomVertexColumn &copy);
46 void operator = (const GeomVertexColumn &copy);
47 INLINE ~GeomVertexColumn();
48
49 INLINE const InternalName *get_name() const;
50 INLINE int get_num_components() const;
51 INLINE int get_num_values() const;
52 INLINE int get_num_elements() const;
53 INLINE NumericType get_numeric_type() const;
54 INLINE Contents get_contents() const;
55 INLINE int get_start() const;
56 INLINE int get_column_alignment() const;
57 INLINE int get_element_stride() const;
58 INLINE int get_component_bytes() const;
59 INLINE int get_total_bytes() const;
60 INLINE bool has_homogeneous_coord() const;
61
62 INLINE bool overlaps_with(int start_byte, int num_bytes) const;
63 INLINE bool is_bytewise_equivalent(const GeomVertexColumn &other) const;
64
65 void set_name(InternalName *name);
66 void set_num_components(int num_components);
67 void set_numeric_type(NumericType numeric_type);
68 void set_contents(Contents contents);
69 void set_start(int start);
70 void set_column_alignment(int column_alignment);
71
72 void output(std::ostream &out) const;
73
74 public:
75 INLINE bool is_packed_argb() const;
76 INLINE bool is_uint8_rgba() const;
77
78 INLINE int compare_to(const GeomVertexColumn &other) const;
79 INLINE bool operator == (const GeomVertexColumn &other) const;
80 INLINE bool operator != (const GeomVertexColumn &other) const;
81 INLINE bool operator < (const GeomVertexColumn &other) const;
82
83 private:
84 class Packer;
85
86 void setup();
87 Packer *make_packer() const;
88
89 public:
90 void write_datagram(BamWriter *manager, Datagram &dg);
91 int complete_pointers(TypedWritable **plist, BamReader *manager);
92 void fillin(DatagramIterator &scan, BamReader *manager);
93
94 private:
95 CPT_InternalName _name;
96 int _num_components;
97 int _num_values;
98 int _num_elements;
99 NumericType _numeric_type;
100 Contents _contents;
101 int _start;
102 int _column_alignment;
103 int _element_stride;
104 int _component_bytes;
105 int _total_bytes;
106 Packer *_packer;
107
108 // This nested class provides the implementation for packing and unpacking
109 // data in a very general way, but also provides the hooks for implementing
110 // the common, very direct code paths (for instance, 3-component float32 to
111 // LVecBase3f) as quickly as possible.
112 class Packer : public MemoryBase {
113 public:
114 virtual ~Packer();
115
116 virtual float get_data1f(const unsigned char *pointer);
117 virtual const LVecBase2f &get_data2f(const unsigned char *pointer);
118 virtual const LVecBase3f &get_data3f(const unsigned char *pointer);
119 virtual const LVecBase4f &get_data4f(const unsigned char *pointer);
120
121 virtual double get_data1d(const unsigned char *pointer);
122 virtual const LVecBase2d &get_data2d(const unsigned char *pointer);
123 virtual const LVecBase3d &get_data3d(const unsigned char *pointer);
124 virtual const LVecBase4d &get_data4d(const unsigned char *pointer);
125
126 virtual int get_data1i(const unsigned char *pointer);
127 virtual const LVecBase2i &get_data2i(const unsigned char *pointer);
128 virtual const LVecBase3i &get_data3i(const unsigned char *pointer);
129 virtual const LVecBase4i &get_data4i(const unsigned char *pointer);
130
131 virtual void set_data1f(unsigned char *pointer, float data);
132 virtual void set_data2f(unsigned char *pointer, const LVecBase2f &data);
133 virtual void set_data3f(unsigned char *pointer, const LVecBase3f &data);
134 virtual void set_data4f(unsigned char *pointer, const LVecBase4f &data);
135
136 virtual void set_data1d(unsigned char *pointer, double data);
137 virtual void set_data2d(unsigned char *pointer, const LVecBase2d &data);
138 virtual void set_data3d(unsigned char *pointer, const LVecBase3d &data);
139 virtual void set_data4d(unsigned char *pointer, const LVecBase4d &data);
140
141 virtual void set_data1i(unsigned char *pointer, int data);
142 virtual void set_data2i(unsigned char *pointer, const LVecBase2i &data);
143 virtual void set_data3i(unsigned char *pointer, const LVecBase3i &data);
144 virtual void set_data4i(unsigned char *pointer, const LVecBase4i &data);
145
146 virtual const char *get_name() const {
147 return "Packer";
148 }
149
150 const GeomVertexColumn *_column;
151 LVecBase2f _v2;
152 LVecBase3f _v3;
153 LVecBase4f _v4;
154 LVecBase2d _v2d;
155 LVecBase3d _v3d;
156 LVecBase4d _v4d;
157 LVecBase2i _v2i;
158 LVecBase3i _v3i;
159 LVecBase4i _v4i;
160 unsigned int _a, _b, _c, _d;
161 };
162
163
164 // This is a specialization on the generic Packer that handles points, which
165 // are special because the fourth component, if not present in the data, is
166 // implicitly 1.0; and if it is present, then any three-component or smaller
167 // return is implicitly divided by the fourth component.
168 class Packer_point : public Packer {
169 public:
170 virtual float get_data1f(const unsigned char *pointer);
171 virtual const LVecBase2f &get_data2f(const unsigned char *pointer);
172 virtual const LVecBase3f &get_data3f(const unsigned char *pointer);
173 virtual const LVecBase4f &get_data4f(const unsigned char *pointer);
174
175 virtual double get_data1d(const unsigned char *pointer);
176 virtual const LVecBase2d &get_data2d(const unsigned char *pointer);
177 virtual const LVecBase3d &get_data3d(const unsigned char *pointer);
178 virtual const LVecBase4d &get_data4d(const unsigned char *pointer);
179
180 virtual void set_data1f(unsigned char *pointer, float data);
181 virtual void set_data2f(unsigned char *pointer, const LVecBase2f &data);
182 virtual void set_data3f(unsigned char *pointer, const LVecBase3f &data);
183 virtual void set_data4f(unsigned char *pointer, const LVecBase4f &data);
184
185 virtual void set_data1d(unsigned char *pointer, double data);
186 virtual void set_data2d(unsigned char *pointer, const LVecBase2d &data);
187 virtual void set_data3d(unsigned char *pointer, const LVecBase3d &data);
188 virtual void set_data4d(unsigned char *pointer, const LVecBase4d &data);
189
190 virtual const char *get_name() const {
191 return "Packer_point";
192 }
193 };
194
195 // This is similar to Packer_point, in that the fourth component is
196 // implicitly 1.0 if it is not present in the data, but we never divide by
197 // alpha. It also transforms integer colors to the 0-1 range.
198 class Packer_color : public Packer {
199 public:
200 virtual float get_data1f(const unsigned char *pointer);
201 virtual const LVecBase2f &get_data2f(const unsigned char *pointer);
202 virtual const LVecBase3f &get_data3f(const unsigned char *pointer);
203 virtual const LVecBase4f &get_data4f(const unsigned char *pointer);
204
205 virtual double get_data1d(const unsigned char *pointer);
206 virtual const LVecBase2d &get_data2d(const unsigned char *pointer);
207 virtual const LVecBase3d &get_data3d(const unsigned char *pointer);
208 virtual const LVecBase4d &get_data4d(const unsigned char *pointer);
209
210 virtual void set_data1f(unsigned char *pointer, float data);
211 virtual void set_data2f(unsigned char *pointer, const LVecBase2f &data);
212 virtual void set_data3f(unsigned char *pointer, const LVecBase3f &data);
213 virtual void set_data4f(unsigned char *pointer, const LVecBase4f &data);
214
215 virtual void set_data1d(unsigned char *pointer, double data);
216 virtual void set_data2d(unsigned char *pointer, const LVecBase2d &data);
217 virtual void set_data3d(unsigned char *pointer, const LVecBase3d &data);
218 virtual void set_data4d(unsigned char *pointer, const LVecBase4d &data);
219
220 virtual const char *get_name() const {
221 return "Packer_color";
222 }
223 };
224
225
226 // These are the specializations on the generic Packer that handle the
227 // direct code paths.
228
229 class Packer_float32_3 : public Packer {
230 public:
231 virtual const LVecBase3f &get_data3f(const unsigned char *pointer);
232 virtual void set_data3f(unsigned char *pointer, const LVecBase3f &value);
233
234 virtual const char *get_name() const {
235 return "Packer_float32_3";
236 }
237 };
238
239 class Packer_point_float32_2 : public Packer_point {
240 public:
241 virtual const LVecBase2f &get_data2f(const unsigned char *pointer);
242 virtual void set_data2f(unsigned char *pointer, const LVecBase2f &value);
243
244 virtual const char *get_name() const {
245 return "Packer_point_float32_2";
246 }
247 };
248
249 class Packer_point_float32_3 : public Packer_point {
250 public:
251 virtual const LVecBase3f &get_data3f(const unsigned char *pointer);
252 virtual void set_data3f(unsigned char *pointer, const LVecBase3f &value);
253
254 virtual const char *get_name() const {
255 return "Packer_point_float32_3";
256 }
257 };
258
259 class Packer_point_float32_4 : public Packer_point {
260 public:
261 virtual const LVecBase4f &get_data4f(const unsigned char *pointer);
262 virtual void set_data4f(unsigned char *pointer, const LVecBase4f &value);
263
264 virtual const char *get_name() const {
265 return "Packer_point_float32_4";
266 }
267 };
268
269 class Packer_nativefloat_3 : public Packer_float32_3 {
270 public:
271 virtual const LVecBase3f &get_data3f(const unsigned char *pointer);
272
273 virtual const char *get_name() const {
274 return "Packer_nativefloat_3";
275 }
276 };
277
278 class Packer_point_nativefloat_2 : public Packer_point_float32_2 {
279 public:
280 virtual const LVecBase2f &get_data2f(const unsigned char *pointer);
281
282 virtual const char *get_name() const {
283 return "Packer_nativefloat_2";
284 }
285 };
286
287 class Packer_point_nativefloat_3 : public Packer_point_float32_3 {
288 public:
289 virtual const LVecBase3f &get_data3f(const unsigned char *pointer);
290
291 virtual const char *get_name() const {
292 return "Packer_point_nativefloat_3";
293 }
294 };
295
296 class Packer_point_nativefloat_4 : public Packer_point_float32_4 {
297 public:
298 virtual const LVecBase4f &get_data4f(const unsigned char *pointer);
299
300 virtual const char *get_name() const {
301 return "Packer_point_nativefloat_4";
302 }
303 };
304
305 class Packer_float64_3 : public Packer {
306 public:
307 virtual const LVecBase3d &get_data3d(const unsigned char *pointer);
308 virtual void set_data3d(unsigned char *pointer, const LVecBase3d &value);
309
310 virtual const char *get_name() const {
311 return "Packer_float64_3";
312 }
313 };
314
315 class Packer_point_float64_2 : public Packer_point {
316 public:
317 virtual const LVecBase2d &get_data2d(const unsigned char *pointer);
318 virtual void set_data2d(unsigned char *pointer, const LVecBase2d &value);
319
320 virtual const char *get_name() const {
321 return "Packer_point_float64_2";
322 }
323 };
324
325 class Packer_point_float64_3 : public Packer_point {
326 public:
327 virtual const LVecBase3d &get_data3d(const unsigned char *pointer);
328 virtual void set_data3d(unsigned char *pointer, const LVecBase3d &value);
329
330 virtual const char *get_name() const {
331 return "Packer_point_float64_3";
332 }
333 };
334
335 class Packer_point_float64_4 : public Packer_point {
336 public:
337 virtual const LVecBase4d &get_data4d(const unsigned char *pointer);
338 virtual void set_data4d(unsigned char *pointer, const LVecBase4d &value);
339
340 virtual const char *get_name() const {
341 return "Packer_point_float64_4";
342 }
343 };
344
345 class Packer_nativedouble_3 final : public Packer_float64_3 {
346 public:
347 virtual const LVecBase3d &get_data3d(const unsigned char *pointer);
348
349 virtual const char *get_name() const {
350 return "Packer_nativedouble_3";
351 }
352 };
353
354 class Packer_point_nativedouble_2 final : public Packer_point_float64_2 {
355 public:
356 virtual const LVecBase2d &get_data2d(const unsigned char *pointer);
357
358 virtual const char *get_name() const {
359 return "Packer_nativedouble_2";
360 }
361 };
362
363 class Packer_point_nativedouble_3 final : public Packer_point_float64_3 {
364 public:
365 virtual const LVecBase3d &get_data3d(const unsigned char *pointer);
366
367 virtual const char *get_name() const {
368 return "Packer_point_nativedouble_3";
369 }
370 };
371
372 class Packer_point_nativedouble_4 : public Packer_point_float64_4 {
373 public:
374 virtual const LVecBase4d &get_data4d(const unsigned char *pointer);
375
376 virtual const char *get_name() const {
377 return "Packer_point_nativedouble_4";
378 }
379 };
380
381 class Packer_argb_packed final : public Packer_color {
382 public:
383 virtual const LVecBase4f &get_data4f(const unsigned char *pointer);
384 virtual const LVecBase4d &get_data4d(const unsigned char *pointer);
385 virtual void set_data4f(unsigned char *pointer, const LVecBase4f &value);
386 virtual void set_data4d(unsigned char *pointer, const LVecBase4d &value);
387
388 virtual const char *get_name() const {
389 return "Packer_argb_packed";
390 }
391 };
392
393 class Packer_rgba_uint8_4 final : public Packer_color {
394 public:
395 virtual const LVecBase4f &get_data4f(const unsigned char *pointer);
396 virtual const LVecBase4d &get_data4d(const unsigned char *pointer);
397 virtual void set_data4f(unsigned char *pointer, const LVecBase4f &value);
398 virtual void set_data4d(unsigned char *pointer, const LVecBase4d &value);
399
400 virtual const char *get_name() const {
401 return "Packer_rgba_uint8_4";
402 }
403 };
404
405 class Packer_rgba_float32_4 : public Packer_color {
406 public:
407 virtual const LVecBase4f &get_data4f(const unsigned char *pointer);
408 virtual void set_data4f(unsigned char *pointer, const LVecBase4f &value);
409
410 virtual const char *get_name() const {
411 return "Packer_rgba_float32_4";
412 }
413 };
414
415 class Packer_rgba_nativefloat_4 final : public Packer_rgba_float32_4 {
416 public:
417 virtual const LVecBase4f &get_data4f(const unsigned char *pointer);
418
419 virtual const char *get_name() const {
420 return "Packer_rgba_nativefloat_4";
421 }
422 };
423
424 class Packer_uint16_1 final : public Packer {
425 public:
426 virtual int get_data1i(const unsigned char *pointer);
427 virtual void set_data1i(unsigned char *pointer, int value);
428
429 virtual const char *get_name() const {
430 return "Packer_uint16_1";
431 }
432 };
433
434 friend class GeomVertexArrayFormat;
435 friend class GeomVertexData;
436 friend class GeomVertexReader;
437 friend class GeomVertexWriter;
438};
439
440INLINE std::ostream &operator << (std::ostream &out, const GeomVertexColumn &obj);
441
442#include "geomVertexColumn.I"
443
444#endif
BamReader
This is the fundamental interface for extracting binary objects from a Bam file, as generated by a Ba...
Definition bamReader.h:110
BamWriter
This is the fundamental interface for writing binary objects to a Bam file, to be extracted later by ...
Definition bamWriter.h:63
CPT_InternalName
This is a const pointer to an InternalName, and should be used in lieu of a CPT(InternalName) in func...
Definition internalName.h:193
DatagramIterator
A class to retrieve the individual data elements previously stored in a Datagram.
Definition datagramIterator.h:30
Datagram
An ordered list of data elements, formatted in memory for transmission over a socket or writing to a ...
Definition datagram.h:38
GeomEnums
This class exists just to provide scoping for the various enumerated types used by Geom,...
Definition geomEnums.h:24
GeomVertexColumn
This defines how a single column is interleaved within a vertex array stored within a Geom.
Definition geomVertexColumn.h:37
GeomVertexColumn::get_num_values
int get_num_values() const
Returns the number of numeric values of the column: the number of distinct numeric values that go int...
Definition geomVertexColumn.I:99
GeomVertexColumn::fillin
void fillin(DatagramIterator &scan, BamReader *manager)
This internal function is called by make_from_bam to read in all of the relevant data from the BamFil...
Definition geomVertexColumn.cxx:430
GeomVertexColumn::get_start
int get_start() const
Returns the byte within the array record at which this column starts.
Definition geomVertexColumn.I:133
GeomVertexColumn::set_column_alignment
void set_column_alignment(int column_alignment)
Changes the column alignment of an existing column.
Definition geomVertexColumn.cxx:94
GeomVertexColumn::get_component_bytes
int get_component_bytes() const
Returns the number of bytes used by each component (that is, by one element of the numeric type).
Definition geomVertexColumn.I:162
GeomVertexColumn::get_numeric_type
NumericType get_numeric_type() const
Returns the token representing the numeric type of the data storage.
Definition geomVertexColumn.I:116
GeomVertexColumn::get_element_stride
int get_element_stride() const
This value is only relevant for matrix types.
Definition geomVertexColumn.I:153
GeomVertexColumn::write_datagram
void write_datagram(BamWriter *manager, Datagram &dg)
Writes the contents of this object to the datagram for shipping out to a Bam file.
Definition geomVertexColumn.cxx:386
GeomVertexColumn::get_column_alignment
int get_column_alignment() const
Returns the alignment requirements for this column.
Definition geomVertexColumn.I:144
GeomVertexColumn::overlaps_with
bool overlaps_with(int start_byte, int num_bytes) const
Returns true if this column overlaps with any of the bytes in the indicated range,...
Definition geomVertexColumn.I:199
GeomVertexColumn::is_bytewise_equivalent
bool is_bytewise_equivalent(const GeomVertexColumn &other) const
Returns true if the data store of this column is exactly the same as that of the other,...
Definition geomVertexColumn.I:209
GeomVertexColumn::set_name
void set_name(InternalName *name)
Replaces the name of an existing column.
Definition geomVertexColumn.cxx:44
GeomVertexColumn::complete_pointers
int complete_pointers(TypedWritable **plist, BamReader *manager)
Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().
Definition geomVertexColumn.cxx:410
GeomVertexColumn::set_numeric_type
void set_numeric_type(NumericType numeric_type)
Changes the numeric type an existing column.
Definition geomVertexColumn.cxx:64
GeomVertexColumn::is_uint8_rgba
bool is_uint8_rgba() const
Returns true if this column is the standard OpenGL representation of 4-component color: C_color,...
Definition geomVertexColumn.I:232
GeomVertexColumn::compare_to
int compare_to(const GeomVertexColumn &other) const
This is used to unquify columns, and hence formats, for the GeomVertexFormat registry.
Definition geomVertexColumn.I:243
GeomVertexColumn::get_num_elements
int get_num_elements() const
Returns the number of times this column is repeated.
Definition geomVertexColumn.I:108
GeomVertexColumn::get_name
const InternalName * get_name() const
Returns the name of this particular data field, e.g.
Definition geomVertexColumn.I:77
GeomVertexColumn::set_contents
void set_contents(Contents contents)
Changes the semantic meaning of an existing column.
Definition geomVertexColumn.cxx:74
GeomVertexColumn::is_packed_argb
bool is_packed_argb() const
Returns true if this column is the standard DirectX representation of 4-component color: C_color,...
Definition geomVertexColumn.I:221
GeomVertexColumn::set_start
void set_start(int start)
Changes the start byte of an existing column.
Definition geomVertexColumn.cxx:84
GeomVertexColumn::set_num_components
void set_num_components(int num_components)
Changes the number of components of an existing column.
Definition geomVertexColumn.cxx:54
GeomVertexColumn::get_contents
Contents get_contents() const
Returns the token representing the semantic meaning of the stored value.
Definition geomVertexColumn.I:124
GeomVertexColumn::has_homogeneous_coord
bool has_homogeneous_coord() const
Returns true if this Contents type is one that includes a homogeneous coordinate in the fourth compon...
Definition geomVertexColumn.I:183
GeomVertexColumn::get_total_bytes
int get_total_bytes() const
Returns the number of bytes used by each element of the column: component_bytes * num_components.
Definition geomVertexColumn.I:171
GeomVertexColumn::get_num_components
int get_num_components() const
Returns the number of components of the column: the number of instances of the NumericType in each el...
Definition geomVertexColumn.I:87
GeomVertexReader
This object provides a high-level interface for quickly reading a sequence of numeric values from a v...
Definition geomVertexReader.h:47
GeomVertexWriter
This object provides a high-level interface for quickly writing a sequence of numeric values from a v...
Definition geomVertexWriter.h:55
InternalName
Encodes a string name in a hash table, mapping it to a pointer.
Definition internalName.h:38
MemoryBase
This class is intended to be the base class of all objects in Panda that might be allocated and delet...
Definition memoryBase.h:65
TypedWritable
Base class for objects that can be written to and read from Bam files.
Definition typedWritable.h:35
plist
This is our own Panda specialization on the default STL list.
Definition plist.h:35
geomEnums.h
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
geomVertexColumn.I
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
internalName.h
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
luse.h
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
pandabase.h
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.
pointerTo.h
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University.