clipsAPI.h File Reference

#include "pxr/pxr.h"
#include "pxr/usd/usd/api.h"
#include "pxr/usd/usd/apiSchemaBase.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/usd/tokens.h"
#include "pxr/base/vt/value.h"
#include "pxr/base/gf/vec3d.h"
#include "pxr/base/gf/vec3f.h"
#include "pxr/base/gf/matrix4d.h"
#include "pxr/base/tf/token.h"
#include "pxr/base/tf/type.h"

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

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)

Macro Definition Documentation

#define USDCLIPS_INFO_KEYS

Definition at line 605 of file clipsAPI.h.

#define USDCLIPS_SET_NAMES

Definition at line 641 of file clipsAPI.h.

Function Documentation

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	(	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.