This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
stitchClips.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef PXR_USD_USD_UTILS_STITCH_CLIPS_H
8#define PXR_USD_USD_UTILS_STITCH_CLIPS_H
9
15
16#include "pxr/pxr.h"
17#include "pxr/usd/usdUtils/api.h"
20#include "pxr/usd/sdf/path.h"
21
22#include <limits>
23
24PXR_NAMESPACE_OPEN_SCOPE
25
26SDF_DECLARE_HANDLES(SdfLayer);
27
103USDUTILS_API
104bool
105UsdUtilsStitchClips(const SdfLayerHandle& resultLayer,
106 const std::vector<std::string>& clipLayerFiles,
107 const SdfPath& clipPath,
108 const double startTimeCode
109 = std::numeric_limits<double>::max(),
110 const double endTimeCode
111 = std::numeric_limits<double>::max(),
112 const bool interpolateMissingClipValues
113 = false,
114 const TfToken& clipSet
115 = UsdClipsAPISetNames->default_);
116
127USDUTILS_API
128bool
129UsdUtilsStitchClipsTopology(const SdfLayerHandle& topologyLayer,
130 const std::vector<std::string>& clipLayerFiles);
131
147USDUTILS_API
148bool
149UsdUtilsStitchClipsManifest(const SdfLayerHandle& manifestLayer,
150 const SdfLayerHandle& topologyLayer,
151 const std::vector<std::string>& clipLayerFiles,
152 const SdfPath& clipPath);
153
202USDUTILS_API
203bool
204UsdUtilsStitchClipsTemplate(const SdfLayerHandle& resultLayer,
205 const SdfLayerHandle& topologyLayer,
206 const SdfLayerHandle& manifestLayer,
207 const SdfPath& clipPath,
208 const std::string& templatePath,
209 const double startTime,
210 const double endTime,
211 const double stride,
212 const double activeOffset
213 = std::numeric_limits<double>::max(),
214 const bool interpolateMissingClipValues
215 = false,
216 const TfToken& clipSet
217 = UsdClipsAPISetNames->default_);
218
228USDUTILS_API
229std::string
230UsdUtilsGenerateClipTopologyName(const std::string& rootLayerName);
231
241USDUTILS_API
242std::string
243UsdUtilsGenerateClipManifestName(const std::string& rootLayerName);
244
245PXR_NAMESPACE_CLOSE_SCOPE
246
247#endif /* PXR_USD_USD_UTILS_STITCH_CLIPS_H */
A scene description container that can combine with other such containers to form simple component as...
Definition: layer.h:84
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
USDUTILS_API std::string UsdUtilsGenerateClipManifestName(const std::string &rootLayerName)
Generates a manifest file name based on an input file name.
USDUTILS_API bool UsdUtilsStitchClips(const SdfLayerHandle &resultLayer, const std::vector< std::string > &clipLayerFiles, const SdfPath &clipPath, const double startTimeCode=std::numeric_limits< double >::max(), const double endTimeCode=std::numeric_limits< double >::max(), const bool interpolateMissingClipValues=false, const TfToken &clipSet=UsdClipsAPISetNames->default_)
A function that creates layers that use USD Value Clips to effectively merge the time samples in the ...
USDUTILS_API std::string UsdUtilsGenerateClipTopologyName(const std::string &rootLayerName)
Generates a topology file name based on an input file name.
USDUTILS_API bool UsdUtilsStitchClipsTemplate(const SdfLayerHandle &resultLayer, const SdfLayerHandle &topologyLayer, const SdfLayerHandle &manifestLayer, const SdfPath &clipPath, const std::string &templatePath, const double startTime, const double endTime, const double stride, const double activeOffset=std::numeric_limits< double >::max(), const bool interpolateMissingClipValues=false, const TfToken &clipSet=UsdClipsAPISetNames->default_)
A function which authors clip template metadata on a particular prim in a result layer,...
USDUTILS_API bool UsdUtilsStitchClipsManifest(const SdfLayerHandle &manifestLayer, const SdfLayerHandle &topologyLayer, const std::vector< std::string > &clipLayerFiles, const SdfPath &clipPath)
A function which creates a clip manifest from the set of clipLayerFiles for use in USD's Value Clips ...
USDUTILS_API bool UsdUtilsStitchClipsTopology(const SdfLayerHandle &topologyLayer, const std::vector< std::string > &clipLayerFiles)
A function which aggregates the topology of a set of clipLayerFiles for use in USD's Value Clips syst...