#include <accessibilityAPI.h>

Inheritance diagram for UsdUIAccessibilityAPI:

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

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

virtual USDUI_API	~UsdUIAccessibilityAPI ()
	Destructor. More...

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

USDUI_API UsdAttribute	GetLabelAttr () const

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

USDUI_API UsdAttribute	GetDescriptionAttr () const

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

USDUI_API UsdAttribute	GetPriorityAttr () const

USDUI_API UsdAttribute	CreatePriorityAttr (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 USDUI_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

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

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

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

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

static USDUI_API bool	IsSchemaPropertyBaseName (const TfToken &baseName)

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

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

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

static USDUI_API UsdUIAccessibilityAPI	CreateDefaultAPI (const UsdPrim &prim)

static USDUI_API UsdUIAccessibilityAPI	CreateDefaultAPI (const UsdSchemaBase &schemaObj)

static USDUI_API UsdUIAccessibilityAPI	ApplyDefaultAPI (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
USDUI_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

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 a 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 a 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.

Note: The API will use "default" as an instance name if no namespace is specified.

There are several best practices for using this schema.:

Most accessibility runtimes support a single accessibility description. Therefore we recommend placing any critical information in the default instance.

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 86 of file accessibilityAPI.h.

Constructor & Destructor Documentation

UsdUIAccessibilityAPI::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 103 of file accessibilityAPI.h.

UsdUIAccessibilityAPI::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 112 of file accessibilityAPI.h.

virtual USDUI_API UsdUIAccessibilityAPI::~UsdUIAccessibilityAPI ( )

virtual

Destructor.

Member Function Documentation

USDUI_API UsdSchemaKind UsdUIAccessibilityAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

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

static USDUI_API UsdUIAccessibilityAPI UsdUIAccessibilityAPI::ApplyDefaultAPI ( const UsdPrim & prim )

static

Applies an instance of the API with the default instance name. /sa Apply

static USDUI_API bool UsdUIAccessibilityAPI::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 USDUI_API UsdUIAccessibilityAPI UsdUIAccessibilityAPI::CreateDefaultAPI ( const UsdPrim & prim )

static

Creates an instance of the API with the default instance name. /sa UsdUIAccessibilityAPI

static USDUI_API UsdUIAccessibilityAPI UsdUIAccessibilityAPI::CreateDefaultAPI ( const UsdSchemaBase & schemaObj )

static

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

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

See GetDescriptionAttr(), 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.

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

See GetLabelAttr(), 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.

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

See GetPriorityAttr(), 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 USDUI_API UsdUIAccessibilityAPI 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);

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

static

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

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

static

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

USDUI_API UsdAttribute UsdUIAccessibilityAPI::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

USDUI_API UsdAttribute UsdUIAccessibilityAPI::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

TfToken UsdUIAccessibilityAPI::GetName ( ) const

inline

Returns the name of this multiple-apply schema instance.

Definition at line 138 of file accessibilityAPI.h.

USDUI_API UsdAttribute UsdUIAccessibilityAPI::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

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

static USDUI_API bool UsdUIAccessibilityAPI::IsSchemaPropertyBaseName ( const TfToken & baseName )

static

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