EsfAttributeQueryInterface Class Reference

Attribute query abstraction for scene adapter implementations. More...

#include <attributeQuery.h>

Inheritance diagram for EsfAttributeQueryInterface:

Public Member Functions
bool	IsValid () const
	Returns true if the query object is valid.
SdfPath	GetPath () const
	Returns the path of the attribute that is being queried.
void	Initialize ()
	Reinitialize the query object from the attribute it was initially constructed with.
bool	Get (VtValue *value, UsdTimeCode time) const
	Gets the resolved value of the attribute at a given time.
std::optional< TsSpline >	GetSpline () const
	Gets the authored spline if the strongest opinion is a spline.
bool	ValueMightBeTimeVarying () const
	Returns true if the attribute value might be varying over time, and false if the value is definitely not varying over time.
bool	IsTimeVarying (UsdTimeCode from, UsdTimeCode to) const
	Returns true if the resolved value of the attribute is different on time from and time to.

Protected Member Functions
	EsfAttributeQueryInterface ()=default
	This constructor may only be called by the scene adapter implementation.

Detailed Description

Attribute query abstraction for scene adapter implementations.

This abstraction closely resembles the UsdAttributeQuery.

The public methods of this class are called during initialization of inputs to the execution network and during authored value invalidation.

Definition at line 33 of file attributeQuery.h.

Constructor & Destructor Documentation

EsfAttributeQueryInterface()

EsfAttributeQueryInterface ( )

protecteddefault

This constructor may only be called by the scene adapter implementation.

Member Function Documentation

Get()

bool Get ( VtValue *  value, UsdTimeCode  time  ) const

inline

Gets the resolved value of the attribute at a given time.

See also

UsdAttribute::Get

Definition at line 66 of file attributeQuery.h.

GetPath()

SdfPath GetPath ( ) const

inline

Returns the path of the attribute that is being queried.

Definition at line 48 of file attributeQuery.h.

GetSpline()

std::optional< TsSpline > GetSpline ( ) const

inline

Gets the authored spline if the strongest opinion is a spline.

See also

UsdAttribute::GetSpline

Definition at line 74 of file attributeQuery.h.

Initialize()

void Initialize ( )

inline

Reinitialize the query object from the attribute it was initially constructed with.

This enables clients to "revive" the query object after changes that affect value resolution previously invalidated it.

Definition at line 58 of file attributeQuery.h.

IsTimeVarying()

bool IsTimeVarying ( UsdTimeCode  from, UsdTimeCode  to  ) const

inline

Returns true if the resolved value of the attribute is different on time from and time to.

Note

This does not examine times between from and to in order to determine if there is a difference in resolved values on in-between times.

Definition at line 95 of file attributeQuery.h.

IsValid()

bool IsValid ( ) const

inline

Returns true if the query object is valid.

See also

UsdAttributeQuery::IsValid

Definition at line 43 of file attributeQuery.h.

ValueMightBeTimeVarying()

bool ValueMightBeTimeVarying ( ) const

inline

Returns true if the attribute value might be varying over time, and false if the value is definitely not varying over time.

See also

UsdAttribute::ValueMightBeTimeVarying

Definition at line 83 of file attributeQuery.h.

---

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

• pxr/exec/esf/attributeQuery.h