#include <labelsAPI.h>

Inheritance diagram for UsdSemanticsLabelsAPI:

Public Member Functions
	UsdSemanticsLabelsAPI (const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())

	UsdSemanticsLabelsAPI (const UsdSchemaBase &schemaObj, const TfToken &name)

virtual USDSEMANTICS_API	~UsdSemanticsLabelsAPI ()
	Destructor. More...

TfToken	GetName () const
	Returns the name of this multiple-apply schema instance. More...

USDSEMANTICS_API UsdAttribute	GetLabelsAttr () const

USDSEMANTICS_API UsdAttribute	CreateLabelsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const

Public Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj)

virtual USD_API	~UsdAPISchemaBase ()=0
	Destructor. More...

Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const

bool	IsTyped () const

bool	IsAPISchema () const
	Returns whether this is an API schema or not. More...

bool	IsAppliedAPISchema () const

bool	IsMultipleApplyAPISchema () const

UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is. More...

USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store `prim` as the held prim. More...

USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by `otherSchema`. More...

virtual USD_API	~UsdSchemaBase ()
	Destructor. More...

USD_API	operator bool () const

UsdPrim	GetPrim () const
	Return this schema object's held prim. More...

SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath(). More...

USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const

Static Public Member Functions
static USDSEMANTICS_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

static USDSEMANTICS_API TfTokenVector	GetSchemaAttributeNames (bool includeInherited, const TfToken &instanceName)

static USDSEMANTICS_API UsdSemanticsLabelsAPI	Get (const UsdStagePtr &stage, const SdfPath &path)

static USDSEMANTICS_API UsdSemanticsLabelsAPI	Get (const UsdPrim &prim, const TfToken &name)

static USDSEMANTICS_API std::vector < UsdSemanticsLabelsAPI >	GetAll (const UsdPrim &prim)

static USDSEMANTICS_API bool	IsSchemaPropertyBaseName (const TfToken &baseName)

static USDSEMANTICS_API bool	IsSemanticsLabelsAPIPath (const SdfPath &path, TfToken *name)

static USDSEMANTICS_API bool	CanApply (const UsdPrim &prim, const TfToken &name, std::string *whyNot=nullptr)

static USDSEMANTICS_API UsdSemanticsLabelsAPI	Apply (const UsdPrim &prim, const TfToken &name)

static USDSEMANTICS_API std::vector< TfToken >	GetDirectTaxonomies (const UsdPrim &prim)

static USDSEMANTICS_API std::vector< TfToken >	ComputeInheritedTaxonomies (const UsdPrim &prim)

Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::MultipleApplyAPI

Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase

Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase

Protected Member Functions
USDSEMANTICS_API UsdSchemaKind	_GetSchemaKind () const override

Protected Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)

const TfToken &	_GetInstanceName () const

USD_API bool	_IsCompatible () const override

Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaKind	_GetSchemaType () const

const TfType &	_GetType () const

USD_API UsdAttribute	_CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const

Friends
class	UsdSchemaRegistry

Additional Inherited Members
Static Protected Member Functions inherited from UsdAPISchemaBase
static USD_API TfTokenVector	_GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType)

Detailed Description

Application of labels for a prim for a taxonomy specified by the schema's instance name.

See UsdSemanticsLabelsQuery for more information about computations and inheritance of semantics.

Definition at line 44 of file labelsAPI.h.

Constructor & Destructor Documentation

UsdSemanticsLabelsAPI::UsdSemanticsLabelsAPI	(	const UsdPrim &	prim = `UsdPrim()`,
		const TfToken &	name = `TfToken()`
	)

inlineexplicit

Construct a UsdSemanticsLabelsAPI on UsdPrim prim with name name . Equivalent to UsdSemanticsLabelsAPI::Get( prim.GetStage(), prim.GetPath().AppendProperty( "semantics:labels:name"));

for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 61 of file labelsAPI.h.

UsdSemanticsLabelsAPI::UsdSemanticsLabelsAPI	(	const UsdSchemaBase &	schemaObj,
		const TfToken &	name
	)

inlineexplicit

Construct a UsdSemanticsLabelsAPI on the prim held by schemaObj with name name. Should be preferred over UsdSemanticsLabelsAPI(schemaObj.GetPrim(), name), as it preserves SchemaBase state.

Definition at line 70 of file labelsAPI.h.

virtual USDSEMANTICS_API UsdSemanticsLabelsAPI::~UsdSemanticsLabelsAPI ( )

virtual

Destructor.

Member Function Documentation

USDSEMANTICS_API UsdSchemaKind UsdSemanticsLabelsAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

static USDSEMANTICS_API UsdSemanticsLabelsAPI UsdSemanticsLabelsAPI::Apply	(	const UsdPrim &	prim,
		const TfToken &	name
	)

static

