#include <primData.h>

Public Member Functions
Prim Data & Behavior
const SdfPath &	GetPath () const

const TfToken &	GetName () const

UsdStage *	GetStage () const

const UsdPrimDefinition &	GetPrimDefinition () const
	Returns the prim definition for this prim. More...

const TfToken &	GetTypeName () const

const UsdPrimTypeInfo &	GetPrimTypeInfo () const
	Returns the full type info for the prim. More...

bool	IsPseudoRoot () const
	Returns true if this prim is the pseudoroot. More...

bool	IsActive () 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

bool	HasPayload () const
	Return true if this prim has one or more payload composition arcs. More...

bool	MayHaveOpinionsInClips () const

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

Parent & Stage
class	Usd_PrimFlagsPredicate
	Return this prim's parent prim. Return nullptr if this is a root prim. More...

class	UsdPrim
	Return this prim's parent prim. Return nullptr if this is a root prim. More...

class	UsdStage
	Return this prim's parent prim. Return nullptr if this is a root prim. More...

void	intrusive_ptr_add_ref (const Usd_PrimData *prim)
	Return this prim's parent prim. Return nullptr if this is a root prim. More...

void	intrusive_ptr_release (const Usd_PrimData *prim)
	Return this prim's parent prim. Return nullptr if this is a root prim. More...

USD_API friend void	Usd_ThrowExpiredPrimAccessError (Usd_PrimData const *p)
	Return this prim's parent prim. Return nullptr if this is a root prim. More...

std::string	Usd_DescribePrimData (const Usd_PrimData *p, SdfPath const &proxyPrimPath)
	Return this prim's parent prim. Return nullptr if this is a root prim. More...

bool	Usd_IsDead (Usd_PrimData const *p)
	Return this prim's parent prim. Return nullptr if this is a root prim. More...

USD_API Usd_PrimDataConstPtr	GetParent () const
	Return this prim's parent prim. Return nullptr if this is a root prim. More...

USD_API const class PcpPrimIndex &	GetPrimIndex () const

USD_API const class PcpPrimIndex &	GetSourcePrimIndex () const

Usd_PrimDataPtr	GetFirstChild () const
	Return this prim's parent prim. Return nullptr if this is a root prim. More...

Usd_PrimDataPtr	GetNextSibling () const
	Return this prim's parent prim. Return nullptr if this is a root prim. More...

Usd_PrimDataPtr	GetParentLink () const
	Return this prim's parent prim. Return nullptr if this is a root prim. More...

Usd_PrimDataPtr	GetNextPrim () const
	Return this prim's parent prim. Return nullptr if this is a root prim. More...

USD_API Usd_PrimDataConstPtr	GetPrimDataAtPathOrInPrototype (const SdfPath &path) const
	Return this prim's parent prim. Return nullptr if this is a root prim. More...

bool	IsInstance () const

bool	IsPrototype () const
	Return true if this prim is a shared prototype prim, false otherwise. More...

bool	IsInPrototype () const

USD_API Usd_PrimDataConstPtr	GetPrototype () const

Detailed Description

Definition at line 72 of file primData.h.

Member Function Documentation

Usd_PrimDataPtr Usd_PrimData::GetFirstChild ( ) const

inline

Return this prim's parent prim. Return nullptr if this is a root prim.

Definition at line 204 of file primData.h.

const TfToken& Usd_PrimData::GetName ( ) const

inline

Returns the composed path for the prim.

This path is absolute with respect to the current stage and may require translation when used in the context of individual layers of which the current stage is composed. This always returns a cached result.

Definition at line 88 of file primData.h.

Usd_PrimDataPtr Usd_PrimData::GetNextPrim ( ) const

inline

Return this prim's parent prim. Return nullptr if this is a root prim.

Definition at line 223 of file primData.h.

Usd_PrimDataPtr Usd_PrimData::GetNextSibling ( ) const

inline

Return this prim's parent prim. Return nullptr if this is a root prim.

Definition at line 207 of file primData.h.

USD_API Usd_PrimDataConstPtr Usd_PrimData::GetParent ( ) const

Return this prim's parent prim. Return nullptr if this is a root prim.

Usd_PrimDataPtr Usd_PrimData::GetParentLink ( ) const

inline

Return this prim's parent prim. Return nullptr if this is a root prim.

Definition at line 215 of file primData.h.

const SdfPath& Usd_PrimData::GetPath ( ) const

inline

Returns the composed path for the prim.

This path is absolute with respect to the current stage and may require translation when used in the context of individual layers of which the current stage is composed. This always returns a cached result.

Definition at line 86 of file primData.h.

USD_API Usd_PrimDataConstPtr Usd_PrimData::GetPrimDataAtPathOrInPrototype ( const SdfPath & path ) const

Return this prim's parent prim. Return nullptr if this is a root prim.

const UsdPrimDefinition& Usd_PrimData::GetPrimDefinition ( ) const

inline

Returns the prim definition for this prim.

Definition at line 93 of file primData.h.

USD_API const class PcpPrimIndex& Usd_PrimData::GetPrimIndex ( ) const

Return a const reference to the PcpPrimIndex for this prim.

The prim's PcpPrimIndex can be used to examine the scene description sites that contribute to the prim's property and metadata values in minute detail.

