objectHints.h

Go to the documentation of this file.

//
// Copyright 2025 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
 
#ifndef PXR_USD_USDUI_OBJECT_HINTS_H
#define PXR_USD_USDUI_OBJECT_HINTS_H
 
 
#include "pxr/usd/usd/object.h"
#include "pxr/usd/usdUI/api.h"
 
#include "pxr/base/tf/envSetting.h"
#include "pxr/base/tf/staticTokens.h"
 
#include <string>
 
PXR_NAMESPACE_OPEN_SCOPE
 
USDUI_API
extern TfEnvSetting<bool> USDUI_WRITE_LEGACY_UI_HINTS;
 
#define USDUI_HINT_KEYS                                     \
    ((UIHints, "uiHints"))                                  \
    ((DisplayName, "displayName"))                          \
    ((DisplayGroup, "displayGroup"))                        \
    ((Hidden, "hidden"))                                    \
    ((ShownIf, "shownIf"))                                  \
    ((ValueLabels, "valueLabels"))                          \
    ((ValueLabelsOrder, "valueLabelsOrder"))                \
    ((DisplayGroupsExpanded, "displayGroupsExpanded"))      \
    ((DisplayGroupsShownIf, "displayGroupsShownIf"))        \
 
TF_DECLARE_PUBLIC_TOKENS(
    UsdUIHintKeys, USDUI_API, USDUI_HINT_KEYS);
 
class UsdUIObjectHints
{
public:
    USDUI_API
    UsdUIObjectHints();
 
    USDUI_API
    explicit UsdUIObjectHints(const UsdObject& obj);
 
    UsdObject GetObject() const { return _obj; }
 
    USDUI_API
    std::string GetDisplayName() const;
 
    USDUI_API
    bool SetDisplayName(const std::string& name);
 
    USDUI_API
    bool GetHidden() const;
 
    USDUI_API
    bool SetHidden(bool hidden);
 
    explicit operator bool() const {
        return bool(_obj);
    }
 
    bool operator==(const UsdUIObjectHints& rhs) const {
        return _obj == rhs._obj;
    }
 
    bool operator!=(const UsdUIObjectHints& rhs) const {
        return !(*this == rhs);
    }
 
protected:
    USDUI_API
    static TfToken _MakeKeyPath(
        const TfToken& key1,
        const TfToken& key2);
 
private:
    UsdObject _obj;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif