Base class for LOD Heuristics. More...

#include <heuristic.h>

Inheritance diagram for UsdLodHeuristic:

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

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

virtual USDLOD_API	~UsdLodHeuristic ()
	Destructor.

USDLOD_API UsdAttribute	GetLodDomainAttr () const
	The "domain" of this heuristic.

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

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

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

virtual USD_API	~UsdTyped ()
	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 UsdLodHeuristic	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdLodHeuristic holding the prim adhering to this schema at `path` on `stage`.

Static Public Member Functions inherited from UsdTyped
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 USD_API UsdTyped	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdTyped holding the prim adhering to this schema at `path` on `stage`.

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

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

Static Public Attributes inherited from UsdTyped
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 UsdTyped
USD_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

USD_API bool	_IsCompatible () const override
	Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility.

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

Detailed Description

Base class for LOD Heuristics.

Due to the varying nature of the inputs, and potentially outputs, of each heuristic, the method of using the heuristic and the type of value that it returns may be different for each type of heuristic. It is the responsibility of the renderer to select a heuristic (or heuristics) that it knows how to use, to invoke it, and to apply the result.

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 52 of file heuristic.h.

Constructor & Destructor Documentation

◆ UsdLodHeuristic() [1/2]

UsdLodHeuristic ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a UsdLodHeuristic on UsdPrim prim .

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

Definition at line 64 of file heuristic.h.

◆ UsdLodHeuristic() [2/2]

UsdLodHeuristic ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a UsdLodHeuristic on the prim held by schemaObj .

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

Definition at line 72 of file heuristic.h.

◆ ~UsdLodHeuristic()

virtual USDLOD_API ~UsdLodHeuristic ( )

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

Reimplemented in UsdLodScreenSizeHeuristic.

◆ CreateLodDomainAttr()

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

See GetLodDomainAttr(), 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 UsdLodHeuristic Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path )

static

Return a UsdLodHeuristic 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:

UsdLodHeuristic(stage->GetPrimAtPath(path));

UsdLodHeuristic::UsdLodHeuristic

UsdLodHeuristic(const UsdPrim &prim=UsdPrim())

Construct a UsdLodHeuristic on UsdPrim prim .

Definition heuristic.h:64

◆ GetLodDomainAttr()

USDLOD_API UsdAttribute GetLodDomainAttr ( ) const

The "domain" of this heuristic.

Predefined generic domains include "imaging", "physics", and "audio". Other generic domain names may be added in the future. If you are creating your own unique heuristics, it is recommended that you prefix them with your company, product, or renderer name.


Declaration	`uniform token lod:domain`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform

◆ 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 111 of file heuristic.h.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped

static

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

See also: UsdSchemaKind

Definition at line 58 of file heuristic.h.

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

pxr/usd/usdLod/heuristic.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ UsdLodHeuristic() [1/2]

◆ UsdLodHeuristic() [2/2]

◆ ~UsdLodHeuristic()

Member Function Documentation

◆ _GetSchemaKind()

◆ CreateLodDomainAttr()

◆ Get()

◆ GetLodDomainAttr()

◆ GetSchemaAttributeNames()

Friends And Related Symbol Documentation

◆ UsdSchemaRegistry

Member Data Documentation

◆ schemaKind