HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HOM_Parm.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  * COMMENTS:
7  */
8 
9 #ifndef __HOM_Parm_h__
10 #define __HOM_Parm_h__
11 
12 #include "HOM_API.h"
13 #include "HOM_Defines.h"
14 #include "HOM_Errors.h"
15 #include "HOM_BaseKeyframe.h"
16 #include "HOM_PtrOrNull.h"
17 #include <string>
18 #include <map>
19 #include <vector>
20 
21 class HOM_Color;
22 class HOM_ParmTemplate;
23 class HOM_ParmTuple;
24 class HOM_Track;
25 class HOM_Ramp;
26 class HOM_Geometry;
27 class HOM_ImageLayer;
28 class HOM_NanoVDB;
29 class UT_WorkBuffer;
30 
31 SWIGOUT(%rename(Parm) HOM_Parm;)
32 
34 {
35 public:
37  { HOM_CONSTRUCT_OBJECT(this) }
38  HOM_Parm(const HOM_Parm &parm)
39  { HOM_CONSTRUCT_OBJECT(this) }
40  virtual ~HOM_Parm()
41  { HOM_DESTRUCT_OBJECT(this) }
42 
43  // We compare against a pointer instead of a reference because we want
44  // to be able to compare against None.
45  virtual bool operator==(HOM_PtrOrNull<HOM_Parm> parm) = 0;
46  virtual bool operator!=(HOM_PtrOrNull<HOM_Parm> parm) = 0;
47  SWIGOUT(%ignore operator<(HOM_Parm *parm);)
48  virtual bool operator<(HOM_Parm *parm) = 0;
49 
50  virtual int __hash__() = 0;
51  virtual std::string __repr__() = 0;
52 
53  SWIGOUT(%newobject node;)
54  virtual HOM_Node *node() = 0;
55 
56  SWIGOUT(%newobject tuple;)
57  SWIGOUT(%warnfilter(321) tuple;)
58  virtual HOM_ParmTuple *tuple() = 0;
59 
60  SWIGOUT(%newobject parmTemplate;)
61  virtual HOM_ParmTemplate *parmTemplate() = 0;
62 
63  virtual std::string name() = 0;
64  virtual std::string path() = 0;
65  virtual std::string description() = 0;
66  virtual int componentIndex() = 0;
67 
68  virtual std::vector<std::string> menuContents() = 0;
69  virtual std::vector<std::string> menuLabels() = 0;
70  virtual std::vector<std::string> menuItems() = 0;
71  virtual bool isDynamicMenu() = 0;
72 
73  SWIGOUT(%kwargs pressButton;)
74  virtual void pressButton(std::map<std::string, hboost::any> const & arguments=std::map<std::string, hboost::any>()) = 0;
75 
76  virtual std::string referenceExpression(HOM_Parm &to_base_parm, HOM_EnumValue *language=nullptr,
77  bool follow_parm_reference=true) = 0;
78 
79  virtual void _set(double float_value) = 0;
80  virtual void _setPending(double float_value) = 0;
81  virtual void _set(int64 int_value) = 0;
82  virtual void _setPending(int64 int_value) = 0;
83  virtual void _set(const char *string_value) = 0;
84  virtual void _setPending(const char *string_value) = 0;
85  virtual void _set(HOM_Geometry *geo) = 0;
86  virtual void _setPending(HOM_Geometry *geo) = 0;
87  virtual void _set(HOM_ImageLayer *layer) = 0;
88  virtual void _setPending(HOM_ImageLayer *layer) = 0;
89  virtual void _set(HOM_NanoVDB *vdb) = 0;
90  virtual void _setPending(HOM_NanoVDB *vdb) = 0;
91  virtual void _set(const std::map<std::string, std::string> &map) = 0;
92  virtual void _setPending(const std::map<std::string, std::string> &map) = 0;
93  virtual void _set(HOM_Ramp *ramp_value) = 0;
94  virtual void _setPending(HOM_Ramp *ramp_value) = 0;
95 
96  virtual void _set(
97  HOM_Parm &parm, HOM_EnumValue *language=nullptr,
98  bool follow_parm_reference=true) = 0;
99 
100  virtual void _setNone() = 0;
101  virtual void _setNonePending() = 0;
102 
103  virtual void setFromParm(HOM_Parm &src) = 0;
104  virtual void setFromParmDefaults(HOM_Parm &src) = 0;
105 
106  virtual void overwriteDefaults() = 0;
107  virtual void revertToDefaults() = 0;
108  virtual void revertToAndRestorePermanentDefaults() = 0;
109  virtual void revertToRampDefaults() = 0;
110  virtual bool hasTemporaryDefaults() = 0;
111  SWIGOUT(%kwargs isAtDefault;)
112  virtual bool isAtDefault(bool compare_temporary_defaults=true,
113  bool compare_expressions=true) = 0;
114  virtual bool isAtRampDefault() = 0;
115 
116  SWIGOUT(%kwargs setExpression;)
117  virtual void setExpression(const char *expression,
118  HOM_EnumValue *language = NULL,
119  bool replace_expression=true) = 0;
120  virtual std::string expression() = 0;
121 
122  virtual HOM_EnumValue *expressionLanguage() = 0;
123 
124  virtual std::string rawValue() = 0;
125 
126  virtual bool isShowingExpression() = 0;
127  virtual void showExpression(bool value) = 0;
128 
129  virtual void setKeyframe(HOM_BaseKeyframe &keyframe) = 0;
130  virtual void setKeyframes(const std::vector<HOM_BaseKeyframe *> &keyframes) = 0;
131 
132  virtual std::vector<HOM_ElemPtr<HOM_BaseKeyframe> > keyframes() = 0;
133 
134  virtual std::vector<HOM_ElemPtr<HOM_BaseKeyframe> >
135  keyframesInRange(double start_frame, double end_frame) = 0;
136 
137  virtual std::vector<HOM_ElemPtr<HOM_BaseKeyframe> > keyframesBefore(double frame) = 0;
138  virtual std::vector<HOM_ElemPtr<HOM_BaseKeyframe> > keyframesAfter(double frame) = 0;
139 
140  virtual double evalAsFloat() = 0;
141  virtual double evalAsFloatAtFrame(double frame) = 0;
142  virtual int64 evalAsInt() = 0;
143  virtual int64 evalAsIntAtFrame(double frame) = 0;
144  virtual std::string evalAsString() = 0;
145  virtual std::string evalAsStringAtFrame(double frame) = 0;
146  virtual HOM_Geometry *evalAsGeometry() = 0;
147  virtual HOM_Geometry *evalAsGeometryAtFrame(double frame) = 0;
148  virtual HOM_ImageLayer *evalAsImageLayer() = 0;
149  virtual HOM_ImageLayer *evalAsImageLayerAtFrame(double frame) = 0;
150  virtual HOM_NanoVDB *evalAsNanoVDB() = 0;
151  virtual HOM_NanoVDB *evalAsNanoVDBAtFrame(double frame) = 0;
152  virtual std::map<std::string, std::string> evalAsJSONMap() = 0;
153  virtual std::map<std::string, std::string>
154  evalAsJSONMapAtFrame(double frame) = 0;
155  SWIGOUT(%newobject evalAsRamp;)
156  virtual HOM_Ramp *evalAsRamp() = 0;
157  SWIGOUT(%newobject evalAsRampAtFrame;)
158  virtual HOM_Ramp *evalAsRampAtFrame(double frame) = 0;
159  SWIGOUT(%newobject evalAsNode;)
160  virtual HOM_Node *evalAsNode() = 0;
161  SWIGOUT(%newobject evalAsNodeAtFrame;)
162  virtual HOM_Node *evalAsNodeAtFrame(double frame) = 0;
163  virtual std::vector<HOM_ElemPtr<HOM_Node> > evalAsNodes() = 0;
164  virtual std::vector<HOM_ElemPtr<HOM_Node> > evalAsNodesAtFrame(double frame) = 0;
165  virtual std::string evalAsNodePath() = 0;
166  virtual std::string evalAsNodePathAtFrame(double frame) = 0;
167  virtual std::vector<std::string> evalAsNodePaths() = 0;
168  virtual std::vector<std::string> evalAsNodePathsAtFrame(double frame) = 0;
169 
170  virtual std::string unexpandedString() = 0;
171 
172  virtual void deleteKeyframeAtFrame(double frame) = 0;
173 
174  virtual void deleteAllKeyframes() = 0;
175 
176  // TODO: Rename this to referencedParm()!
177  SWIGOUT(%newobject getReferencedParm;)
178  virtual HOM_Parm *getReferencedParm() = 0;
179 
180  virtual std::vector<HOM_ElemPtr<HOM_Parm> > parmsReferencingThis() = 0;
181 
182  virtual bool isLocked() = 0;
183  virtual void lock(bool on) = 0;
184 
185  virtual bool isAutoscoped() = 0;
186  virtual void setAutoscope(bool on) = 0;
187 
188  virtual bool isScoped() = 0;
189  virtual void setScope(bool on) = 0;
190 
191  virtual bool isAutoSelected() = 0;
192  virtual void setAutoSelect(bool on) = 0;
193 
194  virtual bool isSelected() = 0;
195  virtual void setSelect(bool on) = 0;
196 
197  virtual std::string alias() = 0;
198  virtual void setAlias(const char *alias_name) = 0;
199 
200  virtual bool isSpare() = 0;
201 
202  virtual bool isTimeDependent() = 0;
203 
204  virtual bool isMultiParmInstance() = 0;
205  virtual bool isMultiParmParent() = 0;
206  SWIGOUT(%newobject parentMultiParm;)
207  virtual HOM_Parm *parentMultiParm() = 0;
208  virtual std::vector<int> multiParmInstanceIndices() = 0;
209 
210  virtual int multiParmInstancesPerItem() = 0;
211  virtual int multiParmInstancesCount() = 0;
212  virtual int multiParmStartOffset() = 0;
213 
214  virtual std::vector<HOM_ElemPtr<HOM_Parm> > multiParmInstances() = 0;
215 
216  virtual void insertMultiParmInstance(int inst_index) = 0;
217 
218  virtual void removeMultiParmInstance(int inst_index) = 0;
219 
220  virtual void moveMultiParmInstances(const std::vector<int> &moves) = 0;
221  virtual void moveUpMultiParmInstance(int inst_index) = 0;
222  virtual void moveDownMultiParmInstance(int inst_index) = 0;
223 
224  virtual std::vector<std::string> containingFolders() = 0;
225  virtual std::vector<int> containingFolderIndices() = 0;
226  virtual std::vector<HOM_ElemPtr<HOM_ParmTuple> >
227  containingFolderSetParmTuples() = 0;
228 
229  SWIGOUT(%kwargs asCode;)
230  virtual std::string asCode(
231  bool brief = false,
232  bool save_values = true,
233  bool save_keyframes = true,
234  bool save_keys_in_frames=false,
235  bool save_flag_values=true,
236  bool save_aliases=true,
237  const char *function_name = NULL) = 0;
238 
239  // You can get the parm data type with parmTemplate().dataType().
240  // However, we need a way to get the parm data type's enum value
241  // from C++ code without creating a temporary ParmTemplate object,
242  // so that's why parmDataTypeEnumId() exists.
243  SWIGOUT(%ignore parmDataTypeEnumId;)
244  virtual int parmDataTypeEnumId() = 0;
245 
246  // For data parameters only.
247  // You can get the data parm type with parmTemplate().dataParmType().
248  // However, we need a way to get the data parm type's enum value
249  // from C++ code without creating a temporary ParmTemplate object,
250  // so that's why dataParmTypeEnumId() exists.
251  SWIGOUT(%ignore dataParmTypeEnumId;)
252  virtual int dataParmTypeEnumId() = 0;
253 
254  SWIGOUT(%newobject createClip;)
255  virtual HOM_Node *createClip(HOM_Node &parent_node,
256  const char *name,
257  bool create_new,
258  bool apply_immediately,
259  bool current_value_only=false,
260  bool create_locked=false,
261  bool set_value_to_default=false) = 0;
262 
263  virtual void appendClip(HOM_Node &chop_node,
264  bool apply_immediately,
265  bool current_value_only=false,
266  bool create_locked=false,
267  bool set_value_to_default=false) = 0;
268 
269  virtual HOM_BinaryString _clipData(double start,
270  double end,
271  bool binary = true,
272  bool use_blosc_compression = true,
273  double sample_rate = 0) = 0;
274 
275  SWIGOUT(%kwargs _setClipData;)
276  virtual void _setClipData(HOM_BinaryString data,
277  bool binary = true,
278  bool blosc_compressed = true,
279  double sample_rate = 0,
280  double start = HOM_MIN_NEGATIVE_DOUBLE) = 0;
281 
282  virtual void _saveClip(std::string file_name,
283  double start,
284  double end,
285  double sample_rate = 0) = 0;
286 
287  SWIGOUT(%kwargs _loadClip;)
288  virtual void _loadClip(std::string file_name,
289  double sample_rate = 0,
290  double start = HOM_MIN_NEGATIVE_DOUBLE) = 0;
291 
292  SWIGOUT(%newobject overrideTrack;)
293  virtual HOM_Track *overrideTrack() = 0;
294  virtual bool isOverrideTrackActive() = 0;
295 
296  virtual void copyToParmClipboard() = 0;
297 
298  virtual bool isDisabled() = 0;
299 
300  virtual void disable(bool on) = 0;
301 
302  virtual bool isHidden() = 0;
303 
304  virtual void hide(bool on) = 0;
305 
306  virtual bool isVisible() = 0;
307 
308  virtual bool isConstrained() = 0;
309 
310  virtual bool isPending() = 0;
311 
312  virtual HOM_EnumValue &keyframeExtrapolation( bool before ) = 0;
313 
314  virtual void setKeyframeExtrapolation( bool before, HOM_EnumValue &e ) = 0;
315 
316  SWIGOUT(%kwargs keyframesRefit;)
317  virtual void keyframesRefit(
318  bool refit, double refit_tol, bool refit_preserve_extrema,
319  bool refit_bezier, bool resample, double resample_rate, double resample_tol,
320  bool range, double range_start, double range_end, HOM_EnumValue &bake_chop, const char *expression="",
321  bool refit_smooth=false) = 0;
322 
323  SWIGOUT(%newobject uiBackgroundColor;)
324  virtual HOM_Color *uiBackgroundColor() = 0;
325 
326  virtual void _moveKeyframes(const std::vector<int> &keyframe_ids,
327  const std::vector<double> &time_offsets,
328  const std::vector<double> &value_offsets) = 0;
329 
330  virtual void _deleteKeyframes(const std::vector<int> &keyframe_ids) = 0;
331 
332  virtual void _moveAllKeyframes( double time_offset, double value_offset)=0;
333 
334 #ifdef SWIG
335 %extend
336 {
337  %warnfilter(321) eval;
338  InterpreterObject eval()
339  {
340  return HOMevalParm(*self);
341  }
342 
343  InterpreterObject evalAtFrame(double frame)
344  {
345  return HOMevalParmAtFrame(*self, frame);
346  }
347 
348  InterpreterObject evalAtTime(double time)
349  {
350  return HOMevalParmAtFrame(*self, HOM().timeToFrame(time));
351  }
352 }
353 #endif
354 };
355 
356 #endif
virtual ~HOM_Parm()
Definition: HOM_Parm.h:40
#define HOM_DESTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:1343
GLenum GLint * range
Definition: glcorearb.h:1925
GT_API const UT_StringHolder time
GLuint start
Definition: glcorearb.h:475
GLsizei const GLfloat * value
Definition: glcorearb.h:824
const GLuint GLenum const void * binary
Definition: glcorearb.h:1924
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
#define SWIGOUT(x)
Definition: HOM_Defines.h:24
string __repr__(VtArray< T > const &self)
Definition: wrapArray.h:312
PUGI__FN xpath_string string_value(const xpath_node &na, xpath_allocator *alloc)
Definition: pugixml.cpp:7990
GLenum GLuint GLint GLint layer
Definition: glcorearb.h:1299
#define HOM_API
Definition: HOM_API.h:13
void ignore(T const &) VULKAN_HPP_NOEXCEPT
Definition: vulkan.hpp:6508
GLuint GLuint end
Definition: glcorearb.h:475
#define HOM_CONSTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:1342
bool operator!=(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Inequality operator, does exact floating point comparisons.
Definition: Mat3.h:556
long long int64
Definition: SYS_Types.h:116
char * lock(exint offset=0, exint reserve_bytes=0)
#define HOM_MIN_NEGATIVE_DOUBLE
Definition: HOM_Defines.h:50
HUSD_API bool eval(VtValue &val, T &ret_val)
GLuint const GLchar * name
Definition: glcorearb.h:786
HOM_Parm(const HOM_Parm &parm)
Definition: HOM_Parm.h:38
OIIO_UTIL_API bool rename(string_view from, string_view to, std::string &err)
HOM_Parm()
Definition: HOM_Parm.h:36
ImageBuf OIIO_API resample(const ImageBuf &src, bool interpolate=true, ROI roi={}, int nthreads=0)
HOM_API HOM_Module & HOM()
bool operator==(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Equality operator, does exact floating point comparisons.
Definition: Mat3.h:542
Definition: format.h:1821
GLenum src
Definition: glcorearb.h:1793