TuttleOFX  1
options.hpp File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

namespace  sam

Defines

#define SAM_HELP_MARGING   35
#define SAM_EXAMPLE_TITLE_COUT(...)   TUTTLE_LOG_INFO( std::endl << color->_yellow << " " << __VA_ARGS__ << color->_std );
#define SAM_EXAMPLE_LINE_COUT(x,...)   TUTTLE_LOG_INFO( color->_green << " " << std::setw(SAM_HELP_MARGING) << x << __VA_ARGS__ << color->_std );

Variables

static const char *const sam::kUrlTuttleofxProject = "http://sites.google.com/site/tuttleofx"
static const char *const sam::kAllOptionLongName = "all"
 options with short-cut
static const char *const sam::kAllOptionString = "all,a"
static const char *const sam::kAllOptionMessage = "do not ignore entries starting with ."
static const char *const sam::kAttributesOptionLongName = "attributes"
static const char *const sam::kAttributesOptionString = "attributes,A"
static const char *const sam::kAttributesOptionMessage = "show all attributes: parameters+clips"
static const char *const sam::kCommandsOptionLongName = "commands"
static const char *const sam::kCommandsOptionString = "commands,c"
static const char *const sam::kCommandsOptionMessage = "show list of all available sam commands"
static const char *const sam::kDirectoriesOptionLongName = "directories"
static const char *const sam::kDirectoriesOptionString = "directories,d"
static const char *const sam::kDirectoriesOptionMessage = "handle directories"
static const char *const sam::kExpressionOptionLongName = "expression"
static const char *const sam::kExpressionOptionString = "expression,e"
static const char *const sam::kExpressionOptionMessage = "use a specific pattern, ex: *.jpg,*.png"
static const char *const sam::kFilesOptionLongName = "files"
static const char *const sam::kFilesOptionString = "files,f"
static const char *const sam::kFilesOptionMessage = "handle files"
static const char *const sam::kFilterOptionLongName = "filter"
static const char *const sam::kFilterOptionString = "filter,F"
static const char *const sam::kFilterOptionMessage = "filtering the output for research a plugin. ex: -f \"*blur,*tuttle*\""
static const char *const sam::kHelpOptionLongName = "help"
static const char *const sam::kHelpOptionString = "help,h"
static const char *const sam::kHelpOptionMessage = "display help"
static const char *const sam::kInputOptionLongName = "input"
static const char *const sam::kInputOptionString = "input,i"
static const char *const sam::kInputOptionMessage = "input pathname: directory, file or sequence pattern"
static const char *const sam::kIgnoreOptionLongName = "ignore"
static const char *const sam::kIgnoreOptionString = "ignore,I"
static const char *const sam::kIgnoreOptionMessage = "ignore the specified sequence"
static const char *const sam::kLongListingOptionLongName = "long-listing"
static const char *const sam::kLongListingOptionString = "long-listing,l"
static const char *const sam::kLongListingOptionMessage = "use a long listing format"
static const char *const sam::kNodesOptionLongName = "nodes"
static const char *const sam::kNodesOptionString = "nodes,n"
static const char *const sam::kNodesOptionMessage = "list all avalaible node"
static const char *const sam::kOffsetOptionLongName = "offset"
static const char *const sam::kOffsetOptionString = "offset,o"
static const char *const sam::kOffsetOptionMessage = "retime the sequence with the given offset. ex: -o 1, -o"
static const char *const sam::kPathOptionLongName = "path"
static const char *const sam::kPathOptionString = "path,p"
static const char *const sam::kPathOptionMessage = "display the absolute path of each object"
static const char *const sam::kQuietOptionLongName = "quiet"
static const char *const sam::kQuietOptionString = "quiet,Q"
static const char *const sam::kQuietOptionMessage = "don't print commands"
static const char *const sam::kRangeOptionLongName = "range"
static const char *const sam::kRangeOptionString = "range,r"
static const char *const sam::kRangeOptionMessage = "processing range (used only if input is a sequence pattern)"
static const char *const sam::kRecursiveOptionLongName = "recursive"
static const char *const sam::kRecursiveOptionString = "recursive,R"
static const char *const sam::kRecursiveOptionMessage = "handle directories and their content recursively"
static const char *const sam::kSequencesOptionLongName = "sequences"
static const char *const sam::kSequencesOptionString = "sequences,s"
static const char *const sam::kSequencesOptionMessage = "handle sequences"
static const char *const sam::kVersionOptionLongName = "version"
static const char *const sam::kVersionOptionString = "version,v"
static const char *const sam::kVersionOptionMessage = "display version"
static const char *const sam::kVerboseOptionLongName = "verbose"
static const char *const sam::kVerboseOptionString = "verbose,V"
static const char *const sam::kVerboseOptionMessage = "verbose level (trace=0, debug=1, warning=2, error=3, fatal=4)"
static const char *const sam::kBinariesListOptionLongName = "binaries-list"
 options without short-cut
