#include <prim.h>

Inheritance diagram for UsdPrim:

Public Types
typedef UsdPrimSiblingIterator	SiblingIterator
	Convenience typedefs. More...

typedef UsdPrimSiblingRange	SiblingRange

typedef UsdPrimSubtreeIterator	SubtreeIterator
	Convenience typedefs. More...

typedef UsdPrimSubtreeRange	SubtreeRange

using	PropertyPredicateFunc = std::function< bool(const TfToken &propertyName)>

Public Member Functions
	UsdPrim ()
	Construct an invalid prim. More...

const UsdPrimTypeInfo &	GetPrimTypeInfo () const

const UsdPrimDefinition &	GetPrimDefinition () const

SdfSpecifier	GetSpecifier () const
	Return this prim's composed specifier. More...

USD_API SdfPrimSpecHandleVector	GetPrimStack () const

USD_API std::vector< std::pair < SdfPrimSpecHandle, SdfLayerOffset > >	GetPrimStackWithLayerOffsets () const

bool	SetSpecifier (SdfSpecifier specifier) const

const TfToken &	GetTypeName () const

bool	SetTypeName (const TfToken &typeName) const
	Author this Prim's typeName at the current EditTarget. More...

bool	ClearTypeName () const

bool	HasAuthoredTypeName () const
	Return true if a typeName has been authored. More...

bool	IsActive () const

bool	SetActive (bool active) const

bool	ClearActive () const

bool	HasAuthoredActive () const

bool	IsLoaded () const

bool	IsModel () const

bool	IsGroup () const

bool	IsComponent () const

USD_API bool	IsSubComponent () const

bool	IsAbstract () const
	Return true if this prim or any of its ancestors is a class. More...

bool	IsDefined () const

bool	HasDefiningSpecifier () const

USD_API TfTokenVector	GetAppliedSchemas () const

USD_API TfTokenVector	GetPropertyNames (const PropertyPredicateFunc &predicate={}) const

USD_API TfTokenVector	GetAuthoredPropertyNames (const PropertyPredicateFunc &predicate={}) const

USD_API std::vector< UsdProperty >	GetProperties (const PropertyPredicateFunc &predicate={}) const

USD_API std::vector< UsdProperty >	GetAuthoredProperties (const PropertyPredicateFunc &predicate={}) const

USD_API std::vector< UsdProperty >	GetPropertiesInNamespace (const std::vector< std::string > &namespaces) const

USD_API std::vector< UsdProperty >	GetPropertiesInNamespace (const std::string &namespaces) const

USD_API std::vector< UsdProperty >	GetAuthoredPropertiesInNamespace (const std::vector< std::string > &namespaces) const

USD_API std::vector< UsdProperty >	GetAuthoredPropertiesInNamespace (const std::string &namespaces) const

USD_API TfTokenVector	GetPropertyOrder () const
	Return the strongest propertyOrder metadata value authored on this prim. More...

void	SetPropertyOrder (const TfTokenVector &order) const

void	ClearPropertyOrder () const

USD_API bool	RemoveProperty (const TfToken &propName)

USD_API UsdProperty	GetProperty (const TfToken &propName) const

USD_API bool	HasProperty (const TfToken &propName) const

USD_API bool	GetKind (TfToken *kind) const

USD_API bool	SetKind (const TfToken &kind) const

USD_API bool	AddAppliedSchema (const TfToken &appliedSchemaName) const

USD_API bool	RemoveAppliedSchema (const TfToken &appliedSchemaName) const

IsA
template<typename SchemaType >
bool	IsA () const

USD_API bool	IsA (const TfType &schemaType) const
	This is an overload of IsA that takes a TfType `schemaType` . More...

USD_API bool	IsA (const TfToken &schemaIdentifier) const

USD_API bool	IsA (const TfToken &schemaFamily, UsdSchemaVersion schemaVersion) const

IsInFamily
USD_API bool	IsInFamily (const TfToken &schemaFamily) const

USD_API bool	IsInFamily (const TfToken &schemaFamily, UsdSchemaVersion schemaVersion, UsdSchemaRegistry::VersionPolicy versionPolicy) const

template<typename SchemaType >
bool	IsInFamily (UsdSchemaRegistry::VersionPolicy versionPolicy) const

USD_API bool	IsInFamily (const TfType &schemaType, UsdSchemaRegistry::VersionPolicy versionPolicy) const

USD_API bool	IsInFamily (const TfToken &schemaIdentifier, UsdSchemaRegistry::VersionPolicy versionPolicy) const

USD_API bool	GetVersionIfIsInFamily (const TfToken &schemaFamily, UsdSchemaVersion *schemaVersion) const

