24#ifndef USD_GENERATED_CLIPSAPI_H
25#define USD_GENERATED_CLIPSAPI_H
30#include "pxr/usd/usd/api.h"
36#include "pxr/base/vt/value.h"
43#include "pxr/base/tf/type.h"
45PXR_NAMESPACE_OPEN_SCOPE
166 static const TfType &_GetStaticTfType();
168 static bool _IsTypedSchema();
172 const TfType &_GetTfType()
const override;
259 const std::string& clipSet)
const;
270 const std::string& clipSet);
288 const std::string& clipSet)
const;
299 const std::string& clipSet);
313 const std::string& clipSet)
const;
324 const std::string& clipSet);
343 const std::string& clipSet)
const;
354 const std::string& clipSet);
374 const std::string& clipSet)
const;
385 const std::string& clipSet);
407 const std::string& clipSet,
408 bool writeBlocksForClipsWithMissingValues =
false)
const;
415 bool writeBlocksForClipsWithMissingValues =
false)
const;
436 bool GetInterpolateMissingClipValues(
bool* interpolate,
437 const std::string& clipSet)
const;
448 const std::string& clipSet);
487 const std::string& clipSet)
const;
498 const std::string& clipSet);
510 const std::string& clipSet)
const;
521 const std::string& clipSet);
533 const std::string& clipSet)
const;
545 const std::string& clipSet);
558 const std::string& clipSet)
const;
569 const std::string& clipSet);
582 const std::string& clipSet)
const;
593 const std::string& clipSet);
605#define USDCLIPS_INFO_KEYS \
608 (interpolateMissingClipValues) \
609 (manifestAssetPath) \
611 (templateAssetPath) \
613 (templateStartTime) \
615 (templateActiveOffset) \
641#define USDCLIPS_SET_NAMES \
642 ((default_, "default")) \
654PXR_NAMESPACE_CLOSE_SCOPE
Contains an asset path and an optional resolved path.
A path value used to locate objects in layers or scenegraphs.
TfType represents a dynamic runtime type.
The base class for all API schemas.
UsdClipsAPI is an API schema that provides an interface to a prim's clip metadata.
USD_API bool SetClipTemplateEndTime(const double clipTemplateEndTime, const std::string &clipSet)
Set the template end time for the clipset named clipSet.
USD_API bool SetClipTimes(const VtVec2dArray &clipTimes)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool GetClipTemplateStride(double *clipTemplateStride) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API SdfLayerRefPtr GenerateClipManifest(const std::string &clipSet, bool writeBlocksForClipsWithMissingValues=false) const
Create a clip manifest containing entries for all attributes in the value clips for clip set clipSet.
USD_API bool SetClipTemplateStride(const double clipTemplateStride)
This is an overloaded member function, provided for convenience. It differs from the above function o...
static USD_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
USD_API bool SetClipPrimPath(const std::string &primPath, const std::string &clipSet)
Set the clip prim path for the clip set named clipSet.
USD_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
static USD_API UsdClipsAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdClipsAPI holding the prim adhering to this schema at path on stage.
USD_API bool SetClipTemplateAssetPath(const std::string &clipTemplateAssetPath, const std::string &clipSet)
Set the clip template asset path for the clip set named clipSet.
USD_API bool GetClipPrimPath(std::string *primPath, const std::string &clipSet) const
Path to the prim in the clips in the clip set named clipSet from which time samples will be read.
USD_API bool GetClipTimes(VtVec2dArray *clipTimes, const std::string &clipSet) const
List of pairs (stage time, clip time) indicating the time in the active clip in the clip set named cl...
USD_API bool SetClipTimes(const VtVec2dArray &clipTimes, const std::string &clipSet)
Set the clip times metadata for this prim.
USD_API bool SetClipTemplateStride(const double clipTemplateStride, const std::string &clipSet)
Set the template stride for the clip set named clipSet.
USD_API bool SetClipTemplateActiveOffset(const double clipTemplateActiveOffset, const std::string &clipSet)
Set the clip template offset for the clip set named clipSet.
static USD_API SdfLayerRefPtr GenerateClipManifestFromLayers(const SdfLayerHandleVector &clipLayers, const SdfPath &clipPrimPath)
Create a clip manifest containing entries for all attributes in the given clipLayers that belong to t...
USD_API bool GetClipTemplateStartTime(double *clipTemplateStartTime, const std::string &clipSet) const
A double which indicates the start of the range USD will use to search for asset paths for the clip s...
USD_API bool SetClipActive(const VtVec2dArray &activeClips)
This is an overloaded member function, provided for convenience. It differs from the above function o...
UsdClipsAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdClipsAPI on UsdPrim prim .
USD_API SdfLayerRefPtr GenerateClipManifest(bool writeBlocksForClipsWithMissingValues=false) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
UsdClipsAPI(const UsdSchemaBase &schemaObj)
Construct a UsdClipsAPI on the prim held by schemaObj .
USD_API bool GetClipTemplateStride(double *clipTemplateStride, const std::string &clipSet) const
A double representing the increment value USD will use when searching for asset paths for the clip se...
USD_API bool SetClipTemplateEndTime(const double clipTemplateEndTime)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool GetClipTemplateAssetPath(std::string *clipTemplateAssetPath, const std::string &clipSet) const
A template string representing a set of assets to be used as clips for the clip set named clipSet.
USD_API bool SetClipTemplateStartTime(const double clipTemplateStartTime, const std::string &clipSet)
Set the template start time for the clip set named clipSet.
USD_API bool SetClipAssetPaths(const VtArray< SdfAssetPath > &assetPaths)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool GetClips(VtDictionary *clips) const
Dictionary that contains the definition of the clip sets on this prim.
USD_API bool SetInterpolateMissingClipValues(bool interpolate)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API VtArray< SdfAssetPath > ComputeClipAssetPaths(const std::string &clipSet) const
Computes and resolves the list of clip asset paths used by the clip set named clipSet.
USD_API bool SetClips(const VtDictionary &clips)
Set the clips dictionary for this prim.
USD_API bool GetClipTemplateEndTime(double *clipTemplateEndTime, const std::string &clipSet) const
A double which indicates the end of the range USD will use to to search for asset paths for the clip ...
USD_API bool GetClipManifestAssetPath(SdfAssetPath *manifestAssetPath) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool SetInterpolateMissingClipValues(bool interpolate, const std::string &clipSet)
Set whether missing clip values are interpolated from surrounding clips.
USD_API bool GetClipPrimPath(std::string *primPath) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool SetClipSets(const SdfStringListOp &clipSets)
Set the clip sets list op for this prim.
USD_API bool SetClipManifestAssetPath(const SdfAssetPath &manifestAssetPath)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool GetInterpolateMissingClipValues(bool *interpolate) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool SetClipTemplateAssetPath(const std::string &clipTemplateAssetPath)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool SetClipTemplateActiveOffset(const double clipTemplateActiveOffset)
This is an overloaded member function, provided for convenience. It differs from the above function o...
virtual USD_API ~UsdClipsAPI()
Destructor.
USD_API bool SetClipTemplateStartTime(const double clipTemplateStartTime)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool GetClipManifestAssetPath(SdfAssetPath *manifestAssetPath, const std::string &clipSet) const
Asset path for the clip manifest for the clip set named clipSet.
USD_API bool GetClipTemplateAssetPath(std::string *clipTemplateAssetPath) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool SetClipManifestAssetPath(const SdfAssetPath &manifestAssetPath, const std::string &clipSet)
Set the clip manifest asset path for this prim.
USD_API bool GetClipTimes(VtVec2dArray *clipTimes) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool GetClipTemplateActiveOffset(double *clipTemplateActiveOffset) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool GetClipAssetPaths(VtArray< SdfAssetPath > *assetPaths, const std::string &clipSet) const
List of asset paths to the clips in the clip set named clipSet.
USD_API bool SetClipAssetPaths(const VtArray< SdfAssetPath > &assetPaths, const std::string &clipSet)
Set the clip asset paths for the clip set named clipSet.
USD_API bool GetClipActive(VtVec2dArray *activeClips, const std::string &clipSet) const
List of pairs (time, clip index) indicating the time on the stage at which the clip in the clip set n...
USD_API bool GetClipTemplateStartTime(double *clipTemplateStartTime) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool GetClipSets(SdfStringListOp *clipSets) const
ListOp that may be used to affect how opinions from clip sets are applied during value resolution.
USD_API bool GetClipActive(VtVec2dArray *activeClips) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool GetClipTemplateEndTime(double *clipTemplateEndTime) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool SetClipActive(const VtVec2dArray &activeClips, const std::string &clipSet)
Set the active clip metadata for the clip set named clipSet.
USD_API bool SetClipPrimPath(const std::string &primPath)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API VtArray< SdfAssetPath > ComputeClipAssetPaths() const
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool GetClipTemplateActiveOffset(double *clipTemplateActiveOffset, const std::string &clipSet) const
A double representing the offset value used by USD when determining the active period for each clip.
USD_API bool GetClipAssetPaths(VtArray< SdfAssetPath > *assetPaths) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
The base class for all schema types in Usd.
Singleton registry that provides access to schema type information and the prim definitions for regis...
Represents an arbitrary dimensional rectangular container class.
A map with string keys and VtValue values.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.