#include <GA_SaveOptions.h>

Inheritance diagram for GA_SaveOptions:

Public Member Functions
	GA_SaveOptions ()

	~GA_SaveOptions () override

GA_SaveOptions &	operator= (const UT_Options &opts)

Public Member Functions inherited from UT_Options
	UT_Options ()

	UT_Options (const UT_Options &src)

virtual	~UT_Options ()

	UT_Options (const char *type_and_name,...)

void	clear ()

bool	load (const char *filename)

bool	save (const char *filename) const

bool	saveOrdered (const char *filename) const

bool	load (const char *filename, UT_IStream &is)

bool	save (const char *filename, std::ostream &os) const

bool	saveOrdered (const char *filename, std::ostream &os) const

bool	saveAsJSON (const char *filename, bool binary=true, bool compact=false) const

bool	saveAsJSON (const char *filename, std::ostream &os, bool binary=true, bool compact=false) const

void	removeOption (const UT_StringHolder &name)

bool	getOptionString (const UT_StringHolder &name, UT_OptionFormat format, UT_WorkBuffer &result) const

bool	getOptionString (const UT_StringHolder &name, UT_OptionFormat format, UT_String &result) const

bool	appendPyDictionary (UT_WorkBuffer &result, bool sorted=false) const

bool	setFromPyDictionary (const char *dict)

bool	setPyOptionString (const UT_StringHolder &name, const char *value)

bool	save (UT_JSONWriter &w, bool compact=false) const

void	save (UT_JSONValueMap &map, bool compact=false) const

bool	load (UT_JSONParser &parser, bool do_clear, UT_IStream *is=0, bool require_type=true)

bool	load (const UT_JSONValueMap &map, bool do_clear, bool allow_type=true, bool allow_dict=false)

void	dump (std::ostream &os) const
	Writes a JSON dump to ostream of the current options. More...

void	dump () const
	Dump to stdout/cout. More...

bool	hasOption (const UT_StringRef &name) const

UT_OptionType	getOptionType (const UT_StringRef &name) const

const UT_OptionEntry *	getOptionEntry (const UT_StringRef &name) const

exint	getNumOptions () const

exint	size () const

exint	entries () const

iterator	begin () const

iterator	end () const

ordered_iterator	obegin () const

ordered_iterator	oend () const

int64	getOptionI (const UT_StringRef &name) const

bool	getOptionB (const UT_StringRef &name) const

fpreal64	getOptionF (const UT_StringRef &name) const

const UT_Vector2D &	getOptionV2 (const UT_StringRef &name) const

const UT_Vector3D &	getOptionV3 (const UT_StringRef &name) const

const UT_Vector4D &	getOptionV4 (const UT_StringRef &name) const

const UT_QuaternionD &	getOptionQ (const UT_StringRef &name) const

const UT_Matrix2D &	getOptionM2 (const UT_StringRef &name) const

const UT_Matrix3D &	getOptionM3 (const UT_StringRef &name) const

const UT_Matrix4D &	getOptionM4 (const UT_StringRef &name) const

const UT_Vector2D &	getOptionUV (const UT_StringRef &name) const

const UT_Vector3D &	getOptionUVW (const UT_StringRef &name) const

const UT_StringHolder &	getOptionS (const UT_StringRef &name) const

void	getOptionS (const UT_StringRef &name, std::string &value) const

void	getOptionS (const UT_StringRef &name, UT_String &value) const

void	getOptionS (const UT_StringRef &name, UT_StringHolder &value) const

void	getOptionS (const UT_StringRef &, UT_WorkBuffer &value) const

const UT_OptionsHolder &	getOptionDict (const UT_StringRef &name) const

const UT_Int64Array &	getOptionIArray (const UT_StringRef &) const

const UT_Fpreal64Array &	getOptionFArray (const UT_StringRef &) const

const UT_StringArray &	getOptionSArray (const UT_StringRef &) const

const UT_Array < UT_OptionsHolder > &	getOptionDictArray (const UT_StringRef &) const

fpreal64	getOptionNum (const UT_StringRef &) const

bool	importOption (const UT_StringRef &name, int &value) const

bool	importOption (const UT_StringRef &name, int64 &value) const

bool	importOption (const UT_StringRef &name, bool &value) const

bool	importOption (const UT_StringRef &name, fpreal32 &value) const

bool	importOption (const UT_StringRef &name, fpreal64 &value) const

bool	importOption (const UT_StringRef &name, std::string &value) const

bool	importOption (const UT_StringRef &name, UT_String &value) const

bool	importOption (const UT_StringRef &name, UT_StringHolder &value) const

bool	importOption (const UT_StringRef &name, UT_OptionsHolder &value) const

bool	importOption (const UT_StringRef &name, UT_Vector2F &value) const

bool	importOption (const UT_StringRef &name, UT_Vector3F &value) const

bool	importOption (const UT_StringRef &name, UT_Vector4F &value) const

bool	importOption (const UT_StringRef &name, UT_QuaternionF &value) const

bool	importOption (const UT_StringRef &name, UT_Matrix2F &value) const

bool	importOption (const UT_StringRef &name, UT_Matrix3F &value) const

bool	importOption (const UT_StringRef &name, UT_Matrix4F &value) const

bool	importOption (const UT_StringRef &name, UT_Vector2D &value) const

bool	importOption (const UT_StringRef &name, UT_Vector3D &value) const

bool	importOption (const UT_StringRef &name, UT_Vector4D &value) const

bool	importOption (const UT_StringRef &name, UT_QuaternionD &value) const

bool	importOption (const UT_StringRef &name, UT_Matrix2D &value) const

bool	importOption (const UT_StringRef &name, UT_Matrix3D &value) const

bool	importOption (const UT_StringRef &name, UT_Matrix4D &value) const

bool	importOption (const UT_StringRef &name, UT_Array< int32 > &value) const

bool	importOption (const UT_StringRef &name, UT_Array< int64 > &value) const

bool	importOption (const UT_StringRef &name, UT_Array< fpreal32 > &value) const

bool	importOption (const UT_StringRef &name, UT_Array< fpreal64 > &value) const

bool	importOption (const UT_StringRef &name, UT_StringArray &value) const

bool	importOption (const UT_StringRef &name, UT_Array< UT_StringHolder > &value) const

bool	importOption (const UT_StringRef &name, UT_Array< UT_OptionsHolder > &value) const

bool	importElement (const UT_StringRef &name, fpreal &value, exint index=0) const

bool	importElement (const UT_StringRef &name, int64 &value, exint index=0) const

UT_Options &	setOptionI (const UT_StringHolder &name, int64 value)

UT_Options &	setOptionB (const UT_StringHolder &name, bool value)

UT_Options &	setOptionF (const UT_StringHolder &name, fpreal64 value)

UT_Options &	setOptionS (const UT_StringHolder &name, const UT_StringHolder &value)

UT_Options &	setOptionSRaw (const UT_StringHolder &name, const UT_StringHolder &value)

UT_Options &	setOptionDict (const UT_StringHolder &name, const UT_OptionsHolder &value)

UT_Options &	setOptionV2 (const UT_StringHolder &name, const UT_Vector2F &value)

UT_Options &	setOptionV2 (const UT_StringHolder &name, const UT_Vector2D &value)

UT_Options &	setOptionV2 (const UT_StringHolder &name, fpreal64 x, fpreal64 y)

UT_Options &	setOptionV3 (const UT_StringHolder &name, const UT_Vector3F &value)

UT_Options &	setOptionV3 (const UT_StringHolder &name, const UT_Vector3D &value)

UT_Options &	setOptionV3 (const UT_StringHolder &name, fpreal64 x, fpreal64 y, fpreal64 z)

UT_Options &	setOptionV4 (const UT_StringHolder &name, const UT_Vector4F &value)

UT_Options &	setOptionV4 (const UT_StringHolder &name, const UT_Vector4D &value)

UT_Options &	setOptionV4 (const UT_StringHolder &name, fpreal64 x, fpreal64 y, fpreal64 z, fpreal64 w)

UT_Options &	setOptionQ (const UT_StringHolder &name, const UT_QuaternionF &value)

UT_Options &	setOptionQ (const UT_StringHolder &name, const UT_QuaternionD &value)

UT_Options &	setOptionM2 (const UT_StringHolder &name, const UT_Matrix2F &value)

UT_Options &	setOptionM2 (const UT_StringHolder &name, const UT_Matrix2D &value)

UT_Options &	setOptionM3 (const UT_StringHolder &name, const UT_Matrix3F &value)