HasAPI
__Using HasAPI in C++__ UsdPrim prim = stage->OverridePrim("/path/to/prim"); MyDomainBozAPI = MyDomainBozAPI::Apply(prim); assert(prim.HasAPI<MyDomainBozAPI>()); assert(prim.HasAPI(TfToken("BozAPI"))); assert(prim.HasAPI(TfToken("BozAPI"), /schemaVersion/ 0)); UsdCollectionAPI collAPI = UsdCollectionAPI::Apply(prim, /instanceName/ TfToken("geom")); assert(prim.HasAPI<UsdCollectionAPI>(); assert(prim.HasAPI(TfToken("CollectionAPI")); assert(prim.HasAPI(TfToken("CollectionAPI"), /schemaVersion/ 0); assert(prim.HasAPI<UsdCollectionAPI>(/instanceName/ TfToken("geom"))) assert(prim.HasAPI(TfToken("CollectionAPI", /instanceName/ TfToken("geom"))); assert(prim.HasAPI(TfToken("CollectionAPI"), /schemaVersion/ 0, /instanceName/ TfToken("geom")); The python version of this method takes as an argument the TfType of the API schema class. Using HasAPI in Python 1 prim = stage.OverridePrim("/path/to/prim") 2 bozAPI = MyDomain.BozAPI.Apply(prim) 3 assert(prim.HasAPI(MyDomain.BozAPI)) 4 assert(prim.HasAPI("BozAPI")) 5 assert(prim.HasAPI("BozAPI", 0)) 6 7 collAPI = Usd.CollectionAPI.Apply(prim, "geom") 8 assert(prim.HasAPI(Usd.CollectionAPI)) 9 assert(prim.HasAPI("CollectionAPI")) 10 assert(prim.HasAPI("CollectionAPI", 0)) 11 12 assert(prim.HasAPI(Usd.CollectionAPI, instanceName="geom")) 13 assert(prim.HasAPI("CollectionAPI", instanceName="geom")) 14 assert(prim.HasAPI("CollectionAPI", 0, instanceName="geom"))
template<typename SchemaType >
bool	HasAPI () const

template<typename SchemaType >
bool	HasAPI (const TfToken &instanceName) const

USD_API bool	HasAPI (const TfType &schemaType) const
	This is an overload of HasAPI that takes a TfType `schemaType` . More...

USD_API bool	HasAPI (const TfType &schemaType, const TfToken &instanceName) const

USD_API bool	HasAPI (const TfToken &schemaIdentifier) const

USD_API bool	HasAPI (const TfToken &schemaIdentifier, const TfToken &instanceName) const

USD_API bool	HasAPI (const TfToken &schemaFamily, UsdSchemaVersion schemaVersion) const

USD_API bool	HasAPI (const TfToken &schemaFamily, UsdSchemaVersion schemaVersion, const TfToken &instanceName) const

HasAPIInFamily
USD_API bool	HasAPIInFamily (const TfToken &schemaFamily) const

USD_API bool	HasAPIInFamily (const TfToken &schemaFamily, const TfToken &instanceName) const

USD_API bool	HasAPIInFamily (const TfToken &schemaFamily, UsdSchemaVersion schemaVersion, UsdSchemaRegistry::VersionPolicy versionPolicy) const

USD_API bool	HasAPIInFamily (const TfToken &schemaFamily, UsdSchemaVersion schemaVersion, UsdSchemaRegistry::VersionPolicy versionPolicy, const TfToken &instanceName) const

template<typename SchemaType >
bool	HasAPIInFamily (UsdSchemaRegistry::VersionPolicy versionPolicy) const

template<typename SchemaType >
bool	HasAPIInFamily (UsdSchemaRegistry::VersionPolicy versionPolicy, const TfToken &instanceName) const

USD_API bool	HasAPIInFamily (const TfType &schemaType, UsdSchemaRegistry::VersionPolicy versionPolicy) const

USD_API bool	HasAPIInFamily (const TfType &schemaType, UsdSchemaRegistry::VersionPolicy versionPolicy, const TfToken &instanceName) const

USD_API bool	HasAPIInFamily (const TfToken &schemaIdentifier, UsdSchemaRegistry::VersionPolicy versionPolicy) const

USD_API bool	HasAPIInFamily (const TfToken &schemaIdentifier, UsdSchemaRegistry::VersionPolicy versionPolicy, const TfToken &instanceName) const

USD_API bool	GetVersionIfHasAPIInFamily (const TfToken &schemaFamily, UsdSchemaVersion *schemaVersion) const

USD_API bool	GetVersionIfHasAPIInFamily (const TfToken &schemaFamily, const TfToken &instanceName, UsdSchemaVersion *schemaVersion) const

CanApplyAPI
template<typename SchemaType >
bool	CanApplyAPI (std::string *whyNot=nullptr) const

template<typename SchemaType >
bool	CanApplyAPI (const TfToken &instanceName, std::string *whyNot=nullptr) const

USD_API bool	CanApplyAPI (const TfType &schemaType, std::string *whyNot=nullptr) const

USD_API bool	CanApplyAPI (const TfType &schemaType, const TfToken &instanceName, std::string *whyNot=nullptr) const

USD_API bool	CanApplyAPI (const TfToken &schemaIdentifier, std::string *whyNot=nullptr) const

USD_API bool	CanApplyAPI (const TfToken &schemaIdentifier, const TfToken &instanceName, std::string *whyNot=nullptr) const

USD_API bool	CanApplyAPI (const TfToken &schemaFamily, UsdSchemaVersion schemaVersion, std::string *whyNot=nullptr) const

USD_API bool	CanApplyAPI (const TfToken &schemaFamily, UsdSchemaVersion schemaVersion, const TfToken &instanceName, std::string *whyNot=nullptr) const

ApplyAPI
template<typename SchemaType >
bool	ApplyAPI () const

template<typename SchemaType >
bool	ApplyAPI (const TfToken &instanceName) const

USD_API bool	ApplyAPI (const TfType &schemaType) const
	This is an overload of ApplyAPI that takes a TfType `schemaType` . More...

USD_API bool	ApplyAPI (const TfType &schemaType, const TfToken &instanceName) const

USD_API bool	ApplyAPI (const TfToken &schemaIdentifier) const

USD_API bool	ApplyAPI (const TfToken &schemaIdentifier, const TfToken &instanceName) const

USD_API bool	ApplyAPI (const TfToken &schemaFamily, UsdSchemaVersion schemaVersion) const

USD_API bool	ApplyAPI (const TfToken &schemaFamily, UsdSchemaVersion schemaVersion, const TfToken &instanceName) const

RemoveAPI
template<typename SchemaType >
bool	RemoveAPI () const

template<typename SchemaType >
bool	RemoveAPI (const TfToken &instanceName) const

USD_API bool	RemoveAPI (const TfType &schemaType) const
	This is an overload of RemoveAPI that takes a TfType `schemaType` . More...

USD_API bool	RemoveAPI (const TfType &schemaType, const TfToken &instanceName) const

USD_API bool	RemoveAPI (const TfToken &schemaIdentifier) const

USD_API bool	RemoveAPI (const TfToken &schemaIdentifier, const TfToken &instanceName) const

USD_API bool	RemoveAPI (const TfToken &schemaFamily, UsdSchemaVersion schemaVersion) const

USD_API bool	RemoveAPI (const TfToken &schemaFamily, UsdSchemaVersion schemaVersion, const TfToken &instanceName) const

Prim Children
USD_API UsdPrim	GetChild (const TfToken &name) const

SiblingRange	GetChildren () const

SiblingRange	GetAllChildren () const
	Return all this prim's children as an iterable range. More...

SiblingRange	GetFilteredChildren (const Usd_PrimFlagsPredicate &predicate) const

USD_API TfTokenVector	GetChildrenNames () const

USD_API TfTokenVector	GetAllChildrenNames () const

USD_API TfTokenVector	GetFilteredChildrenNames (const Usd_PrimFlagsPredicate &predicate) const

SubtreeRange	GetDescendants () const

SubtreeRange	GetAllDescendants () const

SubtreeRange	GetFilteredDescendants (const Usd_PrimFlagsPredicate &predicate) const

USD_API TfTokenVector	GetChildrenReorder () const

void	SetChildrenReorder (const TfTokenVector &order) const

void	ClearChildrenReorder () const

Parent & Stage
UsdPrim	GetParent () const

USD_API UsdPrim	GetNextSibling () const

USD_API UsdPrim	GetFilteredNextSibling (const Usd_PrimFlagsPredicate &predicate) const

USD_API bool	IsPseudoRoot () const

USD_API UsdPrim	GetPrimAtPath (const SdfPath &path) const

USD_API UsdObject	GetObjectAtPath (const SdfPath &path) const

USD_API UsdProperty	GetPropertyAtPath (const SdfPath &path) const

USD_API UsdAttribute	GetAttributeAtPath (const SdfPath &path) const

USD_API UsdRelationship	GetRelationshipAtPath (const SdfPath &path) const

Variants
USD_API UsdVariantSets	GetVariantSets () const

USD_API UsdVariantSet	GetVariantSet (const std::string &variantSetName) const

USD_API bool	HasVariantSets () const

Attributes
USD_API UsdAttribute	CreateAttribute (const TfToken &name, const SdfValueTypeName &typeName, bool custom, SdfVariability variability=SdfVariabilityVarying) const

USD_API UsdAttribute	CreateAttribute (const TfToken &name, const SdfValueTypeName &typeName, SdfVariability variability=SdfVariabilityVarying) const

USD_API UsdAttribute	CreateAttribute (const std::vector< std::string > &nameElts, const SdfValueTypeName &typeName, bool custom, SdfVariability variability=SdfVariabilityVarying) const

USD_API UsdAttribute	CreateAttribute (const std::vector< std::string > &nameElts, const SdfValueTypeName &typeName, SdfVariability variability=SdfVariabilityVarying) const

USD_API std::vector< UsdAttribute >	GetAttributes () const
	Like GetProperties(), but exclude all relationships from the result. More...

USD_API std::vector< UsdAttribute >	GetAuthoredAttributes () const

USD_API UsdAttribute	GetAttribute (const TfToken &attrName) const

USD_API bool	HasAttribute (const TfToken &attrName) const

USD_API SdfPathVector	FindAllAttributeConnectionPaths (Usd_PrimFlagsPredicate const &traversalPredicate, std::function< bool(UsdAttribute const &)> const &pred=nullptr, bool recurseOnSources=false) const

USD_API SdfPathVector	FindAllAttributeConnectionPaths (std::function< bool(UsdAttribute const &)> const &pred=nullptr, bool recurseOnSources=false) const

Relationships
USD_API UsdRelationship	CreateRelationship (const TfToken &relName, bool custom=true) const

USD_API UsdRelationship	CreateRelationship (const std::vector< std::string > &nameElts, bool custom=true) const

USD_API std::vector < UsdRelationship >	GetRelationships () const
	Like GetProperties(), but exclude all attributes from the result. More...

USD_API std::vector < UsdRelationship >	GetAuthoredRelationships () const

USD_API UsdRelationship	GetRelationship (const TfToken &relName) const

USD_API bool	HasRelationship (const TfToken &relName) const

USD_API SdfPathVector	FindAllRelationshipTargetPaths (Usd_PrimFlagsPredicate const &traversalPredicate, std::function< bool(UsdRelationship const &)> const &pred=nullptr, bool recurseOnTargets=false) const

USD_API SdfPathVector	FindAllRelationshipTargetPaths (std::function< bool(UsdRelationship const &)> const &pred=nullptr, bool recurseOnTargets=false) const

Payload Authoring
Deprecated: This API is now deprecated. Please use the HasAuthoredPayloads and the UsdPayloads API returned from GetPayloads() to query and author payloads instead.
USD_API bool	ClearPayload () const

USD_API bool	HasPayload () const

USD_API bool	SetPayload (const SdfPayload &payload) const

USD_API bool	SetPayload (const std::string &assetPath, const SdfPath &primPath) const

USD_API bool	SetPayload (const SdfLayerHandle &layer, const SdfPath &primPath) const

Payloads, Load and Unload
USD_API UsdPayloads	GetPayloads () const

USD_API bool	HasAuthoredPayloads () const
	Return true if this prim has any authored payloads. More...

USD_API void	Load (UsdLoadPolicy policy=UsdLoadWithDescendants) const

USD_API void	Unload () const

References
USD_API UsdReferences	GetReferences () const

USD_API bool	HasAuthoredReferences () const
	Return true if this prim has any authored references. More...

Inherits
USD_API UsdInherits	GetInherits () const

USD_API bool	HasAuthoredInherits () const
	Return true if this prim has any authored inherits. More...

Specializes
USD_API UsdSpecializes	GetSpecializes () const

USD_API bool	HasAuthoredSpecializes () const
	Returns true if this prim has any authored specializes. More...

Composition Structure
const PcpPrimIndex &	GetPrimIndex () const

USD_API PcpPrimIndex	ComputeExpandedPrimIndex () const

USD_API UsdResolveTarget	MakeResolveTargetUpToEditTarget (const UsdEditTarget &editTarget) const

USD_API UsdResolveTarget	MakeResolveTargetStrongerThanEditTarget (const UsdEditTarget &editTarget) const

Public Member Functions inherited from UsdObject
	UsdObject ()
	Default constructor produces an invalid object. More...

template<typename T >
bool	GetMetadata (const TfToken &key, T *value) const

USD_API bool	GetMetadata (const TfToken &key, VtValue *value) const

template<typename T >
bool	SetMetadata (const TfToken &key, const T &value) const

USD_API bool	SetMetadata (const TfToken &key, const VtValue &value) const

USD_API bool	ClearMetadata (const TfToken &key) const

USD_API bool	HasMetadata (const TfToken &key) const

USD_API bool	HasAuthoredMetadata (const TfToken &key) const

template<class T >
bool	GetMetadataByDictKey (const TfToken &key, const TfToken &keyPath, T *value) const

USD_API bool	GetMetadataByDictKey (const TfToken &key, const TfToken &keyPath, VtValue *value) const

template<typename T >
bool	SetMetadataByDictKey (const TfToken &key, const TfToken &keyPath, const T &value) const

USD_API bool	SetMetadataByDictKey (const TfToken &key, const TfToken &keyPath, const VtValue &value) const

USD_API bool	ClearMetadataByDictKey (const TfToken &key, const TfToken &keyPath) const

USD_API bool	HasMetadataDictKey (const TfToken &key, const TfToken &keyPath) const

USD_API bool	HasAuthoredMetadataDictKey (const TfToken &key, const TfToken &keyPath) const

USD_API UsdMetadataValueMap	GetAllMetadata () const

USD_API UsdMetadataValueMap	GetAllAuthoredMetadata () const

USD_API bool	IsHidden () const

USD_API bool	SetHidden (bool hidden) const

USD_API bool	ClearHidden () const
	Clears the opinion for "Hidden" at the current EditTarget. More...

USD_API bool	HasAuthoredHidden () const

USD_API VtDictionary	GetCustomData () const

USD_API VtValue	GetCustomDataByKey (const TfToken &keyPath) const

USD_API void	SetCustomData (const VtDictionary &customData) const

USD_API void	SetCustomDataByKey (const TfToken &keyPath, const VtValue &value) const

USD_API void	ClearCustomData () const

USD_API void	ClearCustomDataByKey (const TfToken &keyPath) const

USD_API bool	HasCustomData () const

USD_API bool	HasCustomDataKey (const TfToken &keyPath) const

USD_API bool	HasAuthoredCustomData () const

USD_API bool	HasAuthoredCustomDataKey (const TfToken &keyPath) const

USD_API VtDictionary	GetAssetInfo () const

USD_API VtValue	GetAssetInfoByKey (const TfToken &keyPath) const

USD_API void	SetAssetInfo (const VtDictionary &customData) const

USD_API void	SetAssetInfoByKey (const TfToken &keyPath, const VtValue &value) const

USD_API void	ClearAssetInfo () const

USD_API void	ClearAssetInfoByKey (const TfToken &keyPath) const

USD_API bool	HasAssetInfo () const

USD_API bool	HasAssetInfoKey (const TfToken &keyPath) const

USD_API bool	HasAuthoredAssetInfo () const

USD_API bool	HasAuthoredAssetInfoKey (const TfToken &keyPath) const

USD_API std::string	GetDocumentation () const

USD_API bool	SetDocumentation (const std::string &doc) const
	Sets this object's documentation (metadata). Returns true on success. More...

USD_API bool	ClearDocumentation () const

USD_API bool	HasAuthoredDocumentation () const

USD_API std::string	GetDisplayName () const

USD_API bool	SetDisplayName (const std::string &name) const

USD_API bool	ClearDisplayName () const

USD_API bool	HasAuthoredDisplayName () const

bool	IsValid () const
	Return true if this is a valid object, false otherwise. More...

	operator bool () const
	Returns `true` if this object is valid, `false` otherwise. More...

USD_API UsdStageWeakPtr	GetStage () const

SdfPath	GetPath () const

const SdfPath &	GetPrimPath () const

UsdPrim	GetPrim () const

const TfToken &	GetName () const

template<class T >
T	As () const

template<class T >
bool	Is () const

USD_API std::string	GetDescription () const

Friends
class	UsdObject

class	UsdPrimSiblingIterator

class	UsdPrimSubtreeIterator

class	UsdProperty

class	UsdSchemaBase

class	UsdAPISchemaBase

class	UsdStage

class	Usd_StageImplAccess

class	UsdPrimRange

class	Usd_PrimData

class	Usd_PrimFlagsPredicate

struct	UsdPrim_RelTargetFinder

struct	UsdPrim_AttrConnectionFinder

const PcpPrimIndex &	Usd_PrimGetSourcePrimIndex (const UsdPrim &)

Instancing
See Usd_Page_ScenegraphInstancing for more details.
bool	IsInstanceable () const

bool	SetInstanceable (bool instanceable) const

bool	ClearInstanceable () const

bool	HasAuthoredInstanceable () const

bool	IsInstance () const

bool	IsInstanceProxy () const

bool	IsPrototype () const

bool	IsInPrototype () const

USD_API UsdPrim	GetPrototype () const

UsdPrim	GetPrimInPrototype () const

USD_API std::vector< UsdPrim >	GetInstances () const

static USD_API bool	IsPrototypePath (const SdfPath &path)

static USD_API bool	IsPathInPrototype (const SdfPath &path)

Additional Inherited Members
Static Public Member Functions inherited from UsdObject
static char	GetNamespaceDelimiter ()

Protected Member Functions inherited from UsdObject
template<class Derived >
	UsdObject (_Null< Derived >)

	UsdObject (const Usd_PrimDataHandle &prim, const SdfPath &proxyPrimPath)

	UsdObject (UsdObjType objType, const Usd_PrimDataHandle &prim, const SdfPath &proxyPrimPath, const TfToken &propName)

UsdStage *	_GetStage () const

USD_API SdfSpecType	_GetDefiningSpecType () const

const Usd_PrimDataHandle &	_Prim () const

const TfToken &	_PropName () const

const SdfPath &	_ProxyPrimPath () const

Detailed Description

UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as described in the Universal Scene Description Composition Compendium

A UsdPrim is the principal container of other types of scene description. It provides API for accessing and creating all of the contained kinds of scene description, which include:

UsdVariantSets - all VariantSets on the prim (GetVariantSets(), GetVariantSet())
UsdReferences - all references on the prim (GetReferences())
UsdInherits - all inherits on the prim (GetInherits())
UsdSpecializes - all specializes on the prim (GetSpecializes())

As well as access to the API objects for properties contained within the prim - UsdPrim as well as all of the following classes are subclasses of UsdObject:

UsdProperty - generic access to all attributes and relationships. A UsdProperty can be queried and cast to a UsdAttribute or UsdRelationship using UsdObject::Is<>() and UsdObject::As<>(). (GetPropertyNames(), GetProperties(), GetPropertiesInNamespace(), GetPropertyOrder(), SetPropertyOrder())
UsdAttribute - access to default and timesampled attribute values, as well as value resolution information, and attribute-specific metadata (CreateAttribute(), GetAttribute(), GetAttributes(), HasAttribute())
UsdRelationship - access to authoring and resolving relationships to other prims and properties (CreateRelationship(), GetRelationship(), GetRelationships(), HasRelationship())

UsdPrim also provides access to iteration through its prim children, optionally making use of the prim predicates facility (GetChildren(), GetAllChildren(), GetFilteredChildren()).

Management

Clients acquire UsdPrim objects, which act like weak/guarded pointers to persistent objects owned and managed by their originating UsdStage. We provide the following guarantees for a UsdPrim acquired via UsdStage::GetPrimAtPath() or UsdStage::OverridePrim() or UsdStage::DefinePrim():

As long as no further mutations to the structure of the UsdStage are made, the UsdPrim will still be valid. Loading and Unloading are considered structural mutations.
When the UsdStage's structure is mutated, the thread performing the mutation will receive a UsdNotice::ObjectsChanged notice after the stage has been reconfigured, which provides details as to what prims may have been created or destroyed, and what prims may simply have changed in some structural way.

Prim access in "reader" threads should be limited to GetPrimAtPath(), which will never cause a mutation to the Stage or its layers.

Please refer to UsdNotice for a listing of the events that could cause UsdNotice::ObjectsChanged to be emitted.

Examples:: LOP/XUSD_TrueAutoCollection.C, and LOP/XUSD_TrueAutoCollection.h.

Definition at line 133 of file prim.h.

Member Typedef Documentation

using UsdPrim::PropertyPredicateFunc = std::function<bool (const TfToken &propertyName)>

Alias for the "predicate" function parameter passed into the various Get{Authored}{PropertyNames,Properties} methods.

Definition at line 321 of file prim.h.

typedef UsdPrimSiblingIterator UsdPrim::SiblingIterator

Convenience typedefs.

Definition at line 137 of file prim.h.

typedef UsdPrimSiblingRange UsdPrim::SiblingRange

Definition at line 138 of file prim.h.

typedef UsdPrimSubtreeIterator UsdPrim::SubtreeIterator

Convenience typedefs.

Definition at line 141 of file prim.h.

typedef UsdPrimSubtreeRange UsdPrim::SubtreeRange

Definition at line 142 of file prim.h.

Constructor & Destructor Documentation

UsdPrim::UsdPrim ( )

inline

Construct an invalid prim.

Definition at line 145 of file prim.h.

Member Function Documentation

USD_API bool UsdPrim::AddAppliedSchema ( const TfToken & appliedSchemaName ) const

Adds the applied API schema name token appliedSchemaName to the apiSchemas metadata for this prim at the current edit target. For multiple-apply schemas the name token should include the instance name for the applied schema, for example 'CollectionAPI:plasticStuff'.

The name will only be added if the list operation at the edit target does not already have this applied schema in its explicit, prepended, or appended lists and is always added to the end of either the prepended or explicit items.

Returns true upon success or if the API schema is already applied in the current edit target.

An error is issued and false returned for any of the following conditions:

this prim is not a valid prim for editing
this prim is valid, but cannot be reached or overridden in the current edit target
the schema name cannot be added to the apiSchemas listOp metadata

Unlike ApplyAPI this method does not require that the name token refer to a valid API schema type. ApplyAPI is the preferred method for applying valid API schemas.

template<typename SchemaType >

bool UsdPrim::ApplyAPI ( ) const

inline

Applies a single-apply API schema with the given C++ type SchemaType to this prim in the current edit target.

This information is stored by adding the API schema's name token to the token-valued, listOp metadata apiSchemas on this prim.

Returns true upon success or if the API schema is already applied in the current edit target.

An error is issued and false returned for any of the following conditions:

this prim is not a valid prim for editing
this prim is valid, but cannot be reached or overridden in the current edit target
the schema name cannot be added to the apiSchemas listOp metadata

Definition at line 1133 of file prim.h.

template<typename SchemaType >

bool UsdPrim::ApplyAPI ( const TfToken & instanceName ) const

inline

Applies a multiple-apply API schema with the given C++ type SchemaType and instance name instanceName to this prim in the current edit target.

This information is stored in the token-valued, listOp metadata apiSchemas on this prim. For example, if SchemaType is 'UsdCollectionAPI' and instanceName is 'plasticStuff', the name 'CollectionAPI:plasticStuff' is added to the 'apiSchemas' listOp metadata.

Returns true upon success or if the API schema is already applied with this instanceName in the current edit target.

An error is issued and false returned for any of the following conditions:

instanceName is empty
this prim is not a valid prim for editing
this prim is valid, but cannot be reached or overridden in the current edit target
the schema name cannot be added to the apiSchemas listOp metadata

Definition at line 1174 of file prim.h.

USD_API bool UsdPrim::ApplyAPI ( const TfType & schemaType ) const

This is an overload of ApplyAPI that takes a TfType schemaType .

USD_API bool UsdPrim::ApplyAPI	(	const TfType &	schemaType,
		const TfToken &	instanceName
	)		const

This is an overload of ApplyAPI(const TfToken &) const "ApplyAPI" with instanceName that takes a TfType schemaType .

USD_API bool UsdPrim::ApplyAPI ( const TfToken & schemaIdentifier ) const

This is an overload of ApplyAPI that takes a schemaIdentifier to determine the schema type.

USD_API bool UsdPrim::ApplyAPI	(	const TfToken &	schemaIdentifier,
		const TfToken &	instanceName
	)		const

This is an overload of ApplyAPI(const TfToken &) const "ApplyAPI" with instanceName that takes a schemaIdentifier to determine the schema type.

USD_API bool UsdPrim::ApplyAPI	(	const TfToken &	schemaFamily,
		UsdSchemaVersion	schemaVersion
	)		const

This is an overload of ApplyAPI that takes a schemaFamily and schemaVersion to determine the schema type.

USD_API bool UsdPrim::ApplyAPI	(	const TfToken &	schemaFamily,
		UsdSchemaVersion	schemaVersion,
		const TfToken &	instanceName
	)		const

This is an overload of ApplyAPI(const TfToken &) const "ApplyAPI" with instanceName that takes a schemaFamily and schemaVersion to determine the schema type.

template<typename SchemaType >

bool UsdPrim::CanApplyAPI ( std::string * whyNot = nullptr ) const

inline

Returns whether a single-apply API schema with the given C++ type SchemaType can be applied to this prim. If the return value is false, and whyNot is provided, the reason the schema cannot be applied is written to whyNot.

Whether the schema can be applied is determined by the schema type definition which may specify that the API schema can only be applied to certain prim types.

The return value of this function only indicates whether it would be valid to apply this schema to the prim. It has no bearing on whether calling ApplyAPI will be successful or not.

Definition at line 1010 of file prim.h.

template<typename SchemaType >

bool UsdPrim::CanApplyAPI	(	const TfToken &	instanceName,
		std::string *	whyNot = `nullptr`
	)		const

inline

Returns whether a multiple-apply API schema with the given C++ type SchemaType can be applied to this prim with the given instanceName. If the return value is false, and whyNot is provided, the reason the schema cannot be applied is written to whyNot.

Whether the schema can be applied is determined by the schema type definition which may specify that the API schema can only be applied to certain prim types. It also determines whether the instance name is a valid instance name for the multiple apply schema.

The return value of this function only indicates whether it would be valid to apply this schema to the prim. It has no bearing on whether calling ApplyAPI will be successful or not.

Definition at line 1044 of file prim.h.

USD_API bool UsdPrim::CanApplyAPI	(	const TfType &	schemaType,
		std::string *	whyNot = `nullptr`
	)		const

This is an overload of CanApplyAPI that takes a TfType schemaType .

USD_API bool UsdPrim::CanApplyAPI	(	const TfType &	schemaType,
		const TfToken &	instanceName,
		std::string *	whyNot = `nullptr`
	)		const

This is an overload of CanApplyAPI(const TfToken &, std::string *) const "CanApplyAPI" with instanceName that takes a TfType schemaType .

USD_API bool UsdPrim::CanApplyAPI	(	const TfToken &	schemaIdentifier,
		std::string *	whyNot = `nullptr`
	)		const

This is an overload of CanApplyAPI that takes a schemaIdentifier to determine the schema type.

USD_API bool UsdPrim::CanApplyAPI	(	const TfToken &	schemaIdentifier,
		const TfToken &	instanceName,
		std::string *	whyNot = `nullptr`
	)		const

This is an overload of CanApplyAPI(const TfToken &, std::string *) const "CanApplyAPI" with instanceName that takes a schemaIdentifier to determine the schema type.

USD_API bool UsdPrim::CanApplyAPI	(	const TfToken &	schemaFamily,
		UsdSchemaVersion	schemaVersion,
		std::string *	whyNot = `nullptr`
	)		const

This is an overload of CanApplyAPI that takes a schemaFamily and schemaVersion to determine the schema type.

USD_API bool UsdPrim::CanApplyAPI	(	const TfToken &	schemaFamily,
		UsdSchemaVersion	schemaVersion,
		const TfToken &	instanceName,
		std::string *	whyNot = `nullptr`
	)		const

This is an overload of CanApplyAPI(const TfToken &, std::string *) const "CanApplyAPI" with instanceName that takes a schemaFamily and schemaVersion to determine the schema type.

bool UsdPrim::ClearActive ( ) const

inline

Remove the authored 'active' opinion at the current EditTarget. Do nothing if there is no authored opinion.

See Usd_ActiveInactive for the effects of activating or deactivating a prim.

Definition at line 253 of file prim.h.

void UsdPrim::ClearChildrenReorder ( ) const

inline

Remove the opinion for the metadata used to reorder children of this prim at the current EditTarget.

Definition at line 1535 of file prim.h.

bool UsdPrim::ClearInstanceable ( ) const

inline

Remove the authored 'instanceable' opinion at the current EditTarget. Do nothing if there is no authored opinion.

Definition at line 2043 of file prim.h.

USD_API bool UsdPrim::ClearPayload ( ) const

Deprecated:: Clears the payload at the current EditTarget for this prim. Return false if the payload could not be cleared.

void UsdPrim::ClearPropertyOrder ( ) const

inline

Remove the opinion for propertyOrder metadata on this prim at the current EditTarget.

Definition at line 473 of file prim.h.

bool UsdPrim::ClearTypeName ( ) const

inline

Clear the opinion for this Prim's typeName at the current edit target.

Definition at line 225 of file prim.h.

USD_API PcpPrimIndex UsdPrim::ComputeExpandedPrimIndex ( ) const

Compute the prim index containing all sites that could contribute opinions to this prim.

This function is similar to UsdPrim::GetPrimIndex. However, the returned prim index includes all sites that could possibly contribute opinions to this prim, not just the sites that currently do so. This is useful in certain situations; for example, this could be used to generate a list of sites where clients could make edits to affect this prim, or for debugging purposes.

For all prims in prototypes, including the prototype prim itself, this is the expanded version of the prim index that was chosen to be shared with all other instances. Thus, the prim index's path will not be the same as the prim's path. Note that this behavior deviates slightly from UsdPrim::GetPrimIndex which always returns an empty prim index for the prototype prim itself.

This function may be relatively slow, since it will recompute the prim index on every call. Clients should prefer UsdPrim::GetPrimIndex unless the additional site information is truly needed.

USD_API UsdAttribute UsdPrim::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 exists. Return a valid attribute if scene description was successfully authored or if it already existed, return invalid attribute otherwise. Note that the supplied typeName and custom arguments are only used in one specific case. See below for details.

Suggested use:

if (UsdAttribute myAttr = prim.CreateAttribute(...)) {
   // success. 
}

To call this, GetPrim() must return a valid prim.

If a spec for this attribute already exists at the current edit target, do nothing.
If a spec for attrName of a different spec type (e.g. a relationship) exists at the current EditTarget, issue an error.
If name refers to a builtin attribute according to the prim's definition, author an attribute spec with required metadata from the definition.
If name refers to a builtin relationship, issue an error.
If there exists an absolute strongest authored attribute spec for attrName, author an attribute spec at the current EditTarget by copying required metadata from that strongest spec.
If there exists an absolute strongest authored relationship spec for attrName, issue an error.
Otherwise author an attribute spec at the current EditTarget using the provided typeName and custom for the required metadata fields. Note that these supplied arguments are only ever used in this particular circumstance, in all other cases they are ignored.

USD_API UsdAttribute UsdPrim::CreateAttribute	(	const TfToken &	name,
		const SdfValueTypeName &	typeName,
		SdfVariability	variability = `SdfVariabilityVarying`
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Create a custom attribute with name, typeName and variability.

USD_API UsdAttribute UsdPrim::CreateAttribute	(	const std::vector< std::string > &	nameElts,
		const SdfValueTypeName &	typeName,
		bool	custom,
		SdfVariability	variability = `SdfVariabilityVarying`
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This overload of CreateAttribute() accepts a vector of name components used to construct a namespaced property name. For details, see Usd_Ordering

USD_API UsdAttribute UsdPrim::CreateAttribute	(	const std::vector< std::string > &	nameElts,
		const SdfValueTypeName &	typeName,
		SdfVariability	variability = `SdfVariabilityVarying`
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Create a custom attribute with nameElts, typeName, and variability.

USD_API UsdRelationship UsdPrim::CreateRelationship	(	const TfToken &	relName,
		bool	custom = `true`
	)		const

Author scene description for the relationship named relName at the current EditTarget if none already exists. Return a valid relationship if scene description was successfully authored or if it already existed, return an invalid relationship otherwise.

Suggested use:

if (UsdRelationship myRel = prim.CreateRelationship(...)) {
   // success. 
}

To call this, GetPrim() must return a valid prim.

If a spec for this relationship already exists at the current edit target, do nothing.
If a spec for relName of a different spec type (e.g. an attribute) exists at the current EditTarget, issue an error.
If name refers to a builtin relationship according to the prim's definition, author a relationship spec with required metadata from the definition.
If name refers to a builtin attribute, issue an error.
If there exists an absolute strongest authored relationship spec for relName, author a relationship spec at the current EditTarget by copying required metadata from that strongest spec.
If there exists an absolute strongest authored attribute spec for relName, issue an error.
Otherwise author a uniform relationship spec at the current EditTarget, honoring custom .

USD_API UsdRelationship UsdPrim::CreateRelationship	(	const std::vector< std::string > &	nameElts,
		bool	custom = `true`
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This overload of CreateRelationship() accepts a vector of name components used to construct a namespaced property name. For details, see Usd_Ordering

USD_API SdfPathVector UsdPrim::FindAllAttributeConnectionPaths	(	Usd_PrimFlagsPredicate const &	traversalPredicate,
		std::function< bool(UsdAttribute const &)> const &	pred = `nullptr`,
		bool	recurseOnSources = `false`
	)		const

Search the prim subtree rooted at this prim according to traversalPredicate for attributes for which predicate returns true, collect their connection source paths and return them in an arbitrary order. If recurseOnSources is true, act as if this function was invoked on the connected prims and owning prims of connected properties also and return the union.

USD_API SdfPathVector UsdPrim::FindAllAttributeConnectionPaths	(	std::function< bool(UsdAttribute const &)> const &	pred = `nullptr`,
		bool	recurseOnSources = `false`
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Invoke FindAllAttributeConnectionPaths() with the UsdPrimDefaultPredicate as its traversalPredicate.

USD_API SdfPathVector UsdPrim::FindAllRelationshipTargetPaths	(	Usd_PrimFlagsPredicate const &	traversalPredicate,
		std::function< bool(UsdRelationship const &)> const &	pred = `nullptr`,
		bool	recurseOnTargets = `false`
	)		const

Search the prim subtree rooted at this prim according to traversalPredicate for relationships for which predicate returns true, collect their target paths and return them in an arbitrary order. If recurseOnTargets is true, act as if this function was invoked on the targeted prims and owning prims of targeted properties also (but not of forwarding relationships) and return the union.

USD_API SdfPathVector UsdPrim::FindAllRelationshipTargetPaths	(	std::function< bool(UsdRelationship const &)> const &	pred = `nullptr`,
		bool	recurseOnTargets = `false`
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Invoke FindAllRelationshipTargetPaths() with the UsdPrimDefaultPredicate as its traversalPredicate.

UsdPrimSiblingRange UsdPrim::GetAllChildren ( ) const

inline

Return all this prim's children as an iterable range.

Definition at line 2512 of file prim.h.

USD_API TfTokenVector UsdPrim::GetAllChildrenNames ( ) const

Return the names of the child prims in the order they appear when iterating over GetAllChildren.

UsdPrimSubtreeRange UsdPrim::GetAllDescendants ( ) const

inline

Return all this prim's descendants as an iterable range.

Note: This method is not yet available in python, pending some refactoring to make it more feasible.

See Prim predicate flags and UsdPrimDefaultPredicate for more information, UsdStage::Traverse(), and UsdPrimRange for more general Stage traversal behaviors.

Definition at line 2772 of file prim.h.

USD_API TfTokenVector UsdPrim::GetAppliedSchemas ( ) const

Return a vector containing the names of API schemas which have been applied to this prim. This includes both the authored API schemas applied using the Apply() method on the particular schema class as well as any built-in API schemas that are automatically included through the prim type's prim definition. To get only the authored API schemas use GetPrimTypeInfo instead.

USD_API UsdAttribute UsdPrim::GetAttribute ( const TfToken & attrName ) const

Return a UsdAttribute with the name attrName. The attribute returned may or may not actually exist so it must be checked for validity. Suggested use:

if (UsdAttribute myAttr = prim.GetAttribute("myAttr")) {
   // myAttr is safe to use. 
   // Edits to the owning stage requires subsequent validation.
} else {
   // myAttr was not defined/authored
}

USD_API UsdAttribute UsdPrim::GetAttributeAtPath ( const SdfPath & path ) const

Returns the attribute at path on the same stage as this prim. If path is relative, it will be anchored to the path of this prim.

Note: There is no guarantee that this method returns an attribute on this prim. This is only guaranteed if path is a purely relative property path.

See Also: GetAttribute(const TfToken&) const; UsdStage::GetAttributeAtPath(const SdfPath&) const

USD_API std::vector<UsdAttribute> UsdPrim::GetAttributes ( ) const

Like GetProperties(), but exclude all relationships from the result.

USD_API std::vector<UsdAttribute> UsdPrim::GetAuthoredAttributes ( ) const

Like GetAttributes(), but exclude attributes without authored scene description from the result. See UsdProperty::IsAuthored().

USD_API std::vector<UsdProperty> UsdPrim::GetAuthoredProperties ( const PropertyPredicateFunc & predicate = {} ) const

Return this prim's properties (attributes and relationships) that have authored scene description, ordered by name according to the strongest propertyOrder statement in scene description if one exists, otherwise ordered according to TfDictionaryLessThan.

If a valid predicate is passed in, then only authored properties whose names pass the predicate are included in the result. This is useful if the client is interested only in a subset of authored properties on the prim. For example, only the ones in a given namespace or only the ones needed to compute a value.

See Also: GetProperties(); UsdProperty::IsAuthored()

USD_API std::vector<UsdProperty> UsdPrim::GetAuthoredPropertiesInNamespace ( const std::vector< std::string > & namespaces ) const

Like GetPropertiesInNamespace(), but exclude properties that do not have authored scene description from the result. See UsdProperty::IsAuthored().

For details of namespaced properties, see Usd_Ordering

USD_API std::vector<UsdProperty> UsdPrim::GetAuthoredPropertiesInNamespace ( const std::string & namespaces ) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. namespaces must be an already-concatenated ordered set of namespaces, and may or may not terminate with the namespace-separator character. If namespaces is empty, this method is equivalent to GetAuthoredProperties().

USD_API TfTokenVector UsdPrim::GetAuthoredPropertyNames ( const PropertyPredicateFunc & predicate = {} ) const

Return this prim's property names (attributes and relationships) that have authored scene description, ordered according to the strongest propertyOrder statement in scene description if one exists, otherwise ordered according to TfDictionaryLessThan.

If a valid predicate is passed in, then only the authored properties whose names pass the predicate are included in the result. This is useful if the client is interested only in a subset of authored properties on the prim. For example, only the ones in a given namespace or only the ones needed to compute a value.

See Also: GetPropertyNames(); UsdProperty::IsAuthored()

USD_API std::vector<UsdRelationship> UsdPrim::GetAuthoredRelationships ( ) const

Like GetRelationships(), but exclude relationships without authored scene description from the result. See UsdProperty::IsAuthored().

USD_API UsdPrim UsdPrim::GetChild ( const TfToken & name ) const

Return this prim's direct child named name if it has one, otherwise return an invalid UsdPrim. Equivalent to:

prim.GetStage()->GetPrimAtPath(prim.GetPath().AppendChild(name))

UsdPrimSiblingRange UsdPrim::GetChildren ( ) const

inline

Return this prim's active, loaded, defined, non-abstract children as an iterable range. Equivalent to:

GetFilteredChildren(UsdPrimDefaultPredicate)

See Prim predicate flags and UsdPrimDefaultPredicate for more information.

Definition at line 2518 of file prim.h.

USD_API TfTokenVector UsdPrim::GetChildrenNames ( ) const

Return the names of the child prims in the order they appear when iterating over GetChildren.

USD_API TfTokenVector UsdPrim::GetChildrenReorder ( ) const

Return the strongest opinion for the metadata used to reorder children of this prim. Due to how reordering of prim children is composed, this value cannot be relied on to get the actual order of the prim's children. Use GetChidrenNames, GetAllChildrenNames, GetFilteredChildrenNames to get the true child order if needed.

UsdPrimSubtreeRange UsdPrim::GetDescendants ( ) const

inline

Return this prim's active, loaded, defined, non-abstract descendants as an iterable range. Equivalent to:

GetFilteredDescendants(UsdPrimDefaultPredicate)

Note: This method is not yet available in python, pending some refactoring to make it more feasible.

See Prim predicate flags and UsdPrimDefaultPredicate for more information, UsdStage::Traverse(), and UsdPrimRange for more general Stage traversal behaviors.

Definition at line 2778 of file prim.h.

UsdPrimSiblingRange UsdPrim::GetFilteredChildren ( const Usd_PrimFlagsPredicate & predicate ) const

inline

Return a subset of all of this prim's children filtered by predicate as an iterable range. The predicate is generated by combining a series of prim flag terms with either && or || and !.

Example usage:

// Get all active model children.
GetFilteredChildren(UsdPrimIsActive && UsdPrimIsModel);
// Get all model children that pass the default predicate.
GetFilteredChildren(UsdPrimDefaultPredicate && UsdPrimIsModel);

If this prim is an instance, no children will be returned unless UsdTraverseInstanceProxies is used to allow instance proxies to be returned, or if this prim is itself an instance proxy.

See Prim predicate flags and UsdPrimDefaultPredicate for more information.

Definition at line 2505 of file prim.h.

USD_API TfTokenVector UsdPrim::GetFilteredChildrenNames ( const Usd_PrimFlagsPredicate & predicate ) const

Return the names of the child prims in the order they appear when iterating over GetFilteredChildren(predicate).

UsdPrimSubtreeRange UsdPrim::GetFilteredDescendants ( const Usd_PrimFlagsPredicate & predicate ) const

inline

Return a subset of all of this prim's descendants filtered by predicate as an iterable range. The predicate is generated by combining a series of prim flag terms with either && or || and !.

Example usage:

// Get all active model descendants.
GetFilteredDescendants(UsdPrimIsActive && UsdPrimIsModel);
// Get all model descendants that pass the default predicate.
GetFilteredDescendants(UsdPrimDefaultPredicate && UsdPrimIsModel);

If this prim is an instance, no descendants will be returned unless UsdTraverseInstanceProxies is used to allow instance proxies to be returned, or if this prim is itself an instance proxy.

Note: This method is not yet available in python, pending some refactoring to make it more feasible.

See Prim predicate flags and UsdPrimDefaultPredicate for more information, UsdStage::Traverse(), and UsdPrimRange for more general Stage traversal behaviors.

Definition at line 2765 of file prim.h.

USD_API UsdPrim UsdPrim::GetFilteredNextSibling ( const Usd_PrimFlagsPredicate & predicate ) const

Return this prim's next sibling that matches predicate if it has one, otherwise return the invalid UsdPrim.

See Prim predicate flags and UsdPrimDefaultPredicate for more information.

USD_API UsdInherits UsdPrim::GetInherits ( ) const

Return a UsdInherits object that allows one to add, remove, or mutate inherits at the currently set UsdEditTarget.

While the UsdInherits object has no methods for listing the currently authored inherits on a prim, one can use a UsdPrimCompositionQuery to query the inherits arcs that are composed by this prim.

See Also: UsdPrimCompositionQuery::GetDirectInherits

USD_API std::vector<UsdPrim> UsdPrim::GetInstances ( ) const

If this prim is a prototype prim, returns all prims that are instances of this prototype. Otherwise, returns an empty vector.

Note that this function will return prims in prototypes for instances that are nested beneath other instances.

USD_API bool UsdPrim::GetKind ( TfToken * kind ) const

Retrieve the authored kind for this prim.

To test whether the returned kind matches a particular known "clientKind":

TfToken kind;
bool isClientKind = prim.GetKind(&kind) and
                    KindRegistry::IsA(kind, clientKind);

Returns: true if there was an authored kind that was successfully read, otherwise false. Note that this will return false for pseudoroot even though pseudoroot is always a group, without any kind (in order to respect model hierarchy rules)

See Also: The Kind module for further details on how to use Kind for classification, and how to extend the taxonomy.

USD_API UsdPrim UsdPrim::GetNextSibling ( ) const

Return this prim's next active, loaded, defined, non-abstract sibling if it has one, otherwise return an invalid UsdPrim. Equivalent to:

GetFilteredNextSibling(UsdPrimDefaultPredicate)

See Prim predicate flags and UsdPrimDefaultPredicate for more information.

USD_API UsdObject UsdPrim::GetObjectAtPath ( const SdfPath & path ) const

Returns the object at path on the same stage as this prim. If path is is relative, it will be anchored to the path of this prim.

See Also: UsdStage::GetObjectAtPath(const SdfPath&) const

UsdPrim UsdPrim::GetParent ( ) const

inline

Return this prim's parent prim. Return an invalid UsdPrim if this is a root prim.

Definition at line 1546 of file prim.h.

USD_API UsdPayloads UsdPrim::GetPayloads ( ) const

Return a UsdPayloads object that allows one to add, remove, or mutate payloads at the currently set UsdEditTarget.

While the UsdPayloads object has no methods for listing the currently authored payloads on a prim, one can use a UsdPrimCompositionQuery to query the payload arcs that are composed by this prim.

USD_API UsdPrim UsdPrim::GetPrimAtPath ( const SdfPath & path ) const

Returns the prim at path on the same stage as this prim. If path is is relative, it will be anchored to the path of this prim.

See Also: UsdStage::GetPrimAtPath(const SdfPath&) const

const UsdPrimDefinition& UsdPrim::GetPrimDefinition ( ) const

inline

Return this prim's definition based on the prim's type if the type is a registered prim type. Returns an empty prim definition if it is not.

Definition at line 164 of file prim.h.

const PcpPrimIndex& UsdPrim::GetPrimIndex ( ) const

inline

Return the cached prim index containing all sites that can contribute opinions to this prim.

The prim index can be used to examine the composition arcs and scene description sites that can contribute to this prim's property and metadata values.

The prim index returned by this function is optimized and may not include sites that do not contribute opinions to this prim. Use UsdPrim::ComputeExpandedPrimIndex to compute a prim index that includes all possible sites that could contribute opinions.

This prim index will be empty for prototype prims. This ensures that these prims do not provide any attribute or metadata values. For all other prims in prototypes, this is the prim index that was chosen to be shared with all other instances. In either case, the prim index's path will not be the same as the prim's path.

Prim indexes may be invalidated by changes to the UsdStage and cannot detect if they are expired. Clients should avoid keeping copies of the prim index across such changes, which include scene description changes or changes to load state.

Definition at line 2150 of file prim.h.

UsdPrim UsdPrim::GetPrimInPrototype ( ) const

inline

If this prim is an instance proxy, return the UsdPrim for the corresponding prim in the instance's prototype. Otherwise, return an invalid UsdPrim.

Definition at line 2107 of file prim.h.

USD_API SdfPrimSpecHandleVector UsdPrim::GetPrimStack ( ) const

Return all the authored SdfPrimSpecs that may contain opinions for this prim in order from strong to weak.

This does not include all the places where contributing prim specs could potentially be created; rather, it includes only those prim specs that already exist. To discover all the places that prim specs could be authored that would contribute opinions, see "Composition Structure"

Note: Use this method for debugging and diagnostic purposes. It is not advisable to retain a PrimStack for expedited metadata value resolution, since not all metadata resolves with simple "strongest opinion wins" semantics.

USD_API std::vector<std::pair<SdfPrimSpecHandle, SdfLayerOffset> > UsdPrim::GetPrimStackWithLayerOffsets ( ) const

Return all the authored SdfPrimSpecs that may contain opinions for this prim in order from strong to weak paired with the cumulative layer offset from the stage's root layer to the layer containing the prim spec.

This behaves exactly the same as UsdPrim::GetPrimStack with the addition of providing the cumulative layer offset of each spec's layer.

Note: Use this method for debugging and diagnostic purposes. It is not advisable to retain a PrimStack for expedited metadata value resolution, since not all metadata resolves with simple "strongest opinion wins" semantics.

const UsdPrimTypeInfo& UsdPrim::GetPrimTypeInfo ( ) const

inline

Return the prim's full type info composed from its type name, applied API schemas, and any fallback types defined on the stage for unrecognized prim type names. The returned type structure contains the "true" schema type used to create this prim's prim definition and answer the IsA query. This value is cached and efficient to query. The cached values are guaranteed to exist for (at least) as long as the prim's stage is open.

See Also: GetTypeName; GetAppliedSchemas; Usd_OM_FallbackPrimTypes

Definition at line 157 of file prim.h.

USD_API std::vector<UsdProperty> UsdPrim::GetProperties ( const PropertyPredicateFunc & predicate = {} ) const

Return all of this prim's properties (attributes and relationships), including all builtin properties, ordered by name according to the strongest propertyOrder statement in scene description if one exists, otherwise ordered according to TfDictionaryLessThan.

If a valid predicate is passed in, then only properties whose names pass the predicate are included in the result. This is useful if the client is interested only in a subset of properties on the prim. For example, only the ones in a given namespace or only the ones needed to compute a value.

To obtain only either attributes or relationships, use either GetAttributes() or GetRelationships().

To determine whether a property is either an attribute or a relationship, use the UsdObject::As() and UsdObject::Is() methods in C++:

// Use As<>() to obtain a subclass instance.
if (UsdAttribute attr = property.As<UsdAttribute>()) {
    // use attribute 'attr'.
else if (UsdRelationship rel = property.As<UsdRelationship>()) {
    // use relationship 'rel'.
}
// Use Is<>() to discriminate only.
if (property.Is<UsdAttribute>()) {
    // property is an attribute.
}

In Python, use the standard isinstance() function:

if isinstance(property, Usd.Attribute):
    # property is a Usd.Attribute.
elif isinstance(property, Usd.Relationship):
    # property is a Usd.Relationship.

See Also: GetAuthoredProperties(); UsdProperty::IsAuthored()

USD_API std::vector<UsdProperty> UsdPrim::GetPropertiesInNamespace ( const std::vector< std::string > & namespaces ) const

Return this prim's properties that are inside the given property namespace ordered according to the strongest propertyOrder statement in scene description if one exists, otherwise ordered according to TfDictionaryLessThan.

A namespaces argument whose elements are ["ri", "attribute"] will return all the properties under the namespace "ri:attribute", i.e. "ri:attribute:*". An empty namespaces argument is equivalent to GetProperties().

For details of namespaced properties, see Usd_Ordering

USD_API std::vector<UsdProperty> UsdPrim::GetPropertiesInNamespace ( const std::string & namespaces ) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. namespaces must be an already-concatenated ordered set of namespaces, and may or may not terminate with the namespace-separator character. If namespaces is empty, this method is equivalent to GetProperties().

USD_API UsdProperty UsdPrim::GetProperty ( const TfToken & propName ) const

Return a UsdProperty with the name propName. The property returned may or may not actually exist so it must be checked for validity. Suggested use:

if (UsdProperty myProp = prim.GetProperty("myProp")) {
   // myProp is safe to use. 
   // Edits to the owning stage requires subsequent validation.
} else {
   // myProp was not defined/authored
}

USD_API UsdProperty UsdPrim::GetPropertyAtPath ( const SdfPath & path ) const

Returns the property at path on the same stage as this prim. If path is relative, it will be anchored to the path of this prim.

Note: There is no guarantee that this method returns a property on this prim. This is only guaranteed if path is a purely relative property path.

See Also: GetProperty(const TfToken&) const; UsdStage::GetPropertyAtPath(const SdfPath&) const

USD_API TfTokenVector UsdPrim::GetPropertyNames ( const PropertyPredicateFunc & predicate = {} ) const

Return all of this prim's property names (attributes and relationships), including all builtin properties.

If a valid predicate is passed in, then only properties whose names pass the predicate are included in the result. This is useful if the client is interested only in a subset of properties on the prim. For example, only the ones in a given namespace or only the ones needed to compute a value.

See Also: GetAuthoredPropertyNames(); UsdProperty::IsAuthored()

USD_API TfTokenVector UsdPrim::GetPropertyOrder ( ) const

Return the strongest propertyOrder metadata value authored on this prim.

USD_API UsdPrim UsdPrim::GetPrototype ( ) const

If this prim is an instance, return the UsdPrim for the corresponding prototype. Otherwise, return an invalid UsdPrim.

USD_API UsdReferences UsdPrim::GetReferences ( ) const

Return a UsdReferences object that allows one to add, remove, or mutate references at the currently set UsdEditTarget.

While the UsdReferences object has no methods for listing the currently authored references on a prim, one can use a UsdPrimCompositionQuery to query the reference arcs that are composed by this prim.

See Also: UsdPrimCompositionQuery::GetDirectReferences

USD_API UsdRelationship UsdPrim::GetRelationship ( const TfToken & relName ) const

Return a UsdRelationship with the name relName. The relationship returned may or may not actually exist so it must be checked for validity. Suggested use:

if (UsdRelationship myRel = prim.GetRelationship("myRel")) {
   // myRel is safe to use.
   // Edits to the owning stage requires subsequent validation.
} else {
   // myRel was not defined/authored
}

USD_API UsdRelationship UsdPrim::GetRelationshipAtPath ( const SdfPath & path ) const

Returns the relationship at path on the same stage as this prim. If path is relative, it will be anchored to the path of this prim.

Note: There is no guarantee that this method returns a relationship on this prim. This is only guaranteed if path is a purely relative property path.

See Also: GetRelationship(const TfToken&) const; UsdStage::GetRelationshipAtPath(const SdfPath&) const

USD_API std::vector<UsdRelationship> UsdPrim::GetRelationships ( ) const

Like GetProperties(), but exclude all attributes from the result.

USD_API UsdSpecializes UsdPrim::GetSpecializes ( ) const

Return a UsdSpecializes object that allows one to add, remove, or mutate specializes at the currently set UsdEditTarget.

While the UsdSpecializes object has no methods for listing the currently authored specializes on a prim, one can use a UsdPrimCompositionQuery to query the specializes arcs that are composed by this prim.

SdfSpecifier UsdPrim::GetSpecifier ( ) const

inline

Return this prim's composed specifier.

Definition at line 169 of file prim.h.

const TfToken& UsdPrim::GetTypeName ( ) const

inline

Return this prim's composed type name. This value is cached and is efficient to query. Note that this is just the composed type name as authored and may not represent the full type of the prim and its prim definition. If you need to reason about the actual type of the prim, use GetPrimTypeInfo instead as it accounts for recognized schemas, applied API schemas, fallback types, etc.

Definition at line 216 of file prim.h.

USD_API UsdVariantSet UsdPrim::GetVariantSet ( const std::string & variantSetName ) const

Retrieve a specifically named VariantSet for editing or constructing a UsdEditTarget.

This is a shortcut for

prim.GetVariantSets().GetVariantSet(variantSetName)

USD_API UsdVariantSets UsdPrim::GetVariantSets ( ) const

Return a UsdVariantSets object representing all the VariantSets present on this prim.

The returned object also provides the API for adding new VariantSets to the prim.

USD_API bool UsdPrim::GetVersionIfHasAPIInFamily	(	const TfToken &	schemaFamily,
		UsdSchemaVersion *	schemaVersion
	)		const

Return true if the prim has an applied API schema that is any version the schemas in the given schemaFamily and if so, populates schemaVersion with the version of the schema that this prim HasAPI.

This function will consider both single-apply and multiple-apply API schemas in the schema family. For the multiple-apply API schemas is a this will return true if any instance of one of the schemas has been applied.

Note that if more than one version of the schemas in schemaFamily are applied to this prim, the highest version number of these schemas will be populated in schemaVersion.

USD_API bool UsdPrim::GetVersionIfHasAPIInFamily	(	const TfToken &	schemaFamily,
		const TfToken &	instanceName,
		UsdSchemaVersion *	schemaVersion
	)		const

Return true if the prim has a specific instance instanceName of an applied multiple-apply API schema that is any version the schemas in the given schemaFamily and if so, populates schemaVersion with the version of the schema that this prim HasAPI(const TfToken &) const "HasAPI".

instanceName must be non-empty, otherwise it is a coding error.

Note that if more than one version of the schemas in schemaFamily is multiple-apply and applied to this prim with the given instanceName, the highest version number of these schemas will be populated in schemaVersion.

USD_API bool UsdPrim::GetVersionIfIsInFamily	(	const TfToken &	schemaFamily,
		UsdSchemaVersion *	schemaVersion
	)		const

Return true if the prim's schema type, is or inherits from the schema type of any version the schema in the given schemaFamily and if so, populates schemaVersion with the version of the schema that this prim IsA.

template<typename SchemaType >

bool UsdPrim::HasAPI ( ) const

inline

Return true if the UsdPrim has had an applied API schema represented by the C++ class type SchemaType applied to it.

This function works for both single-apply and multiple-apply API schema types. If the schema is a multiple-apply API schema this will return true if any instance of the multiple-apply API has been applied.

Definition at line 741 of file prim.h.

template<typename SchemaType >

bool UsdPrim::HasAPI ( const TfToken & instanceName ) const

inline

Return true if the UsdPrim has the specific instance, instanceName, of the multiple-apply API schema represented by the C++ class type SchemaType applied to it.

instanceName must be non-empty, otherwise it is a coding error.

Definition at line 761 of file prim.h.

USD_API bool UsdPrim::HasAPI ( const TfType & schemaType ) const

This is an overload of HasAPI that takes a TfType schemaType .

USD_API bool UsdPrim::HasAPI	(	const TfType &	schemaType,
		const TfToken &	instanceName
	)		const

This is an overload of HasAPI(const TfToken &) const "HasAPI" with instanceName that takes a TfType schemaType .

USD_API bool UsdPrim::HasAPI ( const TfToken & schemaIdentifier ) const

This is an overload of HasAPI that takes a schemaIdentifier to determine the schema type.

USD_API bool UsdPrim::HasAPI	(	const TfToken &	schemaIdentifier,
		const TfToken &	instanceName
	)		const

This is an overload of HasAPI(const TfToken &) const "HasAPI" with instanceName that takes a schemaIdentifier to determine the schema type.

USD_API bool UsdPrim::HasAPI	(	const TfToken &	schemaFamily,
		UsdSchemaVersion	schemaVersion
	)		const

This is an overload of HasAPI that takes a schemaFamily and schemaVersion to determine the schema type.

USD_API bool UsdPrim::HasAPI	(	const TfToken &	schemaFamily,
		UsdSchemaVersion	schemaVersion,
		const TfToken &	instanceName
	)		const

This is an overload of HasAPI(const TfToken &) const "HasAPI" with instanceName that takes a schemaFamily and schemaVersion to determine the schema type.

USD_API bool UsdPrim::HasAPIInFamily ( const TfToken & schemaFamily ) const

Return true if the prim has an applied API schema that is any version of the schemas in the given schemaFamily.

This function will consider both single-apply and multiple-apply API schemas in the schema family. For the multiple-apply API schemas, this will return true if any instance of one of the schemas has been applied.

USD_API bool UsdPrim::HasAPIInFamily	(	const TfToken &	schemaFamily,
		const TfToken &	instanceName
	)		const

Return true if the prim has a specific instance instanceName of an applied multiple-apply API schema that is any version the schemas in the given schemaFamily.

instanceName must be non-empty, otherwise it is a coding error.

USD_API bool UsdPrim::HasAPIInFamily	(	const TfToken &	schemaFamily,
		UsdSchemaVersion	schemaVersion,
		UsdSchemaRegistry::VersionPolicy	versionPolicy
	)		const

Return true if the prim has an applied API schema that is a schema in the given schemaFamily that matches the version filter provided by schemaVersion and versionPolicy.

This function will consider both single-apply and multiple-apply API schemas in the schema family. For the multiple-apply API schemas, this will return true if any instance of one of the filter-passing schemas has been applied.

USD_API bool UsdPrim::HasAPIInFamily	(	const TfToken &	schemaFamily,
		UsdSchemaVersion	schemaVersion,
		UsdSchemaRegistry::VersionPolicy	versionPolicy,
		const TfToken &	instanceName
	)		const

Return true if the prim has a specific instance instanceName of an applied multiple-apply API schema in the given schemaFamily that matches the version filter provided by schemaVersion and versionPolicy.

instanceName must be non-empty, otherwise it is a coding error.

template<typename SchemaType >

bool UsdPrim::HasAPIInFamily ( UsdSchemaRegistry::VersionPolicy versionPolicy ) const

inline

Overload for convenience of HasAPIInFamily(const TfToken&, UsdSchemaVersion, UsdSchemaRegistry::VersionPolicy) const "HasAPIInFamily" that finds a registered schema for the C++ schema class SchemaType and uses that schema's family and version.

Definition at line 867 of file prim.h.

template<typename SchemaType >

bool UsdPrim::HasAPIInFamily	(	UsdSchemaRegistry::VersionPolicy	versionPolicy,
		const TfToken &	instanceName
	)		const

inline

Overload for convenience of HasAPIInFamily(const TfToken&, UsdSchemaVersion, UsdSchemaRegistry::VersionPolicy, const TfToken &) const "HasAPIInFamily" that finds a registered schema for the C++ schema class SchemaType and uses that schema's family and version.

Definition at line 889 of file prim.h.

USD_API bool UsdPrim::HasAPIInFamily	(	const TfType &	schemaType,
		UsdSchemaRegistry::VersionPolicy	versionPolicy
	)		const

Overload for convenience of HasAPIInFamily(const TfToken&, UsdSchemaVersion, UsdSchemaRegistry::VersionPolicy) const "HasAPIInFamily" that finds a registered schema for the given schemaType and uses that schema's family and version.

USD_API bool UsdPrim::HasAPIInFamily	(	const TfType &	schemaType,
		UsdSchemaRegistry::VersionPolicy	versionPolicy,
		const TfToken &	instanceName
	)		const

Overload for convenience of HasAPIInFamily(const TfToken&, UsdSchemaVersion, UsdSchemaRegistry::VersionPolicy, const TfToken &) const "HasAPIInFamily" that finds a registered schema for the given schemaType and uses that schema's family and version.

USD_API bool UsdPrim::HasAPIInFamily	(	const TfToken &	schemaIdentifier,
		UsdSchemaRegistry::VersionPolicy	versionPolicy
	)		const

Overload for convenience of HasAPIInFamily(const TfToken&, UsdSchemaVersion, UsdSchemaRegistry::VersionPolicy) const "HasAPIInFamily" that parses the schema family and version to use from the given schemaIdentifier.

Note that the schema identifier is not required to be a registered schema as it only parsed to get what its family and version would be See UsdSchemaRegistry::ParseSchemaFamilyAndVersionFromIdentifier.

USD_API bool UsdPrim::HasAPIInFamily	(	const TfToken &	schemaIdentifier,
		UsdSchemaRegistry::VersionPolicy	versionPolicy,
		const TfToken &	instanceName
	)		const

Overload for convenience of HasAPIInFamily(const TfToken&, UsdSchemaVersion, UsdSchemaRegistry::VersionPolicy, const TfToken &) const "HasAPIInFamily" that parses the schema family and version to use from the given schemaIdentifier.

Note that the schema identifier is not required to be a registered schema as it only parsed to get what its family and version would be See UsdSchemaRegistry::ParseSchemaFamilyAndVersionFromIdentifier.

USD_API bool UsdPrim::HasAttribute ( const TfToken & attrName ) const

Return true if this prim has an attribute named attrName, false otherwise.

bool UsdPrim::HasAuthoredActive ( ) const

inline

Return true if this prim has an authored opinion for 'active', false otherwise.

See Usd_ActiveInactive for what it means for a prim to be active.

Definition at line 261 of file prim.h.

USD_API bool UsdPrim::HasAuthoredInherits ( ) const

Return true if this prim has any authored inherits.

bool UsdPrim::HasAuthoredInstanceable ( ) const

inline

Return true if this prim has an authored opinion for 'instanceable', false otherwise.

Definition at line 2049 of file prim.h.

USD_API bool UsdPrim::HasAuthoredPayloads ( ) const

Return true if this prim has any authored payloads.

USD_API bool UsdPrim::HasAuthoredReferences ( ) const

Return true if this prim has any authored references.

USD_API bool UsdPrim::HasAuthoredSpecializes ( ) const

Returns true if this prim has any authored specializes.

bool UsdPrim::HasAuthoredTypeName ( ) const

inline

Return true if a typeName has been authored.

Definition at line 230 of file prim.h.

bool UsdPrim::HasDefiningSpecifier ( ) const

inline

Return true if this prim has a specifier of type SdfSpecifierDef or SdfSpecifierClass.

See Also: SdfIsDefiningSpecifier

Definition at line 305 of file prim.h.

USD_API bool UsdPrim::HasPayload ( ) const

Deprecated:: Return true if a payload is present on this prim.

See Also: Usd_Payloads

USD_API bool UsdPrim::HasProperty ( const TfToken & propName ) const

Return true if this prim has an property named propName, false otherwise.

USD_API bool UsdPrim::HasRelationship ( const TfToken & relName ) const

Return true if this prim has a relationship named relName, false otherwise.

USD_API bool UsdPrim::HasVariantSets ( ) const

Return true if this prim has any authored VariantSets.

Note: this connotes only the existence of one of more VariantSets, not that such VariantSets necessarily contain any variants or variant opinions.

template<typename SchemaType >

bool UsdPrim::IsA ( ) const

inline

Return true if the prim's schema type, is or inherits from the TfType of the schema class type SchemaType.

See Also: GetPrimTypeInfo; UsdPrimTypeInfo::GetSchemaType; Usd_OM_FallbackPrimTypes

Definition at line 591 of file prim.h.

USD_API bool UsdPrim::IsA ( const TfType & schemaType ) const

This is an overload of IsA that takes a TfType schemaType .

USD_API bool UsdPrim::IsA ( const TfToken & schemaIdentifier ) const

This is an overload of IsA that takes a schemaIdentifier to determine the schema type.

USD_API bool UsdPrim::IsA	(	const TfToken &	schemaFamily,
		UsdSchemaVersion	schemaVersion
	)		const

This is an overload of IsA that takes a schemaFamily and schemaVersion to determine the schema type.

bool UsdPrim::IsAbstract ( ) const

inline

Return true if this prim or any of its ancestors is a class.

Definition at line 297 of file prim.h.

bool UsdPrim::IsActive ( ) const

inline

Return true if this prim is active, meaning neither it nor any of its ancestors have active=false. Return false otherwise.

See Usd_ActiveInactive for what it means for a prim to be active.

Definition at line 238 of file prim.h.

bool UsdPrim::IsComponent ( ) const

inline

Return true if this prim is a component model based on its kind metadata, false otherwise. If this prim is a component, it is also necessarily a model.

Definition at line 285 of file prim.h.

bool UsdPrim::IsDefined ( ) const

inline

Return true if this prim and all its ancestors have defining specifiers, false otherwise.

See Also: SdfIsDefiningSpecifier.

Definition at line 301 of file prim.h.

bool UsdPrim::IsGroup ( ) const

inline

Return true if this prim is a model group based on its kind metadata, false otherwise. If this prim is a group, it is also necessarily a model.

Note that pseudoroot is always a group (in order to respect model hierarchy rules), even though it cannot have a kind.

Definition at line 280 of file prim.h.

USD_API bool UsdPrim::IsInFamily ( const TfToken & schemaFamily ) const

Return true if the prim's schema type is or inherits from the schema type of any version of the schemas in the given schemaFamily.

USD_API bool UsdPrim::IsInFamily	(	const TfToken &	schemaFamily,
		UsdSchemaVersion	schemaVersion,
		UsdSchemaRegistry::VersionPolicy	versionPolicy
	)		const

Return true if the prim's schema type, is or inherits from the schema type of any schema in the given schemaFamily that matches the version filter provided by schemaVersion and versionPolicy.

template<typename SchemaType >

bool UsdPrim::IsInFamily ( UsdSchemaRegistry::VersionPolicy versionPolicy ) const

inline

Overload for convenience of IsInFamily(const TfToken&, UsdSchemaVersion, UsdSchemaRegistry::VersionPolicy) const "IsInFamily" that finds a registered schema for the C++ schema class SchemaType and uses that schema's family and version.

Definition at line 637 of file prim.h.

USD_API bool UsdPrim::IsInFamily	(	const TfType &	schemaType,
		UsdSchemaRegistry::VersionPolicy	versionPolicy
	)		const

Overload for convenience of IsInFamily(const TfToken&, UsdSchemaVersion, UsdSchemaRegistry::VersionPolicy) const "IsInFamily" that finds a registered schema for the given schemaType and uses that schema's family and version.

USD_API bool UsdPrim::IsInFamily	(	const TfToken &	schemaIdentifier,
		UsdSchemaRegistry::VersionPolicy	versionPolicy
	)		const

Overload for convenience of IsInFamily(const TfToken&, UsdSchemaVersion, UsdSchemaRegistry::VersionPolicy) const "IsInFamily" that parses the schema family and version to use from the given schemaIdentifier.

Note that the schema identifier is not required to be a registered schema as it only parsed to get what its family and version would be See UsdSchemaRegistry::ParseSchemaFamilyAndVersionFromIdentifier.

bool UsdPrim::IsInPrototype ( ) const

inline

Return true if this prim is a prototype prim or a descendant of a prototype prim, false otherwise.

See Also: IsPrototype

Definition at line 2094 of file prim.h.

bool UsdPrim::IsInstance ( ) const

inline

Return true if this prim is an instance of a prototype, false otherwise.

If this prim is an instance, calling GetPrototype() will return the UsdPrim for the corresponding prototype prim.

Definition at line 2058 of file prim.h.

bool UsdPrim::IsInstanceable ( ) const

inline

Return true if this prim has been marked as instanceable.

Note that this is not the same as IsInstance(). A prim may return true for IsInstanceable() and false for IsInstance() if this prim is not active or if it is marked as instanceable but contains no instanceable data.

Definition at line 2029 of file prim.h.

bool UsdPrim::IsInstanceProxy ( ) const

inline

Return true if this prim is an instance proxy, false otherwise. An instance proxy prim represents a descendent of an instance prim.

Definition at line 2063 of file prim.h.

bool UsdPrim::IsLoaded ( ) const

inline

Return true if this prim is active, and either it is loadable and it is loaded, or its nearest loadable ancestor is loaded, or it has no loadable ancestor; false otherwise.

Definition at line 268 of file prim.h.

bool UsdPrim::IsModel ( ) const

inline

Return true if this prim is a model based on its kind metadata, false otherwise.

Definition at line 272 of file prim.h.

static USD_API bool UsdPrim::IsPathInPrototype ( const SdfPath & path )

static

Return true if the given path identifies a prototype prim or a prim or property descendant of a prototype prim, false otherwise.

See Also: IsPrototypePath

bool UsdPrim::IsPrototype ( ) const

inline

Return true if this prim is an instancing prototype prim, false otherwise.

See Also: IsInPrototype

Definition at line 2088 of file prim.h.

static USD_API bool UsdPrim::IsPrototypePath ( const SdfPath & path )

static

Return true if the given path identifies a prototype prim, false otherwise.

This function will return false for prim and property paths that are descendants of a prototype prim path.

See Also: IsPathInPrototype

USD_API bool UsdPrim::IsPseudoRoot ( ) const

Returns true if the prim is the pseudo root.

Equivalent to

prim.GetPath() == SdfPath::AbsoluteRootPath()

USD_API bool UsdPrim::IsSubComponent ( ) const

inline

Return true if this prim is a subcomponent based on its kind metadata, false otherwise.

Note that subcomponent query is not cached because we only cache model-hierarchy-related information, and therefore will be considerably slower than other kind-based queries.

Definition at line 294 of file prim.h.

USD_API void UsdPrim::Load ( UsdLoadPolicy policy = UsdLoadWithDescendants ) const

Load this prim, all its ancestors, and by default all its descendants. If loadPolicy is UsdLoadWithoutDescendants, then load only this prim and its ancestors.

See UsdStage::Load for additional details.

USD_API UsdResolveTarget UsdPrim::MakeResolveTargetStrongerThanEditTarget ( const UsdEditTarget & editTarget ) const

Creates and returns a resolve target that, when passed to a UsdAttributeQuery for one of this prim's attributes, causes value resolution to only consider specs that are stronger than the spec that would be authored for this prim when using the given editTarget.

If the edit target would not affect any specs that could contribute to this prim, a null resolve target is returned.

USD_API UsdResolveTarget UsdPrim::MakeResolveTargetUpToEditTarget ( const UsdEditTarget & editTarget ) const

Creates and returns a resolve target that, when passed to a UsdAttributeQuery for one of this prim's attributes, causes value resolution to only consider weaker specs up to and including the spec that would be authored for this prim when using the given editTarget.

If the edit target would not affect any specs that could contribute to this prim, a null resolve target is returned.

template<typename SchemaType >

bool UsdPrim::RemoveAPI ( ) const

inline

Removes a single-apply API schema with the given C++ type SchemaType from this prim in the current edit target.

This is done by removing the API schema's name token from the token-valued, listOp metadata apiSchemas on this prim as well as authoring an explicit deletion of schema name from the listOp.

Returns true upon success or if the API schema is already deleted in the current edit target.

An error is issued and false returned for any of the following conditions:

this prim is not a valid prim for editing
this prim is valid, but cannot be reached or overridden in the current edit target
the schema name cannot be deleted in the apiSchemas listOp metadata

Definition at line 1253 of file prim.h.

template<typename SchemaType >

bool UsdPrim::RemoveAPI ( const TfToken & instanceName ) const

inline

Removes a multiple-apply API schema with the given C++ type 'SchemaType' and instance name instanceName from this prim in the current edit target.

This is done by removing the instanced schema name token from the token-valued, listOp metadata apiSchemas on this prim as well as authoring an explicit deletion of the name from the listOp. For example, if SchemaType is 'UsdCollectionAPI' and instanceName is 'plasticStuff', the name 'CollectionAPI:plasticStuff' is deleted from the 'apiSchemas' listOp metadata.

Returns true upon success or if the API schema with this instanceName is already deleted in the current edit target.

An error is issued and false returned for any of the following conditions:

instanceName is empty
this prim is not a valid prim for editing
this prim is valid, but cannot be reached or overridden in the current edit target
the schema name cannot be deleted in the apiSchemas listOp metadata

Definition at line 1295 of file prim.h.

USD_API bool UsdPrim::RemoveAPI ( const TfType & schemaType ) const

This is an overload of RemoveAPI that takes a TfType schemaType .

USD_API bool UsdPrim::RemoveAPI	(	const TfType &	schemaType,
		const TfToken &	instanceName
	)		const

This is an overload of RemoveAPI(const TfToken &) const "RemoveAPI" with instanceName that takes a TfType schemaType .

USD_API bool UsdPrim::RemoveAPI ( const TfToken & schemaIdentifier ) const

This is an overload of RemoveAPI that takes a schemaIdentifier to determine the schema type.

USD_API bool UsdPrim::RemoveAPI	(	const TfToken &	schemaIdentifier,
		const TfToken &	instanceName
	)		const

This is an overload of RemoveAPI(const TfToken &) const "RemoveAPI" with instanceName that takes a schemaIdentifier to determine the schema type.

USD_API bool UsdPrim::RemoveAPI	(	const TfToken &	schemaFamily,
		UsdSchemaVersion	schemaVersion
	)		const

This is an overload of RemoveAPI that takes a schemaFamily and schemaVersion to determine the schema type.

USD_API bool UsdPrim::RemoveAPI	(	const TfToken &	schemaFamily,
		UsdSchemaVersion	schemaVersion,
		const TfToken &	instanceName
	)		const

This is an overload of RemoveAPI(const TfToken &) const "RemoveAPI" with instanceName that takes a schemaFamily and schemaVersion to determine the schema type.

USD_API bool UsdPrim::RemoveAppliedSchema ( const TfToken & appliedSchemaName ) const

Removes the applied API schema name token appliedSchemaName from the apiSchemas metadata for this prim at the current edit target. For multiple-apply schemas the name token should include the instance name for the applied schema, for example 'CollectionAPI:plasticStuff'

For an explicit list operation, this removes the applied schema name from the explicit items list if it was present. For a non-explicit list operation, this will remove any occurrence of the applied schema name from the prepended and appended item as well as adding it to the deleted items list.

Returns true upon success or if the API schema is already deleted in the current edit target.

An error is issued and false returned for any of the following conditions:

this prim is not a valid prim for editing
this prim is valid, but cannot be reached or overridden in the current edit target
the schema name cannot be deleted in the apiSchemas listOp metadata

Unlike RemoveAPI this method does not require that the name token refer to a valid API schema type. RemoveAPI is the preferred method for removing valid API schemas.

USD_API bool UsdPrim::RemoveProperty ( const TfToken & propName )

Remove all scene description for the property with the given propName in the current UsdEditTarget. Return true if the property is removed, false otherwise.

Because this method can only remove opinions about the property from the current EditTarget, you may generally find it more useful to use UsdAttribute::Block(), which will ensure that all values from the EditTarget and weaker layers for the property will be ignored.

bool UsdPrim::SetActive ( bool active ) const

inline

Author 'active' metadata for this prim at the current EditTarget.

See Usd_ActiveInactive for the effects of activating or deactivating a prim.

Definition at line 244 of file prim.h.

void UsdPrim::SetChildrenReorder ( const TfTokenVector & order ) const

inline

Author an opinion for the metadata used to reorder children of this prim at the current EditTarget.

Definition at line 1529 of file prim.h.

bool UsdPrim::SetInstanceable ( bool instanceable ) const

inline

Author 'instanceable' metadata for this prim at the current EditTarget.

Definition at line 2037 of file prim.h.

USD_API bool UsdPrim::SetKind ( const TfToken & kind ) const

Author a kind for this prim, at the current UsdEditTarget.

Returns: true if kind was successully authored, otherwise false.

USD_API bool UsdPrim::SetPayload ( const SdfPayload & payload ) const

Deprecated:: Author payload metadata for this prim at the current edit target. Return true on success, false if the value could not be set.

See Also: Usd_Payloads

USD_API bool UsdPrim::SetPayload	(	const std::string &	assetPath,
		const SdfPath &	primPath
	)		const

Deprecated:: Shorthand for SetPayload(SdfPayload(assetPath, primPath)).

USD_API bool UsdPrim::SetPayload	(	const SdfLayerHandle &	layer,
		const SdfPath &	primPath
	)		const

Deprecated:: Shorthand for SetPayload(SdfPayload(layer->GetIdentifier(), primPath)).

void UsdPrim::SetPropertyOrder ( const TfTokenVector & order ) const

inline

Author an opinion for propertyOrder metadata on this prim at the current EditTarget.

Definition at line 467 of file prim.h.

bool UsdPrim::SetSpecifier ( SdfSpecifier specifier ) const

inline

Author an opinion for this Prim's specifier at the current edit target.

Definition at line 205 of file prim.h.

bool UsdPrim::SetTypeName ( const TfToken & typeName ) const

inline

Author this Prim's typeName at the current EditTarget.

Definition at line 219 of file prim.h.

USD_API void UsdPrim::Unload ( ) const

Unloads this prim and all its descendants.

See UsdStage::Unload for additional details.

Friends And Related Function Documentation

friend class Usd_PrimData

friend

Definition at line 2218 of file prim.h.

friend class Usd_PrimFlagsPredicate

friend

Definition at line 2219 of file prim.h.

const PcpPrimIndex& Usd_PrimGetSourcePrimIndex ( const UsdPrim & )

friend

friend class Usd_StageImplAccess

friend

Definition at line 2216 of file prim.h.

friend class UsdAPISchemaBase

friend

Definition at line 2214 of file prim.h.

friend class UsdObject

friend

Definition at line 2209 of file prim.h.

friend struct UsdPrim_AttrConnectionFinder

friend

Definition at line 2221 of file prim.h.

friend struct UsdPrim_RelTargetFinder

friend

Definition at line 2220 of file prim.h.

friend class UsdPrimRange

friend

Definition at line 2217 of file prim.h.

friend class UsdPrimSiblingIterator

friend

Definition at line 2210 of file prim.h.

friend class UsdPrimSubtreeIterator

friend

Definition at line 2211 of file prim.h.

friend class UsdProperty

friend

Definition at line 2212 of file prim.h.

friend class UsdSchemaBase

friend

Definition at line 2213 of file prim.h.

friend class UsdStage

friend

Definition at line 2215 of file prim.h.

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

pxr/usd/usd/prim.h

Public Types

Public Member Functions

Friends

Instancing

Additional Inherited Members

Detailed Description

Management

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation