UT_Options.h File Reference

#include "UT_API.h"
#include "UT_SmallObject.h"
#include "UT_StringArray.h"
#include "UT_StringHolder.h"
#include "UT_ArrayStringMap.h"
#include "UT_UniquePtr.h"
#include "UT_SharedPtr.h"
#include "UT_VectorTypes.h"
#include "UT_ValArray.h"
#include <SYS/SYS_TypeTraits.h>
#include <iosfwd>
#include <string>
#include <memory>
#include <utility>
#include "UT_OptionEntry.h"

Include dependency graph for UT_Options.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	UT_Options
	A map of string to various well defined value types. More...
class	UT_Options::iterator
class	UT_Options::ordered_iterator
class	UT_OptionsRef
class	UT_OptionsHolder
struct	UT::DefaultClearer< T >
struct	UT::DefaultClearer< UT_OptionsHolder >

Namespaces
	UT

Typedefs
using	UT_OptionEntryPtr = UT_UniquePtr< UT_OptionEntry >

Enumerations
enum	UT_OptionType {   UT_OPTION_INVALID = -1, UT_OPTION_INT = 0, UT_OPTION_BOOL = 1, UT_OPTION_FPREAL = 2,   UT_OPTION_STRING = 3, UT_OPTION_VECTOR2 = 4, UT_OPTION_VECTOR3 = 5, UT_OPTION_VECTOR4 = 6,   UT_OPTION_QUATERNION = 7, UT_OPTION_MATRIX3 = 8, UT_OPTION_MATRIX4 = 9, UT_OPTION_UV = 10,   UT_OPTION_UVW = 11, UT_OPTION_STRINGRAW = 12, UT_OPTION_INTARRAY = 13, UT_OPTION_FPREALARRAY = 14,   UT_OPTION_MATRIX2 = 15, UT_OPTION_STRINGARRAY = 16, UT_OPTION_DICT = 17, UT_OPTION_DICTARRAY = 18,   UT_OPTION_STRINGRAWARRAY = 19, UT_OPTION_STRINGUTF8 = 20, UT_OPTION_STRINGUTF8ARRAY = 21, UT_OPTION_NUM_TYPES }
enum	UT_OptionFormat { UT_OPTFMT_DISPLAY, UT_OPTFMT_PYTHON, UT_OPTFMT_VEX, UT_OPTFMT_NUM_TYPES }
	String formatting options for getOptionString. More...

Functions
SYS_FORCE_INLINE size_t	hash_value (const UT_OptionsRef &opt)
SYS_FORCE_INLINE size_t	hash_value (const UT_OptionsHolder &opt)
UT_API size_t	format (char *buffer, size_t buffer_size, const UT_Options &v)
UT_API size_t	format (char *buffer, size_t buffer_size, const UT_OptionsRef &v)

Typedef Documentation

using UT_OptionEntryPtr = UT_UniquePtr<UT_OptionEntry>

Definition at line 84 of file UT_Options.h.

Enumeration Type Documentation

enum UT_OptionFormat

String formatting options for getOptionString.

Enumerator
UT_OPTFMT_DISPLAY
UT_OPTFMT_PYTHON
UT_OPTFMT_VEX
UT_OPTFMT_NUM_TYPES

Definition at line 74 of file UT_Options.h.

enum UT_OptionType

Enumerator
UT_OPTION_INVALID
UT_OPTION_INT
UT_OPTION_BOOL
UT_OPTION_FPREAL
UT_OPTION_STRING
UT_OPTION_VECTOR2
UT_OPTION_VECTOR3
UT_OPTION_VECTOR4
UT_OPTION_QUATERNION
UT_OPTION_MATRIX3
UT_OPTION_MATRIX4
UT_OPTION_UV
UT_OPTION_UVW
UT_OPTION_STRINGRAW
UT_OPTION_INTARRAY
UT_OPTION_FPREALARRAY
UT_OPTION_MATRIX2
UT_OPTION_STRINGARRAY
UT_OPTION_DICT
UT_OPTION_DICTARRAY
UT_OPTION_STRINGRAWARRAY
UT_OPTION_STRINGUTF8
UT_OPTION_STRINGUTF8ARRAY
UT_OPTION_NUM_TYPES

Definition at line 44 of file UT_Options.h.

Function Documentation

UT_API size_t format	(	char *	buffer,
		size_t	buffer_size,
		const UT_Options &	v
	)

UT_API size_t format	(	char *	buffer,
		size_t	buffer_size,
		const UT_OptionsRef &	v
	)

SYS_FORCE_INLINE size_t hash_value

(

const UT_OptionsRef &

opt

)

Definition at line 1084 of file UT_Options.h.

SYS_FORCE_INLINE size_t hash_value

(

const UT_OptionsHolder &

opt

)

Definition at line 1250 of file UT_Options.h.