HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
openvdb::OPENVDB_VERSION_NAME::points::StringAttributeHandle Class Reference

#include <AttributeArrayString.h>

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

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 AttributeArray & array () 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 MetaMap & mMetadata
 

Detailed Description

Definition at line 153 of file AttributeArrayString.h.

Member Typedef Documentation

using openvdb::OPENVDB_VERSION_NAME::points::StringAttributeHandle::Ptr = std::shared_ptr<StringAttributeHandle>

Definition at line 156 of file AttributeArrayString.h.

using openvdb::OPENVDB_VERSION_NAME::points::StringAttributeHandle::UniquePtr = std::unique_ptr<StringAttributeHandle>

Definition at line 157 of file AttributeArrayString.h.

Constructor & Destructor Documentation

openvdb::OPENVDB_VERSION_NAME::points::StringAttributeHandle::StringAttributeHandle ( const AttributeArray &  array,
const MetaMap &  metadata,
const bool  preserveCompression = true 
)

Member Function Documentation

const AttributeArray& openvdb::OPENVDB_VERSION_NAME::points::StringAttributeHandle::array ( ) const

Returns a reference to the array held in the Handle.

static Ptr openvdb::OPENVDB_VERSION_NAME::points::StringAttributeHandle::create ( const AttributeArray &  array,
const MetaMap &  metadata,
const bool  preserveCompression = true 
)
static
Name openvdb::OPENVDB_VERSION_NAME::points::StringAttributeHandle::get ( Index  n,
Index  m = 0 
) const
void openvdb::OPENVDB_VERSION_NAME::points::StringAttributeHandle::get ( Name &  name,
Index  n,
Index  m = 0 
) const
bool openvdb::OPENVDB_VERSION_NAME::points::StringAttributeHandle::hasConstantStride ( ) const
inline

Definition at line 169 of file AttributeArrayString.h.

bool openvdb::OPENVDB_VERSION_NAME::points::StringAttributeHandle::isUniform ( ) const
inline

Definition at line 168 of file AttributeArrayString.h.

Index openvdb::OPENVDB_VERSION_NAME::points::StringAttributeHandle::size ( void  ) const
inline

Definition at line 166 of file AttributeArrayString.h.

Index openvdb::OPENVDB_VERSION_NAME::points::StringAttributeHandle::stride ( ) const
inline

Definition at line 165 of file AttributeArrayString.h.

Member Data Documentation

AttributeHandle<Index, StringCodec<false> > openvdb::OPENVDB_VERSION_NAME::points::StringAttributeHandle::mHandle
protected

Definition at line 178 of file AttributeArrayString.h.

const MetaMap& openvdb::OPENVDB_VERSION_NAME::points::StringAttributeHandle::mMetadata
protected

Definition at line 179 of file AttributeArrayString.h.

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