1 // 2 // Copyright 2016 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_HD_ST_FIELD_H 25 #define PXR_IMAGING_HD_ST_FIELD_H 26 27 #include "pxr/pxr.h" 28 #include "pxr/imaging/hd/version.h" 29 #include "pxr/imaging/hd/field.h" 30 #include "pxr/imaging/hdSt/api.h" 31 32 #include "pxr/imaging/hdSt/textureIdentifier.h" 33 34 PXR_NAMESPACE_OPEN_SCOPE 35 36 /// 37 /// Represents a Field Buffer Prim. 38 /// 39 class HdStField : public HdField { 40 public: 41 /// For now, only fieldType HdStTokens->openvdbAsset is supported. 42 HDST_API 43 HdStField(SdfPath const & id, TfToken const & fieldType); 44 HDST_API 45 ~HdStField() override; 46 47 /// Loads field as 3d texture to generate GetFieldResource. 48 HDST_API 49 void Sync(HdSceneDelegate *sceneDelegate, 50 HdRenderParam *renderParam, 51 HdDirtyBits *dirtyBits) override; 52 53 HDST_API 54 HdDirtyBits GetInitialDirtyBitsMask() const override; 55 56 /// Initialized by Sync. 57 HDST_API GetTextureIdentifier()58 HdStTextureIdentifier const &GetTextureIdentifier() const { 59 return _textureId; 60 } 61 62 /// Get memory request for this field GetTextureMemory()63 size_t GetTextureMemory() const { return _textureMemory; } 64 65 /// Bprim types handled by this class 66 HDST_API 67 static const TfTokenVector &GetSupportedBprimTypes(); 68 69 /// Can bprim type be handled by this class 70 HDST_API 71 static bool IsSupportedBprimType(const TfToken &bprimType); 72 73 private: 74 const TfToken _fieldType; 75 76 HdStTextureIdentifier _textureId; 77 size_t _textureMemory; 78 79 bool _isInitialized : 1; 80 }; 81 82 PXR_NAMESPACE_CLOSE_SCOPE 83 84 #endif //PXR_IMAGING_HD_ST_FIELD_H 85