This API describes Accessibility information on a Prim that may be surfaced to a given runtime's accessibility frameworks. More...

#include <accessibilityAPI.h>

Inheritance diagram for UsdUIAccessibilityAPI:

Public Member Functions
	UsdUIAccessibilityAPI (const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())
	Construct a UsdUIAccessibilityAPI on UsdPrim `prim` with name `name` .

	UsdUIAccessibilityAPI (const UsdSchemaBase &schemaObj, const TfToken &name)
	Construct a UsdUIAccessibilityAPI on the prim held by `schemaObj` with name `name`.

virtual USDUI_API	~UsdUIAccessibilityAPI ()
	Destructor.

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

USDUI_API UsdAttribute	GetLabelAttr () const
	A short label to concisely describe the prim.

USDUI_API UsdAttribute	CreateLabelAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLabelAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDUI_API UsdAttribute	GetDescriptionAttr () const
	An extended description of the prim to provide more details.

USDUI_API UsdAttribute	CreateDescriptionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDescriptionAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDUI_API UsdAttribute	GetPriorityAttr () const
	A hint to the accessibility runtime of how to prioritize this instance's label and description, relative to others.

USDUI_API UsdAttribute	CreatePriorityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPriorityAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

Public Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
	Construct a UsdAPISchemaBase on UsdPrim `prim` .

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
	Construct a UsdAPISchemaBase on the prim held by `schemaObj` .

virtual USD_API	~UsdAPISchemaBase ()=0
	Destructor.

Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
	Returns whether or not this class corresponds to a concrete instantiable prim type in scene description.

bool	IsTyped () const
	Returns whether or not this class inherits from UsdTyped.

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

bool	IsAppliedAPISchema () const
	Returns whether this is an applied API schema or not.

bool	IsMultipleApplyAPISchema () const
	Returns whether this is an applied API schema or not.

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

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

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

virtual USD_API	~UsdSchemaBase ()
	Destructor.

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

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

USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const
	Return the prim definition associated with this schema instance if one exists, otherwise return null.

USD_API	operator bool () const
	Return true if this schema object is compatible with its held prim, false otherwise.

Static Public Member Functions
static USDUI_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

static USDUI_API TfTokenVector	GetSchemaAttributeNames (bool includeInherited, const TfToken &instanceName)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes for a given instance name.

static USDUI_API UsdUIAccessibilityAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdUIAccessibilityAPI holding the prim adhering to this schema at `path` on `stage`.

static USDUI_API UsdUIAccessibilityAPI	Get (const UsdPrim &prim, const TfToken &name)
	Return a UsdUIAccessibilityAPI with name `name` holding the prim `prim`.

static USDUI_API std::vector< UsdUIAccessibilityAPI >	GetAll (const UsdPrim &prim)
	Return a vector of all named instances of UsdUIAccessibilityAPI on the given `prim`.

static USDUI_API bool	IsSchemaPropertyBaseName (const TfToken &baseName)
	Checks if the given name `baseName` is the base name of a property of AccessibilityAPI.

static USDUI_API bool	IsAccessibilityAPIPath (const SdfPath &path, TfToken *name)
	Checks if the given path `path` is of an API schema of type AccessibilityAPI.

static USDUI_API bool	CanApply (const UsdPrim &prim, const TfToken &name, std::string *whyNot=nullptr)
	Returns true if this multiple-apply API schema can be applied, with the given instance name, `name`, to the given `prim`.

static USDUI_API UsdUIAccessibilityAPI	Apply (const UsdPrim &prim, const TfToken &name)
	Applies this multiple-apply API schema to the given `prim` along with the given instance name, `name`.

static USDUI_API UsdUIAccessibilityAPI	CreateDefaultAPI (const UsdPrim &prim)
	Creates an instance of the API with the default instance name.

static USDUI_API UsdUIAccessibilityAPI	CreateDefaultAPI (const UsdSchemaBase &schemaObj)
	Creates an instance of the API with a schema object using the default instance name.

static USDUI_API UsdUIAccessibilityAPI	ApplyDefaultAPI (const UsdPrim &prim)
	Applies an instance of the API with the default instance name.

Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

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

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::MultipleApplyAPI
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Protected Member Functions
USDUI_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

Protected Member Functions inherited from UsdAPISchemaBase
USD_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

	UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on UsdPrim `prim` with the specified `instanceName`.

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on the prim held by `schemaObj` with the given `instanceName`.

