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

#include <stageEdit.h>

+ Inheritance diagram for GusdStageEdit:

Public Member Functions

bool Apply (const SdfLayerHandle &layer, UT_ErrorSeverity sev=UT_ERROR_ABORT) const
 
bool Apply (const UsdStagePtr &stage, UT_ErrorSeverity sev=UT_ERROR_ABORT) const
 
size_t GetHash () const
 
bool operator== (const GusdStageEdit &o) const
 
const UT_Array< SdfPath > & GetVariants () const
 
UT_Array< SdfPath > & GetVariants ()
 
const std::vector< std::string > & GetLayersToMute () const
 
std::vector< std::string > & GetLayersToMute ()
 
- Public Member Functions inherited from UT_IntrusiveRefCounter< GusdStageEdit >
SYS_FORCE_INLINE UT_IntrusiveRefCounter () noexcept
 Default constructor: Sets counter to 0. More...
 
SYS_FORCE_INLINE UT_IntrusiveRefCounter (const UT_IntrusiveRefCounter &) noexcept
 Copy constructor: Sets counter to 0. More...
 
UT_IntrusiveRefCounteroperator= (const UT_IntrusiveRefCounter &) noexcept
 Assignment operator: Does not modify counter. More...
 
SYS_FORCE_INLINE uint32 use_count () const noexcept
 Return current counter. More...
 

Static Public Member Functions

static void GetPrimPathAndEditFromVariantsPath (const SdfPath &pathWithVariants, SdfPath &primPath, GusdStageEditPtr &edit)
 

Additional Inherited Members

- Protected Member Functions inherited from UT_IntrusiveRefCounter< GusdStageEdit >
SYS_FORCE_INLINE ~UT_IntrusiveRefCounter ()
 Destructor: Only derived classes can destruct this. More...
 

Detailed Description

Basic stage edit covering common types of edits.

This class provides a single point for describing all of the common types of edits so that, at least in the typical cases, code pulling data from the stage cache are using a common type of edit.

Note that when applying variant edits, variant selection paths should be stripped of any trailing path components following the variant selection. For example, rather than creating an edit applying variant selection /foo{a=b}bar, it is better to use path /foo{a=b} as the variant selection path. The GetPrimPathAndEditFromVariantsPath helper automatically strips all such trailing path components.

Definition at line 57 of file stageEdit.h.

Member Function Documentation

bool GusdStageEdit::Apply ( const SdfLayerHandle &  layer,
UT_ErrorSeverity  sev = UT_ERROR_ABORT 
) const
bool GusdStageEdit::Apply ( const UsdStagePtr &  stage,
UT_ErrorSeverity  sev = UT_ERROR_ABORT 
) const
size_t GusdStageEdit::GetHash ( ) const
const std::vector<std::string>& GusdStageEdit::GetLayersToMute ( ) const
inline

Definition at line 88 of file stageEdit.h.

std::vector<std::string>& GusdStageEdit::GetLayersToMute ( )
inline

Definition at line 91 of file stageEdit.h.

static void GusdStageEdit::GetPrimPathAndEditFromVariantsPath ( const SdfPath pathWithVariants,
SdfPath primPath,
GusdStageEditPtr edit 
)
static

Extract a prim path and an edit from a path string, which may include variant selections. This covers the common case where a single parameter provides a prim path, which may include variant selections (Eg., as /foo{variant=sel}bar).

const UT_Array<SdfPath>& GusdStageEdit::GetVariants ( ) const
inline

Definition at line 82 of file stageEdit.h.

UT_Array<SdfPath>& GusdStageEdit::GetVariants ( )
inline

Definition at line 85 of file stageEdit.h.

bool GusdStageEdit::operator== ( const GusdStageEdit o) const

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