Ptex: PtexMetaData Class Reference

Ptex

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- Class List
- Class Hierarchy
- Class Members

Public Member Functions | Protected Member Functions | List of all members
PtexMetaData Class Referenceabstract

Meta data accessor. More...

`#include <Ptexture.h>`

Inheritance diagram for PtexMetaData:

## Public Member Functions
virtual void | release ()=0
| Release resources held by this pointer (pointer becomes invalid). More...
virtual int | numKeys ()=0
| Query number of meta data entries stored in file. More...
virtual void | getKey (int n, const char *&key, Ptex::MetaDataType &type)=0
| Query the name and type of a meta data entry. More...
virtual void | getValue (const char *key, const char *&value)=0
| Query the value of a given meta data entry. More...
virtual void | getValue (const char *key, const int8_t *&value, int &count)=0
| Query the value of a given meta data entry. More...
virtual void | getValue (const char *key, const int16_t *&value, int &count)=0
| Query the value of a given meta data entry. More...
virtual void | getValue (const char *key, const int32_t *&value, int &count)=0
| Query the value of a given meta data entry. More...
virtual void | getValue (const char *key, const float *&value, int &count)=0
| Query the value of a given meta data entry. More...
virtual void | getValue (const char *key, const double *&value, int &count)=0
| Query the value of a given meta data entry. More...

## Protected Member Functions
virtual | ~PtexMetaData ()
| Destructor not for public use. Use release() instead. More...

## Detailed Description

Meta data accessor.

Meta data is acquired from PtexTexture and accessed through this interface.

Definition at line 337 of file Ptexture.h.

## Constructor & Destructor Documentation

virtual PtexMetaData::~PtexMetaData | ( |  | ) |
| inlineprotectedvirtual

Destructor not for public use. Use release() instead.

Definition at line 340 of file Ptexture.h.

## Member Function Documentation

virtual void PtexMetaData::getKey | ( | int | n,
|  | const char *& | key,
|  | Ptex::MetaDataType & | type
| ) |  |
| pure virtual

Query the name and type of a meta data entry.

Implemented in PtexReader::MetaData.

Referenced by PtexWriterBase::writeMeta().

virtual void PtexMetaData::getValue | ( | const char * | key,
|  | const char *& | value
| ) |  |
| pure virtual

Query the value of a given meta data entry.

If the key doesn't exist or the type doesn't match, value is set to null

Implemented in PtexReader::MetaData.

Referenced by PtexWriterBase::writeMeta().

virtual void PtexMetaData::getValue | ( | const char * | key,
|  | const int8_t *& | value,
|  | int & | count
| ) |  |
| pure virtual

Query the value of a given meta data entry.

If the key doesn't exist or the type doesn't match, value is set to null

Implemented in PtexReader::MetaData.

virtual void PtexMetaData::getValue | ( | const char * | key,
|  | const int16_t *& | value,
|  | int & | count
| ) |  |
| pure virtual

Query the value of a given meta data entry.

If the key doesn't exist or the type doesn't match, value is set to null

Implemented in PtexReader::MetaData.

virtual void PtexMetaData::getValue | ( | const char * | key,
|  | const int32_t *& | value,
|  | int & | count
| ) |  |
| pure virtual

Query the value of a given meta data entry.

If the key doesn't exist or the type doesn't match, value is set to null

Implemented in PtexReader::MetaData.

virtual void PtexMetaData::getValue | ( | const char * | key,
|  | const float *& | value,
|  | int & | count
| ) |  |
| pure virtual

Query the value of a given meta data entry.

If the key doesn't exist or the type doesn't match, value is set to null

Implemented in PtexReader::MetaData.

virtual void PtexMetaData::getValue | ( | const char * | key,
|  | const double *& | value,
|  | int & | count
| ) |  |
| pure virtual

Query the value of a given meta data entry.

If the key doesn't exist or the type doesn't match, value is set to null

Implemented in PtexReader::MetaData.

virtual int PtexMetaData::numKeys | ( |  | ) |
| pure virtual

Query number of meta data entries stored in file.

Implemented in PtexReader::MetaData.

Referenced by PtexWriterBase::writeMeta().

virtual void PtexMetaData::release | ( |  | ) |
| pure virtual

Release resources held by this pointer (pointer becomes invalid).

Implemented in PtexReader::MetaData.

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

- Ptexture.h