A class which describes the interval at which validation is to be performed. More...

#include <timeRange.h>

Public Member Functions
USDVALIDATION_API	UsdValidationTimeRange ()
	Construct an UsdValidationTimeRange, which signifies validate full time interval, including UsdTimeCode::Default().

USDVALIDATION_API	UsdValidationTimeRange (const UsdTimeCode &timeCode)
	Construct a UsdValidationTimeRange with a specific `timeCode`.

USDVALIDATION_API	UsdValidationTimeRange (const GfInterval &interval, bool includeTimeCodeDefault=true)
	Construct a UsdValidationTimeRange with a specific `interval`.

USDVALIDATION_API bool	IncludesTimeCodeDefault () const
	Return true if the time range includes UsdTimeCode::Default().

USDVALIDATION_API GfInterval	GetInterval () const
	Return the interval to validate.

Detailed Description

A class which describes the interval at which validation is to be performed.

Clients can validate using a GfInterval, which can also encode a closed single time code as well. The interval can be passed to UsdAttribute::GetTimeSamplesInInterval() to retrieve relevant samples. Time dependent attributes can then be validated at each time sample in the validation callback itself by the clients.

UsdValidationTimeRange can also specify if UsdTimeCode::Default() should be included in the validation interval or not.

To validate for all time samples, clients can provide an interval using GfInterval::GetFullInterval().

See also: UsdAttribute::GetTimeSamplesInInterval

Definition at line 37 of file timeRange.h.

Constructor & Destructor Documentation

◆ UsdValidationTimeRange() [1/3]

USDVALIDATION_API UsdValidationTimeRange ( )

Construct an UsdValidationTimeRange, which signifies validate full time interval, including UsdTimeCode::Default().

◆ UsdValidationTimeRange() [2/3]

USDVALIDATION_API UsdValidationTimeRange ( const UsdTimeCode & timeCode )

explicit

Construct a UsdValidationTimeRange with a specific timeCode.

If timeCode is UsdTimeCode::Default(), the time range will be empty, i.e. no time to validate, but _includeTimeCodeDefault will be true.

◆ UsdValidationTimeRange() [3/3]

USDVALIDATION_API UsdValidationTimeRange	(	const GfInterval &	interval,
		bool	includeTimeCodeDefault = `true`
	)

explicit

Construct a UsdValidationTimeRange with a specific interval.

includeTimeCodeDefault is used to determine if UsdTimeCode::Default() should be included in the UsdValidationTimeRange or not (default is true).

Member Function Documentation

◆ GetInterval()

USDVALIDATION_API GfInterval GetInterval ( ) const

Return the interval to validate.

◆ IncludesTimeCodeDefault()

USDVALIDATION_API bool IncludesTimeCodeDefault ( ) const

Return true if the time range includes UsdTimeCode::Default().

The documentation for this class was generated from the following file:

pxr/usdValidation/usdValidation/timeRange.h

Public Member Functions