HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
fieldTextureData.h
Go to the documentation of this file.
1 //
2 // Copyright 2021 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_IMAGING_HIO_FIELD_TEXTURE_DATA_H
25 #define PXR_IMAGING_HIO_FIELD_TEXTURE_DATA_H
26 
27 /// \file hio/fieldTextureData.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/imaging/hio/api.h"
31 #include "pxr/imaging/hio/image.h"
32 
33 #include "pxr/base/gf/bbox3d.h"
34 
35 #include "pxr/base/tf/type.h"
36 
37 #include <memory>
38 #include <string>
39 
41 
42 using HioFieldTextureDataSharedPtr = std::shared_ptr<class HioFieldTextureData>;
43 
44 /// \class HioFieldTextureData
45 ///
46 /// An interface class for reading volume files having a
47 /// transformation.
48 ///
50 {
51 public:
52  HIO_API
54 
55  HIO_API
56  virtual ~HioFieldTextureData();
57 
58  /// Load Volume Field Data
59  ///
60  /// fieldName corresponds to the gridName in an OpenVDB file or
61  /// to the layer/attribute name in a Field3D file.
62  /// fieldIndex corresponds to the partition index
63  /// fieldPurpose corresponds to the partition name/grouping
64  ///
65  /// Returns nullptr and posts an error if the specified data cannot be
66  /// loaded.
67  ///
68  HIO_API
70  std::string const & filePath,
71  std::string const & fieldName,
72  int fieldIndex,
73  std::string const & fieldPurpose,
74  size_t targetMemory);
75 
76  /// Bounding box describing how 3d texture maps into
77  /// world space.
78  ///
79  virtual const GfBBox3d &GetBoundingBox() const = 0;
80 
81  virtual int ResizedWidth() const = 0;
82 
83  virtual int ResizedHeight() const = 0;
84 
85  virtual int ResizedDepth() const = 0;
86 
87  virtual HioFormat GetFormat() const = 0;
88 
89  virtual bool Read() = 0;
90 
91  virtual bool HasRawBuffer() const = 0;
92 
93  virtual unsigned char const * GetRawBuffer() const = 0;
94 
95 private:
96  // Disallow copies
97  HioFieldTextureData(const HioFieldTextureData&) = delete;
98  HioFieldTextureData& operator=(const HioFieldTextureData&) = delete;
99 
100 };
101 
102 /// \class HioFieldTextureDataFactoryBase
103 ///
104 /// A base class to make HioFieldTextureData objects, implemented by plugins.
105 ///
107 {
108 protected:
109  friend class HioFieldTextureData;
110 
111  virtual HioFieldTextureDataSharedPtr _New(
112  std::string const & filePath,
113  std::string const & fieldName,
114  int fieldIndex,
115  std::string const & fieldPurpose,
116  size_t targetMemory) const = 0;
117 };
118 
119 
121 
122 #endif
HIO_API HioFieldTextureData()
virtual int ResizedWidth() const =0
virtual int ResizedDepth() const =0
#define HIO_API
Definition: api.h:40
virtual unsigned char const * GetRawBuffer() const =0
virtual bool Read()=0
Base class of all factory types.
Definition: type.h:73
virtual bool HasRawBuffer() const =0
virtual HIO_API ~HioFieldTextureData()
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
static HIO_API HioFieldTextureDataSharedPtr New(std::string const &filePath, std::string const &fieldName, int fieldIndex, std::string const &fieldPurpose, size_t targetMemory)
virtual const GfBBox3d & GetBoundingBox() const =0
std::shared_ptr< class HioFieldTextureData > HioFieldTextureDataSharedPtr
HioFormat
Definition: types.h:42
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
virtual HioFormat GetFormat() const =0
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
virtual int ResizedHeight() const =0