clipsAPI.h File Reference

Include dependency graph for clipsAPI.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	UsdClipsAPI
	UsdClipsAPI is an API schema that provides an interface to a prim's clip metadata. More...

Macros
#define	USDCLIPS_INFO_KEYS
#define	USDCLIPS_SET_NAMES

Functions
	TF_DECLARE_PUBLIC_TOKENS (UsdClipsAPIInfoKeys, USD_API, USDCLIPS_INFO_KEYS)
	TF_DECLARE_PUBLIC_TOKENS (UsdClipsAPISetNames, USD_API, USDCLIPS_SET_NAMES)

Function Documentation

TF_DECLARE_PUBLIC_TOKENS() [1/2]

TF_DECLARE_PUBLIC_TOKENS	(	UsdClipsAPIInfoKeys	,
		USD_API	,
		USDCLIPS_INFO_KEYS
	)

UsdClipsAPIInfoKeys provides tokens for the various entries in the clips dictionary. UsdClipsAPI provides named API corresponding to each of these entries; see documentation on API for expected values.

See also

UsdClipsAPI::GetClips

The keys provided here are:

• active - see UsdClipsAPI::GetClipActive
• assetPaths - see UsdClipsAPI::GetClipAssetPaths
• manifestAssetPath - see UsdClipsAPI::GetClipManifestAssetPath
• primPath - see UsdClipsAPI::GetClipPrimPath
• templateAssetPath - see UsdClipsAPI::GetClipTemplateAssetPath
• templateEndTime - see UsdClipsAPI::GetClipTemplateEndTime
• templateStartTime - see UsdClipsAPI::GetClipTemplateStartTime
• templateStride - see UsdClipsAPI::GetClipTemplateStride
• templateActiveOffset - see UsdClipsAPI::GetClipTemplateActiveOffset
• times - see UsdClipsAPI::GetClipTimes
• interpolateMissingClipValues - see UsdClipsAPI::GetInterpolateMissingClipValues

TF_DECLARE_PUBLIC_TOKENS() [2/2]

TF_DECLARE_PUBLIC_TOKENS	(	UsdClipsAPISetNames	,
		USD_API	,
		USDCLIPS_SET_NAMES
	)

UsdClipsAPISetNames provides tokens for pre-defined clip set names that may be used with the value clip info functions on UsdClipsAPI.

The tokens are:

• default_ - The default clip set used for API where no clip set is specified.