All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
pathTranslation.h
Go to the documentation of this file.
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_PCP_PATH_TRANSLATION_H
8#define PXR_USD_PCP_PATH_TRANSLATION_H
9
12
13#include "pxr/pxr.h"
14#include "pxr/usd/pcp/api.h"
15
16PXR_NAMESPACE_OPEN_SCOPE
17
18class PcpMapFunction;
19class PcpNodeRef;
20class SdfPath;
21
37PCP_API
40 const PcpNodeRef& sourceNode,
41 const SdfPath& pathInNodeNamespace,
42 bool* pathWasTranslated = 0);
43
59PCP_API
62 const PcpNodeRef& destNode,
63 const SdfPath& pathInRootNamespace,
64 bool* pathWasTranslated = 0);
65
72PCP_API
75 const PcpNodeRef& destNode,
76 const SdfPath& pathInRootNamespace,
77 bool* pathWasTranslated = 0);
78
81PCP_API
84 const PcpMapFunction &mapToRoot,
85 const SdfPath &pathInRootNamespace,
86 bool *pathWasTranslated = 0);
87
90PCP_API
93 const PcpMapFunction &mapToRoot,
94 const SdfPath &pathInNodeNamespace,
95 bool *pathWasTranslated = 0);
96
97PXR_NAMESPACE_CLOSE_SCOPE
98
99#endif // PXR_USD_PCP_PATH_TRANSLATION_H
A function that maps values from one namespace (and time domain) to another.
Definition: mapFunction.h:65
PcpNode represents a node in an expression tree for compositing scene description.
Definition: node.h:47
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
PCP_API SdfPath PcpTranslatePathFromRootToNodeUsingFunction(const PcpMapFunction &mapToRoot, const SdfPath &pathInRootNamespace, bool *pathWasTranslated=0)
Convenience function like PcpTranslatePathFromRootToNode, but takes a function rather than a node.
PCP_API SdfPath PcpTranslateTargetPathFromRootToNode(const PcpNodeRef &destNode, const SdfPath &pathInRootNamespace, bool *pathWasTranslated=0)
Same as PcpTranslatePathFromRootToNode, but explicitly for use when translating paths intended for us...
PCP_API SdfPath PcpTranslatePathFromRootToNode(const PcpNodeRef &destNode, const SdfPath &pathInRootNamespace, bool *pathWasTranslated=0)
Translates pathInRootNamespace from the namespace of the root of the prim index that destNode belongs...
PCP_API SdfPath PcpTranslatePathFromNodeToRoot(const PcpNodeRef &sourceNode, const SdfPath &pathInNodeNamespace, bool *pathWasTranslated=0)
Translates pathInNodeNamespace from the namespace of the prim index node sourceNode to the namespace ...
PCP_API SdfPath PcpTranslatePathFromNodeToRootUsingFunction(const PcpMapFunction &mapToRoot, const SdfPath &pathInNodeNamespace, bool *pathWasTranslated=0)
Convenience function like PcpTranslatePathFromNodeToRoot, but takes a function rather than a node.