SdfCopySpecsValueEdit Class Reference

Value containing an editing operation for SdfCopySpecs. More...

#include <copyUtils.h>

Public Types
using	EditFunction
	Callback to apply a scene description edit to the specified layer and spec path.

Public Member Functions
	SdfCopySpecsValueEdit (const EditFunction &edit)
const EditFunction &	GetEditFunction () const
bool	operator== (const SdfCopySpecsValueEdit &rhs) const
	SdfCopySpecsValueEdit objects are not comparable, but must provide operator== to be stored in a VtValue.
bool	operator!= (const SdfCopySpecsValueEdit &rhs) const

Detailed Description

Value containing an editing operation for SdfCopySpecs.

The SdfShouldCopyValueFn callback allows users to return a value to copy into the destination spec via the valueToCopy parameter. However, there may be cases where it would be more efficient to perform incremental edits using specific SdfLayer API instead.

To accommodate this, consumers may provide a callback that applies a scene description edit in valueToCopy via an SdfCopySpecsValueEdit object.

Definition at line 105 of file copyUtils.h.

Member Typedef Documentation

EditFunction

using EditFunction

Initial value:

 
        std::function<void(const SdfLayerHandle&, const SdfPath&)>

Callback to apply a scene description edit to the specified layer and spec path.

Definition at line 110 of file copyUtils.h.

Constructor & Destructor Documentation

SdfCopySpecsValueEdit()

SdfCopySpecsValueEdit ( const EditFunction & edit )

inlineexplicit

Definition at line 113 of file copyUtils.h.

Member Function Documentation

GetEditFunction()

const EditFunction & GetEditFunction ( ) const

inline

Definition at line 114 of file copyUtils.h.

operator!=()

bool operator!= ( const SdfCopySpecsValueEdit & rhs ) const

inline

Definition at line 119 of file copyUtils.h.

operator==()

bool operator== ( const SdfCopySpecsValueEdit & rhs ) const

inline

SdfCopySpecsValueEdit objects are not comparable, but must provide operator== to be stored in a VtValue.

Definition at line 118 of file copyUtils.h.

---

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

• pxr/usd/sdf/copyUtils.h