OpenVDB  6.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
StringAttributeWriteHandle Class Reference

#include <AttributeArrayString.h>

Inherits StringAttributeHandle.

Public Types

using Ptr = std::shared_ptr< StringAttributeWriteHandle >
 

Public Member Functions

 StringAttributeWriteHandle (AttributeArray &array, const MetaMap &metadata, const bool expand=true)
 
void expand (bool fill=true)
 If this array is uniform, replace it with an array of length size(). More...
 
void collapse ()
 Set membership for the whole array and attempt to collapse. More...
 
void collapse (const Name &name)
 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...
 
void fill (const Name &name)
 Fill the existing array with the given value. More...
 
void set (Index n, const Name &name)
 Set the value of the index to name. More...
 
void set (Index n, Index m, const Name &name)
 
void resetCache ()
 Reset the value cache from the metadata. More...
 
AttributeArrayarray ()
 Returns a reference to the array held in the Write Handle. More...
 
bool contains (const Name &name) const
 Returns whether or not the metadata cache contains a given value. More...
 
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 (AttributeArray &array, const MetaMap &metadata, const bool expand=true)
 
static Ptr create (const AttributeArray &array, const MetaMap &metadata, const bool preserveCompression=true)
 

Protected Attributes

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

Member Typedef Documentation

using Ptr = std::shared_ptr<StringAttributeWriteHandle>

Constructor & Destructor Documentation

StringAttributeWriteHandle ( AttributeArray array,
const MetaMap metadata,
const bool  expand = true 
)

Member Function Documentation

const AttributeArray& array ( ) const
inherited

Returns a reference to the array held in the Handle.

AttributeArray& array ( )

Returns a reference to the array held in the Write Handle.

void collapse ( )

Set membership for the whole array and attempt to collapse.

void collapse ( const Name name)

Set membership for the whole array and attempt to collapse.

Parameters
nameName of the String
bool compact ( )

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

bool contains ( const Name name) const

Returns whether or not the metadata cache contains a given value.

Parameters
nameName of the String.
static Ptr create ( const AttributeArray array,
const MetaMap metadata,
const bool  preserveCompression = true 
)
staticinherited
static Ptr create ( AttributeArray array,
const MetaMap metadata,
const bool  expand = true 
)
static
void expand ( bool  fill = true)

If this array is uniform, replace it with an array of length size().

Parameters
fillif true, assign the uniform value to each element of the array.
void fill ( const Name name)

Fill the existing array with the given value.

Note
Identical to collapse() except a non-uniform array will not become uniform.
Name get ( Index  n,
Index  m = 0 
) const
inherited
void get ( Name name,
Index  n,
Index  m = 0 
) const
inherited
bool hasConstantStride ( ) const
inlineinherited
bool isUniform ( ) const
inlineinherited
void resetCache ( )

Reset the value cache from the metadata.

void set ( Index  n,
const Name name 
)

Set the value of the index to name.

void set ( Index  n,
Index  m,
const Name name 
)
Index size ( ) const
inlineinherited
Index stride ( ) const
inlineinherited

Member Data Documentation

AttributeHandle<StringIndexType, StringCodec<false> > mHandle
protectedinherited
const MetaMap& mMetadata
protectedinherited

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