static const char *const sam::kBinariesListOptionString = kBinariesListOptionLongName
static const char *const sam::kBinariesListOptionMessage = "show list of all available sam binaries"
static const char *const sam::kBriefOptionLongName = "brief"
static const char *const sam::kBriefOptionString = kBriefOptionLongName
static const char *const sam::kBriefOptionMessage = "display a brief summary of the tool"
static const char *const sam::kClipOptionLongName = "clip"
static const char *const sam::kClipOptionString = kClipOptionLongName
static const char *const sam::kClipOptionMessage = "display clip informations"
static const char *const sam::kClipsOptionLongName = "clips"
static const char *const sam::kClipsOptionString = kClipsOptionLongName
static const char *const sam::kClipsOptionMessage = "list clips of the OpenFX plugin"
static const char *const sam::kColorOptionLongName = "color"
static const char *const sam::kColorOptionString = kColorOptionLongName
static const char *const sam::kColorOptionMessage = "display the output with colors"
static const char *const sam::kCommandsListOptionLongName = "commands-list"
static const char *const sam::kCommandsListOptionString = kCommandsListOptionLongName
static const char *const sam::kCommandsListOptionMessage = "show list of all available sam commands"
static const char *const sam::kContinueOnErrorOptionLongName = "continue-on-error"
static const char *const sam::kContinueOnErrorOptionString = kContinueOnErrorOptionLongName
static const char *const sam::kContinueOnErrorOptionMessage = "continue on error"
static const char *const sam::kDisableProcessOptionLongName = "disable-process"
static const char *const sam::kDisableProcessOptionString = kDisableProcessOptionLongName
static const char *const sam::kDisableProcessOptionMessage = "run the command line without computing images (verbose enable)."
static const char *const sam::kForceIdentityNodesProcessOptionLongName = "force-identity-nodes-process"
static const char *const sam::kForceIdentityNodesProcessOptionString = kForceIdentityNodesProcessOptionLongName
static const char *const sam::kForceIdentityNodesProcessOptionMessage = "force identity nodes process (debug option for plugin developers only)"
static const char *const sam::kEnableColorOptionLongName = "enable-color"
static const char *const sam::kEnableColorOptionString = kEnableColorOptionLongName
static const char *const sam::kEnableColorOptionMessage = "enable or disable color"
static const char *const sam::kExpertOptionLongName = "expert"
static const char *const sam::kExpertOptionString = kExpertOptionLongName
static const char *const sam::kExpertOptionMessage = "show expert user options"
static const char *const sam::kFirstImageOptionLongName = "first-image"
static const char *const sam::kFirstImageOptionString = kFirstImageOptionLongName
static const char *const sam::kFirstImageOptionMessage = "specify the first image"
static const char *const sam::kFormatOptionLongName = "format"
static const char *const sam::kFormatOptionString = kFormatOptionLongName
static const char *const sam::kFormatOptionMessage = "display supported formats"
static const char *const sam::kFullDisplayOptionLongName = "full-display"
static const char *const sam::kFullDisplayOptionString = kFullDisplayOptionLongName
static const char *const sam::kFullDisplayOptionMessage = "display everything =directories, files, sequences"
static const char *const sam::kFullRMPathOptionLongName = "full-rm"
static const char *const sam::kFullRMPathOptionString = kFullRMPathOptionLongName
static const char *const sam::kFullRMPathOptionMessage = "remove everything =directories, files, sequences"
static const char *const sam::kGeneratorArgsOptionLongName = "generator-args"
static const char *const sam::kGeneratorArgsOptionString = kGeneratorArgsOptionLongName
static const char *const sam::kGeneratorArgsOptionMessage = "properties of generator plugin"
static const char *const sam::kIdOptionLongName = "id"
static const char *const sam::kIdOptionString = kIdOptionLongName
static const char *const sam::kIdOptionMessage = "set a name/id to the node"
static const char *const sam::kInputDirOptionLongName = "input-dir"
static const char *const sam::kInputDirOptionString = kInputDirOptionLongName
static const char *const sam::kInputDirOptionMessage = "input directories"
static const char *const sam::kInputFirstOptionLongName = "input-first"
static const char *const sam::kInputFirstOptionString = kInputFirstOptionLongName
static const char *const sam::kInputFirstOptionMessage = "specify the first input image in order to select a sub-range of the input sequence"
static const char *const sam::kInputLastOptionLongName = "input-last"
static const char *const sam::kInputLastOptionString = kInputLastOptionLongName
static const char *const sam::kInputLastOptionMessage = "specify the last input image in order to select a sub-range of the input sequence"
static const char *const sam::kLastImageOptionLongName = "last-image"
static const char *const sam::kLastImageOptionString = kLastImageOptionLongName
static const char *const sam::kLastImageOptionMessage = "specify the last image"
static const char *const sam::kNodesListOptionLongName = "nodes-script"
static const char *const sam::kNodesListOptionString = kNodesListOptionLongName
static const char *const sam::kNodesListOptionMessage = "show list of all available nodes (formatted for scripting)"
static const char *const sam::kOutputFirstOptionLongName = "output-first"
static const char *const sam::kOutputFirstOptionString = kOutputFirstOptionLongName
static const char *const sam::kOutputFirstOptionMessage = "specify the first output image, in order to select a sub-range of the output sequence"
static const char *const sam::kOutputLastOptionLongName = "output-last"
static const char *const sam::kOutputLastOptionString = kOutputLastOptionLongName
static const char *const sam::kOutputLastOptionMessage = "specify the last output image, in order to select a sub-range of the output sequence"
static const char *const sam::kParametersOptionLongName = "parameters-list"
static const char *const sam::kParametersOptionString = kParametersOptionLongName
static const char *const sam::kParametersOptionMessage = "list parameters of the OpenFX plugin"
static const char *const sam::kParametersReduxOptionLongName = "parameters-redux-list"
static const char *const sam::kParametersReduxOptionString = kParametersReduxOptionLongName
static const char *const sam::kParametersReduxOptionMessage = "list parameters of the OpenFX plugin (redux informations)"
static const char *const sam::kParamDefaultOptionLongName = "param-default"
static const char *const sam::kParamDefaultOptionString = kParamDefaultOptionLongName
static const char *const sam::kParamDefaultOptionMessage = "parameter default value"
static const char *const sam::kParamGroupOptionLongName = "param-group"
static const char *const sam::kParamGroupOptionString = kParamGroupOptionLongName
static const char *const sam::kParamGroupOptionMessage = "group of the OpenFX plugin"
static const char *const sam::kParamInfosOptionLongName = "param-infos"
static const char *const sam::kParamInfosOptionString = kParamInfosOptionLongName
static const char *const sam::kParamInfosOptionMessage = "display parameter informations"
static const char *const sam::kParamPossibleValuesOptionLongName = "param-possible-values"
static const char *const sam::kParamPossibleValuesOptionString = kParamPossibleValuesOptionLongName
static const char *const sam::kParamPossibleValuesOptionMessage = "possible parameter values"
static const char *const sam::kParamTypeOptionLongName = "param-type"
static const char *const sam::kParamTypeOptionString = kParamTypeOptionLongName
static const char *const sam::kParamTypeOptionMessage = "parameter type"
static const char *const sam::kParamValuesOptionLongName = "param-values"
static const char *const sam::kParamValuesOptionString = kParamValuesOptionLongName
static const char *const sam::kParamValuesOptionMessage = "display parameter values"
static const char *const sam::kPropertiesOptionLongName = "properties"
static const char *const sam::kPropertiesOptionString = kPropertiesOptionLongName
static const char *const sam::kPropertiesOptionMessage = "list properties of the OpenFX plugin"
static const char *const sam::kPluginsOptionLongName = "plugins"
static const char *const sam::kPluginsOptionString = kPropertiesOptionLongName
static const char *const sam::kPluginsOptionMessage = "list of associated plugins for this dummy node"
static const char *const sam::kReaderOptionLongName = "reader"
static const char *const sam::kReaderOptionString = kReaderOptionLongName
static const char *const sam::kReaderOptionMessage = "specify reader node with identifier \"tuttle.XXXreader\""
static const char *const sam::kRelativePathOptionLongName = "relative-path"
static const char *const sam::kRelativePathOptionString = kRelativePathOptionLongName
static const char *const sam::kRelativePathOptionMessage = "display the relative path of each object"
static const char *const sam::kStopOnMissingFileOptionLongName = "stop-on-missing-file"
static const char *const sam::kStopOnMissingFileOptionString = kStopOnMissingFileOptionLongName
static const char *const sam::kStopOnMissingFileOptionMessage = "stop on missing file"
static const char *const sam::kNbCoresOptionLongName = "nb-cores"
static const char *const sam::kNbCoresOptionString = kNbCoresOptionLongName
static const char *const sam::kNbCoresOptionMessage = "set a fix number of CPUs"
static const char *const sam::kRenderScaleOptionLongName = "renderscale"
static const char *const sam::kRenderScaleOptionString = kRenderScaleOptionLongName
static const char *const sam::kRenderScaleOptionMessage = "specify render scale"
static const char *const sam::kScriptOptionLongName = "script"
static const char *const sam::kScriptOptionString = kScriptOptionLongName
static const char *const sam::kScriptOptionMessage = "format the output such as it could be dump in a file and be used as a script"

Define Documentation

#define SAM_EXAMPLE_LINE_COUT (   x,
  ... 
)    TUTTLE_LOG_INFO( color->_green << " " << std::setw(SAM_HELP_MARGING) << x << __VA_ARGS__ << color->_std );

Definition at line 8 of file options.hpp.

Referenced by displayHelp(), main(), and sammvcp().

#define SAM_EXAMPLE_TITLE_COUT (   ...)    TUTTLE_LOG_INFO( std::endl << color->_yellow << " " << __VA_ARGS__ << color->_std );

Definition at line 7 of file options.hpp.

Referenced by displayHelp(), main(), and sammvcp().

#define SAM_HELP_MARGING   35

Definition at line 6 of file options.hpp.