All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdRiRisIntegrator Class Reference

Integrator. More...

+ Inheritance diagram for UsdRiRisIntegrator:

Public Member Functions

 UsdRiRisIntegrator (const UsdPrim &prim=UsdPrim())
 Construct a UsdRiRisIntegrator on UsdPrim prim . More...
 
 UsdRiRisIntegrator (const UsdSchemaBase &schemaObj)
 Construct a UsdRiRisIntegrator on the prim held by schemaObj . More...
 
virtual USDRI_API ~UsdRiRisIntegrator ()
 Destructor. More...
 
USDRI_API UsdAttribute GetFilePathAttr () const
 
C++ Type: SdfAssetPath
Usd Type: SdfValueTypeNames->Asset
Variability: SdfVariabilityVarying
Fallback Value: No Fallback More...
 
USDRI_API UsdAttribute CreateFilePathAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetFilePathAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetArgsPathAttr () const
 
C++ Type: SdfAssetPath
Usd Type: SdfValueTypeNames->Asset
Variability: SdfVariabilityVarying
Fallback Value: No Fallback More...
 
USDRI_API UsdAttribute CreateArgsPathAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetArgsPathAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
- Public Member Functions inherited from UsdTyped
 UsdTyped (const UsdPrim &prim=UsdPrim())
 Construct a UsdTyped on UsdPrim prim . More...
 
 UsdTyped (const UsdSchemaBase &schemaObj)
 Construct a UsdTyped on the prim wrapped by schemaObj . More...
 
- 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. More...
 
bool IsTyped () const
 Returns whether or not this class inherits from UsdTyped. More...
 
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
 
bool IsAppliedAPISchema () const
 Returns whether this is an applied API schema or not. More...
 
bool IsMultipleApplyAPISchema () const
 Returns whether this is an applied API schema or not. More...
 
UsdSchemaType GetSchemaType () const
 
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
 Return true if this schema object is compatible with its held prim, false otherwise. More...
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API SdfPrimSpecHandle GetSchemaClassPrimDefinition () const
 Return the prim definition associated with this schema instance if one exists, otherwise return null. More...
 

Static Public Member Functions

static USDRI_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. More...
 
static USDRI_API UsdRiRisIntegrator Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdRiRisIntegrator holding the prim adhering to this schema at path on stage. More...
 
static USDRI_API UsdRiRisIntegrator Define (const UsdStagePtr &stage, const SdfPath &path)
 Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage. More...
 
- Static Public Member Functions inherited from UsdTyped
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...
 
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. More...
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdTyped
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 Compile time constant representing what kind of schema this class is. More...
 

Protected Member Functions

USDRI_API UsdSchemaType _GetSchemaType () const override
 Returns the type of schema this class belongs to. More...
 
- Protected Member Functions inherited from UsdTyped
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. More...
 
- Protected Member Functions inherited from UsdSchemaBase
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

Integrator.

Only one can be declared in a rib scene.

Definition at line 57 of file risIntegrator.h.

Constructor & Destructor Documentation

UsdRiRisIntegrator ( const UsdPrim prim = UsdPrim())
inlineexplicit

Construct a UsdRiRisIntegrator on UsdPrim prim .

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

Definition at line 69 of file risIntegrator.h.

UsdRiRisIntegrator ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdRiRisIntegrator on the prim held by schemaObj .

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

Definition at line 77 of file risIntegrator.h.

virtual USDRI_API ~UsdRiRisIntegrator ( )
virtual

Destructor.

Member Function Documentation

USDRI_API UsdSchemaType _GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdSchemaBase.

USDRI_API UsdAttribute CreateArgsPathAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute CreateFilePathAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

static USDRI_API UsdRiRisIntegrator Define ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.

The given path must be an absolute prim path that does not contain any variant selections.

If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.

Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.

static USDRI_API UsdRiRisIntegrator Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

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

* UsdRiRisIntegrator(stage->GetPrimAtPath(path));
*
USDRI_API UsdAttribute GetArgsPathAttr ( ) const


C++ Type: SdfAssetPath
Usd Type: SdfValueTypeNames->Asset
Variability: SdfVariabilityVarying
Fallback Value: No Fallback

USDRI_API UsdAttribute GetFilePathAttr ( ) const


C++ Type: SdfAssetPath
Usd Type: SdfValueTypeNames->Asset
Variability: SdfVariabilityVarying
Fallback Value: No Fallback

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

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
static

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

See Also
UsdSchemaType

Definition at line 63 of file risIntegrator.h.


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