All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdRiRisObject Class Reference
+ Inheritance diagram for UsdRiRisObject:

Public Member Functions

 UsdRiRisObject (const UsdPrim &prim=UsdPrim())
 Construct a UsdRiRisObject on UsdPrim prim . More...
 
 UsdRiRisObject (const UsdSchemaBase &schemaObj)
 Construct a UsdRiRisObject on the prim held by schemaObj . More...
 
virtual USDRI_API ~UsdRiRisObject ()
 Destructor. More...
 
USDRI_API UsdAttribute GetFilePathAttr () const
 
Declaration asset info:filePath
C++ Type SdfAssetPath
Usd Type SdfValueTypeNames->Asset
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
 
Declaration asset info:argsPath
C++ Type SdfAssetPath
Usd Type SdfValueTypeNames->Asset
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 UsdShadeShader
 UsdShadeShader (const UsdPrim &prim=UsdPrim())
 Construct a UsdShadeShader on UsdPrim prim . More...
 
 UsdShadeShader (const UsdSchemaBase &schemaObj)
 Construct a UsdShadeShader on the prim held by schemaObj . More...
 
virtual USDSHADE_API ~UsdShadeShader ()
 Destructor. More...
 
USDSHADE_API UsdAttribute GetImplementationSourceAttr () const
 Specifies the attribute that should be consulted to get the shader's implementation or its source code. More...
 
USDSHADE_API UsdAttribute CreateImplementationSourceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetImplementationSourceAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDSHADE_API UsdAttribute GetIdAttr () const
 The id is an identifier for the type or purpose of the shader. More...
 
USDSHADE_API UsdAttribute CreateIdAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetIdAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDSHADE_API UsdShadeShader (const UsdShadeConnectableAPI &connectable)
 Constructor that takes a ConnectableAPI object. More...
 
USDSHADE_API UsdShadeConnectableAPI ConnectableAPI () const
 Contructs and returns a UsdShadeConnectableAPI object with this shader. More...
 
