24#ifndef PXR_USD_PCP_NODE_H
25#define PXR_USD_PCP_NODE_H
28#include "pxr/usd/pcp/api.h"
32#include "pxr/base/tf/hashset.h"
34PXR_NAMESPACE_OPEN_SCOPE
40class PcpNodeRef_ChildrenIterator;
41class PcpNodeRef_ChildrenReverseIterator;
43typedef std::shared_ptr<PcpErrorBase> PcpErrorBasePtr;
66 typedef PcpNodeRef_ChildrenIterator child_const_iterator;
67 typedef PcpNodeRef_ChildrenReverseIterator child_const_reverse_iterator;
68 typedef std::pair<child_const_iterator,
69 child_const_iterator> child_const_range;
84 return _nodeIdx == rhs._nodeIdx && _graph == rhs._graph;
90 return !(*
this == rhs);
102 return !(rhs < *
this);
114 return !(*
this < rhs);
119 size_t operator()(
const PcpNodeRef& rhs)
const
157 PcpErrorBasePtr *error);
163 const PcpPrimIndex_GraphRefPtr& subgraph,
const PcpArc& arc,
164 PcpErrorBasePtr *error);
249 bool IsDueToAncestor()
const;
256 bool HasSymmetry()
const;
272 bool IsInert()
const;
280 bool IsCulled()
const;
287 bool IsRestricted()
const;
317 bool HasSpecs()
const;
322 Pcp_CompressedSdSite GetCompressedSdSite(
size_t layerIndex)
const
324 return Pcp_CompressedSdSite(_nodeIdx, layerIndex);
328 friend class PcpPrimIndex_Graph;
330 friend class PcpNodeRef_ChildrenIterator;
331 friend class PcpNodeRef_ChildrenReverseIterator;
332 friend class PcpNodeRef_PrivateChildrenConstIterator;
333 friend class PcpNodeRef_PrivateChildrenConstReverseIterator;
334 friend class PcpNodeRef_PrivateSubtreeConstIterator;
335 template <
class T>
friend class Pcp_TraversalCache;
338 PcpNodeRef(PcpPrimIndex_Graph* graph,
size_t idx)
339 : _graph(graph), _nodeIdx(idx)
342 size_t _GetNodeIndex()
const {
return _nodeIdx; }
344 inline size_t _GetParentIndex()
const;
345 inline size_t _GetOriginIndex()
const;
347 inline void _SetInert(
bool inert);
348 inline void _SetRestricted(
bool restricted);
350 enum class _Restricted { Yes, Unknown };
351 void _RecordRestrictionDepth(_Restricted isRestricted);
354 PcpPrimIndex_Graph* _graph;
359template <
typename HashState>
362TfHashAppend(HashState& h,
const PcpNodeRef& x){
372typedef TfHashSet<PcpNodeRef, PcpNodeRef::Hash> PcpNodeRefHashSet;
373typedef std::vector<PcpNodeRef> PcpNodeRefVector;
375class PcpNodeRef_PtrProxy {
377 PcpNodeRef* operator->() {
return &_nodeRef; }
379 friend class PcpNodeRef_ChildrenIterator;
380 friend class PcpNodeRef_ChildrenReverseIterator;
381 explicit PcpNodeRef_PtrProxy(
const PcpNodeRef& nodeRef) : _nodeRef(nodeRef) {}
390class PcpNodeRef_ChildrenIterator
393 using iterator_category = std::forward_iterator_tag;
396 using pointer = PcpNodeRef_PtrProxy;
397 using difference_type = std::ptrdiff_t;
401 PcpNodeRef_ChildrenIterator();
406 PcpNodeRef_ChildrenIterator(
const PcpNodeRef& node,
bool end =
false);
408 reference operator*()
const {
return dereference(); }
409 pointer operator->()
const {
return pointer(dereference()); }
411 PcpNodeRef_ChildrenIterator& operator++() {
416 PcpNodeRef_ChildrenIterator operator++(
int) {
417 const PcpNodeRef_ChildrenIterator result = *
this;
422 bool operator==(
const PcpNodeRef_ChildrenIterator& other)
const {
426 bool operator!=(
const PcpNodeRef_ChildrenIterator& other)
const {
427 return !equal(other);
433 bool equal(
const PcpNodeRef_ChildrenIterator& other)
const
437 return (_node == other._node && _index == other._index);
439 reference dereference()
const
441 return reference(_node._graph, _index);
451 friend class PcpNodeRef_ChildrenReverseIterator;
459class PcpNodeRef_ChildrenReverseIterator
462 using iterator_category = std::forward_iterator_tag;
465 using pointer = PcpNodeRef_PtrProxy;
466 using difference_type = std::ptrdiff_t;
470 PcpNodeRef_ChildrenReverseIterator();
474 PcpNodeRef_ChildrenReverseIterator(
const PcpNodeRef_ChildrenIterator&);
479 PcpNodeRef_ChildrenReverseIterator(
const PcpNodeRef& node,
bool end =
false);
481 reference operator*()
const {
return dereference(); }
482 pointer operator->()
const {
return pointer(dereference()); }
484 PcpNodeRef_ChildrenReverseIterator& operator++() {
489 PcpNodeRef_ChildrenReverseIterator operator++(
int) {
490 const PcpNodeRef_ChildrenReverseIterator result = *
this;
495 bool operator==(
const PcpNodeRef_ChildrenReverseIterator& other)
const {
499 bool operator!=(
const PcpNodeRef_ChildrenReverseIterator& other)
const {
500 return !equal(other);
506 bool equal(
const PcpNodeRef_ChildrenReverseIterator& other)
const
510 return (_node == other._node && _index == other._index);
512 reference dereference()
const
514 return reference(_node._graph, _index);
526struct Tf_IteratorInterface<
PcpNodeRef::child_const_range, false> {
527 typedef PcpNodeRef::child_const_iterator IteratorType;
528 static IteratorType Begin(PcpNodeRef::child_const_range
const &c)
532 static IteratorType End(PcpNodeRef::child_const_range
const &c)
539struct Tf_IteratorInterface<
PcpNodeRef::child_const_range, true> {
540 typedef PcpNodeRef::child_const_reverse_iterator IteratorType;
541 static IteratorType Begin(PcpNodeRef::child_const_range
const &c)
545 static IteratorType End(PcpNodeRef::child_const_range
const &c)
552struct Tf_ShouldIterateOverCopy<
PcpNodeRef::child_const_range> :
557PcpNodeRef_ChildrenIterator
558begin(
const PcpNodeRef::child_const_range& r)
565PcpNodeRef_ChildrenIterator
566end(
const PcpNodeRef::child_const_range& r)
574int PcpNode_GetNonVariantPathElementCount(
const SdfPath &path);
576PXR_NAMESPACE_CLOSE_SCOPE
A simple iterator adapter for STL containers.
Represents an arc connecting two nodes in the prim index.
Base class for all error types.
A site specifies a path in a layer stack of scene description.
An expression that yields a PcpMapFunction value.
Object used to iterate over nodes in the prim index graph in strong-to-weak order.
PcpNode represents a node in an expression tree for compositing scene description.
PCP_API void SetRestricted(bool restricted)
Get/set whether this node is restricted.
PCP_API bool CanContributeSpecs() const
Returns true if this node is allowed to contribute opinions for composition, false otherwise.
PCP_API SdfPath GetPathAtIntroduction() const
Returns the path for this node's site when it was introduced.
PCP_API void * GetUniqueIdentifier() const
Returns a value that uniquely identifies this node.
bool operator==(const PcpNodeRef &rhs) const
Returns true if this references the same node as rhs.
PCP_API PcpNodeRef GetRootNode() const
Walk up to the root node of this expression.
size_t PcpNodeRef::* UnspecifiedBoolType
Returns true if this is a valid node reference, false otherwise.
PCP_API SdfPath GetIntroPath() const
Get the path that introduced this node.
PCP_API void SetPermission(SdfPermission perm)
Get/set the permission for this node.
PCP_API void SetIsDueToAncestor(bool isDueToAncestor)
Get/set whether this node was introduced by being copied from its namespace ancestor,...
bool operator>(const PcpNodeRef &rhs) const
Greater than operator.
PCP_API void SetHasSymmetry(bool hasSymmetry)
Get/set whether this node provides any symmetry opinions, either directly or from a namespace ancesto...
PCP_API PcpArcType GetArcType() const
Returns the type of arc connecting this node to its parent node.
PCP_API void SetSpecContributionRestrictedDepth(size_t depth)
Set this node's contribution restriction depth.
PCP_API size_t GetSpecContributionRestrictedDepth() const
Returns the namespace depth (i.e., the path element count) of this node's path when it was restricted...
PCP_API PcpNodeRef GetOriginNode() const
Returns the immediate origin node for this node.
PCP_API PcpLayerStackSite GetSite() const
Get the site this node represents.
PCP_API PcpNodeRef InsertChildSubgraph(const PcpPrimIndex_GraphRefPtr &subgraph, const PcpArc &arc, PcpErrorBasePtr *error)
Inserts subgraph as a child of this node, with the root node of subtree connected to this node via ar...
bool operator<=(const PcpNodeRef &rhs) const
Less than or equal operator.
PCP_API PcpNodeRef GetParentNode() const
Returns this node's immediate parent node.
PCP_API bool IsRootNode() const
Returns true if this node is the root node of the prim index graph.
PCP_API PcpNodeRef GetOriginRootNode() const
Walk up to the root origin node for this node.
PcpPrimIndex_Graph * GetOwningGraph() const
Returns the graph that this node belongs to.
PCP_API const SdfPath & GetPath() const
Returns the path for the site this node represents.
PCP_API int GetSiblingNumAtOrigin() const
Returns this node's index among siblings with the same arc type at this node's origin.
PCP_API void SetHasSpecs(bool hasSpecs)
Returns true if this node has opinions authored for composition, false otherwise.
PCP_API PcpNodeRef InsertChild(const PcpLayerStackSite &site, const PcpArc &arc, PcpErrorBasePtr *error)
Inserts a new child node for site, connected to this node via arc.
PCP_API int GetNamespaceDepth() const
Returns the absolute namespace depth of the node that introduced this node.
bool operator>=(const PcpNodeRef &rhs) const
Greater than or equal operator.
PCP_API bool operator<(const PcpNodeRef &rhs) const
Returns true if this node is 'less' than rhs.
PCP_API const PcpMapExpression & GetMapToRoot() const
Returns mapping function used to translate paths and values from this node directly to the root node.
PCP_API const PcpLayerStackRefPtr & GetLayerStack() const
Returns the layer stack for the site this node represents.
PCP_API void SetInert(bool inert)
Get/set whether this node is inert.
PCP_API int GetDepthBelowIntroduction() const
Return the number of levels of namespace this node's site is below the level at which it was introduc...
PCP_API child_const_range GetChildrenRange() const
Returns an iterator range over the children nodes in strongest to weakest order.
PCP_API void SetCulled(bool culled)
Get/set whether this node is culled.
PCP_API const PcpMapExpression & GetMapToParent() const
Returns mapping function used to translate paths and values from this node to its parent node.
bool operator!=(const PcpNodeRef &rhs) const
Inequality operator.
A path value used to locate objects in layers or scenegraphs.
A user-extensible hashing mechanism for use with runtime hash tables.
#define TF_DECLARE_REF_PTRS(type)
Define standard ref pointer types.
size_t hash_value(const TfToken &x)
Overload hash_value for TfToken.
constexpr size_t PCP_INVALID_INDEX
A value which indicates an invalid index.
PcpArcType
Describes the type of arc connecting two nodes in the prim index.
SdfPermission
An enum that defines permission levels.