Loading...
Searching...
No Matches
sprim.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 PXR_IMAGING_HD_SPRIM_H
25#define PXR_IMAGING_HD_SPRIM_H
26
27#include "pxr/pxr.h"
28#include "pxr/imaging/hd/api.h"
29#include "pxr/imaging/hd/version.h"
30#include "pxr/imaging/hd/types.h"
31
32#include "pxr/usd/sdf/path.h"
33
34PXR_NAMESPACE_OPEN_SCOPE
35
36class HdSceneDelegate;
37class HdRenderParam;
38
52{
53public:
54 HD_API
55 HdSprim(SdfPath const & id);
56 HD_API
57 virtual ~HdSprim();
58
62 SdfPath const& GetId() const { return _id; }
63
71 virtual void Sync(HdSceneDelegate *sceneDelegate,
72 HdRenderParam *renderParam,
73 HdDirtyBits *dirtyBits) = 0;
74
78 HD_API
79 virtual void Finalize(HdRenderParam *renderParam);
80
84 virtual HdDirtyBits GetInitialDirtyBitsMask() const = 0;
85
86private:
87 SdfPath _id;
88};
89
90
91PXR_NAMESPACE_CLOSE_SCOPE
92
93#endif // PXR_IMAGING_HD_SPRIM_H
The HdRenderParam is an opaque (to core Hydra) handle, to an object that is obtained from the render ...
Adapter class providing data exchange with the client scene graph.
Sprim (state prim) is a base class of managing state for non-drawable scene entity (e....
Definition: sprim.h:52
virtual HD_API void Finalize(HdRenderParam *renderParam)
Finalizes object resources.
SdfPath const & GetId() const
Returns the identifier by which this state is known.
Definition: sprim.h:62
virtual HdDirtyBits GetInitialDirtyBitsMask() const =0
Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of thi...
virtual void Sync(HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits)=0
Synchronizes state from the delegate to this object.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:291