HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
HOM_FlipbookSettings.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_FlipbookSettings_h__
10 #define __HOM_FlipbookSettings_h__
11 
12 #include "HOM_API.h"
13 #include "HOM_Defines.h"
14 #include "HOM_Errors.h"
15 #include "HOM_Module.h"
16 #include "HOM_ObjNode.h"
17 #include "HOM_EnumValue.h"
18 
19 SWIGOUT(%rename(FlipbookSettings) HOM_FlipbookSettings;)
20 
22 {
23 public:
25  { HOM_CONSTRUCT_OBJECT(this) }
27  { HOM_CONSTRUCT_OBJECT(this) }
29  { HOM_DESTRUCT_OBJECT(this) }
30 
31  //virtual HOM_FlipbookSettings &operator=(const HOM_FlipbookSettings &) = 0;
32 
33  virtual std::string __repr__() = 0;
34 
35  SWIGOUT(%newobject stash;)
36  virtual HOM_FlipbookSettings *stash() = 0;
37 
38  virtual void copy(const HOM_FlipbookSettings &from_settings) = 0;
39 
40  virtual void outputToMPlay(bool out_mplay) = 0;
41  virtual bool outputToMPlay() = 0;
42 
43  virtual void leaveFrameAtEnd(bool end) = 0;
44  virtual bool leaveFrameAtEnd() = 0;
45 
46  virtual void output(const char *out_name) = 0;
47  virtual std::string output() = 0;
48 
49  virtual void sessionLabel(const char *label) = 0;
50  virtual std::string sessionLabel() = 0;
51 
52  virtual void visibleObjects(const char *visible) = 0;
53  virtual std::string visibleObjects() = 0;
54 
55  virtual void visibleTypes(const HOM_EnumValue &flipbookObjectType) = 0;
56  virtual HOM_EnumValue &visibleTypes() = 0;
57 
58  virtual void frameRange(const std::vector<double> &range) = 0;
59  virtual std::vector<double> frameRange() = 0;
60 
61  virtual void frameIncrement(int increment) = 0;
62  virtual int frameIncrement() = 0;
63 
64  virtual void beautyPassOnly(bool enable) = 0;
65  virtual bool beautyPassOnly() = 0;
66 
67  virtual void renderAllViewports(bool all_views) = 0;
68  virtual bool renderAllViewports() = 0;
69 
70  virtual void appendFramesToCurrent(bool enable) = 0;
71  virtual bool appendFramesToCurrent() = 0;
72 
73  virtual void scopeChannelKeyframesOnly(bool enable) = 0;
74  virtual bool scopeChannelKeyframesOnly() = 0;
75 
76  virtual void blockEditing(bool enable) = 0;
77  virtual bool blockEditing() = 0;
78 
79  virtual void initializeSimulations(bool enable) = 0;
80  virtual bool initializeSimulations() = 0;
81 
82  virtual std::string audioFilename() = 0;
83  virtual void audioFilename(const char *audio_file) = 0;
84 
85  virtual void audioFrameStart(double start) = 0;
86  virtual double audioFrameStart() = 0;
87 
88  virtual void audioTimeOffset(double time) = 0;
89  virtual double audioTimeOffset() = 0;
90 
91  virtual void backgroundImage(const char *image_file) = 0;
92  virtual std::string backgroundImage() = 0;
93 
94  virtual void overrideGamma(bool override) = 0;
95  virtual bool overrideGamma() = 0;
96 
97  virtual void gamma(double gamma) = 0;
98  virtual double gamma() = 0;
99 
100  virtual void overrideLUT(bool override) = 0;
101  virtual bool overrideLUT() = 0;
102 
103  virtual void LUT(const char *lut_file) = 0;
104  virtual std::string LUT() = 0;
105 
106  virtual void antialias(const HOM_EnumValue &flipbookAntialias) = 0;
107  virtual HOM_EnumValue &antialias() = 0;
108 
109  virtual void useMotionBlur(bool enable) = 0;
110  virtual bool useMotionBlur() = 0;
111 
112  virtual void motionBlurSegments(int frames) = 0;
113  virtual int motionBlurSegments() = 0;
114 
115  virtual void motionBlurFrameRange(const HOM_EnumValue &
116  flipbookMotionBlurBias) = 0;
117  virtual HOM_EnumValue &motionBlurFrameRange() = 0;
118 
119  virtual void shutterFromCamera(bool use_camera) = 0;
120  virtual bool shutterFromCamera() = 0;
121 
122  virtual void shutter(double frame_fraction) = 0;
123  virtual double shutter() = 0;
124 
125 
126  virtual void useDepthOfField(bool enable) = 0;
127  virtual bool useDepthOfField() = 0;
128 
129  virtual void depthOfFieldFromCamera(bool use_camera) = 0;
130  virtual bool depthOfFieldFromCamera() = 0;
131 
132  virtual void depthOfFieldQuality(double num_images) =0;
133  virtual double depthOfFieldQuality() =0;
134 
135  virtual void focusDistance(double distance) = 0;
136  virtual double focusDistance() = 0;
137 
138  virtual void aperture(double aperture) = 0;
139  virtual double aperture() = 0;
140 
141  virtual void fStop(double f_stop) = 0;
142  virtual double fStop() = 0;
143 
144  virtual void outputZoom(int zoom) = 0;
145  virtual int outputZoom() = 0;
146 
147  virtual void useResolution(bool use_res) =0;
148  virtual bool useResolution() = 0;
149 
150  virtual void resolution(const std::vector<int> &image_resolution) = 0;
151  virtual std::vector<int> resolution() = 0;
152 
153  virtual void cropOutMaskOverlay(bool crop_mask) = 0;
154  virtual bool cropOutMaskOverlay() = 0;
155 };
156 
157 #endif
#define HOM_DESTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:974
GLenum GLint * range
Definition: glcorearb.h:1924
GLuint GLsizei const GLchar * label
Definition: glcorearb.h:2544
GLuint start
Definition: glcorearb.h:474
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
#define SWIGOUT(x)
Definition: HOM_Defines.h:24
#define HOM_API
Definition: HOM_API.h:13
T distance(const UT_Vector4T< T > &v1, const UT_Vector4T< T > &v2)
Definition: UT_Vector4.h:634
GLuint GLuint end
Definition: glcorearb.h:474
#define HOM_CONSTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:973
virtual std::string __repr__()=0
HOM_FlipbookSettings(const HOM_FlipbookSettings &)