For prototype prims this prim index will be empty; this ensures that these prims do not provide any attribute or metadata values.

For all other prims in prototypes, this is the prim index for the instance that was chosen to serve as the prototype for all other instances.

In either of the above two cases, this prim index will not have the same path as the prim's path.

const UsdPrimTypeInfo& Usd_PrimData::GetPrimTypeInfo ( ) const

inline

Returns the full type info for the prim.

Definition at line 104 of file primData.h.

USD_API Usd_PrimDataConstPtr Usd_PrimData::GetPrototype ( ) const

If this prim is an instance, return the prim data for the corresponding prototype. Otherwise, return nullptr.

USD_API const class PcpPrimIndex& Usd_PrimData::GetSourcePrimIndex ( ) const

Return a const reference to the source PcpPrimIndex for this prim.

For all prims in prototypes (which includes the prototype prim itself), this is the prim index for the instance that was chosen to serve as the prototype for all other instances. This prim index will not have the same path as the prim's path.

USD_API SdfSpecifier Usd_PrimData::GetSpecifier ( ) const

Return this prim's composed specifier.

UsdStage* Usd_PrimData::GetStage ( ) const

inline

Returns the composed path for the prim.

This path is absolute with respect to the current stage and may require translation when used in the context of individual layers of which the current stage is composed. This always returns a cached result.

Definition at line 90 of file primData.h.

const TfToken& Usd_PrimData::GetTypeName ( ) const

inline

Returns the composed type name for the prim. Note that this value is cached and is efficient to query.

Definition at line 99 of file primData.h.

bool Usd_PrimData::HasDefiningSpecifier ( ) const

inline

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

Definition at line 143 of file primData.h.

bool Usd_PrimData::HasPayload ( ) const

inline

Return true if this prim has one or more payload composition arcs.

Definition at line 148 of file primData.h.

bool Usd_PrimData::IsAbstract ( ) const

inline

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

Definition at line 135 of file primData.h.

bool Usd_PrimData::IsActive ( ) const

inline

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

Definition at line 113 of file primData.h.

bool Usd_PrimData::IsComponent ( ) const

inline

Returns the composed path for the prim.

This path is absolute with respect to the current stage and may require translation when used in the context of individual layers of which the current stage is composed. This always returns a cached result.

Definition at line 129 of file primData.h.

bool Usd_PrimData::IsDefined ( ) const

inline

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

See Also: SdfIsDefiningSpecifier.

Definition at line 139 of file primData.h.

bool Usd_PrimData::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.

Definition at line 127 of file primData.h.

bool Usd_PrimData::IsInPrototype ( ) const

inline

Return true if this prim is a child of a shared prototype prim, false otherwise.

Definition at line 254 of file primData.h.

bool Usd_PrimData::IsInstance ( ) const

inline

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

Definition at line 245 of file primData.h.

bool Usd_PrimData::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 118 of file primData.h.

bool Usd_PrimData::IsModel ( ) const

inline

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

Definition at line 122 of file primData.h.

bool Usd_PrimData::IsPrototype ( ) const

inline

Return true if this prim is a shared prototype prim, false otherwise.

Definition at line 248 of file primData.h.

bool Usd_PrimData::IsPseudoRoot ( ) const

inline

Returns true if this prim is the pseudoroot.

Definition at line 109 of file primData.h.

USD_API bool Usd_PrimData::IsSubComponent ( ) const

Returns the composed path for the prim.

This path is absolute with respect to the current stage and may require translation when used in the context of individual layers of which the current stage is composed. This always returns a cached result.

bool Usd_PrimData::MayHaveOpinionsInClips ( ) const

inline

Return true if attributes on this prim may have opinions in clips, false otherwise. If true, the relevant clips will be examined for opinions during value resolution.

Definition at line 153 of file primData.h.

Friends And Related Function Documentation

void intrusive_ptr_add_ref ( const Usd_PrimData * prim )

friend

Return this prim's parent prim. Return nullptr if this is a root prim.

Definition at line 329 of file primData.h.

void intrusive_ptr_release ( const Usd_PrimData * prim )

friend

Return this prim's parent prim. Return nullptr if this is a root prim.

Definition at line 332 of file primData.h.

std::string Usd_DescribePrimData	(	const Usd_PrimData *	p,
		SdfPath const &	proxyPrimPath
	)

friend

Return this prim's parent prim. Return nullptr if this is a root prim.

bool Usd_IsDead ( Usd_PrimData const * p )

friend

Return this prim's parent prim. Return nullptr if this is a root prim.

Definition at line 342 of file primData.h.

friend class Usd_PrimFlagsPredicate

friend

Return this prim's parent prim. Return nullptr if this is a root prim.

Definition at line 275 of file primData.h.

USD_API friend void Usd_ThrowExpiredPrimAccessError ( Usd_PrimData const * p )

friend

Return this prim's parent prim. Return nullptr if this is a root prim.

friend class UsdPrim

friend

Return this prim's parent prim. Return nullptr if this is a root prim.

Definition at line 346 of file primData.h.

friend class UsdStage

friend

Return this prim's parent prim. Return nullptr if this is a root prim.

Definition at line 347 of file primData.h.

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

pxr/usd/usd/primData.h

Public Member Functions

Parent & Stage

Detailed Description

Member Function Documentation

Friends And Related Function Documentation