UsdRiRisPattern Class Reference

Inheritance diagram for UsdRiRisPattern:

Public Member Functions
	UsdRiRisPattern (const UsdPrim &prim=UsdPrim())
	Construct a UsdRiRisPattern on UsdPrim prim . More...
	UsdRiRisPattern (const UsdSchemaBase &schemaObj)
	Construct a UsdRiRisPattern on the prim held by schemaObj . More...
virtual USDRI_API	~UsdRiRisPattern ()
	Destructor. More...
Public Member Functions inherited from UsdRiRisObject
	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	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 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 (bool onlyAuthored=true) 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 (bool onlyAuthored=true) const
	Inputs are represented by attributes in the "inputs:" namespace. More...
USDSHADE_API UsdAttribute	GetImplementationSourceAttr () const
	Forwards to UsdShadeNodeDefAPI(prim). More...
USDSHADE_API UsdAttribute	CreateImplementationSourceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	Forwards to UsdShadeNodeDefAPI(prim). More...
USDSHADE_API UsdAttribute	GetIdAttr () const
	Forwards to UsdShadeNodeDefAPI(prim). More...
USDSHADE_API UsdAttribute	CreateIdAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	Forwards to UsdShadeNodeDefAPI(prim). More...
USDSHADE_API TfToken	GetImplementationSource () const
	Forwards to UsdShadeNodeDefAPI(prim). More...
USDSHADE_API bool	SetShaderId (const TfToken &id) const
	Forwards to UsdShadeNodeDefAPI(prim). More...
USDSHADE_API bool	GetShaderId (TfToken *id) const
	Forwards to UsdShadeNodeDefAPI(prim). More...
USDSHADE_API bool	SetSourceAsset (const SdfAssetPath &sourceAsset, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
	Forwards to UsdShadeNodeDefAPI(prim). More...
USDSHADE_API bool	GetSourceAsset (SdfAssetPath *sourceAsset, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
	Forwards to UsdShadeNodeDefAPI(prim). More...
USDSHADE_API bool	SetSourceAssetSubIdentifier (const TfToken &subIdentifier, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
	Forwards to UsdShadeNodeDefAPI(prim). More...
USDSHADE_API bool	GetSourceAssetSubIdentifier (TfToken *subIdentifier, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
	Forwards to UsdShadeNodeDefAPI(prim). More...
USDSHADE_API bool	SetSourceCode (const std::string &sourceCode, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
	Forwards to UsdShadeNodeDefAPI(prim). More...
USDSHADE_API bool	GetSourceCode (std::string *sourceCode, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
	Forwards to UsdShadeNodeDefAPI(prim). More...
USDSHADE_API SdrShaderNodeConstPtr	GetShaderNodeForSourceType (const TfToken &sourceType) const
	Forwards to UsdShadeNodeDefAPI(prim). 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...
UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is. More...
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 UsdPrimDefinition *	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 UsdRiRisPattern	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdRiRisPattern holding the prim adhering to this schema at path on stage. More...
static USDRI_API UsdRiRisPattern	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 UsdRiRisObject
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 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 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 TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::ConcreteTyped
	Compile time constant representing what kind of schema this class is. More...
Static Public Attributes inherited from UsdRiRisObject
static const UsdSchemaKind	schemaKind = UsdSchemaKind::ConcreteTyped
	Compile time constant representing what kind of schema this class is. More...
Static Public Attributes inherited from UsdShadeShader
static const UsdSchemaKind	schemaKind = UsdSchemaKind::ConcreteTyped
	Compile time constant representing what kind of schema this class is. More...
Static Public Attributes inherited from UsdTyped
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is. More...
Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is. More...

Protected Member Functions
USDRI_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to. More...
Protected Member Functions inherited from UsdShadeShader
USDSHADE_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind 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
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

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 ( 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 ( 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 ( )

virtual

Destructor.

Member Function Documentation

USDRI_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also

UsdSchemaKind

Reimplemented from UsdRiRisObject.

static USDRI_API 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 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& 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 UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped

static

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

See Also

UsdSchemaKind

Definition at line 67 of file risPattern.h.

---

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

• pxr/usd/usdRi/risPattern.h