This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
attributeQuery.h
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef PXR_USD_USD_ATTRIBUTE_QUERY_H
8#define PXR_USD_USD_ATTRIBUTE_QUERY_H
9
10#include "pxr/pxr.h"
11#include "pxr/usd/usd/api.h"
12#include "pxr/usd/usd/attribute.h"
13#include "pxr/usd/usd/common.h"
14#include "pxr/usd/usd/prim.h"
16#include "pxr/usd/usd/resolveTarget.h"
17#include "pxr/usd/usd/timeCode.h"
18
19#include "pxr/base/tf/token.h"
20
21#include <vector>
22
23PXR_NAMESPACE_OPEN_SCOPE
24
25
60{
61public:
63 USD_API
65
67 USD_API
69
71 USD_API
73
75 USD_API
76 explicit UsdAttributeQuery(const UsdAttribute& attr);
77
80 USD_API
81 UsdAttributeQuery(const UsdPrim& prim, const TfToken& attrName);
82
88 USD_API
90 const UsdResolveTarget &resolveTarget);
91
95 USD_API
96 static std::vector<UsdAttributeQuery> CreateQueries(
97 const UsdPrim& prim, const TfTokenVector& attrNames);
98
99 // --------------------------------------------------------------------- //
101 // --------------------------------------------------------------------- //
102
104
106 USD_API
108
111 bool IsValid() const {
112 return GetAttribute().IsValid();
113 }
114
115public:
117 explicit operator bool() const {
118 return IsValid();
119 }
120
122 USD_API
124
126 USD_API
128
130
131 // --------------------------------------------------------------------- //
133 // --------------------------------------------------------------------- //
134
136
141 template <typename T>
142 bool Get(T* value, UsdTimeCode time = UsdTimeCode::Default()) const {
143 static_assert(SdfValueTypeTraits<T>::IsValueType,
144 "T must be an SdfValueType.");
145 return _Get(value, time);
146 }
149 USD_API
150 bool Get(VtValue* value, UsdTimeCode time = UsdTimeCode::Default()) const;
151
154 //
158 USD_API
159 bool GetTimeSamples(std::vector<double>* times) const;
160
165 USD_API
167 std::vector<double>* times) const;
168
181 USD_API
183 const std::vector<UsdAttributeQuery> &attrQueries,
184 std::vector<double> *times);
185
197 USD_API
199 const std::vector<UsdAttributeQuery> &attrQueries,
200 const GfInterval &interval,
201 std::vector<double> *times);
202
206 USD_API
207 size_t GetNumTimeSamples() const;
208
213 USD_API
214 bool GetBracketingTimeSamples(double desiredTime,
215 double* lower,
216 double* upper,
217 bool* hasTimeSamples) const;
218
224 USD_API
225 bool HasValue() const;
226
236 USD_API
238
243 USD_API
244 bool HasAuthoredValue() const;
245
250 USD_API
251 bool HasFallbackValue() const;
252
257 USD_API
259
261
262private:
263 void _Initialize();
264
265 void _Initialize(const UsdResolveTarget &resolveTarget);
266
267 template <typename T>
268 USD_API
269 bool _Get(T* value, UsdTimeCode time) const;
270
271private:
272 UsdAttribute _attr;
273 UsdResolveInfo _resolveInfo;
274 std::unique_ptr<UsdResolveTarget> _resolveTarget;
275};
276
277PXR_NAMESPACE_CLOSE_SCOPE
278
279#endif // PXR_USD_USD_ATTRIBUTE_QUERY_H
A basic mathematical interval class.
Definition: interval.h:33
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:160
Object for efficiently making repeated queries for attribute values.
USD_API UsdAttributeQuery()
Construct an invalid query object.
USD_API bool GetTimeSamples(std::vector< double > *times) const
Populates a vector with authored sample times.
USD_API bool GetBracketingTimeSamples(double desiredTime, double *lower, double *upper, bool *hasTimeSamples) const
Populate lower and upper with the next greater and lesser value relative to the desiredTime.
USD_API UsdAttributeQuery(const UsdAttributeQuery &other)
Copy constructor.
USD_API UsdAttributeQuery(UsdAttributeQuery &&other)=default
Move constructor.
USD_API UsdAttributeQuery(const UsdAttribute &attr, const UsdResolveTarget &resolveTarget)
Construct a new query for the attribute attr with the given resolve target resolveTarget.
USD_API bool GetTimeSamplesInInterval(const GfInterval &interval, std::vector< double > *times) const
Populates a vector with authored sample times in interval.
static USD_API bool GetUnionedTimeSamples(const std::vector< UsdAttributeQuery > &attrQueries, std::vector< double > *times)
Populates the given vector, times with the union of all the authored sample times on all of the given...
USD_API UsdAttributeQuery & operator=(UsdAttributeQuery &&other)=default
Move assignment.
USD_API UsdAttributeQuery(const UsdPrim &prim, const TfToken &attrName)
Construct a new query for the attribute named attrName under the prim prim.
USD_API bool HasAuthoredValueOpinion() const
USD_API const UsdAttribute & GetAttribute() const
Return the attribute associated with this query.
USD_API bool HasValue() const
Return true if the attribute associated with this query has an authored default value,...
bool Get(T *value, UsdTimeCode time=UsdTimeCode::Default()) const
Perform value resolution to fetch the value of the attribute associated with this query at the reques...
USD_API bool Get(VtValue *value, UsdTimeCode time=UsdTimeCode::Default()) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
static USD_API std::vector< UsdAttributeQuery > CreateQueries(const UsdPrim &prim, const TfTokenVector &attrNames)
Construct new queries for the attributes named in attrNames under the prim prim.
USD_API bool HasFallbackValue() const
Return true if the attribute associated with this query has a fallback value provided by a registered...
USD_API UsdAttributeQuery & operator=(const UsdAttributeQuery &other)
Copy assignment.
USD_API UsdAttributeQuery(const UsdAttribute &attr)
Construct a new query for the attribute attr.
bool IsValid() const
Return true if this query is valid (i.e.
static USD_API bool GetUnionedTimeSamplesInInterval(const std::vector< UsdAttributeQuery > &attrQueries, const GfInterval &interval, std::vector< double > *times)
Populates the given vector, times with the union of all the authored sample times in the GfInterval,...
USD_API size_t GetNumTimeSamples() const
Returns the number of time samples that have been authored.
USD_API bool ValueMightBeTimeVarying() const
Return true if it is possible, but not certain, that this attribute's value changes over time,...
USD_API bool HasAuthoredValue() const
Return true if this attribute has either an authored default value or authored time samples.
bool IsValid() const
Return true if this is a valid object, false otherwise.
Definition: object.h:126
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
Container for information about the source of an attribute's value, i.e.
Definition: resolveInfo.h:52
Defines a subrange of nodes and layers within a prim's prim index to consider when performing value r...
Definition: resolveTarget.h:56
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:67
static constexpr UsdTimeCode Default()
Produce a UsdTimeCode representing the sentinel value for 'default'.
Definition: timeCode.h:95
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:147
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:440