24 #ifndef PXR_USD_USD_PRIM_H 25 #define PXR_USD_USD_PRIM_H 30 #include "pxr/usd/usd/api.h" 35 #include "pxr/usd/sdf/schema.h" 43 #include "pxr/usd/sdf/path.h" 45 #include <boost/iterator/iterator_adaptor.hpp> 46 #include <boost/range/iterator_range.hpp> 49 #include <type_traits> 52 PXR_NAMESPACE_OPEN_SCOPE
155 return _Prim()->GetPrimTypeInfo();
162 return _Prim()->GetPrimDefinition();
187 return SetMetadata(SdfFieldKeys->Specifier, specifier);
201 return SetMetadata(SdfFieldKeys->TypeName, typeName);
219 bool IsActive()
const {
return _Prim()->IsActive(); }
249 bool IsLoaded()
const {
return _Prim()->IsLoaded(); }
253 bool IsModel()
const {
return _Prim()->IsModel(); }
258 bool IsGroup()
const {
return _Prim()->IsGroup(); }
270 return _Prim()->HasDefiningSpecifier();
285 std::function<bool (
const TfToken &propertyName)>;
395 std::vector<UsdProperty>
403 std::vector<UsdProperty>
412 std::vector<UsdProperty>
414 const std::vector<std::string> &namespaces)
const;
422 std::vector<UsdProperty>
477 bool _IsA(
const TfType& schemaType,
bool validateSchemaType)
const;
482 bool _HasSingleApplyAPI(
const TfType& schemaType)
const;
485 bool _HasMultiApplyAPI(
const TfType& schemaType,
486 const TfToken &instanceName)
const;
495 bool _CanApplyAPI(
const TfType& schemaType,
496 std::string *whyNot)
const;
499 bool _CanApplyAPI(
const TfType& schemaType,
501 std::string *whyNot)
const;
504 bool _ApplyAPI(
const TfType& schemaType)
const;
507 bool _ApplyAPI(
const TfType& schemaType,
508 const TfToken& instanceName)
const;
511 bool _RemoveAPI(
const TfType& schemaType)
const;
514 bool _RemoveAPI(
const TfType& schemaType,
515 const TfToken& instanceName)
const;
522 template <
typename T>
524 static_assert(std::is_base_of<UsdSchemaBase, T>::value,
525 "Provided type must derive UsdSchemaBase.");
526 return _IsA(TfType::Find<T>(),
false);
534 bool IsA(
const TfType& schemaType)
const;
569 template <
typename T>
573 static_assert(std::is_base_of<UsdAPISchemaBase, T>::value,
574 "Provided type must derive UsdAPISchemaBase.");
575 static_assert(!std::is_same<UsdAPISchemaBase, T>::value,
576 "Provided type must not be UsdAPISchemaBase.");
583 "Provided schema type must be a single apply API schema.");
585 return _HasSingleApplyAPI(TfType::Find<T>());
596 template <
typename T>
600 static_assert(std::is_base_of<UsdAPISchemaBase, T>::value,
601 "Provided type must derive UsdAPISchemaBase.");
602 static_assert(!std::is_same<UsdAPISchemaBase, T>::value,
603 "Provided type must not be UsdAPISchemaBase.");
605 "Provided schema type must be a multi apply API schema.");
607 return _HasMultiApplyAPI(TfType::Find<T>(), instanceName);
640 template <
typename SchemaType>
642 static_assert(std::is_base_of<UsdAPISchemaBase, SchemaType>::value,
643 "Provided type must derive UsdAPISchemaBase.");
644 static_assert(!std::is_same<UsdAPISchemaBase, SchemaType>::value,
645 "Provided type must not be UsdAPISchemaBase.");
647 "Provided schema type must be a single apply API schema.");
649 static const TfType schemaType = TfType::Find<SchemaType>();
650 return _CanApplyAPI(schemaType, whyNot);
661 std::string *whyNot =
nullptr)
const;
676 template <
typename SchemaType>
678 std::string *whyNot =
nullptr)
const {
679 static_assert(std::is_base_of<UsdAPISchemaBase, SchemaType>::value,
680 "Provided type must derive UsdAPISchemaBase.");
681 static_assert(!std::is_same<UsdAPISchemaBase, SchemaType>::value,
682 "Provided type must not be UsdAPISchemaBase.");
684 "Provided schema type must be a multiple apply API schema.");
686 static const TfType schemaType = TfType::Find<SchemaType>();
687 return _CanApplyAPI(schemaType, instanceName, whyNot);
699 std::string *whyNot =
nullptr)
const;
716 template <
typename SchemaType>
718 static_assert(std::is_base_of<UsdAPISchemaBase, SchemaType>::value,
719 "Provided type must derive UsdAPISchemaBase.");
720 static_assert(!std::is_same<UsdAPISchemaBase, SchemaType>::value,
721 "Provided type must not be UsdAPISchemaBase.");
723 "Provided schema type must be a single apply API schema.");
725 static const TfType schemaType = TfType::Find<SchemaType>();
726 return _ApplyAPI(schemaType);
758 template <
typename SchemaType>
760 static_assert(std::is_base_of<UsdAPISchemaBase, SchemaType>::value,
761 "Provided type must derive UsdAPISchemaBase.");
762 static_assert(!std::is_same<UsdAPISchemaBase, SchemaType>::value,
763 "Provided type must not be UsdAPISchemaBase.");
765 "Provided schema type must be a multiple apply API schema.");
767 static const TfType schemaType = TfType::Find<SchemaType>();
768 return _ApplyAPI(schemaType, instanceName);
796 template <
typename SchemaType>
798 static_assert(std::is_base_of<UsdAPISchemaBase, SchemaType>::value,
799 "Provided type must derive UsdAPISchemaBase.");
800 static_assert(!std::is_same<UsdAPISchemaBase, SchemaType>::value,
801 "Provided type must not be UsdAPISchemaBase.");
803 "Provided schema type must be a single apply API schema.");
805 static const TfType schemaType = TfType::Find<SchemaType>();
806 return _RemoveAPI(schemaType);
839 template <
typename SchemaType>
841 static_assert(std::is_base_of<UsdAPISchemaBase, SchemaType>::value,
842 "Provided type must derive UsdAPISchemaBase.");
843 static_assert(!std::is_same<UsdAPISchemaBase, SchemaType>::value,
844 "Provided type must not be UsdAPISchemaBase.");
846 "Provided schema type must be a multiple apply API schema.");
848 static const TfType schemaType = TfType::Find<SchemaType>();
849 return _RemoveAPI(schemaType, instanceName);
860 const TfToken& instanceName)
const;
976 const Usd_PrimFlagsPredicate &predicate)
const;
1056 Usd_PrimDataConstPtr prim = get_pointer(_Prim());
1057 SdfPath proxyPrimPath = _ProxyPrimPath();
1058 Usd_MoveToParent(prim, proxyPrimPath);
1059 return UsdPrim(prim, proxyPrimPath);
1080 const Usd_PrimFlagsPredicate &predicate)
const;
1224 const std::vector<std::string> &nameElts,
1233 const std::vector<std::string> &nameElts,
1274 std::function<
bool (
UsdAttribute const &)>
const &pred =
nullptr,
1275 bool recurseOnSources =
false)
const;
1319 bool custom=
true)
const;
1369 bool recurseOnTargets =
false)
const;
1405 const std::string& assetPath,
const SdfPath& primPath)
const;
1518 bool instanceable =
false;
1519 return GetMetadata(SdfFieldKeys->Instanceable, &instanceable) &&
1526 return SetMetadata(SdfFieldKeys->Instanceable, instanceable);
1552 return Usd_IsInstanceProxy(_Prim(), _ProxyPrimPath());
1667 friend class Usd_PrimData;
1668 friend class Usd_PrimFlagsPredicate;
1669 friend struct UsdPrim_RelTargetFinder;
1670 friend struct UsdPrim_AttrConnectionFinder;
1673 UsdPrim(
const Usd_PrimDataHandle &primData,
1675 :
UsdObject(primData, proxyPrimPath) { }
1679 const Usd_PrimDataHandle &prim,
1682 :
UsdObject(objType, prim, proxyPrimPath, propName) {}
1686 _MakeSiblingRange(
const Usd_PrimFlagsPredicate &pred)
const;
1690 _MakeDescendantsRange(
const Usd_PrimFlagsPredicate &pred)
const;
1693 std::vector<UsdProperty>
1699 bool applyOrder=
true,
1703 std::vector<UsdProperty>
1704 _GetPropertiesInNamespace(
const std::string &namespaces,
1705 bool onlyAuthored)
const;
1708 std::vector<UsdAttribute>
1709 _GetAttributes(
bool onlyAuthored,
bool applyOrder=
false)
const;
1712 std::vector<UsdRelationship>
1713 _GetRelationships(
bool onlyAuthored,
bool applyOrder=
false)
const;
1726 {
return _Prim()->GetSourcePrimIndex(); }
1780 template <
class ForwardRange>
1784 template <
class ForwardRange>
1794 operator unspecified_bool_type()
const;
1797 bool equal(
const iterator_range&)
const;
1825 UsdPrimSiblingIterator,
1826 const Usd_PrimData *,
1828 boost::forward_traversal_tag,
1840 const Usd_PrimFlagsPredicate &predicate)
1841 : iterator_adaptor_(i)
1842 , _proxyPrimPath(proxyPrimPath)
1843 , _predicate(predicate) {
1845 if (base() && !Usd_EvalPredicate(_predicate, base(), _proxyPrimPath))
1850 friend class boost::iterator_core_access;
1852 return base() == other.base() &&
1853 _proxyPrimPath == other._proxyPrimPath &&
1854 _predicate == other._predicate;
1858 base_type &base = base_reference();
1859 if (Usd_MoveToNextSiblingOrParent(base, _proxyPrimPath, _predicate)) {
1866 return UsdPrim(base(), _proxyPrimPath);
1870 Usd_PrimFlagsPredicate _predicate;
1878 struct Tf_ShouldIterateOverCopy<
1881 struct Tf_ShouldIterateOverCopy<
1890 return _MakeSiblingRange(
1891 Usd_CreatePredicateForTraversal(_Prim(), _ProxyPrimPath(), pred));
1908 UsdPrim::_MakeSiblingRange(
const Usd_PrimFlagsPredicate &pred)
const {
1909 Usd_PrimDataConstPtr firstChild = get_pointer(_Prim());
1910 SdfPath firstChildPath = _ProxyPrimPath();
1911 if (!Usd_MoveToChild(firstChild, firstChildPath, pred)) {
1912 firstChild =
nullptr;
1916 return SiblingRange(
1972 template <
class ForwardRange>
1976 template <
class ForwardRange>
1986 operator unspecified_bool_type()
const;
1989 bool equal(
const iterator_range&)
const;
2017 UsdPrimSubtreeIterator,
2018 const Usd_PrimData *,
2020 boost::forward_traversal_tag,
2032 const Usd_PrimFlagsPredicate &predicate)
2033 : iterator_adaptor_(i)
2034 , _proxyPrimPath(proxyPrimPath)
2035 , _predicate(predicate) {
2037 base_type &base = base_reference();
2038 if (base && !Usd_EvalPredicate(_predicate, base, _proxyPrimPath)) {
2039 if (Usd_MoveToNextSiblingOrParent(base, _proxyPrimPath,
2048 friend class boost::iterator_core_access;
2050 return base() == other.base() &&
2051 _proxyPrimPath == other._proxyPrimPath &&
2052 _predicate == other._predicate;
2056 base_type &base = base_reference();
2057 if (!Usd_MoveToChild(base, _proxyPrimPath, _predicate)) {
2058 while (Usd_MoveToNextSiblingOrParent(base, _proxyPrimPath,
2064 return UsdPrim(base(), _proxyPrimPath);
2068 Usd_PrimFlagsPredicate _predicate;
2076 struct Tf_ShouldIterateOverCopy<
2079 struct Tf_ShouldIterateOverCopy<
2087 return _MakeDescendantsRange(
2088 Usd_CreatePredicateForTraversal(_Prim(), _ProxyPrimPath(), pred));
2105 UsdPrim::_MakeDescendantsRange(
const Usd_PrimFlagsPredicate &pred)
const {
2106 Usd_PrimDataConstPtr firstChild = get_pointer(_Prim());
2107 SdfPath firstChildPath = _ProxyPrimPath();
2108 Usd_PrimDataConstPtr endChild = firstChild;
2109 SdfPath endChildPath = firstChildPath;
2110 if (Usd_MoveToChild(firstChild, firstChildPath, pred)) {
2111 while (Usd_MoveToNextSiblingOrParent(endChild, endChildPath, pred)) {}
2114 return SubtreeRange(
2126 return UsdPrim(_prim, _proxyPrimPath);
2129 PXR_NAMESPACE_CLOSE_SCOPE
2131 #endif // PXR_USD_USD_PRIM_H const UsdPrimTypeInfo & GetPrimTypeInfo() const
Return the prim's full type info composed from its type name, applied API schemas,...
void ClearPropertyOrder() const
Remove the opinion for propertyOrder metadata on this prim at the current EditTarget.
A proxy class for applying listOp edits to the specializes list for a prim.
bool SetMetadata(const TfToken &key, const T &value) const
Set metadatum key's value to value.
iterator::value_type value_type
Iterator value_type.
USD_API std::vector< UsdRelationship > GetAuthoredRelationships() const
Like GetRelationships(), but exclude relationships without authored scene description from the result...
unspecified integral type difference_type
Iterator difference type.
USD_API bool HasAttribute(const TfToken &attrName) const
Return true if this prim has an attribute named attrName, false otherwise.
UsdObjType
Enum values to represent the various Usd object types.
bool SetSpecifier(SdfSpecifier specifier) const
Author an opinion for this Prim's specifier at the current edit target.
USD_API bool HasAuthoredPayloads() const
Return true if this prim has any authored payloads.
USD_API bool AddAppliedSchema(const TfToken &appliedSchemaName) const
Adds the applied API schema name token appliedSchemaName to the apiSchemas metadata for this prim at ...
bool empty() const
Return begin() == end().
PcpPrimIndex is an index of the all sites of scene description that contribute opinions to a specific...
bool CanApplyAPI(std::string *whyNot=nullptr) const
}@
unspecified UsdPrimDefaultPredicate
The default predicate used for prim traversals in methods like UsdPrim::GetChildren,...
USD_API UsdInherits GetInherits() const
Return a UsdInherits object that allows one to add, remove, or mutate inherits at the currently set U...
Standard pointer typedefs.
friend bool operator!=(const UsdPrimSubtreeIterator &lhs, const UsdPrimSubtreeIterator &rhs)
Inequality.
iterator end() const
Past-the-end iterator.
SubtreeRange GetFilteredDescendants(const Usd_PrimFlagsPredicate &predicate) const
Return a subset of all of this prim's descendants filtered by predicate as an iterable range.
value_type reference
Iterator reference type, in this case the same as value_type.
friend bool operator==(const UsdPrimSiblingIterator &lhs, const UsdPrimSiblingIterator &rhs)
Equality.
bool CanApplyAPI(const TfToken &instanceName, std::string *whyNot=nullptr) const
Returns whether a multiple-apply API schema with the given C++ type 'SchemaType' can be applied to th...
bool IsGroup() const
Return true if this prim is a model group based on its kind metadata, false otherwise.
SdfSpecifier GetSpecifier() const
Return this prim's composed specifier.
UsdPrimSiblingIterator iterator
Iterator type.
void SetChildrenReorder(const TfTokenVector &order) const
Author an opinion for the metadata used to reorder children of this prim at the current EditTarget.
friend bool operator!=(const UsdPrimSiblingRange &lhs, const UsdPrimSiblingRange &rhs)
Inequality comparison.
USD_API UsdProperty GetProperty(const TfToken &propName) const
Return a UsdProperty with the name propName.
USD_API std::vector< UsdAttribute > GetAttributes() const
Like GetProperties(), but exclude all relationships from the result.
USD_API UsdAttribute CreateAttribute(const TfToken &name, const SdfValueTypeName &typeName, bool custom, SdfVariability variability=SdfVariabilityVarying) const
Author scene description for the attribute named attrName at the current EditTarget if none already e...
UsdPrim value_type
Iterator value type.
bool IsActive() const
Return true if this prim is active, meaning neither it nor any of its ancestors have active=false.
bool ClearInstanceable() const
Remove the authored 'instanceable' opinion at the current EditTarget.
bool HasAuthoredInstanceable() const
Return true if this prim has an authored opinion for 'instanceable', false otherwise.
friend bool operator!=(const UsdPrimSiblingIterator &lhs, const UsdPrimSiblingIterator &rhs)
Inequality.
USD_API UsdReferences GetReferences() const
Return a UsdReferences object that allows one to add, remove, or mutate references at the currently s...
USD_API std::vector< UsdProperty > GetProperties(const PropertyPredicateFunc &predicate={}) const
Return all of this prim's properties (attributes and relationships), including all builtin properties...
bool empty() const
Return begin() == end().
SubtreeRange GetDescendants() const
Return this prim's active, loaded, defined, non-abstract descendants as an iterable range.
The outermost container for scene description, which owns and presents composed prims as a scenegraph...
friend bool operator==(const UsdPrimSiblingRange &lhs, const UsdPrimSiblingRange &rhs)
Equality comparison.
Represents a value type name, i.e.
Load a prim plus all its descendants.
bool IsInstanceable() const
Return true if this prim has been marked as instanceable.
A proxy class for applying listOp edits to the inherit paths list for a prim.
friend bool operator!=(const UsdPrimSubtreeRange &lhs, const UsdPrimSubtreeRange &rhs)
Inequality comparison.
static USD_API bool IsPathInPrototype(const SdfPath &path)
Return true if the given path identifies a prototype prim or a prim or property descendant of a proto...
UsdPrimSiblingIterator & operator++()
Postincrement.
unspecified integral type difference_type
Iterator difference type.
USD_API TfTokenVector GetChildrenNames() const
Return the names of the child prims in the order they appear when iterating over GetChildren.
USD_API bool HasAuthoredInherits() const
Return true if this prim has any authored inherits.
USD_API UsdPrim GetFilteredNextSibling(const Usd_PrimFlagsPredicate &predicate) const
Return this prim's next sibling that matches predicate if it has one, otherwise return the invalid Us...
USD_API std::vector< UsdProperty > GetAuthoredPropertiesInNamespace(const std::vector< std::string > &namespaces) const
Like GetPropertiesInNamespace(), but exclude properties that do not have authored scene description f...
The base class for all API schemas.
USD_API UsdVariantSet GetVariantSet(const std::string &variantSetName) const
Retrieve a specifically named VariantSet for editing or constructing a UsdEditTarget.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
USD_API UsdPrim GetChild(const TfToken &name) const
Return this prim's direct child named name if it has one, otherwise return an invalid UsdPrim.
USD_API bool RemoveProperty(const TfToken &propName)
Remove all scene description for the property with the given propName in the current UsdEditTarget.
bool IsInstance() const
Return true if this prim is an instance of a prototype, false otherwise.
USD_API void Load(UsdLoadPolicy policy=UsdLoadWithDescendants) const
Load this prim, all its ancestors, and by default all its descendants.
USD_API bool HasAuthoredSpecializes() const
Returns true if this prim has any authored specializes.
bool IsInPrototype() const
Return true if this prim is a prototype prim or a descendant of a prototype prim, false otherwise.
bool equal(const iterator_range &) const
Equality compare.
USD_API TfTokenVector GetPropertyOrder() const
Return the strongest propertyOrder metadata value authored on this prim.
USD_API bool IsPseudoRoot() const
Returns true if the prim is the pseudo root.
Forward iterator range of sibling UsdPrim s.
UsdReferences provides an interface to authoring and introspecting references in Usd.
USD_API UsdAttribute GetAttribute(const TfToken &attrName) const
Return a UsdAttribute with the name attrName.
USD_API bool HasAuthoredReferences() const
Return true if this prim has any authored references.
UsdPrimSubtreeIterator iterator
Iterator type.
iterator::value_type value_type
Iterator value_type.
USD_API bool HasRelationship(const TfToken &relName) const
Return true if this prim has a relationship named relName, false otherwise.
USD_API SdfPathVector FindAllRelationshipTargetPaths(std::function< bool(UsdRelationship const &)> const &pred=nullptr, bool recurseOnTargets=false) const
Search the prim subtree rooted at this prim for relationships for which predicate returns true,...
reference front() const
Return *begin(). This range must not be empty.
void SetPropertyOrder(const TfTokenVector &order) const
Author an opinion for propertyOrder metadata on this prim at the current EditTarget.
Token for efficient comparison, assignment, and hashing of known strings.
bool SetInstanceable(bool instanceable) const
Author 'instanceable' metadata for this prim at the current EditTarget.
USD_API PcpPrimIndex ComputeExpandedPrimIndex() const
Compute the prim index containing all sites that could contribute opinions to this prim.
bool RemoveAPI() const
Removes a single-apply API schema with the given C++ type 'SchemaType' from this prim in the current ...
std::enable_if< T::schemaKind==UsdSchemaKind::MultipleApplyAPI, bool >::type HasAPI(const TfToken &instanceName=TfToken()) const
Return true if the UsdPrim has had a multiple-apply API schema represented by the C++ class type T ap...
reference operator *() const
Dereference.
unspecified integral type difference_type
Iterator difference type.
iterator_range & advance_end(difference_type n)
Advance this range's end iterator.
USD_API bool ClearMetadata(const TfToken &key) const
Clears the authored key's value at the current EditTarget, returning false on error.
iterator begin() const
First iterator.
const UsdPrimDefinition & GetPrimDefinition() const
Return this prim's definition based on the prim's type if the type is a registered prim type.
UsdPrimSiblingRange(UsdPrimSiblingIterator begin, UsdPrimSiblingIterator end)
Construct with a pair of iterators.
const PcpPrimIndex & GetPrimIndex() const
Return the cached prim index containing all sites that can contribute opinions to this prim.
UsdPrimSubtreeIterator & operator++()
Postincrement.
bool IsAbstract() const
Return true if this prim or any of its ancestors is a class.
USD_API TfTokenVector GetAuthoredPropertyNames(const PropertyPredicateFunc &predicate={}) const
Return this prim's property names (attributes and relationships) that have authored scene description...
USD_API bool HasProperty(const TfToken &propName) const
Return true if this prim has an property named propName, false otherwise.
USD_API bool SetPayload(const SdfPayload &payload) const
USD_API std::vector< UsdProperty > GetPropertiesInNamespace(const std::vector< std::string > &namespaces) const
Return this prim's properties that are inside the given property namespace ordered according to the s...
A UsdVariantSet represents a single VariantSet in USD (e.g.
bool ApplyAPI() const
Applies a single-apply API schema with the given C++ type 'SchemaType' to this prim in the current ed...
Forward iterator range of sibling UsdPrim s.
USD_API TfTokenVector GetAllChildrenNames() const
Return the names of the child prims in the order they appear when iterating over GetAllChildren.
USD_API UsdPrim GetPrototype() const
If this prim is an instance, return the UsdPrim for the corresponding prototype.
UsdPrim GetParent() const
Return this prim's parent prim.
SiblingRange GetFilteredChildren(const Usd_PrimFlagsPredicate &predicate) const
Return a subset of all of this prim's children filtered by predicate as an iterable range.
SiblingRange GetChildren() const
Return this prim's active, loaded, defined, non-abstract children as an iterable range.
Base class for Usd scenegraph objects, providing common API.
Represents a payload and all its meta data.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
UsdPrimSiblingRange & operator=(const ForwardRange &r)
Assign from another compatible range type.
bool IsA() const
Return true if the prim's schema type, is or inherits schema type T.
SdfSpecifier
An enum that identifies the possible specifiers for an SdfPrimSpec.
UsdPrim value_type
Iterator value type.
std::vector< TfToken > TfTokenVector
Convenience types.
friend bool operator==(const UsdPrimSubtreeRange &lhs, const UsdPrimSubtreeRange &rhs)
Equality comparison.
bool IsInstanceProxy() const
Return true if this prim is an instance proxy, false otherwise.
UsdPrimSubtreeRange & operator=(const ForwardRange &r)
Assign from another compatible range type.
const TfToken & GetTypeName() const
Return this prim's composed type name.
SubtreeRange GetAllDescendants() const
Return all this prim's descendants as an iterable range.
unspecified type operator->() const
Indirection.
USD_API bool HasVariantSets() const
Return true if this prim has any authored VariantSets.
USD_API UsdVariantSets GetVariantSets() const
Return a UsdVariantSets object representing all the VariantSets present on this prim.
A path value used to locate objects in layers or scenegraphs.
USD_API bool ClearPayload() const
bool GetMetadata(const TfToken &key, T *value) const
Resolve the requested metadatum named key into value, returning true on success.
iterator_range & advance_begin(difference_type n)
Advance this range's begin iterator.
iterator::reference reference
Iterator reference_type.
USD_API bool HasPayload() const
UsdPayloads provides an interface to authoring and introspecting payloads.
bool HasAuthoredActive() const
Return true if this prim has an authored opinion for 'active', false otherwise.
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
USD_API TfTokenVector GetPropertyNames(const PropertyPredicateFunc &predicate={}) const
Return all of this prim's property names (attributes and relationships), including all builtin proper...
USD_API SdfPathVector FindAllAttributeConnectionPaths(std::function< bool(UsdAttribute const &)> const &pred=nullptr, bool recurseOnSources=false) const
Search the prim subtree rooted at this prim for attributes for which predicate returns true,...
USD_API UsdRelationship GetRelationshipAtPath(const SdfPath &path) const
Returns the relationship at path on the same stage as this prim.
unspecified type operator->() const
Indirection.
USD_API void Unload() const
Unloads this prim and all its descendants.
SdfVariability
An enum that identifies variability types for attributes.
bool ClearTypeName() const
Clear the opinion for this Prim's typeName at the current edit target.
Class that holds the full type information for a prim.
SiblingRange GetAllChildren() const
Return all this prim's children as an iterable range.
bool RemoveAPI(const TfToken &instanceName) const
Removes a multiple-apply API schema with the given C++ type 'SchemaType' and instance name instanceNa...
USD_API std::vector< UsdPrim > GetInstances() const
If this prim is a prototype prim, returns all prims that are instances of this prototype.
friend bool operator==(const UsdPrimSubtreeIterator &lhs, const UsdPrimSubtreeIterator &rhs)
Equality.
UsdLoadPolicy
Controls UsdStage::Load() and UsdPrim::Load() behavior regarding whether or not descendant prims are ...
Multiple Apply API Schema.
UsdPrim GetPrimInPrototype() const
If this prim is an instance proxy, return the UsdPrim for the corresponding prim in the instance's pr...
Base class for UsdAttribute and UsdRelationship scenegraph objects.
bool ClearActive() const
Remove the authored 'active' opinion at the current EditTarget.
bool SetTypeName(const TfToken &typeName) const
Author this Prim's typeName at the current EditTarget.
An forward-iterable range that traverses a subtree of prims rooted at a given prim in depth-first ord...
const SdfPath & GetPrimPath() const
Return this object's path if this object is a prim, otherwise this object's nearest owning prim's pat...
bool HasAuthoredTypeName() const
Return true if a typeName has been authored.
void ClearChildrenReorder() const
Remove the opinion for the metadata used to reorder children of this prim at the current EditTarget.
bool IsModel() const
Return true if this prim is a model based on its kind metadata, false otherwise.
bool IsLoaded() const
Return true if this prim is active, and either it is loadable and it is loaded, or its nearest loadab...
unspecified integral type difference_type
Iterator difference type.
Class representing the builtin definition of a prim given the schemas registered in the schema regist...
reference operator *() const
Dereference.
bool IsPrototype() const
Return true if this prim is an instancing prototype prim, false otherwise.
Forward traversal iterator of sibling UsdPrim s.
unspecified UsdPrimAllPrimsPredicate
Predicate that includes all prims.
iterator begin() const
First iterator.
USD_API bool RemoveAppliedSchema(const TfToken &appliedSchemaName) const
Removes the applied API schema name token appliedSchemaName from the apiSchemas metadata for this pri...
UsdPrim()
Construct an invalid prim.
std::function< bool(const TfToken &propertyName)> PropertyPredicateFunc
Alias for the "predicate" function parameter passed into the various Get{Authored}{PropertyNames,...
reference front() const
Return *begin(). This range must not be empty.
TfType represents a dynamic runtime type.
UsdPrimSubtreeIterator SubtreeIterator
Convenience typedefs.
bool IsDefined() const
Return true if this prim and all its ancestors have defining specifiers, false otherwise.
USD_API SdfPrimSpecHandleVector GetPrimStack() const
Return all the authored SdfPrimSpecs that may contain opinions for this prim in order from strong to ...
bool equal(const iterator_range &) const
Equality compare.
USD_API TfTokenVector GetAppliedSchemas() const
Return a vector containing the names of API schemas which have been applied to this prim.
UsdPrimSiblingIterator SiblingIterator
Convenience typedefs.
USD_API UsdSpecializes GetSpecializes() const
Return a UsdSpecializes object that allows one to add, remove, or mutate specializes at the currently...
USD_API UsdPrim GetPrimAtPath(const SdfPath &path) const
Returns the prim at path on the same stage as this prim.
UsdPrimSiblingIterator const_iterator
Const iterator type.
USD_API UsdObject GetObjectAtPath(const SdfPath &path) const
Returns the object at path on the same stage as this prim.
UsdVariantSets represents the collection of VariantSets that are present on a UsdPrim.
iterator end() const
Past-the-end iterator.
bool SetActive(bool active) const
Author 'active' metadata for this prim at the current EditTarget.
UsdPrimSubtreeIterator const_iterator
Const iterator type.
The base class for all schema types in Usd.
USD_API UsdRelationship GetRelationship(const TfToken &relName) const
Return a UsdRelationship with the name relName.
iterator::reference reference
Iterator reference_type.
Forward traversal iterator of sibling UsdPrim s.
USD_API UsdAttribute GetAttributeAtPath(const SdfPath &path) const
Returns the attribute at path on the same stage as this prim.
USD_API UsdPrim GetNextSibling() const
Return this prim's next active, loaded, defined, non-abstract sibling if it has one,...
USD_API UsdProperty GetPropertyAtPath(const SdfPath &path) const
Returns the property at path on the same stage as this prim.
USD_API TfTokenVector GetFilteredChildrenNames(const Usd_PrimFlagsPredicate &predicate) const
Return the names of the child prims in the order they appear when iterating over GetFilteredChildren(...
USD_API UsdPayloads GetPayloads() const
Return a UsdPayloads object that allows one to add, remove, or mutate payloads at the currently set U...
iterator_range & advance_end(difference_type n)
Advance this range's end iterator.
UsdPrim GetPrim() const
Return this object if it is a prim, otherwise return this object's nearest owning prim.
std::enable_if< T::schemaKind !=UsdSchemaKind::MultipleApplyAPI, bool >::type HasAPI() const
Using HasAPI in C++
USD_API TfTokenVector GetChildrenReorder() const
Return the strongest opinion for the metadata used to reorder children of this prim.
UsdPrimSubtreeRange(UsdPrimSubtreeIterator begin, UsdPrimSubtreeIterator end)
Construct with a pair of iterators.
static USD_API bool IsPrototypePath(const SdfPath &path)
Return true if the given path identifies a prototype prim, false otherwise.
USD_API bool HasAuthoredMetadata(const TfToken &key) const
Returns true if the key has an authored value, false if no value was authored or the only value avail...
USD_API UsdRelationship CreateRelationship(const TfToken &relName, bool custom=true) const
Author scene description for the relationship named relName at the current EditTarget if none already...
value_type reference
Iterator reference type, in this case the same as value_type.
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
USD_API std::vector< UsdRelationship > GetRelationships() const
Like GetProperties(), but exclude all attributes from the result.
bool ApplyAPI(const TfToken &instanceName) const
Applies a multiple-apply API schema with the given C++ type 'SchemaType' and instance name instanceNa...
USD_API std::vector< UsdAttribute > GetAuthoredAttributes() const
Like GetAttributes(), but exclude attributes without authored scene description from the result.
iterator_range & advance_begin(difference_type n)
Advance this range's begin iterator.
bool HasDefiningSpecifier() const
Return true if this prim has a specifier of type SdfSpecifierDef or SdfSpecifierClass.
USD_API std::vector< UsdProperty > GetAuthoredProperties(const PropertyPredicateFunc &predicate={}) const
Return this prim's properties (attributes and relationships) that have authored scene description,...