HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
openvdb::OPENVDB_VERSION_NAME::points::GroupWriteHandle Class Reference

#include <AttributeGroup.h>

+ Inheritance diagram for openvdb::OPENVDB_VERSION_NAME::points::GroupWriteHandle:

Public Types

using Ptr = std::shared_ptr< GroupWriteHandle >
 
- Public Types inherited from openvdb::OPENVDB_VERSION_NAME::points::GroupHandle
using Ptr = std::shared_ptr< GroupHandle >
 
using GroupIndex = std::pair< Index, uint8_t >
 

Public Member Functions

 GroupWriteHandle (GroupAttributeArray &array, const GroupType &offset)
 
void set (Index n, bool on)
 
bool collapse (bool on)
 Set membership for the whole array and attempt to collapse. More...
 
bool compact ()
 Compact the existing array to become uniform if all values are identical. More...
 
- Public Member Functions inherited from openvdb::OPENVDB_VERSION_NAME::points::GroupHandle
 GroupHandle (const GroupAttributeArray &array, const GroupType &offset)
 
 GroupHandle (const GroupAttributeArray &array, const GroupType &bitMask, BitMask)
 
Index size () const
 
bool isUniform () const
 
bool get (Index n) const
 

Additional Inherited Members

- Protected Attributes inherited from openvdb::OPENVDB_VERSION_NAME::points::GroupHandle
const GroupAttributeArraymArray
 
const GroupType mBitMask
 

Detailed Description

Definition at line 128 of file AttributeGroup.h.

Member Typedef Documentation

Constructor & Destructor Documentation

openvdb::OPENVDB_VERSION_NAME::points::GroupWriteHandle::GroupWriteHandle ( GroupAttributeArray array,
const GroupType offset 
)

Member Function Documentation

bool openvdb::OPENVDB_VERSION_NAME::points::GroupWriteHandle::collapse ( bool  on)

Set membership for the whole array and attempt to collapse.

Parameters
onTrue or false for inclusion in group
Note
This method guarantees that all attributes will have group membership changed according to the input bool, however compaction will not be performed if other groups that share the same underlying array are non-uniform. The return value indicates if the group array ends up being uniform.
bool openvdb::OPENVDB_VERSION_NAME::points::GroupWriteHandle::compact ( )

Compact the existing array to become uniform if all values are identical.

void openvdb::OPENVDB_VERSION_NAME::points::GroupWriteHandle::set ( Index  n,
bool  on 
)

The documentation for this class was generated from the following file: