24#ifndef PXR_USD_PCP_MAP_FUNCTION_H
25#define PXR_USD_PCP_MAP_FUNCTION_H
28#include "pxr/usd/pcp/api.h"
29#include "pxr/usd/sdf/path.h"
31#include "pxr/usd/sdf/pathExpression.h"
36PXR_NAMESPACE_OPEN_SCOPE
85 typedef std::map<SdfPath, SdfPath, SdfPath::FastLessThan>
PathMap;
86 typedef std::pair<SdfPath, SdfPath> PathPair;
87 typedef std::vector<PathPair> PathPairVector;
171 std::vector<SdfPathExpression::PathPattern>
172 *unmappedPatterns =
nullptr,
173 std::vector<SdfPathExpression::ExpressionReference>
174 *unmappedRefs =
nullptr
194 std::vector<SdfPathExpression::PathPattern>
195 *unmappedPatterns =
nullptr,
196 std::vector<SdfPathExpression::ExpressionReference>
197 *unmappedRefs =
nullptr
238 PathPair
const *sourceToTargetEnd,
240 bool hasRootIdentity);
244 _MapPathExpressionImpl(
247 std::vector<SdfPathExpression::PathPattern> *unmappedPatterns,
248 std::vector<SdfPathExpression::ExpressionReference> *unmappedRefs
254 static const int _MaxLocalPairs = 2;
258 _Data(PathPair
const *begin, PathPair
const *end,
bool hasRootIdentity)
259 : numPairs(end-begin)
260 , hasRootIdentity(hasRootIdentity) {
263 if (numPairs <= _MaxLocalPairs) {
264 std::uninitialized_copy(begin, end, localPairs);
267 new (&remotePairs) std::shared_ptr<PathPair>(
268 new PathPair[numPairs], std::default_delete<PathPair[]>());
269 std::copy(begin, end, remotePairs.get());
273 _Data(_Data
const &other)
274 : numPairs(other.numPairs)
275 , hasRootIdentity(other.hasRootIdentity) {
276 if (numPairs <= _MaxLocalPairs) {
277 std::uninitialized_copy(
279 other.localPairs + other.numPairs, localPairs);
282 new (&remotePairs) std::shared_ptr<PathPair>(other.remotePairs);
286 : numPairs(other.numPairs)
287 , hasRootIdentity(other.hasRootIdentity) {
288 if (numPairs <= _MaxLocalPairs) {
289 PathPair *dst = localPairs;
290 PathPair *src = other.localPairs;
291 PathPair *srcEnd = other.localPairs + other.numPairs;
292 for (; src != srcEnd; ++src, ++dst) {
293 ::new (
static_cast<void*
>(std::addressof(*dst)))
294 PathPair(std::move(*src));
299 std::shared_ptr<PathPair>(std::move(other.remotePairs));
302 _Data &operator=(_Data
const &other) {
303 if (
this != &other) {
305 new (
this) _Data(other);
309 _Data &operator=(_Data &&other) {
310 if (
this != &other) {
312 new (
this) _Data(std::move(other));
317 if (numPairs <= _MaxLocalPairs) {
318 for (PathPair *p = localPairs; numPairs--; ++p) {
323 remotePairs.~shared_ptr<PathPair>();
327 bool IsNull()
const {
328 return numPairs == 0 && !hasRootIdentity;
331 PathPair
const *begin()
const {
332 return numPairs <= _MaxLocalPairs ? localPairs : remotePairs.get();
335 PathPair
const *end()
const {
336 return begin() + numPairs;
339 bool operator==(_Data
const &other)
const {
340 return numPairs == other.numPairs &&
341 hasRootIdentity == other.hasRootIdentity &&
342 std::equal(begin(), end(), other.begin());
345 bool operator!=(_Data
const &other)
const {
346 return !(*
this == other);
349 template <
class HashState>
350 friend void TfHashAppend(HashState &h, _Data
const &data){
351 h.Append(data.hasRootIdentity);
352 h.Append(data.numPairs);
353 h.AppendRange(std::begin(data), std::end(data));
357 PathPair localPairs[_MaxLocalPairs > 0 ? _MaxLocalPairs : 1];
358 std::shared_ptr<PathPair> remotePairs;
360 typedef int PairCount;
361 PairCount numPairs = 0;
362 bool hasRootIdentity =
false;
366 template <
typename HashState>
384PXR_NAMESPACE_CLOSE_SCOPE
A function that maps values from one namespace (and time domain) to another.
static PCP_API PcpMapFunction Create(const PathMap &sourceToTargetMap, const SdfLayerOffset &offset)
Constructs a map function with the given arguments.
PCP_API void Swap(PcpMapFunction &map)
Swap the contents of this map function with map.
PCP_API SdfPathExpression MapTargetToSource(const SdfPathExpression &pathExpr, std::vector< SdfPathExpression::PathPattern > *unmappedPatterns=nullptr, std::vector< SdfPathExpression::ExpressionReference > *unmappedRefs=nullptr) const
Map all path pattern prefix paths and expression reference paths in the target namespace to the sourc...
PCP_API SdfPath MapSourceToTarget(const SdfPath &path) const
Map a path in the source namespace to the target.
bool HasRootIdentity() const
Return true if the map function maps the absolute root path to the absolute root path,...
PCP_API bool IsIdentity() const
Return true if the map function is the identity function.
PCP_API size_t Hash() const
Return a size_t hash for this map function.
PCP_API SdfPathExpression MapSourceToTarget(const SdfPathExpression &pathExpr, std::vector< SdfPathExpression::PathPattern > *unmappedPatterns=nullptr, std::vector< SdfPathExpression::ExpressionReference > *unmappedRefs=nullptr) const
Map all path pattern prefix paths and expression reference paths in the source namespace to the targe...
PCP_API std::string GetString() const
Returns a string representation of this mapping for debugging purposes.
static PCP_API const PathMap & IdentityPathMap()
Returns an identity path mapping.
PcpMapFunction()=default
Construct a null function.
PCP_API SdfPath MapTargetToSource(const SdfPath &path) const
Map a path in the target namespace to the source.
PCP_API bool operator!=(const PcpMapFunction &map) const
Inequality.
const SdfLayerOffset & GetTimeOffset() const
The time offset of the mapping.
std::map< SdfPath, SdfPath, SdfPath::FastLessThan > PathMap
A mapping from path to path.
static PCP_API const PcpMapFunction & Identity()
Construct an identity map function.
PCP_API PcpMapFunction ComposeOffset(const SdfLayerOffset &newOffset) const
Compose this map function over a hypothetical map function that has an identity path mapping and offs...
PCP_API PcpMapFunction GetInverse() const
Return the inverse of this map function.
PCP_API PcpMapFunction Compose(const PcpMapFunction &f) const
Compose this map over the given map function.
PCP_API bool IsIdentityPathMapping() const
Return true if the map function uses the identity path mapping.
PCP_API bool operator==(const PcpMapFunction &map) const
Equality.
PCP_API bool IsNull() const
Return true if this map function is the null function.
PCP_API PathMap GetSourceToTargetMap() const
The set of path mappings, from source to target.
Represents a time offset and scale between layers.
Objects of this class represent a logical expression syntax tree consisting of SdfPath matching patte...
A path value used to locate objects in layers or scenegraphs.
A user-extensible hashing mechanism for use with runtime hash tables.
size_t hash_value(const half h)
Overload hash_value for half.