const TfToken &	_GetInstanceName () const
	Returns the instance name of the API schema object belonging to a multiple-apply API schema.

USD_API bool	_IsCompatible () const override
	Check whether this APISchema object is valid for the currently held prim.

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)
	Returns a vector of names of API schema objects belonging to a multiple-apply API schema applied to a given prim.

Detailed Description

This API describes Accessibility information on a Prim that may be surfaced to a given runtime's accessibility frameworks.

This information may be used by assistive tooling such as voice controls or screen readers. Accessibility information is provided as a standard triplet of label, description and priority.

OpenUSD does not provide an accessibility runtime itself, but endeavours to provide the information needed for compatible runtimes to extract and present this information.

This is a multiple apply schema, and so may have multiple namespaced accessibility triplets, where an instance name may reflect a given purpose for that triplet. For example, you may desire to express different information for different aspects of the prim, such as size or color.

There are several best practices for using this schema:

Most accessibility runtimes support a single accessibility description. Therefore we recommend using a namespace labeled "default" for any critical information.

A default value should be authored if using time sampled accessibility information. This helps accessibility runtimes that do not currently support time sampled information.

Provide accessibility information of your scene on the default prim of the layer, and any top level prims. This allows accessibility systems to provide concise scene descriptions to a user, but also allows supporting accessibility systems that either do not support hierarchy information or when a user has turned off that level of granularity. Accessibility information may still be provided on other prims in the hierarchy.

Note: The use of the default prim and top level prims for scene accessibility descriptions is a recommended convention. Outside of that, accessibility information is not implicitly inherited through a prim hierarchy. The inheritance should be left to the accessibility runtime to decide how best to surface information to users.

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdUITokens. So to set an attribute to the value "rightHanded", use UsdUITokens->rightHanded as the value.

Definition at line 83 of file accessibilityAPI.h.

Constructor & Destructor Documentation

◆ UsdUIAccessibilityAPI() [1/2]

UsdUIAccessibilityAPI	(	const UsdPrim &	prim = `UsdPrim()`,
		const TfToken &	name = `TfToken()`
	)

inlineexplicit

Construct a UsdUIAccessibilityAPI on UsdPrim prim with name name .

Equivalent to UsdUIAccessibilityAPI::Get( prim.GetStage(), prim.GetPath().AppendProperty( "accessibility:name"));

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

Definition at line 100 of file accessibilityAPI.h.

◆ UsdUIAccessibilityAPI() [2/2]

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

inlineexplicit

Construct a UsdUIAccessibilityAPI on the prim held by schemaObj with name name.

Should be preferred over UsdUIAccessibilityAPI(schemaObj.GetPrim(), name), as it preserves SchemaBase state.

Definition at line 109 of file accessibilityAPI.h.

◆ ~UsdUIAccessibilityAPI()

virtual USDUI_API ~UsdUIAccessibilityAPI ( )

virtual

Destructor.

Member Function Documentation

◆ _GetSchemaKind()

USDUI_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

◆ Apply()

static USDUI_API UsdUIAccessibilityAPI 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 "AccessibilityAPI:<i>name</i>" to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is 'instance1', the token 'AccessibilityAPI:instance1' is added to 'apiSchemas'.

Returns: A valid UsdUIAccessibilityAPI object is returned upon success. An invalid (or empty) UsdUIAccessibilityAPI 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()

◆ ApplyDefaultAPI()

static USDUI_API UsdUIAccessibilityAPI ApplyDefaultAPI ( const UsdPrim & prim )

static

Applies an instance of the API with the default instance name.

/sa Apply

◆ CanApply()

static USDUI_API bool 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()

◆ CreateDefaultAPI() [1/2]

static USDUI_API UsdUIAccessibilityAPI CreateDefaultAPI ( const UsdPrim & prim )

static

Creates an instance of the API with the default instance name.

/sa UsdUIAccessibilityAPI

◆ CreateDefaultAPI() [2/2]

static USDUI_API UsdUIAccessibilityAPI CreateDefaultAPI ( const UsdSchemaBase & schemaObj )

static

Creates an instance of the API with a schema object using the default instance name.

/sa UsdUIAccessibilityAPI

◆ CreateDescriptionAttr()

USDUI_API UsdAttribute CreateDescriptionAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetDescriptionAttr(), and also Create vs Get Property Methods 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.

◆ CreateLabelAttr()

USDUI_API UsdAttribute CreateLabelAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetLabelAttr(), and also Create vs Get Property Methods 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.

◆ CreatePriorityAttr()

USDUI_API UsdAttribute CreatePriorityAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetPriorityAttr(), and also Create vs Get Property Methods 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.

◆ Get() [1/2]

static USDUI_API UsdUIAccessibilityAPI Get	(	const UsdPrim &	prim,
		const TfToken &	name
	)

static

Return a UsdUIAccessibilityAPI with name name holding the prim prim.

Shorthand for UsdUIAccessibilityAPI(prim, name);

◆ Get() [2/2]

static USDUI_API UsdUIAccessibilityAPI Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

Return a UsdUIAccessibilityAPI 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>.accessibility:name .

This is shorthand for the following:

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

◆ GetAll()

static USDUI_API std::vector< UsdUIAccessibilityAPI > GetAll ( const UsdPrim & prim )

static

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

◆ GetDescriptionAttr()

USDUI_API UsdAttribute GetDescriptionAttr ( ) const

An extended description of the prim to provide more details.

If a label attribute is not authored in a given instance name, the description attribute should not be used in it its place. A description is an optional attribute, and some accessibility systems may only use the label.

Descriptions may be time varying for runtimes that support it. For example, you may describe what a character is doing at a given time.


Declaration	`string description`
C++ Type	std::string
Usd Type	SdfValueTypeNames->String

◆ GetLabelAttr()

USDUI_API UsdAttribute GetLabelAttr ( ) const

A short label to concisely describe the prim.

It is not recommended to time vary the label unless the concise description changes substantially.

There is no specific suggested length for the label, but it is recommended to keep it succinct.


Declaration	`string label`
C++ Type	std::string
Usd Type	SdfValueTypeNames->String

◆ GetName()

TfToken GetName ( ) const

inline

Returns the name of this multiple-apply schema instance.

Definition at line 135 of file accessibilityAPI.h.

◆ GetPriorityAttr()

USDUI_API UsdAttribute GetPriorityAttr ( ) const

A hint to the accessibility runtime of how to prioritize this instance's label and description, relative to others.

This attribute is optional and is considered a hint that runtimes may ignore, if they feel there are other necessities that take precedence over the prioritization values.

Priority may not be time varying.


Declaration	`uniform token priority = "standard"`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	low, standard, high

◆ GetSchemaAttributeNames() [1/2]

static USDUI_API TfTokenVector 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.

◆ GetSchemaAttributeNames() [2/2]

static USDUI_API const TfTokenVector & 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.

◆ IsAccessibilityAPIPath()

static USDUI_API bool IsAccessibilityAPIPath	(	const SdfPath &	path,
		TfToken *	name
	)

static

Checks if the given path path is of an API schema of type AccessibilityAPI.

If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

◆ IsSchemaPropertyBaseName()

static USDUI_API bool IsSchemaPropertyBaseName ( const TfToken & baseName )

static

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

Friends And Related Function Documentation

◆ UsdSchemaRegistry

friend class UsdSchemaRegistry

friend

Definition at line 235 of file accessibilityAPI.h.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI

static

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

See also: UsdSchemaKind

Definition at line 89 of file accessibilityAPI.h.

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

pxr/usd/usdUI/accessibilityAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UsdUIAccessibilityAPI() [1/2]

◆ UsdUIAccessibilityAPI() [2/2]

◆ ~UsdUIAccessibilityAPI()

Member Function Documentation

◆ _GetSchemaKind()

◆ Apply()

◆ ApplyDefaultAPI()

◆ CanApply()

◆ CreateDefaultAPI() [1/2]

◆ CreateDefaultAPI() [2/2]

◆ CreateDescriptionAttr()

◆ CreateLabelAttr()

◆ CreatePriorityAttr()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetAll()

◆ GetDescriptionAttr()

◆ GetLabelAttr()

◆ GetName()

◆ GetPriorityAttr()

◆ GetSchemaAttributeNames() [1/2]

◆ GetSchemaAttributeNames() [2/2]

◆ IsAccessibilityAPIPath()

◆ IsSchemaPropertyBaseName()

Friends And Related Function Documentation

◆ UsdSchemaRegistry

Member Data Documentation

◆ schemaKind