propertyHints.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_PROPERTY_HINTS_H
#define PXR_USD_USDUI_PROPERTY_HINTS_H


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

PXR_NAMESPACE_OPEN_SCOPE

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

    USDUI_API
    explicit UsdUIPropertyHints(const UsdProperty& prop);

    UsdProperty GetProperty() const { return _prop; }

    USDUI_API
    std::string GetDisplayGroup() const;

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

    USDUI_API
    std::string GetShownIf() const;

    USDUI_API
    bool SetShownIf(const std::string& shownIf);

private:
    UsdProperty _prop;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif