HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | List of all members
SIM_Options Class Reference

#include <SIM_Options.h>

+ Inheritance diagram for SIM_Options:

Public Member Functions

 SIM_Options ()
 
 SIM_Options (SIM_OptionsUser *owner)
 
 ~SIM_Options () override
 
void setOptionFromPointAttribute (GA_Offset ptoff, const GA_Attribute *attrib)
 
const SIM_Options & operator= (const SIM_Options &src)
 
- Public Member Functions inherited from OP_Options
 OP_Options ()
 
 ~OP_Options () override
 
 OP_Options (const OP_Options &)=delete
 
void interpolate (const OP_Options &source1, const OP_Options &source2, fpreal interp)
 
void setOptionFromTemplate (const OP_Node *node, const PRM_Template &tplate, int pi, fpreal time, bool usetemplatetoken=false, DEP_MicroNode *depnode=0, UT_Array< CH_Channel * > *channels=0)
 
void setOptionFromTemplate (const OP_Node *node, const PRM_Parm &parm, const PRM_Template &tplate, fpreal time, bool usetemplatetoken=false, DEP_MicroNode *depnode=0, UT_Array< CH_Channel * > *channels=0, const UT_StringRef *option_name=0)
 
void setOptionFromParm (const OP_Node *node, int pi, int vi, fpreal time)
 
void setOptionFromTemplateDefault (const PRM_Template &tp)
 
bool setOptionFromCommand (const char *optionname, const char *optionvalue, fpreal optionvaluefloat, UT_OptionType optiontype)
 
UT_DMatrix4 getTransformFromOptions () const
 
const OP_Options & operator= (const UT_Options &src)
 Set one OP_Options equal to another. More...
 
- 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)
 

Protected Member Functions

void optionChanged (const char *name) override
 
- Protected Member Functions inherited from OP_Options
void getInterpolatedInt (int64 &value, int64 source1, int64 source2, fpreal interp) const
 These functions perform the actual interpolation of each data type. More...
 
void getInterpolatedBool (bool &value, bool source1, bool source2, fpreal interp) const
 
void getInterpolatedFpreal (fpreal64 &value, fpreal source1, fpreal source2, fpreal interp) const
 
void getInterpolatedString (UT_StringHolder &value, const UT_StringHolder &source1, const UT_StringHolder &source2, fpreal interp) const
 
void getInterpolatedDict (UT_OptionsHolder &value, const UT_OptionsHolder &source1, const UT_OptionsHolder &source2, fpreal interp) const
 
void getInterpolatedVector2 (UT_Vector2D &value, const UT_Vector2D &source1, const UT_Vector2D &source2, fpreal interp) const
 
void getInterpolatedVector3 (UT_Vector3D &value, const UT_Vector3D &source1, const UT_Vector3D &source2, fpreal interp) const
 
void getInterpolatedVector4 (UT_Vector4D &value, const UT_Vector4D &source1, const UT_Vector4D &source2, fpreal interp) const
 
void getInterpolatedQuaternion (UT_QuaternionD &value, const UT_QuaternionD &source1, const UT_QuaternionD &source2, fpreal interp) const
 
void getInterpolatedMatrix2 (UT_Matrix2D &value, const UT_Matrix2D &source1, const UT_Matrix2D &source2, fpreal interp) const
 
void getInterpolatedMatrix3 (UT_Matrix3D &value, const UT_Matrix3D &source1, const UT_Matrix3D &source2, fpreal interp) const
 
void getInterpolatedMatrix4 (UT_Matrix4D &value, const UT_Matrix4D &source1, const UT_Matrix4D &source2, fpreal interp) const
 
void getInterpolatedIntArray (UT_Int64Array &value, const UT_Int64Array &source1, const UT_Int64Array &source2, fpreal interp)
 
void getInterpolatedFprealArray (UT_Fpreal64Array &value, const UT_Fpreal64Array &source1, const UT_Fpreal64Array &source2, fpreal interp)
 
void getInterpolatedStringArray (UT_StringArray &value, const UT_StringArray &source1, const UT_StringArray &source2, fpreal interp)
 
void getInterpolatedDictArray (UT_Array< UT_OptionsHolder > &value, const UT_Array< UT_OptionsHolder > &source1, const UT_Array< UT_OptionsHolder > &source2, fpreal interp)
 
- 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)
 
UT_OptionEntryPtr parsePyValue (const char *&value, char sep_delim, char close_delim= '\0')
 

Additional Inherited Members

- Static Public Member Functions inherited from OP_Options
static UT_OptionType getOptionTypeFromTemplate (const PRM_Template &tp)
 
- 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...
 

Detailed Description

This class stores a set of name/value pairs. Each value can be one of several different data types. No automatic conversion between data types is provided, so accessing existing data requires knowledge of both the data name and the data type.

Examples:
SIM/SIM_ForceOrbit.C, SIM/SIM_ForceOrbit.h, SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.

Definition at line 27 of file SIM_Options.h.

Constructor & Destructor Documentation

SIM_Options::SIM_Options ( )
explicit
SIM_Options::SIM_Options ( SIM_OptionsUser *  owner)
explicit
SIM_Options::~SIM_Options ( )
override

Member Function Documentation

const SIM_Options& SIM_Options::operator= ( const SIM_Options &  src)
void SIM_Options::optionChanged ( const char *  name)
overrideprotectedvirtual

This function is called whenever data is added, removed, or changed. If the name parameter is null, then multiple pieces of data were changed simultaneously (probably through a load or assignment operation). This function just calls SIM_OptionsUser::optionChanged() on each user of this data.

Reimplemented from OP_Options.

void SIM_Options::setOptionFromPointAttribute ( GA_Offset  ptoff,
const GA_Attribute *  attrib 
)

Sets an option based on a geometric point and an attribute. This utility function relieves the programmer from worrying about the data type of the attribute and mapping it to the matching SIM_Options data type.

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