authorshipAPI.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 USDMEDIA_GENERATED_AUTHORSHIPAPI_H
#define USDMEDIA_GENERATED_AUTHORSHIPAPI_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/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;
 
// -------------------------------------------------------------------------- //
// AUTHORSHIPAPI                                                              //
// -------------------------------------------------------------------------- //
 
class UsdMediaAuthorshipAPI : public UsdAPISchemaBase
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI;
 
    explicit UsdMediaAuthorshipAPI(
        const UsdPrim& prim=UsdPrim(), const TfToken &name=TfToken())
        : UsdAPISchemaBase(prim, /*instanceName*/ name)
    { }
 
    explicit UsdMediaAuthorshipAPI(
        const UsdSchemaBase& schemaObj, const TfToken &name)
        : UsdAPISchemaBase(schemaObj, /*instanceName*/ name)
    { }
 
    USDMEDIA_API
    virtual ~UsdMediaAuthorshipAPI();
 
    USDMEDIA_API
    static const TfTokenVector &
    GetSchemaAttributeNames(bool includeInherited=true);
 
    USDMEDIA_API
    static TfTokenVector
    GetSchemaAttributeNames(bool includeInherited, const TfToken &instanceName);
 
    TfToken GetName() const {
        return _GetInstanceName();
    }
 
    USDMEDIA_API
    static UsdMediaAuthorshipAPI
    Get(const UsdStagePtr &stage, const SdfPath &path);
 
    USDMEDIA_API
    static UsdMediaAuthorshipAPI
    Get(const UsdPrim &prim, const TfToken &name);
 
    USDMEDIA_API
    static std::vector<UsdMediaAuthorshipAPI>
    GetAll(const UsdPrim &prim);
 
    USDMEDIA_API
    static bool
    IsSchemaPropertyBaseName(const TfToken &baseName);
 
    USDMEDIA_API
    static bool
    IsAuthorshipAPIPath(const SdfPath &path, TfToken *name);
 
    USDMEDIA_API
    static bool 
    CanApply(const UsdPrim &prim, const TfToken &name, 
             std::string *whyNot=nullptr);
 
    USDMEDIA_API
    static UsdMediaAuthorshipAPI 
    Apply(const UsdPrim &prim, const TfToken &name);
 
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:
    // --------------------------------------------------------------------- //
    // SOFTWAREPACKAGE 
    // --------------------------------------------------------------------- //
    USDMEDIA_API
    UsdAttribute GetSoftwarePackageAttr() const;
 
    USDMEDIA_API
    UsdAttribute CreateSoftwarePackageAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // SOFTWAREVERSION 
    // --------------------------------------------------------------------- //
    USDMEDIA_API
    UsdAttribute GetSoftwareVersionAttr() const;
 
    USDMEDIA_API
    UsdAttribute CreateSoftwareVersionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // DIGITALSOURCETYPE 
    // --------------------------------------------------------------------- //
    USDMEDIA_API
    UsdAttribute GetDigitalSourceTypeAttr() const;
 
    USDMEDIA_API
    UsdAttribute CreateDigitalSourceTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // CREATOR 
    // --------------------------------------------------------------------- //
    USDMEDIA_API
    UsdAttribute GetCreatorAttr() const;
 
    USDMEDIA_API
    UsdAttribute CreateCreatorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // DESCRIPTION 
    // --------------------------------------------------------------------- //
    USDMEDIA_API
    UsdAttribute GetDescriptionAttr() const;
 
    USDMEDIA_API
    UsdAttribute CreateDescriptionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // INPUTS 
    // --------------------------------------------------------------------- //
    USDMEDIA_API
    UsdAttribute GetInputsAttr() const;
 
    USDMEDIA_API
    UsdAttribute CreateInputsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // CREATED 
    // --------------------------------------------------------------------- //
    USDMEDIA_API
    UsdAttribute GetCreatedAttr() const;
 
    USDMEDIA_API
    UsdAttribute CreateCreatedAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // INSTANCEID 
    // --------------------------------------------------------------------- //
    USDMEDIA_API
    UsdAttribute GetInstanceIDAttr() const;
 
    USDMEDIA_API
    UsdAttribute CreateInstanceIDAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // USAGETERMS 
    // --------------------------------------------------------------------- //
    USDMEDIA_API
    UsdAttribute GetUsageTermsAttr() const;
 
    USDMEDIA_API
    UsdAttribute CreateUsageTermsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // COPYRIGHTOWNER 
    // --------------------------------------------------------------------- //
    USDMEDIA_API
    UsdAttribute GetCopyrightOwnerAttr() const;
 
    USDMEDIA_API
    UsdAttribute CreateCopyrightOwnerAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // CONTACT 
    // --------------------------------------------------------------------- //
    USDMEDIA_API
    UsdAttribute GetContactAttr() const;
 
    USDMEDIA_API
    UsdAttribute CreateContactAttr(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)--
 
    USDMEDIA_API
    static std::vector<UsdMediaAuthorshipAPI>
    GetAllOnStage(const UsdStagePtr &stage);
 
    USDMEDIA_API
    static std::vector<UsdMediaAuthorshipAPI>
    ComputeAccumulatedRecords(const UsdPrim &prim);
 
    USDMEDIA_API
    static std::vector<UsdMediaAuthorshipAPI>
    GetAllUnder(const UsdPrim &prim);
 
 
    USDMEDIA_API
    static std::vector<UsdMediaAuthorshipAPI>
    GetShadowed(const UsdPrim &prim);
 
    USDMEDIA_API
    static std::vector<UsdMediaAuthorshipAPI>
    GetDuplicates(const UsdPrim &prim);
 
    USDMEDIA_API
    static std::vector<UsdMediaAuthorshipAPI>
    GetAllShadowed(const UsdStagePtr &stage);
 
    USDMEDIA_API
    static std::vector<UsdMediaAuthorshipAPI>
    GetAllDuplicates(const UsdStagePtr &stage);
 
 
    USDMEDIA_API
    static SdfPathVector
    GetAllInLayer(const SdfLayerHandle &layer);
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif