primHints.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_PRIM_HINTS_H
#define PXR_USD_USDUI_PRIM_HINTS_H


#include "pxr/usd/usdUI/objectHints.h"
#include "pxr/usd/usd/prim.h"

#include "pxr/base/vt/dictionary.h"

PXR_NAMESPACE_OPEN_SCOPE

class UsdUIPrimHints : public UsdUIObjectHints
{
public:
    USDUI_API
    UsdUIPrimHints();

    USDUI_API
    explicit UsdUIPrimHints(const UsdPrim& prim);

    UsdPrim GetPrim() const { return _prim; }

    USDUI_API
    VtDictionary GetDisplayGroupsExpanded() const;

    USDUI_API
    bool SetDisplayGroupsExpanded(const VtDictionary& expanded);

    USDUI_API
    bool GetDisplayGroupExpanded(const std::string& group) const;

    USDUI_API
    bool SetDisplayGroupExpanded(
        const std::string& group,
        bool expanded);

    USDUI_API
    VtDictionary GetDisplayGroupsShownIf() const;

    USDUI_API
    bool SetDisplayGroupsShownIf(const VtDictionary& shownIf);

    USDUI_API
    std::string GetDisplayGroupShownIf(const std::string& group) const;

    USDUI_API
    bool SetDisplayGroupShownIf(
        const std::string& group,
        const std::string& shownIf);

private:
    UsdPrim _prim;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif