HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
HioFieldTextureData Class Referenceabstract

#include <fieldTextureData.h>

Public Member Functions

HIO_API HioFieldTextureData ()
 
virtual HIO_API ~HioFieldTextureData ()
 
virtual const GfBBox3d & GetBoundingBox () const =0
 
virtual int ResizedWidth () const =0
 
virtual int ResizedHeight () const =0
 
virtual int ResizedDepth () const =0
 
virtual HioFormat GetFormat () const =0
 
virtual bool Read ()=0
 
virtual bool HasRawBuffer () const =0
 
virtual unsigned char const * GetRawBuffer () const =0
 

Static Public Member Functions

static HIO_API
HioFieldTextureDataSharedPtr 		New (std::string const &filePath, std::string const &fieldName, int fieldIndex, std::string const &fieldPurpose, size_t targetMemory)
 

Detailed Description

An interface class for reading volume files having a transformation.

Definition at line 49 of file fieldTextureData.h.

Constructor & Destructor Documentation

HIO_API HioFieldTextureData::HioFieldTextureData ( )
virtual HIO_API HioFieldTextureData::~HioFieldTextureData ( )
virtual

Member Function Documentation

virtual const GfBBox3d& HioFieldTextureData::GetBoundingBox ( ) const
pure virtual

Bounding box describing how 3d texture maps into world space.

virtual HioFormat HioFieldTextureData::GetFormat ( ) const
pure virtual
virtual unsigned char const* HioFieldTextureData::GetRawBuffer ( ) const
pure virtual
virtual bool HioFieldTextureData::HasRawBuffer ( ) const
pure virtual
static HIO_API HioFieldTextureDataSharedPtr HioFieldTextureData::New ( std::string const &  filePath,
std::string const &  fieldName,
int  fieldIndex,
std::string const &  fieldPurpose,
size_t  targetMemory 
)
static

Load Volume Field Data

fieldName corresponds to the gridName in an OpenVDB file or to the layer/attribute name in a Field3D file. fieldIndex corresponds to the partition index fieldPurpose corresponds to the partition name/grouping

Returns nullptr and posts an error if the specified data cannot be loaded.

virtual bool HioFieldTextureData::Read ( )
pure virtual
virtual int HioFieldTextureData::ResizedDepth ( ) const
pure virtual
virtual int HioFieldTextureData::ResizedHeight ( ) const
pure virtual
virtual int HioFieldTextureData::ResizedWidth ( ) const
pure virtual
The documentation for this class was generated from the following file: