OptionsProcessor Class Reference

Class to process all the command line options. More...

#include <optionsprocessor.h>

Classes
struct	VideoCodec

Public Member Functions
	OptionsProcessor (boost::program_options::variables_map &vm, const boost::program_options::options_description &po_visible)
void	process_settings_options ()
void	process_info_options ()
Job	extract_job ()
synfig::RendDesc	extract_renddesc (const synfig::RendDesc &renddesc)
	Overwrite the input RendDesc object with the options given in the command line.
synfig::TargetParam	extract_targetparam ()
void	print_target_video_codecs_help () const

Detailed Description

Class to process all the command line options.

Constructor & Destructor Documentation

OptionsProcessor::OptionsProcessor	(	boost::program_options::variables_map &	vm,
		const boost::program_options::options_description &	po_visible
	)

Member Function Documentation

void OptionsProcessor::process_settings_options

(

)

Settings options verbose, quiet, threads, benchmarks

References _, SynfigToolGeneralOptions::get_threads(), SynfigToolGeneralOptions::get_verbosity(), SynfigToolGeneralOptions::instance(), SynfigToolGeneralOptions::set_should_be_quiet(), SynfigToolGeneralOptions::set_should_print_benchmarks(), SynfigToolGeneralOptions::set_threads(), SynfigToolGeneralOptions::set_verbosity(), and VERBOSE_OUT.

Referenced by main().

void OptionsProcessor::process_info_options

(

)

Information options Options that will only display information

References _, synfig::Importer::book(), synfig::Target::book(), synfig::Module::book(), synfig::Layer::book(), synfig::LinkableValueNode::book(), CATEGORY_DO_NOT_USE, synfig::Layer::create(), PACKAGE, print_target_video_codecs_help(), print_usage(), SYNFIG_COPYRIGHT, SYNFIG_LICENSE, SYNFIGTOOL_HELP, and VERSION.

Referenced by main().

Job OptionsProcessor::extract_job

(

)

Extract the necessary options to create a job After this, it is necessary to overwrite the necessary RendDesc options and set the target parameters, if provided. Then can be processed

References _, Job::canvas, DEFAULT_QUALITY, Job::extract_alpha, Job::filename, synfig::open_canvas_as(), Job::outfilename, print_canvas_info(), print_child_canvases(), Job::quality, Job::root, SYNFIGTOOL_FILENOTFOUND, SYNFIGTOOL_INVALIDJOB, SYNFIGTOOL_MISSINGARGUMENT, SYNFIGTOOL_OK, Job::target_name, and VERBOSE_OUT.

Referenced by main().

RendDesc OptionsProcessor::extract_renddesc

(

const synfig::RendDesc &

renddesc

)

Overwrite the input RendDesc object with the options given in the command line.

References _, synfig::RendDesc::get_frame_rate(), synfig::RendDesc::get_h(), synfig::Time::get_string(), synfig::RendDesc::get_time_start(), synfig::RendDesc::get_w(), synfig::RendDesc::set_antialias(), synfig::RendDesc::set_frame_rate(), synfig::RendDesc::set_span(), synfig::RendDesc::set_time(), synfig::RendDesc::set_time_end(), synfig::RendDesc::set_time_start(), synfig::RendDesc::set_wh(), synfig::RendDesc::set_x_res(), synfig::RendDesc::set_y_res(), VERBOSE_OUT, and synfig::warning().

Referenced by main().

TargetParam OptionsProcessor::extract_targetparam

(

)

Extract the target parameters from the options given in the command line video-codec, bitrate, sequence-separator

References _, synfig::TargetParam::bitrate, synfig::TargetParam::sequence_separator, SYNFIGTOOL_MISSINGARGUMENT, SYNFIGTOOL_UNKNOWNARGUMENT, tolower, VERBOSE_OUT, and synfig::TargetParam::video_codec.

Referenced by main().

void OptionsProcessor::print_target_video_codecs_help

(

)

const

Referenced by process_info_options().

---

The documentation for this class was generated from the following files:

• optionsprocessor.h
• optionsprocessor.cpp