UsdInherits Class Reference

A proxy class for applying listOp edits to the inherit paths list for a prim. More...

Public Member Functions

USD_API bool AddInherit (const SdfPath &primPath, UsdListPosition position=UsdListPositionBackOfPrependList)
 Adds a path to the inheritPaths listOp at the current EditTarget, in the position specified by position. More...
 
USD_API bool RemoveInherit (const SdfPath &primPath)
 Removes the specified path from the inheritPaths listOp at the current EditTarget. More...
 
USD_API bool ClearInherits ()
 Removes the authored inheritPaths listOp edits at the current edit target. More...
 
USD_API bool SetInherits (const SdfPathVector &items)
 Explicitly set the inherited paths, potentially blocking weaker opinions that add or remove items, returning true on success, false if the edit could not be performed. More...
 
USD_API SdfPathVector GetAllDirectInherits () const
 Return all the paths in this prim's stage's local layer stack that would compose into this prim via direct inherits (excluding prim specs that would be composed into this prim due to inherits authored on ancestral prims) in strong-to-weak order. More...
 
const UsdPrimGetPrim () 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 inherit paths list for a prim.

All paths passed to the UsdInherits API are expected to be in the namespace of the owning prim's stage. Subroot prim inherit 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 inherit paths will not be translated.

Definition at line 51 of file inherits.h.

Member Function Documentation

◆ AddInherit()

USD_API bool AddInherit ( const SdfPath primPath,
UsdListPosition  position = UsdListPositionBackOfPrependList 
)

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

◆ ClearInherits()

USD_API bool ClearInherits ( )

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

◆ GetAllDirectInherits()

USD_API SdfPathVector GetAllDirectInherits ( ) const

Return all the paths in this prim's stage's local layer stack that would compose into this prim via direct inherits (excluding prim specs that would be composed into this prim due to inherits authored on ancestral prims) in strong-to-weak order.

Note that there currently may not be any scene description at these paths on the stage. This returns all the potential places that such opinions could appear.

◆ GetPrim()

const UsdPrim& GetPrim ( ) const
inline

Return the prim this object is bound to.

Definition at line 91 of file inherits.h.

◆ RemoveInherit()

USD_API bool RemoveInherit ( const SdfPath primPath)

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

◆ SetInherits()

USD_API bool SetInherits ( const SdfPathVector &  items)

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


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