All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
field.h
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 HDST_FIELD_H
25 #define HDST_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 #include "pxr/imaging/hdSt/fieldResource.h"
32 
33 #include "pxr/base/tf/declarePtrs.h"
34 
35 PXR_NAMESPACE_OPEN_SCOPE
36 
40 class HdStField : public HdField {
41 public:
43  HDST_API
44  HdStField(SdfPath const & id, TfToken const & fieldType);
45  HDST_API
46  ~HdStField() override;
47 
49  HDST_API
50  void Sync(HdSceneDelegate *sceneDelegate,
51  HdRenderParam *renderParam,
52  HdDirtyBits *dirtyBits) override;
53 
54  HDST_API
55  HdDirtyBits GetInitialDirtyBitsMask() const override;
56 
58  HdStFieldResourceSharedPtr GetFieldResource() const {
59  return _fieldResource;
60  }
61 
62 private:
63  const TfToken _fieldType;
64 
65  HdStFieldResourceSharedPtr _fieldResource;
66 };
67 
68 PXR_NAMESPACE_CLOSE_SCOPE
69 
70 #endif //HDST_FIELD_H
HdStFieldResourceSharedPtr GetFieldResource() const
Initialized by Sync.
Definition: field.h:58
HDST_API HdStField(SdfPath const &id, TfToken const &fieldType)
For now, only fieldType HdStTokens->openvdbAsset is supported.
The HdRenderParam is an opaque (to core Hydra) handle, to an object that is obtained from the render ...
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
Hydra schema for a USD field primitive.
Definition: field.h:52
Adapter class providing data exchange with the client scene graph.
HDST_API HdDirtyBits GetInitialDirtyBitsMask() const override
Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of thi...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
Represents a Field Buffer Prim.
Definition: field.h:40
HDST_API void Sync(HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
Loads field as 3d texture to generate GetFieldResource.