HOM_Utils.h

Go to the documentation of this file.

/*
* PROPRIETARY INFORMATION.  This software is proprietary to
* Side Effects Software Inc., and is not to be reproduced,
* transmitted, or disclosed in any way without written permission.
*
* COMMENTS:
*/

#ifndef __HOM_Utils_h__
#define __HOM_Utils_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_EnumValue.h"
#include <UT/UT_Options.h>
#include <hboost/any.hpp>
#include <map>

//----------------------------------------------------------------------------
// UT_Options

// Returns the UT_OptionType for a hou.fieldType enum value.
HOM_API UT_OptionType HOMoptionTypeForEnumValue(
        HOM_EnumValue &enum_value);

// Returns the hou.fieldType enum value given a UT_OptionType.
HOM_API HOM_EnumValue &HOMoptionTypeToEnumValue(
        UT_OptionType optiontype);

// Sets an option from a HOM_UTOptionAny value.  The type hint is used only
// when the value type is ambiguous (ex: HOM_Vector2 can be mapped to either
// UT_OPTION_VECTOR2 or UT_OPTION_UV).
HOM_API bool HOMsetOptionFromUTOptionAny(
        UT_Options &options, const char *name, const HOM_UTOptionAny &value,
        UT_OptionType hint = UT_OPTION_INVALID);

// Sets up an options from a map of anys.
HOM_API void HOMsetOptionsFromStdMap(
        UT_Options &options,
        const std::map<std::string, hboost::any> &map);

// Converts an option any into a hboost::any
HOM_API hboost::any HOMoptionEntryToBoostAny(
        const UT_OptionEntry &option_entry);

// Converts a UT_Options into a map of hboost::any.
HOM_API std::map<std::string, hboost::any> HOMoptionsToStdMap(
        const UT_Options &options);

#endif