|
HDK
|
#include <clipsAPI.h>
Inheritance diagram for UsdClipsAPI:Static Public Member Functions | |
| static USD_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| static USD_API UsdClipsAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
| Static Public Member Functions inherited from UsdAPISchemaBase | |
| static USD_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| Static Public Member Functions inherited from UsdSchemaBase | |
| static const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Attributes | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::NonAppliedAPI |
| Static Public Attributes inherited from UsdAPISchemaBase | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
| Static Public Attributes inherited from UsdSchemaBase | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Protected Member Functions | |
| USD_API UsdSchemaKind | _GetSchemaKind () const override |
| Protected Member Functions inherited from UsdAPISchemaBase | |
| UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName) | |
| UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName) | |
| const TfToken & | _GetInstanceName () const |
| USD_API bool | _IsCompatible () const override |
| Protected Member Functions inherited from UsdSchemaBase | |
| virtual UsdSchemaKind | _GetSchemaType () const |
| const TfType & | _GetType () const |
| USD_API UsdAttribute | _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const |
Friends | |
| class | UsdSchemaRegistry |
Additional Inherited Members | |
| Static Protected Member Functions inherited from UsdAPISchemaBase | |
| static USD_API TfTokenVector | _GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType) |
UsdClipsAPI is an API schema that provides an interface to a prim's clip metadata. Clips are a "value resolution" feature that allows one to specify a sequence of usd files (clips) to be consulted, over time, as a source of varying overrides for the prims at and beneath this prim in namespace.
SetClipAssetPaths() establishes the set of clips that can be consulted. SetClipActive() specifies the ordering of clip application over time (clips can be repeated), while SetClipTimes() specifies time-mapping from stage-time to clip-time for the clip active at a given stage-time, which allows for time-dilation and repetition of clips. Finally, SetClipPrimPath() determines the path within each clip that will map to this prim, i.e. the location within the clip at which we will look for opinions for this prim.
The clip asset paths, times and active metadata can also be specified through template clip metadata. This can be desirable when your set of assets is very large, as the template metadata is much more concise. SetClipTemplateAssetPath() establishes the asset identifier pattern of the set of clips to be consulted. SetClipTemplateStride(), SetClipTemplateEndTime(), and SetClipTemplateStartTime() specify the range in which USD will search, based on the template. From the set of resolved asset paths, times and active will be derived internally.
A prim may have multiple "clip sets" – named sets of clips that each have their own values for the metadata described above. For example, a prim might have a clip set named "Clips_1" that specifies some group of clip asset paths, and another clip set named "Clips_2" that uses an entirely different set of clip asset paths. These clip sets are composed across composition arcs, so clip sets for a prim may be defined in multiple sublayers or references, for example. Individual metadata for a given clip set may be sparsely overridden.
Important facts about clips:
This leads to the common structure in which we reference a model asset on a prim, and then author clips at the same site: the asset reference will provide the topology and unvarying data for the model, while the clips will provide the time-sampled animation.
For further information, see Usd_Page_ValueClips
Definition at line 105 of file clipsAPI.h.
Construct a UsdClipsAPI on UsdPrim prim . Equivalent to UsdClipsAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim
Definition at line 117 of file clipsAPI.h.
|
inlineexplicit |
Construct a UsdClipsAPI on the prim held by schemaObj . Should be preferred over UsdClipsAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 125 of file clipsAPI.h.
|
virtual |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
Reimplemented from UsdAPISchemaBase.
| USD_API VtArray<SdfAssetPath> UsdClipsAPI::ComputeClipAssetPaths | ( | const std::string & | clipSet | ) | const |
Computes and resolves the list of clip asset paths used by the clip set named clipSet. This is the same list of paths that would be used during value resolution.
If the clip set is defined using template clip metadata, this function will compute the asset paths based on the template parameters. Otherwise this function will use the authored clipAssetPaths.
| USD_API VtArray<SdfAssetPath> UsdClipsAPI::ComputeClipAssetPaths | ( | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API SdfLayerRefPtr UsdClipsAPI::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. This returns an anonymous layer that can be exported and reused (
If writeBlocksForClipsWithMissingValues is true, the generated manifest will have value blocks authored for each attribute at the activation times of clips that do not contain time samples for that attribute. This accelerates searches done when the interpolation of missing clip values is enabled. See GetInterpolateMissingClipValues and Usd_ValueClips_ClipValueResolution_InterpolatingGaps for more details.
Returns an invalid SdfLayerRefPtr on failure.
| USD_API SdfLayerRefPtr UsdClipsAPI::GenerateClipManifest | ( | bool | writeBlocksForClipsWithMissingValues = false | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
|
static |
Create a clip manifest containing entries for all attributes in the given clipLayers that belong to the prim at clipPrimPath and all descendants. This returns an anonymous layer that can be exported and reused (
Returns an invalid SdfLayerRefPtr on failure.
|
static |
Return a UsdClipsAPI holding the prim adhering to this schema at path on stage. If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:
| USD_API bool UsdClipsAPI::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 named clipSet specified by the clip index is active. For instance, a value of [(0.0, 0), (20.0, 1)] indicates that clip 0 is active at time 0 and clip 1 is active at time 20.
| USD_API bool UsdClipsAPI::GetClipActive | ( | VtVec2dArray * | activeClips | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::GetClipAssetPaths | ( | VtArray< SdfAssetPath > * | assetPaths, |
| const std::string & | clipSet | ||
| ) | const |
List of asset paths to the clips in the clip set named clipSet. This list is unordered, but elements in this list are referred to by index in other clip-related fields.
| USD_API bool UsdClipsAPI::GetClipAssetPaths | ( | VtArray< SdfAssetPath > * | assetPaths | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::GetClipManifestAssetPath | ( | SdfAssetPath * | manifestAssetPath, |
| const std::string & | clipSet | ||
| ) | const |
Asset path for the clip manifest for the clip set named clipSet. The clip manifest indicates which attributes have time samples authored in the clips specified on this prim. During value resolution, clips will only be examined if the attribute exists and is declared as varying in the manifest. See Usd_ValueClips_ClipManifest for more details.
For instance, if this prim's path is </Prim_1>, the clip prim path is </Prim>, and we want values for the attribute </Prim_1.size>, we will only look within this prim's clips if the attribute </Prim.size> exists and is varying in the manifest.
| USD_API bool UsdClipsAPI::GetClipManifestAssetPath | ( | SdfAssetPath * | manifestAssetPath | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::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.
This prim's path will be substituted with this value to determine the final path in the clip from which to read data. For instance, if this prims' path is '/Prim_1', the clip prim path is '/Prim', and we want to get values for the attribute '/Prim_1.size'. The clip prim path will be substituted in, yielding '/Prim.size', and each clip will be examined for values at that path.
| USD_API bool UsdClipsAPI::GetClipPrimPath | ( | std::string * | primPath | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::GetClips | ( | VtDictionary * | clips | ) | const |
Dictionary that contains the definition of the clip sets on this prim.
Each entry in this dictionary defines a clip set: the entry's key is the name of the clip set and the entry's value is a dictionary containing the metadata that specifies the clips in the set.
See UsdClipsAPIInfoKeys for the keys used for each clip set's dictionary, or use the other API to set or get values for a given clip set.
| USD_API bool UsdClipsAPI::GetClipSets | ( | SdfStringListOp * | clipSets | ) | const |
ListOp that may be used to affect how opinions from clip sets are applied during value resolution.
By default, clip sets in a layer stack are examined in lexicographical order by name for attribute values during value resolution. The clip sets listOp can be used to reorder the clip sets in a layer stack or remove them entirely from consideration during value resolution without modifying the clips dictionary.
This is not the list of clip sets that are authored on this prim. To retrieve that information, use GetClips to examine the clips dictionary directly.
This function returns the clip sets listOp from the current edit target.
| USD_API bool UsdClipsAPI::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 UsdClipsAPI::GetClipTemplateActiveOffset | ( | double * | clipTemplateActiveOffset | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::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. This string can be of two forms:
integer frames: path/basename.###.usd
subinteger frames: path/basename.##.##.usd.
For the integer portion of the specification, USD will take a particular time, determined by the template start time, stride, and end time, and pad it with zeros up to the number of hashes provided so long as the number of hashes is greater than the digits required to specify the integer value.
For instance:
time = 12, template asset path = foo.##.usd => foo.12.usd time = 12, template asset path = foo.###.usd => foo.012.usd time = 333, template asset path = foo.#.usd => foo.333.usd
In the case of subinteger portion of a specifications, USD requires the specification to be exact.
For instance:
time = 1.15, template asset path = foo.#.###.usd => foo.1.150.usd time = 1.145, template asset path = foo.#.##.usd => foo.1.15.usd time = 1.1, template asset path = foo.#.##.usd => foo.1.10.usd
Note that USD requires that hash groups be adjacent in the string, and that there only be one or two such groups.
| USD_API bool UsdClipsAPI::GetClipTemplateAssetPath | ( | std::string * | clipTemplateAssetPath | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::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 set named clipSet. This value is inclusive in that range.
| USD_API bool UsdClipsAPI::GetClipTemplateEndTime | ( | double * | clipTemplateEndTime | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::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 set named clipSet. This value is inclusive in that range.
| USD_API bool UsdClipsAPI::GetClipTemplateStartTime | ( | double * | clipTemplateStartTime | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::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 set named clipSet.
| USD_API bool UsdClipsAPI::GetClipTemplateStride | ( | double * | clipTemplateStride | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::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 clipSet that should be consulted for values at the corresponding stage time.
During value resolution, this list will be sorted by stage time; times will then be linearly interpolated between consecutive entries. For instance, for clip times [(0.0, 0.0), (10.0, 20.0)], at stage time 0, values from the active clip at time 0 will be used, at stage time 5, values from the active clip at time 10, and at stage time 10, clip values at time 20.
| USD_API bool UsdClipsAPI::GetClipTimes | ( | VtVec2dArray * | clipTimes | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::GetInterpolateMissingClipValues | ( | bool * | interpolate, |
| const std::string & | clipSet | ||
| ) | const |
Dictionary that contains the definition of the clip sets on this prim.
Each entry in this dictionary defines a clip set: the entry's key is the name of the clip set and the entry's value is a dictionary containing the metadata that specifies the clips in the set.
See UsdClipsAPIInfoKeys for the keys used for each clip set's dictionary, or use the other API to set or get values for a given clip set.
| USD_API bool UsdClipsAPI::GetInterpolateMissingClipValues | ( | bool * | interpolate | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
|
static |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. Does not include attributes that may be authored by custom/extended methods of the schemas involved.
| USD_API bool UsdClipsAPI::SetClipActive | ( | const VtVec2dArray & | activeClips, |
| const std::string & | clipSet | ||
| ) |
Set the active clip metadata for the clip set named clipSet.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::SetClipAssetPaths | ( | const VtArray< SdfAssetPath > & | assetPaths, |
| const std::string & | clipSet | ||
| ) |
Set the clip asset paths for the clip set named clipSet
| USD_API bool UsdClipsAPI::SetClipAssetPaths | ( | const VtArray< SdfAssetPath > & | assetPaths | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::SetClipManifestAssetPath | ( | const SdfAssetPath & | manifestAssetPath, |
| const std::string & | clipSet | ||
| ) |
Set the clip manifest asset path for this prim.
| USD_API bool UsdClipsAPI::SetClipManifestAssetPath | ( | const SdfAssetPath & | manifestAssetPath | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::SetClipPrimPath | ( | const std::string & | primPath, |
| const std::string & | clipSet | ||
| ) |
Set the clip prim path for the clip set named clipSet.
| USD_API bool UsdClipsAPI::SetClipPrimPath | ( | const std::string & | primPath | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::SetClips | ( | const VtDictionary & | clips | ) |
Set the clips dictionary for this prim.
| USD_API bool UsdClipsAPI::SetClipSets | ( | const SdfStringListOp & | clipSets | ) |
Set the clip sets list op for this prim.
| USD_API bool UsdClipsAPI::SetClipTemplateActiveOffset | ( | const double | clipTemplateActiveOffset, |
| const std::string & | clipSet | ||
| ) |
Set the clip template offset for the clip set named clipSet.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::SetClipTemplateAssetPath | ( | const std::string & | clipTemplateAssetPath, |
| const std::string & | clipSet | ||
| ) |
Set the clip template asset path for the clip set named clipSet.
| USD_API bool UsdClipsAPI::SetClipTemplateAssetPath | ( | const std::string & | clipTemplateAssetPath | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::SetClipTemplateEndTime | ( | const double | clipTemplateEndTime, |
| const std::string & | clipSet | ||
| ) |
Set the template end time for the clipset named clipSet.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::SetClipTemplateStartTime | ( | const double | clipTemplateStartTime, |
| const std::string & | clipSet | ||
| ) |
Set the template start time for the clip set named clipSet.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::SetClipTemplateStride | ( | const double | clipTemplateStride, |
| const std::string & | clipSet | ||
| ) |
Set the template stride for the clip set named clipSet.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::SetClipTimes | ( | const VtVec2dArray & | clipTimes, |
| const std::string & | clipSet | ||
| ) |
Set the clip times metadata for this prim.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
| USD_API bool UsdClipsAPI::SetInterpolateMissingClipValues | ( | bool | interpolate, |
| const std::string & | clipSet | ||
| ) |
Set whether missing clip values are interpolated from surrounding clips.
| USD_API bool UsdClipsAPI::SetInterpolateMissingClipValues | ( | bool | interpolate | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function operates on the default clip set.
|
friend |
Definition at line 164 of file clipsAPI.h.
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 111 of file clipsAPI.h.
1.8.6 
