types.h File Reference

#include "pxr/pxr.h"
#include "pxr/usd/pcp/api.h"
#include "pxr/usd/pcp/site.h"
#include "pxr/usd/sdf/layer.h"
#include "pxr/base/tf/pxrTslRobinMap/robin_set.h"
#include <limits>
#include <vector>

Include dependency graph for types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	PcpSiteTrackerSegment
struct	Pcp_SdSiteRef
struct	Pcp_CompressedSdSite

Typedefs
typedef std::vector < PcpSiteTrackerSegment >	PcpSiteTracker
typedef std::vector < Pcp_CompressedSdSite >	Pcp_CompressedSdSiteVector
typedef std::map< std::string, std::vector< std::string > >	PcpVariantFallbackMap
using	PcpTokenSet = pxr_tsl::robin_set< TfToken, TfToken::HashFunctor >

Enumerations
enum	PcpArcType {   PcpArcTypeRoot, PcpArcTypeInherit, PcpArcTypeVariant, PcpArcTypeRelocate,   PcpArcTypeReference, PcpArcTypePayload, PcpArcTypeSpecialize, PcpNumArcTypes }
enum	PcpRangeType {   PcpRangeTypeRoot, PcpRangeTypeInherit, PcpRangeTypeVariant, PcpRangeTypeReference,   PcpRangeTypePayload, PcpRangeTypeSpecialize, PcpRangeTypeAll, PcpRangeTypeWeakerThanRoot,   PcpRangeTypeStrongerThanPayload, PcpRangeTypeInvalid }

Functions
bool	PcpIsInheritArc (PcpArcType arcType)
bool	PcpIsSpecializeArc (PcpArcType arcType)
bool	PcpIsClassBasedArc (PcpArcType arcType)

Variables
constexpr size_t	PCP_INVALID_INDEX = std::numeric_limits<size_t>::max()

Typedef Documentation

typedef std::vector<Pcp_CompressedSdSite> Pcp_CompressedSdSiteVector

Definition at line 189 of file types.h.

std::vector< PcpSiteTrackerSegment > PcpSiteTracker

Represents a single path through the composition tree. As the tree is being built, we add segments to the tracker. If we encounter a site that we've already visited, we've found a cycle.

Definition at line 128 of file types.h.

using PcpTokenSet = pxr_tsl::robin_set<TfToken, TfToken::HashFunctor>

Definition at line 208 of file types.h.

PcpVariantFallbackMap

typedef std::map<std::string, std::vector<std::string>> PcpVariantFallbackMap

A "map of lists" of fallbacks to attempt to use when evaluating variant sets that lack an authored selection.

This maps a name of a variant set (ex: "shadingComplexity") to a ordered list of variant selection names. If there is no variant selection in scene description, Pcp will check for each listed fallback in sequence, using the first one that exists.

Definition at line 206 of file types.h.

Enumeration Type Documentation

enum PcpArcType

Describes the type of arc connecting two nodes in the prim index.

Enumerator
PcpArcTypeRoot
PcpArcTypeInherit
PcpArcTypeVariant
PcpArcTypeRelocate
PcpArcTypeReference
PcpArcTypePayload
PcpArcTypeSpecialize
PcpNumArcTypes

Definition at line 44 of file types.h.

enum PcpRangeType

Enumerator
PcpRangeTypeRoot
PcpRangeTypeInherit
PcpRangeTypeVariant
PcpRangeTypeReference
PcpRangeTypePayload
PcpRangeTypeSpecialize
PcpRangeTypeAll
PcpRangeTypeWeakerThanRoot
PcpRangeTypeStrongerThanPayload
PcpRangeTypeInvalid

Definition at line 61 of file types.h.

Function Documentation

bool PcpIsClassBasedArc ( PcpArcType  arcType )

inline

Returns true if arcType represents a class-based composition arc, false otherwise.

The key characteristic of these arcs is that they imply additional sources of opinions outside of the site where the arc is introduced.

Definition at line 109 of file types.h.

bool PcpIsInheritArc ( PcpArcType  arcType )

inline

Returns true if arcType represents an inherit arc, false otherwise.

Definition at line 89 of file types.h.

bool PcpIsSpecializeArc ( PcpArcType  arcType )

inline

Returns true if arcType represents a specialize arc, false otherwise.

Definition at line 97 of file types.h.

Variable Documentation

size_t PCP_INVALID_INDEX = std::numeric_limits<size_t>::max()

A value which indicates an invalid index. This is simply used inplace of either -1 or numeric_limits::max() (which are equivalent for size_t). for better clarity.

Definition at line 217 of file types.h.