HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HUSD_EditCustomData.h
Go to the documentation of this file.
1 /*
2  * Copyright 2019 Side Effects Software Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 
18 #ifndef __HUSD_EditCustomData_h__
19 #define __HUSD_EditCustomData_h__
20 
21 #include "HUSD_API.h"
22 #include "HUSD_DataHandle.h"
23 #include "HUSD_TimeCode.h"
24 #include <UT/UT_StringHolder.h>
25 
26 class HUSD_FindPrims;
27 class HUSD_FindProps;
28 
30 {
31 public:
34 
35  // These functions set the actual custom data on the layer, prim, or
36  // property. The UtValueType parameters can be any of:
37  // bool
38  // int
39  // int64
40  // UT_Vector2i
41  // UT_Vector3i
42  // UT_Vector4i
43  // fpreal32
44  // fpreal64
45  // UT_Vector2F
46  // UT_Vector3F
47  // UT_Vector4F
48  // UT_QuaternionF
49  // UT_QuaternionH
50  // UT_Matrix3D
51  // UT_Matrix4D
52  // UT_StringHolder
53  // Make sure to explicitly cast to one of these data types, even if
54  // implicit conversions exist.
55  template<typename UtValueType>
56  bool setLayerCustomData(const UT_StringRef &key,
57  const UtValueType &value) const;
58  template<typename UtValueType>
59  bool setCustomData(const HUSD_FindPrims &findprims,
60  const UT_StringRef &key,
61  const UtValueType &value) const;
62  template<typename UtValueType>
63  bool setCustomData(const HUSD_FindProps &findprops,
64  const UT_StringRef &key,
65  const UtValueType &value) const;
66 
67  bool removeLayerCustomData(const UT_StringRef &key) const;
68  bool removeCustomData(const HUSD_FindPrims &findprims,
69  const UT_StringRef &key) const;
70  bool removeCustomData(const HUSD_FindProps &findprops,
71  const UT_StringRef &key) const;
72 
73  bool clearLayerCustomData() const;
74  bool clearCustomData(const HUSD_FindPrims &findprims) const;
75  bool clearCustomData(const HUSD_FindProps &findprops) const;
76 
77 private:
78  HUSD_AutoWriteLock &myWriteLock;
79 };
80 
81 #endif
82 
#define HUSD_API
Definition: HUSD_API.h:32
GLsizei const GLfloat * value
Definition: glew.h:1849