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

#include <risPattern.h>

+ Inheritance diagram for UsdRiRisPattern:

Public Member Functions

 UsdRiRisPattern (const UsdPrim &prim=UsdPrim())
 
 UsdRiRisPattern (const UsdSchemaBase &schemaObj)
 
virtual USDRI_API ~UsdRiRisPattern ()
 Destructor. More...
 
- Public Member Functions inherited from UsdRiRisObject
 UsdRiRisObject (const UsdPrim &prim=UsdPrim())
 
 UsdRiRisObject (const UsdSchemaBase &schemaObj)
 
virtual USDRI_API ~UsdRiRisObject ()
 Destructor. More...
 
USDRI_API UsdAttribute GetFilePathAttr () const
 
USDRI_API UsdAttribute CreateFilePathAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetArgsPathAttr () const
 
USDRI_API UsdAttribute CreateArgsPathAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
- Public Member Functions inherited from UsdShadeShader
 UsdShadeShader (const UsdPrim &prim=UsdPrim())
 
 UsdShadeShader (const UsdSchemaBase &schemaObj)
 
virtual USDSHADE_API ~UsdShadeShader ()
 Destructor. More...
 
USDSHADE_API UsdAttribute GetImplementationSourceAttr () const
 
USDSHADE_API UsdAttribute CreateImplementationSourceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDSHADE_API UsdAttribute GetIdAttr () const
 
USDSHADE_API UsdAttribute CreateIdAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDSHADE_API UsdShadeShader (const UsdShadeConnectableAPI &connectable)
 
USDSHADE_API UsdShadeConnectableAPI ConnectableAPI () const
 
USDSHADE_API SdrShaderNodeConstPtr GetShaderNodeForSourceType (const TfToken &sourceType) const
 
USDSHADE_API UsdShadeOutput CreateOutput (const TfToken &name, const SdfValueTypeName &typeName)
 
USDSHADE_API UsdShadeOutput GetOutput (const TfToken &name) const
 
USDSHADE_API std::vector
< UsdShadeOutput
GetOutputs () const
 
USDSHADE_API UsdShadeInput CreateInput (const TfToken &name, const SdfValueTypeName &typeName)
 
USDSHADE_API UsdShadeInput GetInput (const TfToken &name) const
 
USDSHADE_API std::vector
< UsdShadeInput
GetInputs () const
 
USDSHADE_API TfToken GetImplementationSource () const
 
USDSHADE_API bool SetShaderId (const TfToken &id) const
 
USDSHADE_API bool GetShaderId (TfToken *id) const
 
USDSHADE_API bool SetSourceAsset (const SdfAssetPath &sourceAsset, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
 
USDSHADE_API bool GetSourceAsset (SdfAssetPath *sourceAsset, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
 
USDSHADE_API bool SetSourceAssetSubIdentifier (const TfToken &subIdentifier, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
 
USDSHADE_API bool GetSourceAssetSubIdentifier (TfToken *subIdentifier, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
 
USDSHADE_API bool SetSourceCode (const std::string &sourceCode, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
 
USDSHADE_API bool GetSourceCode (std::string *sourceCode, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
 
USDSHADE_API NdrTokenMap GetSdrMetadata () const
 
USDSHADE_API std::string GetSdrMetadataByKey (const TfToken &key) const
 
USDSHADE_API void SetSdrMetadata (const NdrTokenMap &sdrMetadata) const
 
USDSHADE_API void SetSdrMetadataByKey (const TfToken &key, const std::string &value) const
 
USDSHADE_API bool HasSdrMetadata () const
 
USDSHADE_API bool HasSdrMetadataByKey (const TfToken &key) const
 
USDSHADE_API void ClearSdrMetadata () const
 
USDSHADE_API void ClearSdrMetadataByKey (const TfToken &key) const
 
- Public Member Functions inherited from UsdTyped
 UsdTyped (const UsdPrim &prim=UsdPrim())
 
 UsdTyped (const UsdSchemaBase &schemaObj)
 
virtual USD_API ~UsdTyped ()
 
- 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
 
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
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const
 

Static Public Member Functions

static USDRI_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDRI_API UsdRiRisPattern Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDRI_API UsdRiRisPattern Define (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdRiRisObject
static USDRI_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDRI_API UsdRiRisObject Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDRI_API UsdRiRisObject Define (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdShadeShader
static USDSHADE_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDSHADE_API UsdShadeShader Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDSHADE_API UsdShadeShader Define (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdTyped
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 
static USD_API UsdTyped Get (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
 
- Static Public Attributes inherited from UsdRiRisObject
static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
 
- Static Public Attributes inherited from UsdShadeShader
static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
 
- Static Public Attributes inherited from UsdTyped
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 

Protected Member Functions

USDRI_API UsdSchemaType _GetSchemaType () const override
 
- Protected Member Functions inherited from UsdShadeShader
USDSHADE_API UsdSchemaType _GetSchemaType () const override
 
- Protected Member Functions inherited from UsdTyped
USD_API bool _IsCompatible () const override
 
- 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

Deprecated:
Specialized RIS shader schemas have been deprecated in favor of all shader prims being simple UsdShadeShader. This schema will be removed in a future release.

Represents a ris pattern object. Multiple of these can be assigned.

Definition at line 61 of file risPattern.h.

Constructor & Destructor Documentation

UsdRiRisPattern::UsdRiRisPattern ( const UsdPrim prim = UsdPrim())
inlineexplicit

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

Definition at line 73 of file risPattern.h.

UsdRiRisPattern::UsdRiRisPattern ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdRiRisPattern on the prim held by schemaObj . Should be preferred over UsdRiRisPattern(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 81 of file risPattern.h.

virtual USDRI_API UsdRiRisPattern::~UsdRiRisPattern ( )
virtual

Destructor.

Member Function Documentation

USDRI_API UsdSchemaType UsdRiRisPattern::_GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdRiRisObject.

static USDRI_API UsdRiRisPattern UsdRiRisPattern::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 UsdRiRisPattern UsdRiRisPattern::Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

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

UsdRiRisPattern(stage->GetPrimAtPath(path));
static USDRI_API const TfTokenVector& UsdRiRisPattern::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 Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 145 of file risPattern.h.

Member Data Documentation

const UsdSchemaType UsdRiRisPattern::schemaType = UsdSchemaType::ConcreteTyped
static

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

See Also
UsdSchemaType

Definition at line 67 of file risPattern.h.


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