Applies this multiple-apply API schema to the given prim along with the given instance name, name.

This information is stored by adding "SemanticsLabelsAPI:<i>name</i>" to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is 'instance1', the token 'SemanticsLabelsAPI:instance1' is added to 'apiSchemas'.

Returns: A valid UsdSemanticsLabelsAPI object is returned upon success. An invalid (or empty) UsdSemanticsLabelsAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

See Also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

static USDSEMANTICS_API bool UsdSemanticsLabelsAPI::CanApply	(	const UsdPrim &	prim,
		const TfToken &	name,
		std::string *	whyNot = `nullptr`
	)

static

Returns true if this multiple-apply API schema can be applied, with the given instance name, name, to the given prim. If this schema can not be a applied the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.

Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.

See Also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

static USDSEMANTICS_API std::vector<TfToken> UsdSemanticsLabelsAPI::ComputeInheritedTaxonomies ( const UsdPrim & prim )

static

Get the unique instance names (taxonomies) of all applications of UsdSemanticsLabelsAPI for the specified prim and its ancestors.

See Also: GetDirectTaxonomies

USDSEMANTICS_API UsdAttribute UsdSemanticsLabelsAPI::CreateLabelsAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetLabelsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

static USDSEMANTICS_API UsdSemanticsLabelsAPI UsdSemanticsLabelsAPI::Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

Return a UsdSemanticsLabelsAPI holding the prim adhering to this schema at path on stage. If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. path must be of the format <path>.semantics:labels:name .

This is shorthand for the following:

TfToken name = SdfPath::StripNamespace(path.GetToken());
UsdSemanticsLabelsAPI(
    stage->GetPrimAtPath(path.GetPrimPath()), name);

static USDSEMANTICS_API UsdSemanticsLabelsAPI UsdSemanticsLabelsAPI::Get	(	const UsdPrim &	prim,
		const TfToken &	name
	)

static

Return a UsdSemanticsLabelsAPI with name name holding the prim prim. Shorthand for UsdSemanticsLabelsAPI(prim, name);

static USDSEMANTICS_API std::vector<UsdSemanticsLabelsAPI> UsdSemanticsLabelsAPI::GetAll ( const UsdPrim & prim )

static

Return a vector of all named instances of UsdSemanticsLabelsAPI on the given prim.

static USDSEMANTICS_API std::vector<TfToken> UsdSemanticsLabelsAPI::GetDirectTaxonomies ( const UsdPrim & prim )

static

Get the instance names (taxonomies) of all applications of UsdSemanticsLabelsAPI for the specified prim.

Prefer UsdSemanticsLabelsAPI::GetAll(prim) if the instances of the schema may be needed.

Prefer prim.HasAPI<UsdSemanticsLabelsAPI>(taxonomy) for checking if a taxonomy has been directly applied to the prim.

See Also: ComputeInheritedTaxonomies; GetAll

USDSEMANTICS_API UsdAttribute UsdSemanticsLabelsAPI::GetLabelsAttr ( ) const

Array of labels specified directly at this prim.


Declaration	`token[] __INSTANCE_NAME__ = []`
C++ Type	VtArray<TfToken>
Usd Type	SdfValueTypeNames->TokenArray

TfToken UsdSemanticsLabelsAPI::GetName ( ) const

inline

Returns the name of this multiple-apply schema instance.

Definition at line 96 of file labelsAPI.h.

static USDSEMANTICS_API const TfTokenVector& UsdSemanticsLabelsAPI::GetSchemaAttributeNames ( bool includeInherited = true )

static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

static USDSEMANTICS_API TfTokenVector UsdSemanticsLabelsAPI::GetSchemaAttributeNames	(	bool	includeInherited,
		const TfToken &	instanceName
	)

static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes for a given instance name. Does not include attributes that may be authored by custom/extended methods of the schemas involved. The names returned will have the proper namespace prefix.

static USDSEMANTICS_API bool UsdSemanticsLabelsAPI::IsSchemaPropertyBaseName ( const TfToken & baseName )

static

Checks if the given name baseName is the base name of a property of SemanticsLabelsAPI.

static USDSEMANTICS_API bool UsdSemanticsLabelsAPI::IsSemanticsLabelsAPIPath	(	const SdfPath &	path,
		TfToken *	name
	)

static

Checks if the given path path is of an API schema of type SemanticsLabelsAPI. If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

Friends And Related Function Documentation

friend class UsdSchemaRegistry

friend

Definition at line 196 of file labelsAPI.h.

Member Data Documentation

const UsdSchemaKind UsdSemanticsLabelsAPI::schemaKind = UsdSchemaKind::MultipleApplyAPI

static

Compile time constant representing what kind of schema this class is.

See Also: UsdSchemaKind

Definition at line 50 of file labelsAPI.h.

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

pxr/usd/usdSemantics/labelsAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation