clipsAPI.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 USD_GENERATED_CLIPSAPI_H
#define USD_GENERATED_CLIPSAPI_H


#include "pxr/pxr.h"
#include "pxr/usd/usd/api.h"
#include "pxr/usd/usd/apiSchemaBase.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/usd/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;

// -------------------------------------------------------------------------- //
// CLIPSAPI                                                                   //
// -------------------------------------------------------------------------- //

class UsdClipsAPI : public UsdAPISchemaBase
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::NonAppliedAPI;

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

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

    USD_API
    virtual ~UsdClipsAPI();

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

    USD_API
    static UsdClipsAPI
    Get(const UsdStagePtr &stage, const SdfPath &path);


protected:
    USD_API
    UsdSchemaKind _GetSchemaKind() const override;

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

    static bool _IsTypedSchema();

    // override SchemaBase virtuals.
    USD_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)--
    //

    // --------------------------------------------------------------------- //
    // --------------------------------------------------------------------- //

    USD_API
    bool GetClips(VtDictionary* clips) const;

    USD_API
    bool SetClips(const VtDictionary& clips);

    USD_API
    bool GetClipSets(SdfStringListOp* clipSets) const;

    USD_API
    bool SetClipSets(const SdfStringListOp& clipSets);

    USD_API
    VtArray<SdfAssetPath>
    ComputeClipAssetPaths(const std::string& clipSet) const;

    USD_API
    VtArray<SdfAssetPath> ComputeClipAssetPaths() const;

    USD_API
    bool GetClipAssetPaths(VtArray<SdfAssetPath>* assetPaths,
                           const std::string& clipSet) const;
    USD_API
    bool GetClipAssetPaths(VtArray<SdfAssetPath>* assetPaths) const;

    USD_API
    bool SetClipAssetPaths(const VtArray<SdfAssetPath>& assetPaths,
                           const std::string& clipSet);
    USD_API
    bool SetClipAssetPaths(const VtArray<SdfAssetPath>& assetPaths);

    USD_API
    bool GetClipPrimPath(std::string* primPath, 
                         const std::string& clipSet) const;
    USD_API
    bool GetClipPrimPath(std::string* primPath) const;

    USD_API
    bool SetClipPrimPath(const std::string& primPath, 
                         const std::string& clipSet);
    USD_API
    bool SetClipPrimPath(const std::string& primPath);

    USD_API
    bool GetClipActive(VtVec2dArray* activeClips, 
                       const std::string& clipSet) const;
    USD_API
    bool GetClipActive(VtVec2dArray* activeClips) const;

    USD_API
    bool SetClipActive(const VtVec2dArray& activeClips, 
                       const std::string& clipSet);
    USD_API
    bool SetClipActive(const VtVec2dArray& activeClips);

    USD_API
    bool GetClipTimes(VtVec2dArray* clipTimes, 
                      const std::string& clipSet) const;
    USD_API
    bool GetClipTimes(VtVec2dArray* clipTimes) const;

    USD_API
    bool SetClipTimes(const VtVec2dArray& clipTimes, 
                      const std::string& clipSet);
    USD_API
    bool SetClipTimes(const VtVec2dArray& clipTimes);

    USD_API
    bool GetClipManifestAssetPath(SdfAssetPath* manifestAssetPath,
                                  const std::string& clipSet) const;
    USD_API
    bool GetClipManifestAssetPath(SdfAssetPath* manifestAssetPath) const;

    USD_API
    bool SetClipManifestAssetPath(const SdfAssetPath& manifestAssetPath,
                                  const std::string& clipSet);
    USD_API
    bool SetClipManifestAssetPath(const SdfAssetPath& manifestAssetPath);

    USD_API
    SdfLayerRefPtr GenerateClipManifest(
        const std::string& clipSet,
        bool writeBlocksForClipsWithMissingValues = false) const;

    USD_API
    SdfLayerRefPtr GenerateClipManifest(
        bool writeBlocksForClipsWithMissingValues = false) const;

    USD_API
    static SdfLayerRefPtr 
    GenerateClipManifestFromLayers(const SdfLayerHandleVector& clipLayers, 
                                   const SdfPath& clipPrimPath);

    // Flag indicating whether values for a clip that does not contain authored
    // time samples are interpolated from surrounding clips.
    //
    // If this flag is set, values for clips that do not have authored time
    // samples for an attribute that is declared in the manifest without a
    // fallback value will be interpolated from values in surrounding clips.
    // This is disabled by default.
    USD_API
    bool GetInterpolateMissingClipValues(bool* interpolate,
                                         const std::string& clipSet) const;

    USD_API
    bool GetInterpolateMissingClipValues(bool* interpolate) const;

    USD_API
    bool SetInterpolateMissingClipValues(bool interpolate,
                                         const std::string& clipSet);

    USD_API
    bool SetInterpolateMissingClipValues(bool interpolate);

    USD_API
    bool GetClipTemplateAssetPath(std::string* clipTemplateAssetPath, 
                                  const std::string& clipSet) const;
    USD_API
    bool GetClipTemplateAssetPath(std::string* clipTemplateAssetPath) const;

    USD_API
    bool SetClipTemplateAssetPath(const std::string& clipTemplateAssetPath, 
                                  const std::string& clipSet);
    USD_API
    bool SetClipTemplateAssetPath(const std::string& clipTemplateAssetPath);

    USD_API
    bool GetClipTemplateStride(double* clipTemplateStride, 
                               const std::string& clipSet) const;
    USD_API
    bool GetClipTemplateStride(double* clipTemplateStride) const;

    USD_API
    bool SetClipTemplateActiveOffset(const double clipTemplateActiveOffset,
                                     const std::string& clipSet);

    USD_API
    bool SetClipTemplateActiveOffset(const double clipTemplateActiveOffset);

    USD_API
    bool GetClipTemplateActiveOffset(double* clipTemplateActiveOffset,
                                     const std::string& clipSet) const;

    USD_API
    bool GetClipTemplateActiveOffset(double* clipTemplateActiveOffset) const;

    USD_API
    bool SetClipTemplateStride(const double clipTemplateStride, 
                               const std::string& clipSet);
    USD_API
    bool SetClipTemplateStride(const double clipTemplateStride);

    USD_API
    bool GetClipTemplateStartTime(double* clipTemplateStartTime, 
                                  const std::string& clipSet) const;
    USD_API
    bool GetClipTemplateStartTime(double* clipTemplateStartTime) const;

    USD_API
    bool SetClipTemplateStartTime(const double clipTemplateStartTime, 
                                  const std::string& clipSet);
    USD_API
    bool SetClipTemplateStartTime(const double clipTemplateStartTime);

    USD_API
    bool GetClipTemplateEndTime(double* clipTemplateEndTime, 
                                const std::string& clipSet) const;
    USD_API
    bool GetClipTemplateEndTime(double* clipTemplateEndTime) const;

    USD_API
    bool SetClipTemplateEndTime(const double clipTemplateEndTime, 
                                const std::string& clipSet);
    USD_API
    bool SetClipTemplateEndTime(const double clipTemplateEndTime);


};

#define USDCLIPS_INFO_KEYS  \
    (active)                \
    (assetPaths)            \
    (interpolateMissingClipValues) \
    (manifestAssetPath)     \
    (primPath)              \
    (templateAssetPath)     \
    (templateEndTime)       \
    (templateStartTime)     \
    (templateStride)        \
    (templateActiveOffset)  \
    (times)                 \

TF_DECLARE_PUBLIC_TOKENS(UsdClipsAPIInfoKeys, USD_API, USDCLIPS_INFO_KEYS);

#define USDCLIPS_SET_NAMES     \
    ((default_, "default"))    \

TF_DECLARE_PUBLIC_TOKENS(UsdClipsAPISetNames, USD_API, USDCLIPS_SET_NAMES);

PXR_NAMESPACE_CLOSE_SCOPE

#endif