Loading...
Searching...
No Matches
coordSys.h
1//
2// Copyright 2019 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_COORD_SYS_H
25#define PXR_IMAGING_HD_COORD_SYS_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/sprim.h"
31
32PXR_NAMESPACE_OPEN_SCOPE
33
56class HdCoordSys : public HdSprim
57{
58public:
59 HD_API
60 HdCoordSys(SdfPath const & id);
61 HD_API
62 ~HdCoordSys() override;
63
64 // Change tracking for HdCoordSys
65 enum DirtyBits : HdDirtyBits {
66 Clean = 0,
67 DirtyName = 1 << 0,
68 DirtyTransform = 1 << 1,
69 AllDirty = (DirtyTransform
70 |DirtyName)
71 };
72
77 TfToken GetName() const { return _name; }
78
79 HD_API
80 void Sync(HdSceneDelegate *sceneDelegate,
81 HdRenderParam *renderParam,
82 HdDirtyBits *dirtyBits) override;
83
84 HD_API
85 HdDirtyBits GetInitialDirtyBitsMask() const override;
86
87private:
88 TfToken _name;
89};
90
91PXR_NAMESPACE_CLOSE_SCOPE
92
93#endif // PXR_IMAGING_HD_COORD_SYS_H
HdCoordSys representes a coordinate system as a Hydra state prim.
Definition: coordSys.h:57
HD_API void Sync(HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
Synchronizes state from the delegate to this object.
TfToken GetName() const
Returns the name bound to this coordinate system.
Definition: coordSys.h:77
HD_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...
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
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88