UsdSpecializes Class Reference

#include <specializes.h>

Public Member Functions
USD_API bool	AddSpecialize (const SdfPath &primPath, UsdListPosition position=UsdListPositionBackOfPrependList)
USD_API bool	RemoveSpecialize (const SdfPath &primPath)
USD_API bool	ClearSpecializes ()
USD_API bool	SetSpecializes (const SdfPathVector &items)
const UsdPrim &	GetPrim () const
	Return the prim this object is bound to. More...
UsdPrim	GetPrim ()
	operator bool ()

Friends
class	UsdPrim

Detailed Description

A proxy class for applying listOp edits to the specializes list for a prim.

All paths passed to the UsdSpecializes API are expected to be in the namespace of the owning prim's stage. Subroot prim specializes paths will be translated from this namespace to the namespace of the current edit target, if necessary. If a path cannot be translated, a coding error will be issued and no changes will be made. Root prim specializes paths will not be translated.

Definition at line 51 of file specializes.h.

Member Function Documentation

USD_API bool UsdSpecializes::AddSpecialize	(	const SdfPath &	primPath,
		UsdListPosition	position = UsdListPositionBackOfPrependList
	)

Adds a path to the specializes listOp at the current EditTarget, in the position specified by position.

USD_API bool UsdSpecializes::ClearSpecializes

(

)

Removes the authored specializes listOp edits at the current edit target.

const UsdPrim& UsdSpecializes::GetPrim ( ) const

inline

Return the prim this object is bound to.

Definition at line 81 of file specializes.h.

UsdPrim UsdSpecializes::GetPrim ( )

inline

Definition at line 82 of file specializes.h.

UsdSpecializes::operator bool ( )

inlineexplicit

Definition at line 84 of file specializes.h.

USD_API bool UsdSpecializes::RemoveSpecialize

(

const SdfPath &

primPath

)

Removes the specified path from the specializes listOp at the current EditTarget.

USD_API bool UsdSpecializes::SetSpecializes

(

const SdfPathVector &

items

)

Explicitly set specializes paths, potentially blocking weaker opinions that add or remove items, returning true on success, false if the edit could not be performed.

Friends And Related Function Documentation

friend class UsdPrim

friend

Definition at line 52 of file specializes.h.

---

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

• pxr/usd/usd/specializes.h