USDSHADE_API SdrShaderNodeConstPtr GetShaderNodeForSourceType (const TfToken &sourceType) const
 This method attempts to ensure that there is a ShaderNode in the shader registry (i.e. More...
 
USDSHADE_API UsdShadeOutput CreateOutput (const TfToken &name, const SdfValueTypeName &typeName)
 Create an output which can either have a value or can be connected. More...
 
USDSHADE_API UsdShadeOutput GetOutput (const TfToken &name) const
 Return the requested output if it exists. More...
 
USDSHADE_API std::vector
< UsdShadeOutput
GetOutputs () const
 Outputs are represented by attributes in the "outputs:" namespace. More...
 
USDSHADE_API UsdShadeInput CreateInput (const TfToken &name, const SdfValueTypeName &typeName)
 Create an input which can either have a value or can be connected. More...
 
USDSHADE_API UsdShadeInput GetInput (const TfToken &name) const
 Return the requested input if it exists. More...
 
USDSHADE_API std::vector
< UsdShadeInput
GetInputs () const
 Inputs are represented by attributes in the "inputs:" namespace. More...
 
USDSHADE_API TfToken GetImplementationSource () const
 Reads the value of info:implementationSource attribute and returns a token identifying the attribute that must be consulted to identify the shader's source program. More...
 
USDSHADE_API bool SetShaderId (const TfToken &id) const
 Sets the shader's ID value. More...
 
USDSHADE_API bool GetShaderId (TfToken *id) const
 Fetches the shader's ID value from the info:id attribute, if the shader's info:implementationSource is id. More...
 
USDSHADE_API bool SetSourceAsset (const SdfAssetPath &sourceAsset, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
 Sets the shader's source-asset path value to sourceAsset for the given source type, sourceType. More...
 
USDSHADE_API bool GetSourceAsset (SdfAssetPath *sourceAsset, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
 Fetches the shader's source asset value for the specified sourceType value from the info:sourceType:sourceAsset attribute, if the shader's info:implementationSource is sourceAsset. More...
 
USDSHADE_API bool SetSourceAssetSubIdentifier (const TfToken &subIdentifier, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
 Set a sub-identifier to be used with a source asset of the given source type. More...
 
USDSHADE_API bool GetSourceAssetSubIdentifier (TfToken *subIdentifier, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
 Fetches the shader's sub-identifier for the source asset with the specified sourceType value from the info:sourceType: sourceAsset:subIdentifier attribute, if the shader's info: implementationSource is sourceAsset. More...
 
USDSHADE_API bool SetSourceCode (const std::string &sourceCode, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
 Sets the shader's source-code value to sourceCode for the given source type, sourceType. More...
 
USDSHADE_API bool GetSourceCode (std::string *sourceCode, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
 Fetches the shader's source code for the specified sourceType value by reading the info:sourceType:sourceCode attribute, if the shader's info:implementationSource is sourceCode. More...
 
USDSHADE_API NdrTokenMap GetSdrMetadata () const
 Returns this shader's composed "sdrMetadata" dictionary as a NdrTokenMap. More...
 
USDSHADE_API std::string GetSdrMetadataByKey (const TfToken &key) const
 Returns the value corresponding to key in the composed sdrMetadata dictionary. More...
 
USDSHADE_API void SetSdrMetadata (const NdrTokenMap &sdrMetadata) const
 Authors the given sdrMetadata on this shader at the current EditTarget. More...
 
USDSHADE_API void SetSdrMetadataByKey (const TfToken &key, const std::string &value) const
 Sets the value corresponding to key to the given string value, in the shader's "sdrMetadata" dictionary at the current EditTarget. More...
 
USDSHADE_API bool HasSdrMetadata () const
 Returns true if the shader has a non-empty composed "sdrMetadata" dictionary value. More...
 
USDSHADE_API bool HasSdrMetadataByKey (const TfToken &key) const
 Returns true if there is a value corresponding to the given key in the composed "sdrMetadata" dictionary. More...
 
USDSHADE_API void ClearSdrMetadata () const
 Clears any "sdrMetadata" value authored on the shader in the current EditTarget. More...
 
USDSHADE_API void ClearSdrMetadataByKey (const TfToken &key) const
 Clears the entry corresponding to the given key in the "sdrMetadata" dictionary authored in the current EditTarget. 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 UsdRiRisObject Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdRiRisObject holding the prim adhering to this schema at path on stage. More...
 
static USDRI_API UsdRiRisObject 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 UsdShadeShader
static USDSHADE_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 USDSHADE_API UsdShadeShader Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdShadeShader holding the prim adhering to this schema at path on stage. More...
 
static USDSHADE_API UsdShadeShader 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 UsdShadeShader
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 UsdShadeShader
USDSHADE_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

Deprecated:
Specialized RIS shader schemas have been deprecated in favor of all shader prims being simple UsdShadeShader. Represents a ris object with connectable parameters.

Definition at line 59 of file risObject.h.

Constructor & Destructor Documentation

UsdRiRisObject ( const UsdPrim prim = UsdPrim())
inlineexplicit

Construct a UsdRiRisObject on UsdPrim prim .

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

Definition at line 71 of file risObject.h.

UsdRiRisObject ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdRiRisObject on the prim held by schemaObj .

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

Definition at line 79 of file risObject.h.

virtual USDRI_API ~UsdRiRisObject ( )
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.

Reimplemented in UsdRiRisOslPattern, and UsdRiRisPattern.

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

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

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

Declaration asset info:argsPath
C++ Type SdfAssetPath
Usd Type SdfValueTypeNames->Asset

USDRI_API UsdAttribute GetFilePathAttr ( ) const

Declaration asset info:filePath
C++ Type SdfAssetPath
Usd Type SdfValueTypeNames->Asset

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 65 of file risObject.h.


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