Loading...
Searching...
No Matches
stitchClips.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the Apache License, Version 2.0 (the "Apache License")
5// with the following modification; you may not use this file except in
6// compliance with the Apache License and the following modification to it:
7// Section 6. Trademarks. is deleted and replaced with:
8//
9// 6. Trademarks. This License does not grant permission to use the trade
10// names, trademarks, service marks, or product names of the Licensor
11// and its affiliates, except as required to comply with Section 4(c) of
12// the License and to reproduce the content of the NOTICE file.
13//
14// You may obtain a copy of the Apache License at
15//
16// http://www.apache.org/licenses/LICENSE-2.0
17//
18// Unless required by applicable law or agreed to in writing, software
19// distributed under the Apache License with the above modification is
20// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21// KIND, either express or implied. See the Apache License for the specific
22// language governing permissions and limitations under the Apache License.
23//
24#ifndef PXR_USD_USD_UTILS_STITCH_CLIPS_H
25#define PXR_USD_USD_UTILS_STITCH_CLIPS_H
26
32
33#include "pxr/pxr.h"
34#include "pxr/usd/usdUtils/api.h"
37#include "pxr/usd/sdf/path.h"
38
39#include <limits>
40
41PXR_NAMESPACE_OPEN_SCOPE
42
43SDF_DECLARE_HANDLES(SdfLayer);
44
120USDUTILS_API
121bool
122UsdUtilsStitchClips(const SdfLayerHandle& resultLayer,
123 const std::vector<std::string>& clipLayerFiles,
124 const SdfPath& clipPath,
125 const double startTimeCode
126 = std::numeric_limits<double>::max(),
127 const double endTimeCode
128 = std::numeric_limits<double>::max(),
129 const bool interpolateMissingClipValues
130 = false,
131 const TfToken& clipSet
132 = UsdClipsAPISetNames->default_);
133
144USDUTILS_API
145bool
146UsdUtilsStitchClipsTopology(const SdfLayerHandle& topologyLayer,
147 const std::vector<std::string>& clipLayerFiles);
148
164USDUTILS_API
165bool
166UsdUtilsStitchClipsManifest(const SdfLayerHandle& manifestLayer,
167 const SdfLayerHandle& topologyLayer,
168 const std::vector<std::string>& clipLayerFiles,
169 const SdfPath& clipPath);
170
219USDUTILS_API
220bool
221UsdUtilsStitchClipsTemplate(const SdfLayerHandle& resultLayer,
222 const SdfLayerHandle& topologyLayer,
223 const SdfLayerHandle& manifestLayer,
224 const SdfPath& clipPath,
225 const std::string& templatePath,
226 const double startTime,
227 const double endTime,
228 const double stride,
229 const double activeOffset
230 = std::numeric_limits<double>::max(),
231 const bool interpolateMissingClipValues
232 = false,
233 const TfToken& clipSet
234 = UsdClipsAPISetNames->default_);
235
245USDUTILS_API
246std::string
247UsdUtilsGenerateClipTopologyName(const std::string& rootLayerName);
248
258USDUTILS_API
259std::string
260UsdUtilsGenerateClipManifestName(const std::string& rootLayerName);
261
262PXR_NAMESPACE_CLOSE_SCOPE
263
264#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:100
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
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...