UT_Options &	setOptionM3 (const UT_StringHolder &name, const UT_Matrix3D &value)

UT_Options &	setOptionM4 (const UT_StringHolder &name, const UT_Matrix4F &value)

UT_Options &	setOptionM4 (const UT_StringHolder &name, const UT_Matrix4D &value)

UT_Options &	setOptionUV (const UT_StringHolder &name, const UT_Vector2F &value)

UT_Options &	setOptionUV (const UT_StringHolder &name, const UT_Vector2D &value)

UT_Options &	setOptionUVW (const UT_StringHolder &name, const UT_Vector3F &value)

UT_Options &	setOptionUVW (const UT_StringHolder &name, const UT_Vector3D &value)

UT_Options &	setOptionSArray (const UT_StringHolder &name, const UT_StringHolder *values, size_t size)
	Set string array options. More...

UT_Options &	setOptionSArray (const UT_StringHolder &name, const char const values, size_t size)

UT_Options &	setOptionSArray (const UT_StringHolder &name, const UT_StringArray &value)

UT_Options &	setOptionDictArray (const UT_StringHolder &name, const UT_OptionsHolder *values, size_t size)
	Set dict array options. More...

UT_Options &	setOptionDictArray (const UT_StringHolder &name, const UT_Array< UT_OptionsHolder > &value)

unsigned	hash () const
	Get a hash code for the options. More...

bool	operator== (const UT_Options &src) const
	Comparison operator. More...

bool	operator!= (const UT_Options &src) const

bool	isEqual (const UT_Options &src, fpreal64 tol) const
	Comparison operator with a tolerance for float values. More...

const UT_Options &	operator= (const UT_Options &src)
	Assignment operator. More...

void	merge (const UT_Options &src)

void	merge (const UT_Options &src, bool(match)(const UT_StringHolder &name, const UT_OptionEntry , void ), void data)

virtual int64	getMemoryUsage (bool inclusive) const

void	setOption (const UT_StringHolder &name, UT_OptionEntryPtr value)

UT_Options &	setOptionIArray (const UT_StringHolder &name, const int32 *values, size_t size)

UT_Options &	setOptionIArray (const UT_StringHolder &name, const int64 *values, size_t size)

UT_Options &	setOptionIArray (const UT_StringHolder &name, const UT_Array< int64 > &value)

UT_Options &	setOptionFArray (const UT_StringHolder &name, const fpreal32 *values, size_t size)

UT_Options &	setOptionFArray (const UT_StringHolder &name, const fpreal64 *values, size_t size)

UT_Options &	setOptionFArray (const UT_StringHolder &name, const UT_Array< fpreal64 > &value)

Additional Inherited Members
Static Public Member Functions inherited from UT_Options
static UT_OptionType	optionType (const UT_StringRef &kwd)
	Lookup an option type based on a keyword. More...

Protected Member Functions inherited from UT_Options
const UT_StringHolder *	findOptionS (const UT_StringRef &name) const

void	addError (const char filename, int linecount, const char error_str) const

bool	sendOptionChanges () const

void	setSendOptionChanges (bool f)

virtual void	optionChanged (const char *name)

UT_OptionEntryPtr	parsePyValue (const char *&value, char sep_delim, char close_delim= '\0')

Detailed Description

Class to specify options for loading geometry.

In addition, when saving to JSON format, see UT_JSONWriter for options. Any options prefixed with 'json:' will be interpreted by the JSON writer (i.e. json:indentstep).

For each option, there are five methods created:

static const char *optionName() { return "name"; }
TYPE   option(TYPE defval=DEFAULT) const
              { return importOption(name,v) ? v : defval; }
bool   importOption(TYPE &v) const { return importOption(name,v); }
void   setOption() { setOption<>(name, v); }

Definition at line 30 of file GA_SaveOptions.h.

Constructor & Destructor Documentation

GA_SaveOptions::GA_SaveOptions ( )

inline

Definition at line 33 of file GA_SaveOptions.h.

GA_SaveOptions::~GA_SaveOptions ( )

override

Member Function Documentation

GA_SaveOptions& GA_SaveOptions::operator= ( const UT_Options & opts )

inline

Definition at line 39 of file GA_SaveOptions.h.

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

GA/GA_SaveOptions.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation