AL_USDMaya  0.16.6
USD to Maya Bridge
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
AL::maya::OptionsParser Class Reference

Utility class that parses the file translator options passed through by Maya. More...

#include <FileTranslatorOptions.h>

Public Member Functions

 OptionsParser ()
 ctor
 
 ~OptionsParser ()
 dtor
 
MStatus parse (const MString &optionString)
 Given a string containing a semi-colon separated list of options passed to a file translator plugin, this function will parse and extract all of the option values. More...
 
bool getBool (const char *const str) const
 Given the text name of an option, returns the boolean value for that option. More...
 
int getInt (const char *const str) const
 Given the text name of an option, returns the integer value for that option. More...
 
float getFloat (const char *const str) const
 Given the text name of an option, returns the floating point value for that option. More...
 
MString getString (const char *const str) const
 Given the text name of an option, returns the string value for that option. More...
 

Friends

class FileTranslatorOptions
 

Detailed Description

Utility class that parses the file translator options passed through by Maya.

Member Function Documentation

bool AL::maya::OptionsParser::getBool ( const char *const  str) const
inline

Given the text name of an option, returns the boolean value for that option.

Parameters
strthe name of the option
Returns
the option value
float AL::maya::OptionsParser::getFloat ( const char *const  str) const
inline

Given the text name of an option, returns the floating point value for that option.

Parameters
strthe name of the option
Returns
the option value
int AL::maya::OptionsParser::getInt ( const char *const  str) const
inline

Given the text name of an option, returns the integer value for that option.

Parameters
strthe name of the option
Returns
the option value
MString AL::maya::OptionsParser::getString ( const char *const  str) const
inline

Given the text name of an option, returns the string value for that option.

Parameters
strthe name of the option
Returns
the option value
MStatus AL::maya::OptionsParser::parse ( const MString &  optionString)

Given a string containing a semi-colon separated list of options passed to a file translator plugin, this function will parse and extract all of the option values.

Parameters
optionStringthe option string to parse
Returns
MS::kSuccess if the parsing was successful, false otherwise.

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