Panda3D
somethingToEggConverter.I
Go to the documentation of this file.
1 /**
2  * PANDA 3D SOFTWARE
3  * Copyright (c) Carnegie Mellon University. All rights reserved.
4  *
5  * All use of this software is subject to the terms of the revised BSD
6  * license. You should have received a copy of this license along
7  * with this source code in a file named "LICENSE."
8  *
9  * @file somethingToEggConverter.I
10  * @author drose
11  * @date 2001-04-26
12  */
13 
14 /**
15  * Resets the error flag to the no-error state. had_error() will return false
16  * until a new error is generated.
17  */
19 clear_error() {
20  _error = false;
21 }
22 
23 /**
24  * Returns true if an error was detected during the conversion process (unless
25  * _allow_errors is true), false otherwise.
26  */
28 had_error() const {
29  return !_allow_errors && (_error || _path_replace->had_error());
30 }
31 
32 /**
33  * Replaces the PathReplace object (which specifies how to mangle paths from
34  * the source to the destination egg file) with a new one.
35  */
37 set_path_replace(PathReplace *path_replace) {
38  _path_replace = path_replace;
39 }
40 
41 /**
42  * Returns a pointer to the PathReplace object associated with this converter.
43  * If the converter is non-const, this returns a non-const pointer, which can
44  * be adjusted.
45  */
48  return _path_replace;
49 }
50 
51 /**
52  * Returns a pointer to the PathReplace object associated with this converter.
53  * If the converter is non-const, this returns a non-const pointer, which can
54  * be adjusted.
55  */
57 get_path_replace() const {
58  return _path_replace;
59 }
60 
61 /**
62  * Specifies how source animation will be converted into egg structures. The
63  * default is AC_none, which means animation tables will be ignored. This is
64  * only meaningful for converters that understand animation.
65  */
67 set_animation_convert(AnimationConvert animation_convert) {
68  _animation_convert = animation_convert;
69 }
70 
71 /**
72  * Returns how source animation will be converted into egg structures.
73  */
75 get_animation_convert() const {
76  return _animation_convert;
77 }
78 
79 /**
80  * Specifies the name of the character generated. This name should match
81  * between all the model and channel egg files for a particular character and
82  * its associated animations.
83  */
85 set_character_name(const std::string &character_name) {
86  _character_name = character_name;
87 }
88 
89 /**
90  * Returns the name of the character generated. See set_character_name().
91  */
92 INLINE const std::string &SomethingToEggConverter::
93 get_character_name() const {
94  return _character_name;
95 }
96 
97 /**
98  * Specifies the starting frame of the animation to convert, in the units
99  * specified by set_input_frame_rate(). If this is unspecified, the starting
100  * frame is taken from the source, for instance from the first frame of the
101  * animation slider.
102  */
104 set_start_frame(double start_frame) {
105  _start_frame = start_frame;
106  _control_flags |= CF_start_frame;
107 }
108 
109 /**
110  * Returns true if the starting frame has been explicitly specified via
111  * set_start_frame(), or false if the starting frame should be implicit based
112  * on the source.
113  */
115 has_start_frame() const {
116  return (_control_flags & CF_start_frame) != 0;
117 }
118 
119 /**
120  * Returns the value set by a previous call to set_start_frame(). It is an
121  * error to call this if has_start_frame() returns false.
122  */
124 get_start_frame() const {
125  nassertr(has_start_frame(), 0.0);
126  return _start_frame;
127 }
128 
129 /**
130  * Removes the value previously set by set_start_frame().
131  */
134  _start_frame = 0.0;
135  _control_flags &= ~CF_start_frame;
136 }
137 
138 /**
139  * Specifies the ending frame of the animation to convert, in the units
140  * specified by set_input_frame_rate(). If this is unspecified, the ending
141  * frame is taken from the source, for instance from the last frame of the
142  * animation slider.
143  */
145 set_end_frame(double end_frame) {
146  _end_frame = end_frame;
147  _control_flags |= CF_end_frame;
148 }
149 
150 /**
151  * Returns true if the ending frame has been explicitly specified via
152  * set_end_frame(), or false if the ending frame should be implicit based on
153  * the source.
154  */
156 has_end_frame() const {
157  return (_control_flags & CF_end_frame) != 0;
158 }
159 
160 /**
161  * Returns the value set by a previous call to set_end_frame(). It is an
162  * error to call this if has_end_frame() returns false.
163  */
165 get_end_frame() const {
166  nassertr(has_end_frame(), 0.0);
167  return _end_frame;
168 }
169 
170 /**
171  * Removes the value previously set by set_end_frame().
172  */
174 clear_end_frame() {
175  _end_frame = 0.0;
176  _control_flags &= ~CF_end_frame;
177 }
178 
179 /**
180  * Specifies the increment between frames to extract. This is the amount to
181  * increment the time slider (in units of internal_frame_rate) between
182  * extracting each frame. If this is not specified, the default is taken from
183  * the animation package, or 1.0 if the animation package does not specified a
184  * frame increment.
185  */
187 set_frame_inc(double frame_inc) {
188  _frame_inc = frame_inc;
189  _control_flags |= CF_frame_inc;
190 }
191 
192 /**
193  * Returns true if the frame increment has been explicitly specified via
194  * set_frame_inc(), or false if the ending frame should be implicit based on
195  * the source.
196  */
198 has_frame_inc() const {
199  return (_control_flags & CF_frame_inc) != 0;
200 }
201 
202 /**
203  * Returns the value set by a previous call to set_frame_inc(). It is an
204  * error to call this if has_frame_inc() returns false.
205  */
207 get_frame_inc() const {
208  nassertr(has_frame_inc(), 0.0);
209  return _frame_inc;
210 }
211 
212 /**
213  * Removes the value previously set by set_frame_inc().
214  */
216 clear_frame_inc() {
217  _frame_inc = 0.0;
218  _control_flags &= ~CF_frame_inc;
219 }
220 
221 /**
222  * Specifies the frame of animation to represent the neutral pose of the
223  * model.
224  */
226 set_neutral_frame(double neutral_frame) {
227  _neutral_frame = neutral_frame;
228  _control_flags |= CF_neutral_frame;
229 }
230 
231 /**
232  * Returns true if the neutral frame has been explicitly specified via
233  * set_neutral_frame(), or false otherwise.
234  */
236 has_neutral_frame() const {
237  return (_control_flags & CF_neutral_frame) != 0;
238 }
239 
240 /**
241  * Returns the value set by a previous call to set_neutral_frame(). It is an
242  * error to call this if has_neutral_frame() returns false.
243  */
245 get_neutral_frame() const {
246  nassertr(has_neutral_frame(), 0.0);
247  return _neutral_frame;
248 }
249 
250 /**
251  * Removes the value previously set by set_neutral_frame().
252  */
255  _neutral_frame = 0.0;
256  _control_flags &= ~CF_neutral_frame;
257 }
258 
259 /**
260  * Specifies the number of frames per second that is represented by the
261  * "frame" unit in the animation package. If this is omitted, it is taken
262  * from whatever the file header indicates. Some animation packages do not
263  * encode a frame rate, in which case the default if this is omitted is the
264  * same as the output frame rate.
265  */
267 set_input_frame_rate(double input_frame_rate) {
268  _input_frame_rate = input_frame_rate;
269  _control_flags |= CF_input_frame_rate;
270 }
271 
272 /**
273  * Returns true if the frame rate has been explicitly specified via
274  * set_input_frame_rate(), or false otherwise.
275  */
277 has_input_frame_rate() const {
278  return (_control_flags & CF_input_frame_rate) != 0;
279 }
280 
281 /**
282  * Returns the value set by a previous call to set_input_frame_rate(). It is
283  * an error to call this if has_input_frame_rate() returns false.
284  */
286 get_input_frame_rate() const {
287  nassertr(has_input_frame_rate(), 0.0);
288  return _input_frame_rate;
289 }
290 
291 /**
292  * Removes the value previously set by set_input_frame_rate().
293  */
296  _input_frame_rate = 0.0;
297  _control_flags &= ~CF_input_frame_rate;
298 }
299 
300 /**
301  * Specifies the number of frames per second that the resulting animation
302  * should be played at. If this is omitted, it is taken to be the same as the
303  * input frame rate.
304  */
306 set_output_frame_rate(double output_frame_rate) {
307  _output_frame_rate = output_frame_rate;
308  _control_flags |= CF_output_frame_rate;
309 }
310 
311 /**
312  * Returns true if the frame rate has been explicitly specified via
313  * set_output_frame_rate(), or false otherwise.
314  */
316 has_output_frame_rate() const {
317  return (_control_flags & CF_output_frame_rate) != 0;
318 }
319 
320 /**
321  * Returns the value set by a previous call to set_output_frame_rate(). It is
322  * an error to call this if has_output_frame_rate() returns false.
323  */
325 get_output_frame_rate() const {
326  nassertr(has_output_frame_rate(), 0.0);
327  return _output_frame_rate;
328 }
329 
330 /**
331  * Removes the value previously set by set_output_frame_rate().
332  */
335  _output_frame_rate = 0.0;
336  _control_flags &= ~CF_output_frame_rate;
337 }
338 
339 /**
340  * Returns the default frame rate if nothing is specified for input_frame_rate
341  * or output_frame_rate, and the animation package does not have an implicit
342  * frame rate.
343  */
346  return 24.0;
347 }
348 
349 /**
350  * Sets the merge_externals flag. When this is true, external references
351  * within the source file are read in and merged directly; otherwise, only a
352  * reference to a similarly-named egg file is inserted.
353  */
355 set_merge_externals(bool merge_externals) {
356  _merge_externals = merge_externals;
357 }
358 
359 /**
360  * Returns the current state of the merge_externals flag. See
361  * set_merge_externals().
362  */
364 get_merge_externals() const {
365  return _merge_externals;
366 }
367 
368 /**
369  * Sets the EggData to NULL and makes the converter invalid.
370  */
372 clear_egg_data() {
373  set_egg_data(nullptr);
374 }
375 
376 /**
377  * Returns the EggData structure.
378  */
380 get_egg_data() {
381  return _egg_data;
382 }
383 
384 /**
385  * Converts the indicated model filename to a relative or absolute or whatever
386  * filename, according to _path_replace.
387  */
389 convert_model_path(const Filename &orig_filename) {
390  return _path_replace->convert_path(orig_filename);
391 }
AnimationConvert
This enumerated type lists the methods by which animation from an animation package might be represen...
This is the primary interface into all the egg data, and the root of the egg file structure.
Definition: eggData.h:37
The name of a file, such as a texture file or an Egg file.
Definition: filename.h:39
This encapsulates the user's command-line request to replace existing, incorrect pathnames to models ...
Definition: pathReplace.h:36
bool had_error() const
Returns true if an error was detected during the conversion process (unless _allow_errors is true),...
void clear_end_frame()
Removes the value previously set by set_end_frame().
AnimationConvert get_animation_convert() const
Returns how source animation will be converted into egg structures.
Filename convert_model_path(const Filename &orig_filename)
Converts the indicated model filename to a relative or absolute or whatever filename,...
void clear_input_frame_rate()
Removes the value previously set by set_input_frame_rate().
void clear_start_frame()
Removes the value previously set by set_start_frame().
bool has_output_frame_rate() const
Returns true if the frame rate has been explicitly specified via set_output_frame_rate(),...
bool has_start_frame() const
Returns true if the starting frame has been explicitly specified via set_start_frame(),...
void set_input_frame_rate(double input_frame_rate)
Specifies the number of frames per second that is represented by the "frame" unit in the animation pa...
void clear_output_frame_rate()
Removes the value previously set by set_output_frame_rate().
PathReplace * get_path_replace()
Returns a pointer to the PathReplace object associated with this converter.
void clear_frame_inc()
Removes the value previously set by set_frame_inc().
EggData * get_egg_data()
Returns the EggData structure.
double get_input_frame_rate() const
Returns the value set by a previous call to set_input_frame_rate().
bool has_neutral_frame() const
Returns true if the neutral frame has been explicitly specified via set_neutral_frame(),...
void clear_neutral_frame()
Removes the value previously set by set_neutral_frame().
bool get_merge_externals() const
Returns the current state of the merge_externals flag.
void set_end_frame(double end_frame)
Specifies the ending frame of the animation to convert, in the units specified by set_input_frame_rat...
void set_animation_convert(AnimationConvert animation_convert)
Specifies how source animation will be converted into egg structures.
void set_character_name(const std::string &character_name)
Specifies the name of the character generated.
void set_merge_externals(bool merge_externals)
Sets the merge_externals flag.
double get_frame_inc() const
Returns the value set by a previous call to set_frame_inc().
static double get_default_frame_rate()
Returns the default frame rate if nothing is specified for input_frame_rate or output_frame_rate,...
void set_path_replace(PathReplace *path_replace)
Replaces the PathReplace object (which specifies how to mangle paths from the source to the destinati...
double get_output_frame_rate() const
Returns the value set by a previous call to set_output_frame_rate().
double get_end_frame() const
Returns the value set by a previous call to set_end_frame().
void set_neutral_frame(double neutral_frame)
Specifies the frame of animation to represent the neutral pose of the model.
void set_output_frame_rate(double output_frame_rate)
Specifies the number of frames per second that the resulting animation should be played at.
void set_start_frame(double start_frame)
Specifies the starting frame of the animation to convert, in the units specified by set_input_frame_r...
bool has_input_frame_rate() const
Returns true if the frame rate has been explicitly specified via set_input_frame_rate(),...
void clear_error()
Resets the error flag to the no-error state.
void set_frame_inc(double frame_inc)
Specifies the increment between frames to extract.
double get_start_frame() const
Returns the value set by a previous call to set_start_frame().
const std::string & get_character_name() const
Returns the name of the character generated.
double get_neutral_frame() const
Returns the value set by a previous call to set_neutral_frame().
void set_egg_data(EggData *egg_data)
Sets the egg data that will be filled in when convert_file() is called.
bool has_frame_inc() const
Returns true if the frame increment has been explicitly specified via set_frame_inc(),...
bool has_end_frame() const
Returns true if the ending frame has been explicitly specified via set_end_frame(),...
void clear_egg_data()
Sets the EggData to NULL and makes the converter invalid.