assetPreviewsAPI.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef USDMEDIA_GENERATED_ASSETPREVIEWSAPI_H
#define USDMEDIA_GENERATED_ASSETPREVIEWSAPI_H


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

#include "pxr/usd/sdf/types.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;

// -------------------------------------------------------------------------- //
// ASSETPREVIEWSAPI                                                           //
// -------------------------------------------------------------------------- //

class UsdMediaAssetPreviewsAPI : public UsdAPISchemaBase
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;

    explicit UsdMediaAssetPreviewsAPI(const UsdPrim& prim=UsdPrim())
        : UsdAPISchemaBase(prim)
    {
    }

    explicit UsdMediaAssetPreviewsAPI(const UsdSchemaBase& schemaObj)
        : UsdAPISchemaBase(schemaObj)
    {
    }

    USDMEDIA_API
    virtual ~UsdMediaAssetPreviewsAPI();

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

    USDMEDIA_API
    static UsdMediaAssetPreviewsAPI
    Get(const UsdStagePtr &stage, const SdfPath &path);


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

    USDMEDIA_API
    static UsdMediaAssetPreviewsAPI 
    Apply(const UsdPrim &prim);

protected:
    USDMEDIA_API
    UsdSchemaKind _GetSchemaKind() const override;

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

    static bool _IsTypedSchema();

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

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)--
    
    struct Thumbnails
    {
        USDMEDIA_API
        explicit Thumbnails(const SdfAssetPath &defaultImage=SdfAssetPath());

        SdfAssetPath   defaultImage;
    };
    
    USDMEDIA_API
    bool GetDefaultThumbnails(Thumbnails *defaultThumbnails) const;

    USDMEDIA_API
    void SetDefaultThumbnails(const Thumbnails &defaultThumbnails) const;
    
    USDMEDIA_API
    void ClearDefaultThumbnails() const;

    USDMEDIA_API
    static UsdMediaAssetPreviewsAPI 
    GetAssetDefaultPreviews(const std::string &layerPath);
    
    USDMEDIA_API
    static UsdMediaAssetPreviewsAPI 
    GetAssetDefaultPreviews(const SdfLayerHandle &layer);

private:
    UsdStageRefPtr _defaultMaskedStage;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif