OpenVDB: openvdb/points/AttributeSet.h Source File

OpenVDB 11.0.0

Loading...
Searching...
No Matches
AttributeSet.h
Go to the documentation of this file.
1// Copyright Contributors to the OpenVDB Project
2// SPDX-License-Identifier: MPL-2.0
3
4/// @file points/AttributeSet.h
5///
6/// @authors Dan Bailey, Mihai Alden
7///
8/// @brief Set of Attribute Arrays which tracks metadata about each array.
9
10#ifndef OPENVDB_POINTS_ATTRIBUTE_SET_HAS_BEEN_INCLUDED
11#define OPENVDB_POINTS_ATTRIBUTE_SET_HAS_BEEN_INCLUDED
12
13#include "AttributeArray.h"
14#include <openvdb/version.h>
15#include <openvdb/MetaMap.h>
16
17#include <limits>
18#include <memory>
19#include <vector>
20
21
22class TestAttributeSet;
23
24
25namespace openvdb {
26 OPENVDB_USE_VERSION_NAMESPACE
27namespace OPENVDB_VERSION_NAME {
28namespace points {
29
30
31 using GroupType = uint8_t;
32
33
34////////////////////////////////////////
35
36
37/// Ordered collection of uniquely-named attribute arrays
38 class OPENVDB_API AttributeSet
39{
40public:
41 enum AttributePositionLabel : size_t { INVALID_POS = std::numeric_limits<size_t>::max() };
42
43 using Ptr = std::shared_ptr<AttributeSet>;
44 using ConstPtr = std::shared_ptr<const AttributeSet>;
45 using UniquePtr = std::unique_ptr<AttributeSet>;
46
47 class Descriptor;
48
49 using DescriptorPtr = std::shared_ptr<Descriptor>;
50 using DescriptorConstPtr = std::shared_ptr<const Descriptor>;
51
52 //////////
53
54 struct Util
55 {
56 /// Attribute and type name pair.
57 struct NameAndType {
58 NameAndType(const std::string& n, const NamePair& t, const Index s = 1)
59 : name(n), type(t), stride(s) {}
60 Name name;
61 NamePair type;
62 Index stride;
63 };
64
65 using NameAndTypeVec = std::vector<NameAndType>;
66 using NameToPosMap = std::map<std::string, size_t>;
67 using GroupIndex = std::pair<size_t, uint8_t>;
68 };
69
70 //////////
71
72 AttributeSet();
73
74 /// Construct a new AttributeSet from the given AttributeSet.
75 /// @param attributeSet the old attribute set
76 /// @param arrayLength the desired length of the arrays in the new AttributeSet
77 /// @param lock an optional scoped registry lock to avoid contention
78 /// @note This constructor is typically used to resize an existing AttributeSet as
79 /// it transfers attribute metadata such as hidden and transient flags
80 AttributeSet(const AttributeSet& attributeSet, Index arrayLength,
81 const AttributeArray::ScopedRegistryLock* lock = nullptr);
82
83 /// Construct a new AttributeSet from the given Descriptor.
84 /// @param descriptor stored in the new AttributeSet and used in construction
85 /// @param arrayLength the desired length of the arrays in the new AttributeSet
86 /// @param lock an optional scoped registry lock to avoid contention
87 /// @note Descriptors do not store attribute metadata such as hidden and transient flags
88 /// which live on the AttributeArrays, so for constructing from an existing AttributeSet
89 /// use the AttributeSet(const AttributeSet&, Index) constructor instead
90 AttributeSet(const DescriptorPtr& descriptor, Index arrayLength = 1,
91 const AttributeArray::ScopedRegistryLock* lock = nullptr);
92
93 /// Shallow copy constructor, the descriptor and attribute arrays will be shared.
94 AttributeSet(const AttributeSet&);
95
96 /// Disallow copy assignment, since it wouldn't be obvious whether the copy is deep or shallow.
97 AttributeSet& operator=(const AttributeSet&) = delete;
98
99 //@{
100 /// @brief Return a reference to this attribute set's descriptor, which might
101 /// be shared with other sets.
102 Descriptor& descriptor() { return *mDescr; }
103 const Descriptor& descriptor() const { return *mDescr; }
104 //@}
105
106 /// @brief Return a pointer to this attribute set's descriptor, which might be
107 /// shared with other sets
108 DescriptorPtr descriptorPtr() const { return mDescr; }
109
110 /// Return the number of attributes in this set.
111 size_t size() const { return mAttrs.size(); }
112
113 /// Return the number of bytes of memory used by this attribute set.
114 size_t memUsage() const;
115
116#if OPENVDB_ABI_VERSION_NUMBER >= 10
117 /// Return the number of bytes of memory used by this attribute set once it
118 /// has been deserialized (this may be different to memUsage() if delay-loading
119 /// is in use).
120 size_t memUsageIfLoaded() const;
121#endif
122
123 /// @brief Return the position of the attribute array whose name is @a name,
124 /// or @c INVALID_POS if no match is found.
125 size_t find(const std::string& name) const;
126
127 /// @brief Replace the attribute array whose name is @a name.
128 /// @return The position of the updated attribute array or @c INVALID_POS
129 /// if the given name does not exist or if the replacement failed because
130 /// the new array type does not comply with the descriptor.
131 size_t replace(const std::string& name, const AttributeArray::Ptr&);
132
133 /// @brief Replace the attribute array stored at position @a pos in this container.
134 /// @return The position of the updated attribute array or @c INVALID_POS
135 /// if replacement failed because the new array type does not comply with
136 /// the descriptor.
137 size_t replace(size_t pos, const AttributeArray::Ptr&);
138
139 //@{
140 /// @brief Return a pointer to the attribute array whose name is @a name or
141 /// a null pointer if no match is found.
142 const AttributeArray* getConst(const std::string& name) const;
143 const AttributeArray* get(const std::string& name) const;
144 AttributeArray* get(const std::string& name);
145 //@}
146
147 //@{
148 /// @brief Return a pointer to the attribute array stored at position @a pos
149 /// in this set.
150 const AttributeArray* getConst(size_t pos) const;
151 const AttributeArray* get(size_t pos) const;
152 AttributeArray* get(size_t pos);
153 //@}
154
155 //@{
156 /// @brief Return the group offset from the name or index of the group
157 /// A group attribute array is a single byte (8-bit), each bit of which
158 /// can denote a group. The group offset is the position of the bit that
159 /// denotes the requested group if all group attribute arrays in the set
160 /// (and only attribute arrays marked as group) were to be laid out linearly
161 /// according to their order in the set.
162 size_t groupOffset(const Name& groupName) const;
163 size_t groupOffset(const Util::GroupIndex& index) const;
164 //@}
165
166 /// Return the group index from the name of the group
167 Util::GroupIndex groupIndex(const Name& groupName) const;
168 /// Return the group index from the offset of the group
169 /// @note see offset description for groupOffset()
170 Util::GroupIndex groupIndex(const size_t offset) const;
171
172 /// Return the indices of the attribute arrays which are group attribute arrays
173 std::vector<size_t> groupAttributeIndices() const;
174
175 /// Return true if the attribute array stored at position @a pos is shared.
176 bool isShared(size_t pos) const;
177 /// @brief If the attribute array stored at position @a pos is shared,
178 /// replace the array with a deep copy of itself that is not
179 /// shared with anyone else.
180 void makeUnique(size_t pos);
181
182 /// Append attribute @a attribute (simple method)
183 AttributeArray::Ptr appendAttribute(const Name& name,
184 const NamePair& type,
185 const Index strideOrTotalSize = 1,
186 const bool constantStride = true,
187 const Metadata* defaultValue = nullptr);
188
189 /// Append attribute @a attribute (descriptor-sharing)
190 /// Requires current descriptor to match @a expected
191 /// On append, current descriptor is replaced with @a replacement
192 /// Provide a @a lock object to avoid contention from appending in parallel
193 AttributeArray::Ptr appendAttribute(const Descriptor& expected, DescriptorPtr& replacement,
194 const size_t pos, const Index strideOrTotalSize = 1,
195 const bool constantStride = true,
196 const Metadata* defaultValue = nullptr,
197 const AttributeArray::ScopedRegistryLock* lock = nullptr);
198
199 /// @brief Remove and return an attribute array by name
200 /// @param name the name of the attribute array to release
201 /// @details Detaches the attribute array from this attribute set and returns it, if
202 /// @a name is invalid, returns an empty shared pointer. This also updates the descriptor
203 /// to remove the reference to the attribute array.
204 /// @note AttributeArrays are stored as shared pointers, so they are not guaranteed
205 /// to be unique. Check the reference count before blindly re-using in a new AttributeSet.
206 AttributeArray::Ptr removeAttribute(const Name& name);
207
208 /// @brief Remove and return an attribute array by index
209 /// @param pos the position index of the attribute to release
210 /// @details Detaches the attribute array from this attribute set and returns it, if
211 /// @a pos is invalid, returns an empty shared pointer. This also updates the descriptor
212 /// to remove the reference to the attribute array.
213 /// @note AttributeArrays are stored as shared pointers, so they are not guaranteed
214 /// to be unique. Check the reference count before blindly re-using in a new AttributeSet.
215 AttributeArray::Ptr removeAttribute(const size_t pos);
216
217 /// @brief Remove and return an attribute array by index (unsafe method)
218 /// @param pos the position index of the attribute to release
219 /// @details Detaches the attribute array from this attribute set and returns it, if
220 /// @a pos is invalid, returns an empty shared pointer.
221 /// In cases where the AttributeSet is due to be destroyed, a small performance
222 /// advantage can be gained by leaving the attribute array as a nullptr and not
223 /// updating the descriptor. However, this leaves the AttributeSet in an invalid
224 /// state making it unsafe to call any methods that implicitly derefence the attribute array.
225 /// @note AttributeArrays are stored as shared pointers, so they are not guaranteed
226 /// to be unique. Check the reference count before blindly re-using in a new AttributeSet.
227 /// @warning Only use this method if you're an expert and know the risks of not
228 /// updating the array of attributes or the descriptor.
229 AttributeArray::Ptr removeAttributeUnsafe(const size_t pos);
230
231 /// Drop attributes with @a pos indices (simple method)
232 /// Creates a new descriptor for this attribute set
233 void dropAttributes(const std::vector<size_t>& pos);
234
235 /// Drop attributes with @a pos indices (descriptor-sharing method)
236 /// Requires current descriptor to match @a expected
237 /// On drop, current descriptor is replaced with @a replacement
238 void dropAttributes(const std::vector<size_t>& pos,
239 const Descriptor& expected, DescriptorPtr& replacement);
240
241 /// Re-name attributes in set to match a provided descriptor
242 /// Replaces own descriptor with @a replacement
243 void renameAttributes(const Descriptor& expected, const DescriptorPtr& replacement);
244
245 /// Re order attribute set to match a provided descriptor
246 /// Replaces own descriptor with @a replacement
247 void reorderAttributes(const DescriptorPtr& replacement);
248
249 /// Replace the current descriptor with a @a replacement
250 /// Note the provided Descriptor must be identical to the replacement
251 /// unless @a allowMismatchingDescriptors is true (default is false)
252 void resetDescriptor(const DescriptorPtr& replacement, const bool allowMismatchingDescriptors = false);
253
254 /// Read the entire set from a stream.
255 void read(std::istream&);
256 /// Write the entire set to a stream.
257 /// @param outputTransient if true, write out transient attributes
258 void write(std::ostream&, bool outputTransient = false) const;
259
260 /// This will read the attribute descriptor from a stream.
261 void readDescriptor(std::istream&);
262 /// This will write the attribute descriptor to a stream.
263 /// @param outputTransient if true, write out transient attributes
264 void writeDescriptor(std::ostream&, bool outputTransient = false) const;
265
266 /// This will read the attribute metadata from a stream.
267 void readMetadata(std::istream&);
268 /// This will write the attribute metadata to a stream.
269 /// @param outputTransient if true, write out transient attributes
270 /// @param paged if true, data is written out in pages
271 void writeMetadata(std::ostream&, bool outputTransient = false, bool paged = false) const;
272
273 /// This will read the attribute data from a stream.
274 void readAttributes(std::istream&);
275 /// This will write the attribute data to a stream.
276 /// @param outputTransient if true, write out transient attributes
277 void writeAttributes(std::ostream&, bool outputTransient = false) const;
278
279 /// Compare the descriptors and attribute arrays on the attribute sets
280 /// Exit early if the descriptors do not match
281 bool operator==(const AttributeSet& other) const;
282 bool operator!=(const AttributeSet& other) const { return !this->operator==(other); }
283
284private:
285 using AttrArrayVec = std::vector<AttributeArray::Ptr>;
286
287 DescriptorPtr mDescr;
288 AttrArrayVec mAttrs;
289}; // class AttributeSet
290
291////////////////////////////////////////
292
293
294/// A container for ABI=5 to help ease introduction of upcoming features
295 namespace future {
296 class Container
297 {
298 class Element { };
299 std::vector<std::shared_ptr<Element>> mElements;
300 };
301}
302
303
304////////////////////////////////////////
305
306
307/// @brief An immutable object that stores name, type and AttributeSet position
308/// for a constant collection of attribute arrays.
309/// @note The attribute name is actually mutable, but the attribute type
310/// and position can not be changed after creation.
311 class OPENVDB_API AttributeSet::Descriptor
312{
313public:
314 using Ptr = std::shared_ptr<Descriptor>;
315
316 using NameAndType = Util::NameAndType;
317 using NameAndTypeVec = Util::NameAndTypeVec;
318 using GroupIndex = Util::GroupIndex;
319 using NameToPosMap = Util::NameToPosMap;
320 using ConstIterator = NameToPosMap::const_iterator;
321
322 /// Utility method to construct a NameAndType sequence.
323 struct Inserter {
324 NameAndTypeVec vec;
325 Inserter& add(const NameAndType& nameAndType) {
326 vec.push_back(nameAndType); return *this;
327 }
328 Inserter& add(const Name& name, const NamePair& type) {
329 vec.emplace_back(name, type); return *this;
330 }
331 Inserter& add(const NameAndTypeVec& other) {
332 for (NameAndTypeVec::const_iterator it = other.begin(), itEnd = other.end(); it != itEnd; ++it) {
333 vec.emplace_back(it->name, it->type);
334 }
335 return *this;
336 }
337 };
338
339 //////////
340
341 Descriptor();
342
343 /// Copy constructor
344 Descriptor(const Descriptor&);
345
346 /// Create a new descriptor from a position attribute type and assumes "P" (for convenience).
347 static Ptr create(const NamePair&);
348
349 /// Create a new descriptor as a duplicate with a new attribute appended
350 Ptr duplicateAppend(const Name& name, const NamePair& type) const;
351
352 /// Create a new descriptor as a duplicate with existing attributes dropped
353 Ptr duplicateDrop(const std::vector<size_t>& pos) const;
354
355 /// Return the number of attributes in this descriptor.
356 size_t size() const { return mTypes.size(); }
357
358 /// Return the number of attributes with this attribute type
359 size_t count(const NamePair& type) const;
360
361 /// Return the number of bytes of memory used by this attribute set.
362 size_t memUsage() const;
363
364 /// @brief Return the position of the attribute array whose name is @a name,
365 /// or @c INVALID_POS if no match is found.
366 size_t find(const std::string& name) const;
367
368 /// Rename an attribute array
369 size_t rename(const std::string& fromName, const std::string& toName);
370
371 /// Return the name of the attribute array's type.
372 const Name& valueType(size_t pos) const;
373 /// Return the name of the attribute array's type.
374 const NamePair& type(size_t pos) const;
375
376 /// Retrieve metadata map
377 MetaMap& getMetadata();
378 const MetaMap& getMetadata() const;
379
380 /// Return true if the attribute has a default value
381 bool hasDefaultValue(const Name& name) const;
382 /// Get a default value for an existing attribute
383 template<typename ValueType>
384 ValueType getDefaultValue(const Name& name) const
385 {
386 const size_t pos = find(name);
387 if (pos == INVALID_POS) {
388 OPENVDB_THROW(LookupError, "Cannot find attribute name to set default value.")
389 }
390
391 std::stringstream ss;
392 ss << "default:" << name;
393
394 auto metadata = mMetadata.getMetadata<TypedMetadata<ValueType>>(ss.str());
395
396 if (metadata) return metadata->value();
397
398 return zeroVal<ValueType>();
399 }
400 /// Set a default value for an existing attribute
401 void setDefaultValue(const Name& name, const Metadata& defaultValue);
402 // Remove the default value if it exists
403 void removeDefaultValue(const Name& name);
404 // Prune any default values for which the key is no longer present
405 void pruneUnusedDefaultValues();
406
407 /// Return true if this descriptor is equal to the given one.
408 bool operator==(const Descriptor&) const;
409 /// Return true if this descriptor is not equal to the given one.
410 bool operator!=(const Descriptor& rhs) const { return !this->operator==(rhs); }
411 /// Return true if this descriptor contains the same attributes
412 /// as the given descriptor, ignoring attribute order
413 bool hasSameAttributes(const Descriptor& rhs) const;
414
415 /// Return a reference to the name-to-position map.
416 const NameToPosMap& map() const { return mNameMap; }
417 /// Return a reference to the name-to-position group map.
418 const NameToPosMap& groupMap() const { return mGroupMap; }
419
420 /// Return @c true if group exists
421 bool hasGroup(const Name& group) const;
422 /// @brief Define a group name to offset mapping
423 /// @param group group name
424 /// @param offset group offset
425 /// @param checkValidOffset throws if offset out-of-range or in-use
426 void setGroup(const Name& group, const size_t offset,
427 const bool checkValidOffset = false);
428 /// Drop any mapping keyed by group name
429 void dropGroup(const Name& group);
430 /// Clear all groups
431 void clearGroups();
432 /// Rename a group
433 size_t renameGroup(const std::string& fromName, const std::string& toName);
434 /// Return a unique name for a group based on given name
435 const Name uniqueGroupName(const Name& name) const;
436
437 //@{
438 /// @brief Return the group offset from the name or index of the group
439 /// A group attribute array is a single byte (8-bit), each bit of which
440 /// can denote a group. The group offset is the position of the bit that
441 /// denotes the requested group if all group attribute arrays in the set
442 /// (and only attribute arrays marked as group) were to be laid out linearly
443 /// according to their order in the set.
444 size_t groupOffset(const Name& groupName) const;
445 size_t groupOffset(const GroupIndex& index) const;
446 //@}
447
448 /// Return the group index from the name of the group
449 GroupIndex groupIndex(const Name& groupName) const;
450 /// Return the group index from the offset of the group
451 /// @note see offset description for groupOffset()
452 GroupIndex groupIndex(const size_t offset) const;
453
454 /// Return number of bits occupied by a group attribute array
455 static size_t groupBits() { return sizeof(GroupType) * CHAR_BIT; }
456
457 /// Return the total number of available groups
458 /// (group bits * number of group attributes)
459 size_t availableGroups() const;
460
461 /// Return the number of empty group slots which correlates to the number of groups
462 /// that can be stored without increasing the number of group attribute arrays
463 size_t unusedGroups() const;
464
465 /// Return @c true if there are sufficient empty slots to allow compacting
466 bool canCompactGroups() const;
467
468 /// @brief Return a group offset that is not in use
469 /// @param hint if provided, request a specific offset as a hint
470 /// @return index of an offset or size_t max if no available group offsets
471 size_t unusedGroupOffset(size_t hint = std::numeric_limits<size_t>::max()) const;
472
473 /// @brief Determine if a move is required to efficiently compact the data and store the
474 /// source name, offset and the target offset in the input parameters
475 /// @param sourceName source name
476 /// @param sourceOffset source offset
477 /// @param targetOffset target offset
478 /// @return @c true if move is required to compact the data
479 bool requiresGroupMove(Name& sourceName, size_t& sourceOffset, size_t& targetOffset) const;
480
481 /// @brief Test if there are any group names shared by both descriptors which
482 /// have a different index
483 /// @param rhs the descriptor to compare with
484 /// @return @c true if an index collision exists
485 bool groupIndexCollision(const Descriptor& rhs) const;
486
487 /// Return a unique name for an attribute array based on given name
488 const Name uniqueName(const Name& name) const;
489
490 /// Return true if the name is valid
491 static bool validName(const Name& name);
492
493 /// @brief Extract each name from @a nameStr into @a includeNames, or into @a excludeNames
494 /// if the name is prefixed with a caret.
495 /// @param nameStr the input string of names
496 /// @param includeNames on exit, the list of names that are not prefixed with a caret
497 /// @param excludeNames on exit, the list of names that are prefixed with a caret
498 /// @param includeAll on exit, @c true if a "*" wildcard is present in the @a includeNames
499 static void parseNames( std::vector<std::string>& includeNames,
500 std::vector<std::string>& excludeNames,
501 bool& includeAll,
502 const std::string& nameStr);
503
504 /// @brief Extract each name from @a nameStr into @a includeNames, or into @a excludeNames
505 /// if the name is prefixed with a caret.
506 static void parseNames( std::vector<std::string>& includeNames,
507 std::vector<std::string>& excludeNames,
508 const std::string& nameStr);
509
510 /// Serialize this descriptor to the given stream.
511 void write(std::ostream&) const;
512 /// Unserialize this transform from the given stream.
513 void read(std::istream&);
514
515protected:
516 /// Append to a vector of names and types from this Descriptor in position order
517 void appendTo(NameAndTypeVec& attrs) const;
518
519 /// Create a new descriptor from the given attribute and type name pairs
520 /// and copy the group maps and metamap.
521 static Ptr create(const NameAndTypeVec&, const NameToPosMap&, const MetaMap&);
522
523 size_t insert(const std::string& name, const NamePair& typeName);
524
525private:
526 friend class ::TestAttributeSet;
527
528 NameToPosMap mNameMap;
529 std::vector<NamePair> mTypes;
530 NameToPosMap mGroupMap;
531 MetaMap mMetadata;
532 // as this change is part of an ABI change, there's no good reason to reduce the reserved
533 // space aside from keeping the memory size of an AttributeSet the same for convenience
534 // (note that this assumes a typical three-pointer implementation for std::vector)
535 future::Container mFutureContainer; // occupies 3 reserved slots
536 int64_t mReserved[5]; // for future use
537}; // class Descriptor
538
539} // namespace points
540} // namespace OPENVDB_VERSION_NAME
541} // namespace openvdb
542
543#endif // OPENVDB_POINTS_ATTRIBUTE_ARRAY_HAS_BEEN_INCLUDED
AttributeArray.h
Attribute Array storage templated on type and compression codec.
MetaMap.h
OPENVDB_API
#define OPENVDB_API
Definition Platform.h:274
openvdb::v11_0::LookupError
Definition Exceptions.h:60
openvdb::v11_0::MetaMap
Container that maps names (strings) to values of arbitrary types.
Definition MetaMap.h:20
openvdb::v11_0::Metadata
Base class for storing metadata information in a grid.
Definition Metadata.h:24
openvdb::v11_0::TypedMetadata
Templated metadata class to hold specific types.
Definition Metadata.h:122
openvdb::v11_0::points::AttributeArray::ScopedRegistryLock
Definition AttributeArray.h:119
openvdb::v11_0::points::AttributeArray
Base class for storing attribute data.
Definition AttributeArray.h:93
openvdb::v11_0::points::AttributeArray::Ptr
std::shared_ptr< AttributeArray > Ptr
Definition AttributeArray.h:125
openvdb::v11_0::points::AttributeSet::Descriptor
An immutable object that stores name, type and AttributeSet position for a constant collection of att...
Definition AttributeSet.h:312
openvdb::v11_0::points::AttributeSet::Descriptor::ConstIterator
NameToPosMap::const_iterator ConstIterator
Definition AttributeSet.h:320
openvdb::v11_0::points::AttributeSet::Descriptor::requiresGroupMove
bool requiresGroupMove(Name &sourceName, size_t &sourceOffset, size_t &targetOffset) const
Determine if a move is required to efficiently compact the data and store the source name,...
openvdb::v11_0::points::AttributeSet::Descriptor::groupOffset
size_t groupOffset(const Name &groupName) const
Return the group offset from the name or index of the group A group attribute array is a single byte ...
openvdb::v11_0::points::AttributeSet::Descriptor::groupIndex
GroupIndex groupIndex(const size_t offset) const
openvdb::v11_0::points::AttributeSet::Descriptor::unusedGroups
size_t unusedGroups() const
openvdb::v11_0::points::AttributeSet::Descriptor::operator==
bool operator==(const Descriptor &) const
Return true if this descriptor is equal to the given one.
openvdb::v11_0::points::AttributeSet::Descriptor::GroupIndex
Util::GroupIndex GroupIndex
Definition AttributeSet.h:318
openvdb::v11_0::points::AttributeSet::Descriptor::getMetadata
const MetaMap & getMetadata() const
openvdb::v11_0::points::AttributeSet::Descriptor::clearGroups
void clearGroups()
Clear all groups.
openvdb::v11_0::points::AttributeSet::Descriptor::memUsage
size_t memUsage() const
Return the number of bytes of memory used by this attribute set.
openvdb::v11_0::points::AttributeSet::Descriptor::renameGroup
size_t renameGroup(const std::string &fromName, const std::string &toName)
Rename a group.
openvdb::v11_0::points::AttributeSet::Descriptor::validName
static bool validName(const Name &name)
Return true if the name is valid.
openvdb::v11_0::points::AttributeSet::Descriptor::groupOffset
size_t groupOffset(const GroupIndex &index) const
openvdb::v11_0::points::AttributeSet::Descriptor::size
size_t size() const
Return the number of attributes in this descriptor.
Definition AttributeSet.h:356
openvdb::v11_0::points::AttributeSet::Descriptor::NameAndTypeVec
Util::NameAndTypeVec NameAndTypeVec
Definition AttributeSet.h:317
openvdb::v11_0::points::AttributeSet::Descriptor::rename
size_t rename(const std::string &fromName, const std::string &toName)
Rename an attribute array.
openvdb::v11_0::points::AttributeSet::Descriptor::find
size_t find(const std::string &name) const
Return the position of the attribute array whose name is name, or INVALID_POS if no match is found.
openvdb::v11_0::points::AttributeSet::Descriptor::groupIndexCollision
bool groupIndexCollision(const Descriptor &rhs) const
Test if there are any group names shared by both descriptors which have a different index.
openvdb::v11_0::points::AttributeSet::Descriptor::duplicateDrop
Ptr duplicateDrop(const std::vector< size_t > &pos) const
Create a new descriptor as a duplicate with existing attributes dropped.
openvdb::v11_0::points::AttributeSet::Descriptor::unusedGroupOffset
size_t unusedGroupOffset(size_t hint=std::numeric_limits< size_t >::max()) const
Return a group offset that is not in use.
openvdb::v11_0::points::AttributeSet::Descriptor::valueType
const Name & valueType(size_t pos) const
Return the name of the attribute array's type.
openvdb::v11_0::points::AttributeSet::Descriptor::operator!=
bool operator!=(const Descriptor &rhs) const
Return true if this descriptor is not equal to the given one.
Definition AttributeSet.h:410
openvdb::v11_0::points::AttributeSet::Descriptor::write
void write(std::ostream &) const
Serialize this descriptor to the given stream.
openvdb::v11_0::points::AttributeSet::Descriptor::type
const NamePair & type(size_t pos) const
Return the name of the attribute array's type.
openvdb::v11_0::points::AttributeSet::Descriptor::duplicateAppend
Ptr duplicateAppend(const Name &name, const NamePair &type) const
Create a new descriptor as a duplicate with a new attribute appended.
openvdb::v11_0::points::AttributeSet::Descriptor::create
static Ptr create(const NameAndTypeVec &, const NameToPosMap &, const MetaMap &)
openvdb::v11_0::points::AttributeSet::Descriptor::setDefaultValue
void setDefaultValue(const Name &name, const Metadata &defaultValue)
Set a default value for an existing attribute.
openvdb::v11_0::points::AttributeSet::Descriptor::canCompactGroups
bool canCompactGroups() const
Return true if there are sufficient empty slots to allow compacting.
openvdb::v11_0::points::AttributeSet::Descriptor::appendTo
void appendTo(NameAndTypeVec &attrs) const
Append to a vector of names and types from this Descriptor in position order.
openvdb::v11_0::points::AttributeSet::Descriptor::read
void read(std::istream &)
Unserialize this transform from the given stream.
openvdb::v11_0::points::AttributeSet::Descriptor::removeDefaultValue
void removeDefaultValue(const Name &name)
openvdb::v11_0::points::AttributeSet::Descriptor::Ptr
std::shared_ptr< Descriptor > Ptr
Definition AttributeSet.h:314
openvdb::v11_0::points::AttributeSet::Descriptor::setGroup
void setGroup(const Name &group, const size_t offset, const bool checkValidOffset=false)
Define a group name to offset mapping.
openvdb::v11_0::points::AttributeSet::Descriptor::Descriptor
Descriptor(const Descriptor &)
Copy constructor.
openvdb::v11_0::points::AttributeSet::Descriptor::pruneUnusedDefaultValues
void pruneUnusedDefaultValues()
openvdb::v11_0::points::AttributeSet::Descriptor::map
const NameToPosMap & map() const
Return a reference to the name-to-position map.
Definition AttributeSet.h:416
openvdb::v11_0::points::AttributeSet::Descriptor::groupMap
const NameToPosMap & groupMap() const
Return a reference to the name-to-position group map.
Definition AttributeSet.h:418
openvdb::v11_0::points::AttributeSet::Descriptor::parseNames
static void parseNames(std::vector< std::string > &includeNames, std::vector< std::string > &excludeNames, const std::string &nameStr)
Extract each name from nameStr into includeNames, or into excludeNames if the name is prefixed with a...
openvdb::v11_0::points::AttributeSet::Descriptor::Descriptor
Descriptor()
openvdb::v11_0::points::AttributeSet::Descriptor::parseNames
static void parseNames(std::vector< std::string > &includeNames, std::vector< std::string > &excludeNames, bool &includeAll, const std::string &nameStr)
Extract each name from nameStr into includeNames, or into excludeNames if the name is prefixed with a...
openvdb::v11_0::points::AttributeSet::Descriptor::hasDefaultValue
bool hasDefaultValue(const Name &name) const
Return true if the attribute has a default value.
openvdb::v11_0::points::AttributeSet::Descriptor::getDefaultValue
ValueType getDefaultValue(const Name &name) const
Get a default value for an existing attribute.
Definition AttributeSet.h:384
openvdb::v11_0::points::AttributeSet::Descriptor::groupIndex
GroupIndex groupIndex(const Name &groupName) const
Return the group index from the name of the group.
openvdb::v11_0::points::AttributeSet::Descriptor::insert
size_t insert(const std::string &name, const NamePair &typeName)
openvdb::v11_0::points::AttributeSet::Descriptor::count
size_t count(const NamePair &type) const
Return the number of attributes with this attribute type.
openvdb::v11_0::points::AttributeSet::Descriptor::groupBits
static size_t groupBits()
Return number of bits occupied by a group attribute array.
Definition AttributeSet.h:455
openvdb::v11_0::points::AttributeSet::Descriptor::getMetadata
MetaMap & getMetadata()
Retrieve metadata map.
openvdb::v11_0::points::AttributeSet::Descriptor::uniqueName
const Name uniqueName(const Name &name) const
Return a unique name for an attribute array based on given name.
openvdb::v11_0::points::AttributeSet::Descriptor::availableGroups
size_t availableGroups() const
openvdb::v11_0::points::AttributeSet::Descriptor::NameToPosMap
Util::NameToPosMap NameToPosMap
Definition AttributeSet.h:319
openvdb::v11_0::points::AttributeSet::Descriptor::create
static Ptr create(const NamePair &)
Create a new descriptor from a position attribute type and assumes "P" (for convenience).
openvdb::v11_0::points::AttributeSet::Descriptor::dropGroup
void dropGroup(const Name &group)
Drop any mapping keyed by group name.
openvdb::v11_0::points::AttributeSet::Descriptor::hasSameAttributes
bool hasSameAttributes(const Descriptor &rhs) const
openvdb::v11_0::points::AttributeSet::Descriptor::hasGroup
bool hasGroup(const Name &group) const
Return true if group exists.
openvdb::v11_0::points::AttributeSet::Descriptor::uniqueGroupName
const Name uniqueGroupName(const Name &name) const
Return a unique name for a group based on given name.
openvdb::v11_0::points::AttributeSet
Ordered collection of uniquely-named attribute arrays.
Definition AttributeSet.h:39
openvdb::v11_0::points::AttributeSet::replace
size_t replace(const std::string &name, const AttributeArray::Ptr &)
Replace the attribute array whose name is name.
openvdb::v11_0::points::AttributeSet::get
const AttributeArray * get(const std::string &name) const
openvdb::v11_0::points::AttributeSet::descriptorPtr
DescriptorPtr descriptorPtr() const
Return a pointer to this attribute set's descriptor, which might be shared with other sets.
Definition AttributeSet.h:108
openvdb::v11_0::points::AttributeSet::groupOffset
size_t groupOffset(const Name &groupName) const
Return the group offset from the name or index of the group A group attribute array is a single byte ...
openvdb::v11_0::points::AttributeSet::writeDescriptor
void writeDescriptor(std::ostream &, bool outputTransient=false) const
openvdb::v11_0::points::AttributeSet::dropAttributes
void dropAttributes(const std::vector< size_t > &pos, const Descriptor &expected, DescriptorPtr &replacement)
openvdb::v11_0::points::AttributeSet::memUsageIfLoaded
size_t memUsageIfLoaded() const
openvdb::v11_0::points::AttributeSet::groupIndex
Util::GroupIndex groupIndex(const Name &groupName) const
Return the group index from the name of the group.
openvdb::v11_0::points::AttributeSet::memUsage
size_t memUsage() const
Return the number of bytes of memory used by this attribute set.
openvdb::v11_0::points::AttributeSet::readDescriptor
void readDescriptor(std::istream &)
This will read the attribute descriptor from a stream.
openvdb::v11_0::points::AttributeSet::readAttributes
void readAttributes(std::istream &)
This will read the attribute data from a stream.
openvdb::v11_0::points::AttributeSet::size
size_t size() const
Return the number of attributes in this set.
Definition AttributeSet.h:111
openvdb::v11_0::points::AttributeSet::operator==
bool operator==(const AttributeSet &other) const
openvdb::v11_0::points::AttributeSet::getConst
const AttributeArray * getConst(const std::string &name) const
Return a pointer to the attribute array whose name is name or a null pointer if no match is found.
openvdb::v11_0::points::AttributeSet::find
size_t find(const std::string &name) const
Return the position of the attribute array whose name is name, or INVALID_POS if no match is found.
openvdb::v11_0::points::AttributeSet::getConst
const AttributeArray * getConst(size_t pos) const
Return a pointer to the attribute array stored at position pos in this set.
openvdb::v11_0::points::AttributeSet::AttributeSet
AttributeSet(const AttributeSet &attributeSet, Index arrayLength, const AttributeArray::ScopedRegistryLock *lock=nullptr)
openvdb::v11_0::points::AttributeSet::appendAttribute
AttributeArray::Ptr appendAttribute(const Name &name, const NamePair &type, const Index strideOrTotalSize=1, const bool constantStride=true, const Metadata *defaultValue=nullptr)
Append attribute attribute (simple method)
openvdb::v11_0::points::AttributeSet::descriptor
const Descriptor & descriptor() const
Definition AttributeSet.h:103
openvdb::v11_0::points::AttributeSet::get
const AttributeArray * get(size_t pos) const
openvdb::v11_0::points::AttributeSet::replace
size_t replace(size_t pos, const AttributeArray::Ptr &)
Replace the attribute array stored at position pos in this container.
openvdb::v11_0::points::AttributeSet::removeAttribute
AttributeArray::Ptr removeAttribute(const size_t pos)
Remove and return an attribute array by index.
openvdb::v11_0::points::AttributeSet::removeAttributeUnsafe
AttributeArray::Ptr removeAttributeUnsafe(const size_t pos)
Remove and return an attribute array by index (unsafe method)
openvdb::v11_0::points::AttributeSet::removeAttribute
AttributeArray::Ptr removeAttribute(const Name &name)
Remove and return an attribute array by name.
openvdb::v11_0::points::AttributeSet::renameAttributes
void renameAttributes(const Descriptor &expected, const DescriptorPtr &replacement)
openvdb::v11_0::points::AttributeSet::resetDescriptor
void resetDescriptor(const DescriptorPtr &replacement, const bool allowMismatchingDescriptors=false)
openvdb::v11_0::points::AttributeSet::operator=
AttributeSet & operator=(const AttributeSet &)=delete
Disallow copy assignment, since it wouldn't be obvious whether the copy is deep or shallow.
openvdb::v11_0::points::AttributeSet::writeAttributes
void writeAttributes(std::ostream &, bool outputTransient=false) const
openvdb::v11_0::points::AttributeSet::AttributeSet
AttributeSet(const AttributeSet &)
Shallow copy constructor, the descriptor and attribute arrays will be shared.
openvdb::v11_0::points::AttributeSet::operator!=
bool operator!=(const AttributeSet &other) const
Definition AttributeSet.h:282
openvdb::v11_0::points::AttributeSet::DescriptorConstPtr
std::shared_ptr< const Descriptor > DescriptorConstPtr
Definition AttributeSet.h:50
openvdb::v11_0::points::AttributeSet::read
void read(std::istream &)
Read the entire set from a stream.
openvdb::v11_0::points::AttributeSet::descriptor
Descriptor & descriptor()
Return a reference to this attribute set's descriptor, which might be shared with other sets.
Definition AttributeSet.h:102
openvdb::v11_0::points::AttributeSet::Ptr
std::shared_ptr< AttributeSet > Ptr
Definition AttributeSet.h:43
openvdb::v11_0::points::AttributeSet::reorderAttributes
void reorderAttributes(const DescriptorPtr &replacement)
openvdb::v11_0::points::AttributeSet::AttributeSet
AttributeSet(const DescriptorPtr &descriptor, Index arrayLength=1, const AttributeArray::ScopedRegistryLock *lock=nullptr)
openvdb::v11_0::points::AttributeSet::writeMetadata
void writeMetadata(std::ostream &, bool outputTransient=false, bool paged=false) const
openvdb::v11_0::points::AttributeSet::makeUnique
void makeUnique(size_t pos)
If the attribute array stored at position pos is shared, replace the array with a deep copy of itself...
openvdb::v11_0::points::AttributeSet::AttributePositionLabel
AttributePositionLabel
Definition AttributeSet.h:41
openvdb::v11_0::points::AttributeSet::AttributeSet
AttributeSet()
openvdb::v11_0::points::AttributeSet::groupOffset
size_t groupOffset(const Util::GroupIndex &index) const
openvdb::v11_0::points::AttributeSet::dropAttributes
void dropAttributes(const std::vector< size_t > &pos)
openvdb::v11_0::points::AttributeSet::groupIndex
Util::GroupIndex groupIndex(const size_t offset) const
openvdb::v11_0::points::AttributeSet::appendAttribute
AttributeArray::Ptr appendAttribute(const Descriptor &expected, DescriptorPtr &replacement, const size_t pos, const Index strideOrTotalSize=1, const bool constantStride=true, const Metadata *defaultValue=nullptr, const AttributeArray::ScopedRegistryLock *lock=nullptr)
openvdb::v11_0::points::AttributeSet::ConstPtr
std::shared_ptr< const AttributeSet > ConstPtr
Definition AttributeSet.h:44
openvdb::v11_0::points::AttributeSet::UniquePtr
std::unique_ptr< AttributeSet > UniquePtr
Definition AttributeSet.h:45
openvdb::v11_0::points::AttributeSet::get
AttributeArray * get(const std::string &name)
openvdb::v11_0::points::AttributeSet::write
void write(std::ostream &, bool outputTransient=false) const
openvdb::v11_0::points::AttributeSet::groupAttributeIndices
std::vector< size_t > groupAttributeIndices() const
Return the indices of the attribute arrays which are group attribute arrays.
openvdb::v11_0::points::AttributeSet::get
AttributeArray * get(size_t pos)
openvdb::v11_0::points::AttributeSet::readMetadata
void readMetadata(std::istream &)
This will read the attribute metadata from a stream.
openvdb::v11_0::points::AttributeSet::DescriptorPtr
std::shared_ptr< Descriptor > DescriptorPtr
Definition AttributeSet.h:49
openvdb::v11_0::points::AttributeSet::isShared
bool isShared(size_t pos) const
Return true if the attribute array stored at position pos is shared.
openvdb::v11_0::points::future::Container
Definition AttributeSet.h:297
openvdb::v11_0::points::GroupType
uint8_t GroupType
Definition AttributeSet.h:31
openvdb::v11_0::Name
std::string Name
Definition Name.h:19
openvdb::v11_0::Index
Index32 Index
Definition Types.h:54
openvdb::v11_0::NamePair
std::pair< Name, Name > NamePair
Definition AttributeArray.h:39
openvdb
Definition Exceptions.h:13
OPENVDB_THROW
#define OPENVDB_THROW(exception, message)
Definition Exceptions.h:74
openvdb::v11_0::points::AttributeSet::Descriptor::Inserter
Utility method to construct a NameAndType sequence.
Definition AttributeSet.h:323
openvdb::v11_0::points::AttributeSet::Descriptor::Inserter::add
Inserter & add(const Name &name, const NamePair &type)
Definition AttributeSet.h:328
openvdb::v11_0::points::AttributeSet::Descriptor::Inserter::add
Inserter & add(const NameAndTypeVec &other)
Definition AttributeSet.h:331
openvdb::v11_0::points::AttributeSet::Descriptor::Inserter::add
Inserter & add(const NameAndType &nameAndType)
Definition AttributeSet.h:325
openvdb::v11_0::points::AttributeSet::Descriptor::Inserter::vec
NameAndTypeVec vec
Definition AttributeSet.h:324
openvdb::v11_0::points::AttributeSet::Util::NameAndType
Attribute and type name pair.
Definition AttributeSet.h:57
openvdb::v11_0::points::AttributeSet::Util::NameAndType::NameAndType
NameAndType(const std::string &n, const NamePair &t, const Index s=1)
Definition AttributeSet.h:58
openvdb::v11_0::points::AttributeSet::Util::NameAndType::name
Name name
Definition AttributeSet.h:60
openvdb::v11_0::points::AttributeSet::Util::NameAndType::stride
Index stride
Definition AttributeSet.h:62
openvdb::v11_0::points::AttributeSet::Util::NameAndType::type
NamePair type
Definition AttributeSet.h:61
openvdb::v11_0::points::AttributeSet::Util
Definition AttributeSet.h:55
openvdb::v11_0::points::AttributeSet::Util::GroupIndex
std::pair< size_t, uint8_t > GroupIndex
Definition AttributeSet.h:67
openvdb::v11_0::points::AttributeSet::Util::NameToPosMap
std::map< std::string, size_t > NameToPosMap
Definition AttributeSet.h:66
openvdb::v11_0::points::AttributeSet::Util::NameAndTypeVec
std::vector< NameAndType > NameAndTypeVec
Definition AttributeSet.h:65
OPENVDB_VERSION_NAME
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition version.h.in:121
OPENVDB_USE_VERSION_NAMESPACE
#define OPENVDB_USE_VERSION_NAMESPACE
Definition version.h.in:212