All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 USDUTILS_STITCH_CLIPS_H
25 #define USDUTILS_STITCH_CLIPS_H
26 
32 
33 #include "pxr/pxr.h"
34 #include "pxr/usd/usdUtils/api.h"
35 #include "pxr/usd/usd/clipsAPI.h"
36 #include "pxr/usd/sdf/declareHandles.h"
37 #include "pxr/usd/sdf/path.h"
38 
39 #include <limits>
40 
41 PXR_NAMESPACE_OPEN_SCOPE
42 
43 SDF_DECLARE_HANDLES(SdfLayer);
44 
108 USDUTILS_API
109 bool
110 UsdUtilsStitchClips(const SdfLayerHandle& resultLayer,
111  const std::vector<std::string>& clipLayerFiles,
112  const SdfPath& clipPath,
113  const double startTimeCode
114  = std::numeric_limits<double>::max(),
115  const double endTimeCode
116  = std::numeric_limits<double>::max(),
117  const TfToken& clipSet
118  = UsdClipsAPISetNames->default_);
119 
130 USDUTILS_API
131 bool
132 UsdUtilsStitchClipsTopology(const SdfLayerHandle& topologyLayer,
133  const std::vector<std::string>& clipLayerFiles);
134 
174 USDUTILS_API
175 bool
176 UsdUtilsStitchClipsTemplate(const SdfLayerHandle& resultLayer,
177  const SdfLayerHandle& topologyLayer,
178  const SdfPath& clipPath,
179  const std::string& templatePath,
180  const double startTime,
181  const double endTime,
182  const double stride,
183  const double activeOffset
184  = std::numeric_limits<double>::max(),
185  const TfToken& clipSet
186  = UsdClipsAPISetNames->default_);
187 
197 USDUTILS_API
198 std::string
199 UsdUtilsGenerateClipTopologyName(const std::string& rootLayerName);
200 
201 
202 PXR_NAMESPACE_CLOSE_SCOPE
203 
204 #endif /* USDUTILS_STITCH_CLIPS_H */
A unit of scene description that you combine with other units of scene description to form a shot...
Definition: layer.h:93
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&#39;s Value Clips syst...
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 TfToken &clipSet=UsdClipsAPISetNames->default_)
A function that creates layers that use USD Value Clips to effectively merge the time samples in the ...
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
USDUTILS_API std::string UsdUtilsGenerateClipTopologyName(const std::string &rootLayerName)
Generates a topology file name based on an input file name.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
USDUTILS_API bool UsdUtilsStitchClipsTemplate(const SdfLayerHandle &resultLayer, const SdfLayerHandle &topologyLayer, 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 TfToken &clipSet=UsdClipsAPISetNames->default_)
A function which authors clip template metadata on a particular prim in a result layer, as well as adding the topologyLayer to the list of subLayers on the resultLayer.