All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pathTranslation.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PCP_PATH_TRANSLATION_H
25 #define PCP_PATH_TRANSLATION_H
26 
29 
30 #include "pxr/pxr.h"
31 #include "pxr/usd/pcp/api.h"
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
35 class PcpMapFunction;
36 class PcpNodeRef;
37 class SdfPath;
38 
54 PCP_API
55 SdfPath
57  const PcpNodeRef& sourceNode,
58  const SdfPath& pathInNodeNamespace,
59  bool* pathWasTranslated = 0);
60 
76 PCP_API
77 SdfPath
79  const PcpNodeRef& destNode,
80  const SdfPath& pathInRootNamespace,
81  bool* pathWasTranslated = 0);
82 
89 PCP_API
90 SdfPath
92  const PcpNodeRef& destNode,
93  const SdfPath& pathInRootNamespace,
94  bool* pathWasTranslated = 0);
95 
98 PCP_API
99 SdfPath
101  const PcpMapFunction &mapToRoot,
102  const SdfPath &pathInRootNamespace,
103  bool *pathWasTranslated = 0);
104 
107 PCP_API
108 SdfPath
110  const PcpMapFunction &mapToRoot,
111  const SdfPath &pathInNodeNamespace,
112  bool *pathWasTranslated = 0);
113 
114 PXR_NAMESPACE_CLOSE_SCOPE
115 
116 #endif // PCP_PATH_TRANSLATION_H
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...
PcpNode represents a node in an expression tree for compositing scene description.
Definition: node.h:65
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 PcpTranslatePathFromNodeToRootUsingFunction(const PcpMapFunction &mapToRoot, const SdfPath &pathInNodeNamespace, bool *pathWasTranslated=0)
Convenience function like PcpTranslatePathFromNodeToRoot, but takes a function rather than a node...
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 ...
A function that maps values from one namespace (and time domain) to another.
Definition: mapFunction.h:80
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287