All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PcpMapFunction Class Reference

#include <mapFunction.h>

Public Types

typedef std::map< SdfPath,
SdfPath, SdfPath::FastLessThan
 A mapping from path to path. More...
typedef std::pair< SdfPath,
typedef std::vector< PathPairPathPairVector

Public Member Functions

 PcpMapFunction ()=default
 Construct a null function. More...
PCP_API void Swap (PcpMapFunction &map)
 Swap the contents of this map function with map. More...
void swap (PcpMapFunction &map)
PCP_API bool operator== (const PcpMapFunction &map) const
 Equality. More...
PCP_API bool operator!= (const PcpMapFunction &map) const
 Inequality. More...
PCP_API bool IsNull () const
PCP_API bool IsIdentity () const
PCP_API bool IsIdentityPathMapping () const
bool HasRootIdentity () const
PCP_API SdfPath MapSourceToTarget (const SdfPath &path) const
PCP_API SdfPath MapTargetToSource (const SdfPath &path) const
PCP_API PcpMapFunction Compose (const PcpMapFunction &f) const
PCP_API PcpMapFunction ComposeOffset (const SdfLayerOffset &newOffset) const
PCP_API PcpMapFunction GetInverse () const
PCP_API PathMap GetSourceToTargetMap () const
 The set of path mappings, from source to target. More...
const SdfLayerOffsetGetTimeOffset () const
 The time offset of the mapping. More...
PCP_API std::string GetString () const
PCP_API size_t Hash () const
 Return a size_t hash for this map function. More...

Static Public Member Functions

static PCP_API PcpMapFunction Create (const PathMap &sourceToTargetMap, const SdfLayerOffset &offset)
static PCP_API const
Identity ()
 Construct an identity map function. More...
static PCP_API const PathMapIdentityPathMap ()
 Returns an identity path mapping. More...


PcpMapFunctionPcp_MakeIdentity ()

Detailed Description

A function that maps values from one namespace (and time domain) to another. It represents the transformation that an arc such as a reference arc applies as it incorporates values across the arc.

Take the example of a reference arc, where a source path </Model> is referenced as a target path, </Model_1>. The source path </Model> is the source of the opinions; the target path </Model_1> is where they are incorporated in the scene. Values in the model that refer to paths relative to </Model> must be transformed to be relative to </Model_1> instead. The PcpMapFunction for the arc provides this service.

Map functions have a specific domain, or set of values they can operate on. Any values outside the domain cannot be mapped. The domain precisely tracks what areas of namespace can be referred to across various forms of arcs.

Map functions can be chained to represent a series of map operations applied in sequence. The map function represent the cumulative effect as efficiently as possible. For example, in the case of a chained reference from </Model> to </Model> to </Model> to </Model_1>, this is effectively the same as a mapping directly from </Model> to </Model_1>. Representing the cumulative effect of arcs in this way is important for handling larger scenes efficiently.

Map functions can be inverted. Formally, map functions are bijections (one-to-one and onto), which ensures that they can be inverted. Put differently, no information is lost by applying a map function to set of values within its domain; they retain their distinct identities and can always be mapped back.

One analogy that may or may not be helpful: In the same way a geometric transform maps a model's points in its rest space into the world coordinates for a particular instance, a PcpMapFunction maps values about a referenced model into the composed scene for a particular instance of that model. But rather than translating and rotating points, the map function shifts the values in namespace (and time).

Definition at line 80 of file mapFunction.h.

Member Typedef Documentation

A mapping from path to path.

Definition at line 84 of file mapFunction.h.

Definition at line 85 of file mapFunction.h.

Definition at line 86 of file mapFunction.h.

Constructor & Destructor Documentation

PcpMapFunction::PcpMapFunction ( )

Construct a null function.

Member Function Documentation

PCP_API PcpMapFunction PcpMapFunction::Compose ( const PcpMapFunction f) const

Compose this map over the given map function. The result will represent the application of f followed by the application of this function.

PCP_API PcpMapFunction PcpMapFunction::ComposeOffset ( const SdfLayerOffset newOffset) const

Compose this map function over a hypothetical map function that has an identity path mapping and offset. This is equivalent to building such a map function and invoking Compose(), but is faster.

static PCP_API PcpMapFunction PcpMapFunction::Create ( const PathMap sourceToTargetMap,
const SdfLayerOffset offset 

Constructs a map function with the given arguments. Returns a null map function on error (see IsNull()).

sourceToTargetMapThe map from source paths to target paths.
offsetThe time offset to apply from source to target.
PCP_API PcpMapFunction PcpMapFunction::GetInverse ( ) const

Return the inverse of this map function. This returns a true inverse inv: for any path p in this function's domain that it maps to p', inv(p') -> p.

PCP_API PathMap PcpMapFunction::GetSourceToTargetMap ( ) const

The set of path mappings, from source to target.

PCP_API std::string PcpMapFunction::GetString ( ) const

Returns a string representation of this mapping for debugging purposes.

const SdfLayerOffset& PcpMapFunction::GetTimeOffset ( ) const

The time offset of the mapping.

Definition at line 176 of file mapFunction.h.

PCP_API size_t PcpMapFunction::Hash ( ) const

Return a size_t hash for this map function.

bool PcpMapFunction::HasRootIdentity ( ) const

Return true if the map function maps the absolute root path to the absolute root path, false otherwise.

Definition at line 141 of file mapFunction.h.

static PCP_API const PcpMapFunction& PcpMapFunction::Identity ( )

Construct an identity map function.

static PCP_API const PathMap& PcpMapFunction::IdentityPathMap ( )

Returns an identity path mapping.

PCP_API bool PcpMapFunction::IsIdentity ( ) const

Return true if the map function is the identity function. The identity function has an identity path mapping and time offset.

PCP_API bool PcpMapFunction::IsIdentityPathMapping ( ) const

Return true if the map function uses the identity path mapping. If true, MapSourceToTarget() always returns the path unchanged. However, this map function may have a non-identity time offset.

PCP_API bool PcpMapFunction::IsNull ( ) const

Return true if this map function is the null function. For a null function, MapSourceToTarget() always returns an empty path.

PCP_API SdfPath PcpMapFunction::MapSourceToTarget ( const SdfPath path) const

Map a path in the source namespace to the target. If the path is not in the domain, returns an empty path.

PCP_API SdfPath PcpMapFunction::MapTargetToSource ( const SdfPath path) const

Map a path in the target namespace to the source. If the path is not in the co-domain, returns an empty path.


PCP_API bool PcpMapFunction::operator== ( const PcpMapFunction map) const


PCP_API void PcpMapFunction::Swap ( PcpMapFunction map)

Swap the contents of this map function with map.

void PcpMapFunction::swap ( PcpMapFunction map)

Definition at line 113 of file mapFunction.h.

Friends And Related Function Documentation

PcpMapFunction* Pcp_MakeIdentity ( )

The documentation for this class was generated from the following file: