accessibilityAPI.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef USDUI_GENERATED_ACCESSIBILITYAPI_H
#define USDUI_GENERATED_ACCESSIBILITYAPI_H


#include "pxr/pxr.h"
#include "pxr/usd/usdUI/api.h"
#include "pxr/usd/usd/apiSchemaBase.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/usdUI/tokens.h"

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

#include "pxr/base/gf/vec3d.h"
#include "pxr/base/gf/vec3f.h"
#include "pxr/base/gf/matrix4d.h"

#include "pxr/base/tf/token.h"
#include "pxr/base/tf/type.h"

PXR_NAMESPACE_OPEN_SCOPE

class SdfAssetPath;

// -------------------------------------------------------------------------- //
// ACCESSIBILITYAPI                                                           //
// -------------------------------------------------------------------------- //

class UsdUIAccessibilityAPI : public UsdAPISchemaBase
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI;

    explicit UsdUIAccessibilityAPI(
        const UsdPrim& prim=UsdPrim(), const TfToken &name=TfToken())
        : UsdAPISchemaBase(prim, /*instanceName*/ name)
    { }

    explicit UsdUIAccessibilityAPI(
        const UsdSchemaBase& schemaObj, const TfToken &name)
        : UsdAPISchemaBase(schemaObj, /*instanceName*/ name)
    { }

    USDUI_API
    virtual ~UsdUIAccessibilityAPI();

    USDUI_API
    static const TfTokenVector &
    GetSchemaAttributeNames(bool includeInherited=true);

    USDUI_API
    static TfTokenVector
    GetSchemaAttributeNames(bool includeInherited, const TfToken &instanceName);

    TfToken GetName() const {
        return _GetInstanceName();
    }

    USDUI_API
    static UsdUIAccessibilityAPI
    Get(const UsdStagePtr &stage, const SdfPath &path);

    USDUI_API
    static UsdUIAccessibilityAPI
    Get(const UsdPrim &prim, const TfToken &name);

    USDUI_API
    static std::vector<UsdUIAccessibilityAPI>
    GetAll(const UsdPrim &prim);

    USDUI_API
    static bool
    IsSchemaPropertyBaseName(const TfToken &baseName);

    USDUI_API
    static bool
    IsAccessibilityAPIPath(const SdfPath &path, TfToken *name);

    USDUI_API
    static bool 
    CanApply(const UsdPrim &prim, const TfToken &name, 
             std::string *whyNot=nullptr);

    USDUI_API
    static UsdUIAccessibilityAPI 
    Apply(const UsdPrim &prim, const TfToken &name);

protected:
    USDUI_API
    UsdSchemaKind _GetSchemaKind() const override;

private:
    // needs to invoke _GetStaticTfType.
    friend class UsdSchemaRegistry;
    USDUI_API
    static const TfType &_GetStaticTfType();

    static bool _IsTypedSchema();

    // override SchemaBase virtuals.
    USDUI_API
    const TfType &_GetTfType() const override;

public:
    // --------------------------------------------------------------------- //
    // LABEL 
    // --------------------------------------------------------------------- //
    USDUI_API
    UsdAttribute GetLabelAttr() const;

    USDUI_API
    UsdAttribute CreateLabelAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // DESCRIPTION 
    // --------------------------------------------------------------------- //
    USDUI_API
    UsdAttribute GetDescriptionAttr() const;

    USDUI_API
    UsdAttribute CreateDescriptionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // PRIORITY 
    // --------------------------------------------------------------------- //
    USDUI_API
    UsdAttribute GetPriorityAttr() const;

    USDUI_API
    UsdAttribute CreatePriorityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // ===================================================================== //
    // Feel free to add custom code below this line, it will be preserved by 
    // the code generator. 
    //
    // Just remember to: 
    //  - Close the class declaration with }; 
    //  - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
    //  - Close the include guard with #endif
    // ===================================================================== //
    // --(BEGIN CUSTOM CODE)--

    USDUI_API
    static UsdUIAccessibilityAPI CreateDefaultAPI(const UsdPrim& prim);

    USDUI_API
    static UsdUIAccessibilityAPI CreateDefaultAPI(const UsdSchemaBase& schemaObj);

    USDUI_API
    static UsdUIAccessibilityAPI ApplyDefaultAPI(const UsdPrim& prim);
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif