API for overriding Level of Detail (LOD) choices. More...

#include <overrideAPI.h>

Inheritance diagram for UsdLodOverrideAPI:

Public Member Functions
	UsdLodOverrideAPI (const UsdPrim &prim=UsdPrim())
	Construct a UsdLodOverrideAPI on UsdPrim `prim` .

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

virtual USDLOD_API	~UsdLodOverrideAPI ()
	Destructor.

USDLOD_API UsdAttribute	GetLodOverrideModeAttr () const
	How to apply override to LOD decisions.

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

USDLOD_API UsdAttribute	GetLodOverrideIndexAttr () const
	The index value to use when lod:override:mode is "indexedLOD".

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

USDLOD_API TfToken	ComputeLODOverride (float *overrideIndex, UsdTimeCode time=UsdTimeCode::Default()) const
	Compute the current the LOD override (if any) for this prim.

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 USDLOD_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 USDLOD_API UsdLodOverrideAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdLodOverrideAPI holding the prim adhering to this schema at `path` on `stage`.

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

static USDLOD_API UsdLodOverrideAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`.

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::SingleApplyAPI
	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
USDLOD_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

Protected Member Functions inherited from UsdAPISchemaBase
	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

API for overriding Level of Detail (LOD) choices.

This API schema defines an LOD override for namespace descendents. When the renderer encounters a prim with LODRootAPI applied, it should first check to see if there is an override for the LOD domain of interest before consulting heuristics or the root's lod:default:index.

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

Definition at line 51 of file overrideAPI.h.

Constructor & Destructor Documentation

◆ UsdLodOverrideAPI() [1/2]

UsdLodOverrideAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a UsdLodOverrideAPI on UsdPrim prim .

Equivalent to UsdLodOverrideAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 63 of file overrideAPI.h.

◆ UsdLodOverrideAPI() [2/2]

UsdLodOverrideAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a UsdLodOverrideAPI on the prim held by schemaObj .

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

Definition at line 71 of file overrideAPI.h.

◆ ~UsdLodOverrideAPI()

virtual USDLOD_API ~UsdLodOverrideAPI ( )

virtual

Destructor.

Member Function Documentation

◆ _GetSchemaKind()

USDLOD_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

◆ Apply()

static USDLOD_API UsdLodOverrideAPI Apply ( const UsdPrim & prim )

static

Applies this single-apply API schema to the given prim.

This information is stored by adding "LODOverrideAPI" to the token-valued, listOp metadata apiSchemas on the prim.

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

◆ CanApply()

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

static

Returns true if this single-apply API schema can be applied to the given prim.

If this schema can not be a applied to 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()

◆ ComputeLODOverride()

USDLOD_API TfToken ComputeLODOverride	(	float *	overrideIndex,
		UsdTimeCode	time = UsdTimeCode::Default() ) const

Compute the current the LOD override (if any) for this prim.

ComputeLODOverride will search up the namespace hierarchy starting with this prim, looking for a prim with LODOverrideAPI applied and a lod:override:mode that is not "inherited". It will return the mode and may store a floating point value in overrideIndex. If the mode is "indexedLOD" then the value of lod:override:index will be stored in overrideIndex, otherwise overrideIndex will be unchanged.

◆ CreateLodOverrideIndexAttr()

USDLOD_API UsdAttribute CreateLodOverrideIndexAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false ) const

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

◆ CreateLodOverrideModeAttr()

USDLOD_API UsdAttribute CreateLodOverrideModeAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false ) const

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

static USDLOD_API UsdLodOverrideAPI Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path )

static

Return a UsdLodOverrideAPI 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. This is shorthand for the following:

UsdLodOverrideAPI(stage->GetPrimAtPath(path));

UsdLodOverrideAPI::UsdLodOverrideAPI

UsdLodOverrideAPI(const UsdPrim &prim=UsdPrim())

Construct a UsdLodOverrideAPI on UsdPrim prim .

Definition overrideAPI.h:63

◆ GetLodOverrideIndexAttr()

USDLOD_API UsdAttribute GetLodOverrideIndexAttr ( ) const

The index value to use when lod:override:mode is "indexedLOD".

If the value is outside the range of available LOD items, the renderer must clamp the value into range to select an appropriate LOD. If the value is fractional, the renderer may choose to blend or interpolate between multiple LOD items. Alternatively, the renderer may simply round the value to the nearest integer.


Declaration	`float lod:override:index = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

◆ GetLodOverrideModeAttr()

USDLOD_API UsdAttribute GetLodOverrideModeAttr ( ) const

How to apply override to LOD decisions.

Valid values are:

inherited: The default. This prim does not provide any override information, it inherits any value set above it.
noOverride: There is explicitly no override. Use the heuristics.
indexedLOD: The lod:override:index property provides the value.
noLOD: No LOD items should be displayed.
allLOD: All LOD items should be displayed.


Declaration	`token lod:override:mode = "inherited"`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Allowed Values	inherited, noOverride, indexedLOD, noLOD, allLOD

◆ GetSchemaAttributeNames()

static USDLOD_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.

Friends And Related Symbol Documentation

◆ UsdSchemaRegistry

friend class UsdSchemaRegistry

friend

Definition at line 149 of file overrideAPI.h.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See also: UsdSchemaKind

Definition at line 57 of file overrideAPI.h.

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

pxr/usd/usdLod/overrideAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UsdLodOverrideAPI() [1/2]

◆ UsdLodOverrideAPI() [2/2]

◆ ~UsdLodOverrideAPI()

Member Function Documentation

◆ _GetSchemaKind()

◆ Apply()

◆ CanApply()

◆ ComputeLODOverride()

◆ CreateLodOverrideIndexAttr()

◆ CreateLodOverrideModeAttr()

◆ Get()

◆ GetLodOverrideIndexAttr()

◆ GetLodOverrideModeAttr()

◆ GetSchemaAttributeNames()

Friends And Related Symbol Documentation

◆ UsdSchemaRegistry

Member Data Documentation

◆ schemaKind