OpenVDB  12.0.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
StringAttributeHandle Class Reference

#include <openvdb/points/AttributeArrayString.h>

Inherited by StringAttributeWriteHandle.

Public Types

using Ptr = std::shared_ptr< StringAttributeHandle >
 
using UniquePtr = std::unique_ptr< StringAttributeHandle >
 

Public Member Functions

 StringAttributeHandle (const AttributeArray &array, const MetaMap &metadata, const bool preserveCompression=true)
 
Index stride () const
 
Index size () const
 
bool isUniform () const
 
bool hasConstantStride () const
 
Name get (Index n, Index m=0) const
 
void get (Name &name, Index n, Index m=0) const
 
const AttributeArrayarray () const
 Returns a reference to the array held in the Handle. More...
 

Static Public Member Functions

static Ptr create (const AttributeArray &array, const MetaMap &metadata, const bool preserveCompression=true)
 

Protected Attributes

AttributeHandle< Index, StringCodec< false > > mHandle
 
const MetaMapmMetadata
 

Member Typedef Documentation

using Ptr = std::shared_ptr<StringAttributeHandle>
using UniquePtr = std::unique_ptr<StringAttributeHandle>

Constructor & Destructor Documentation

StringAttributeHandle ( const AttributeArray array,
const MetaMap metadata,
const bool  preserveCompression = true 
)

Member Function Documentation

const AttributeArray& array ( ) const

Returns a reference to the array held in the Handle.

static Ptr create ( const AttributeArray array,
const MetaMap metadata,
const bool  preserveCompression = true 
)
static
Name get ( Index  n,
Index  m = 0 
) const
void get ( Name name,
Index  n,
Index  m = 0 
) const
bool hasConstantStride ( ) const
inline
bool isUniform ( ) const
inline
Index size ( ) const
inline
Index stride ( ) const
inline

Member Data Documentation

AttributeHandle<Index, StringCodec<false> > mHandle
protected
const MetaMap& mMetadata
protected