UsdRiStatementsAPI Class Reference

Container namespace schema for all renderman statements. More...

+ Inheritance diagram for UsdRiStatementsAPI:

Public Member Functions

 UsdRiStatementsAPI (const UsdPrim &prim=UsdPrim())
 Construct a UsdRiStatementsAPI on UsdPrim prim . More...
 
 UsdRiStatementsAPI (const UsdSchemaBase &schemaObj)
 Construct a UsdRiStatementsAPI on the prim held by schemaObj . More...
 
virtual USDRI_API ~UsdRiStatementsAPI ()
 Destructor. More...
 
USDRI_API UsdAttribute CreateRiAttribute (const TfToken &name, const std::string &riType, const std::string &nameSpace="user")
 Create a rib attribute on the prim to which this schema is attached. More...
 
USDRI_API UsdAttribute CreateRiAttribute (const TfToken &name, const TfType &tfType, const std::string &nameSpace="user")
 Creates an attribute of the given tfType. More...
 
USDRI_API UsdAttribute GetRiAttribute (const TfToken &name, const std::string &nameSpace="user")
 Return a UsdAttribute representing the Ri attribute with the name name, in the namespace nameSpace. More...
 
USDRI_API std::vector< UsdPropertyGetRiAttributes (const std::string &nameSpace="") const
 Return all rib attributes on this prim, or under a specific namespace (e.g. "user"). More...
 
USDRI_API void SetCoordinateSystem (const std::string &coordSysName)
 Sets the "ri:coordinateSystem" attribute to the given string value, creating the attribute if needed. More...
 
USDRI_API std::string GetCoordinateSystem () const
 Returns the value in the "ri:coordinateSystem" attribute if it exists. More...
 
USDRI_API bool HasCoordinateSystem () const
 Returns true if the underlying prim has a ri:coordinateSystem opinion. More...
 
USDRI_API void SetScopedCoordinateSystem (const std::string &coordSysName)
 Sets the "ri:scopedCoordinateSystem" attribute to the given string value, creating the attribute if needed. More...
 
USDRI_API std::string GetScopedCoordinateSystem () const
 Returns the value in the "ri:scopedCoordinateSystem" attribute if it exists. More...
 
USDRI_API bool HasScopedCoordinateSystem () const
 Returns true if the underlying prim has a ri:scopedCoordinateSystem opinion. More...
 
USDRI_API bool GetModelCoordinateSystems (SdfPathVector *targets) const
 Populates the output targets with the authored ri:modelCoordinateSystems, if any. More...
 
USDRI_API bool GetModelScopedCoordinateSystems (SdfPathVector *targets) const
 Populates the output targets with the authored ri:modelScopedCoordinateSystems, if any. More...
 
- Public Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
 Construct a UsdAPISchemaBase on UsdPrim prim . More...
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
 Construct a UsdAPISchemaBase on the prim held by schemaObj . More...
 
virtual USD_API ~UsdAPISchemaBase ()=0
 Destructor. 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 UsdPrimDefinitionGetSchemaClassPrimDefinition () 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 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 USDRI_API UsdRiStatementsAPI Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdRiStatementsAPI holding the prim adhering to this schema at path on stage. More...
 
static USDRI_API bool CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
 Returns true if this single-apply API schema can be applied to the given prim. More...
 
static USDRI_API UsdRiStatementsAPI Apply (const UsdPrim &prim)
 Applies this single-apply API schema to the given prim. More...
 
static TfToken GetRiAttributeName (const UsdProperty &prop)
 Return the base, most-specific name of the rib attribute. More...
 
static USDRI_API TfToken GetRiAttributeNameSpace (const UsdProperty &prop)
 Return the containing namespace of the rib attribute (e.g. "user"). More...
 
static USDRI_API bool IsRiAttribute (const UsdProperty &prop)
 Return true if the property is in the "ri:attributes" namespace. More...
 
static USDRI_API std::string MakeRiAttributePropertyName (const std::string &attrName)
 Returns the given attrName prefixed with the full Ri attribute namespace, creating a name suitable for an RiAttribute UsdProperty. More...
 
- Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API 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 Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdAPISchemaBase
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 UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
 Construct a multiple-apply UsdAPISchemaBase on UsdPrim prim with the specified instanceName. More...
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
 Construct a multiple-apply UsdAPISchemaBase on the prim held by schemaObj with the given instanceName. More...
 
const TfToken_GetInstanceName () const
 Returns the instance name of the API schema object belonging to a multiple-apply API schema. More...
 
USD_API bool _IsCompatible () const override
 Check whether this APISchema object is valid for the currently held. 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
 

Additional Inherited Members

- Static Protected Member Functions inherited from UsdAPISchemaBase
template<typename APISchemaType >
static APISchemaType _ApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName)
 Helper method to apply a single-apply API schema with the given schema name apiSchemaName' and C++ type 'APISchemaType'. More...
 
template<typename APISchemaType >
static APISchemaType _MultipleApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName, const TfToken &instanceName)
 Helper method to apply a multiple-apply API schema with the given schema name apiSchemaName', C++ type 'APISchemaType' and instance name instanceName. More...
 

Detailed Description

Container namespace schema for all renderman statements.

Note
The longer term goal is for clients to go directly to primvar or render-attribute API's, instead of using UsdRi StatementsAPI for inherited attributes. Anticpating this, StatementsAPI can smooth the way via a few environment variables:
  • USDRI_STATEMENTS_READ_OLD_ENCODING: Causes StatementsAPI to read old-style attributes instead of primvars in the "ri:" namespace.

Definition at line 69 of file statementsAPI.h.

Constructor & Destructor Documentation

◆ UsdRiStatementsAPI() [1/2]

UsdRiStatementsAPI ( const UsdPrim prim = UsdPrim())
inlineexplicit

Construct a UsdRiStatementsAPI on UsdPrim prim .

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

Definition at line 81 of file statementsAPI.h.

◆ UsdRiStatementsAPI() [2/2]

UsdRiStatementsAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdRiStatementsAPI on the prim held by schemaObj .

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

Definition at line 89 of file statementsAPI.h.

◆ ~UsdRiStatementsAPI()

virtual USDRI_API ~UsdRiStatementsAPI ( )
virtual

Destructor.

Member Function Documentation

◆ _GetSchemaKind()

USDRI_API UsdSchemaKind _GetSchemaKind ( ) const
overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also
UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

◆ Apply()

static USDRI_API UsdRiStatementsAPI Apply ( const UsdPrim prim)
static

Applies this single-apply API schema to the given prim.

This information is stored by adding "StatementsAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns
A valid UsdRiStatementsAPI object is returned upon success. An invalid (or empty) UsdRiStatementsAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()

◆ CanApply()

static USDRI_API bool CanApply ( const UsdPrim prim,
std::string *  whyNot = nullptr 
)
static

Returns true if this single-apply API schema can be applied to the given prim.

If this schema can not be a applied to the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.

Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.

See also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()

◆ CreateRiAttribute() [1/2]

USDRI_API UsdAttribute CreateRiAttribute ( const TfToken name,
const std::string &  riType,
const std::string &  nameSpace = "user" 
)

Create a rib attribute on the prim to which this schema is attached.

A rib attribute consists of an attribute "nameSpace" and an attribute "name". For example, the namespace "cull" may define attributes "backfacing" and "hidden", and user-defined attributes belong to the namespace "user".

This method makes no attempt to validate that the given nameSpace and name are actually meaningful to prman or any other renderer.

Parameters
riTypeshould be a known RenderMan type definition, which can be array-valued. For instance, both "color" and "float[3]" are valid values for riType.

◆ CreateRiAttribute() [2/2]

USDRI_API UsdAttribute CreateRiAttribute ( const TfToken name,
const TfType tfType,
const std::string &  nameSpace = "user" 
)

Creates an attribute of the given tfType.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ Get()

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

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

UsdRiStatementsAPI(stage->GetPrimAtPath(path));

◆ GetCoordinateSystem()

USDRI_API std::string GetCoordinateSystem ( ) const

Returns the value in the "ri:coordinateSystem" attribute if it exists.

◆ GetModelCoordinateSystems()

USDRI_API bool GetModelCoordinateSystems ( SdfPathVector *  targets) const

Populates the output targets with the authored ri:modelCoordinateSystems, if any.

Returns true if the query was successful.

◆ GetModelScopedCoordinateSystems()

USDRI_API bool GetModelScopedCoordinateSystems ( SdfPathVector *  targets) const

Populates the output targets with the authored ri:modelScopedCoordinateSystems, if any.

Returns true if the query was successful.

◆ GetRiAttribute()

USDRI_API UsdAttribute GetRiAttribute ( const TfToken name,
const std::string &  nameSpace = "user" 
)

Return a UsdAttribute representing the Ri attribute with the name name, in the namespace nameSpace.

The attribute returned may or may not actually exist so it must be checked for validity.

◆ GetRiAttributeName()

static TfToken GetRiAttributeName ( const UsdProperty prop)
inlinestatic

Return the base, most-specific name of the rib attribute.

For example, the name of the rib attribute "cull:backfacing" is "backfacing"

Definition at line 248 of file statementsAPI.h.

◆ GetRiAttributeNameSpace()

static USDRI_API TfToken GetRiAttributeNameSpace ( const UsdProperty prop)
static

Return the containing namespace of the rib attribute (e.g. "user").

◆ GetRiAttributes()

USDRI_API std::vector<UsdProperty> GetRiAttributes ( const std::string &  nameSpace = "") const

Return all rib attributes on this prim, or under a specific namespace (e.g. "user").

As noted above, rib attributes can be either UsdAttribute or UsdRelationship, and like all UsdProperties, need not have a defined value.

◆ GetSchemaAttributeNames()

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.

◆ GetScopedCoordinateSystem()

USDRI_API std::string GetScopedCoordinateSystem ( ) const

Returns the value in the "ri:scopedCoordinateSystem" attribute if it exists.

◆ HasCoordinateSystem()

USDRI_API bool HasCoordinateSystem ( ) const

Returns true if the underlying prim has a ri:coordinateSystem opinion.

◆ HasScopedCoordinateSystem()

USDRI_API bool HasScopedCoordinateSystem ( ) const

Returns true if the underlying prim has a ri:scopedCoordinateSystem opinion.

◆ IsRiAttribute()

static USDRI_API bool IsRiAttribute ( const UsdProperty prop)
static

Return true if the property is in the "ri:attributes" namespace.

◆ MakeRiAttributePropertyName()

static USDRI_API std::string MakeRiAttributePropertyName ( const std::string &  attrName)
static

Returns the given attrName prefixed with the full Ri attribute namespace, creating a name suitable for an RiAttribute UsdProperty.

This handles conversion of common separator characters used in other packages, such as periods and underscores.

Will return empty string if attrName is not a valid property identifier; otherwise, will return a valid property name that identifies the property as an RiAttribute, according to the following rules:

  • If attrName is already a properly constructed RiAttribute property name, return it unchanged.
  • If attrName contains two or more tokens separated by a colon, consider the first to be the namespace, and the rest the name, joined by underscores
  • If attrName contains two or more tokens separated by a period, consider the first to be the namespace, and the rest the name, joined by underscores
  • If attrName contains two or more tokens separated by an, underscore consider the first to be the namespace, and the rest the name, joined by underscores
  • else, assume attrName is the name, and "user" is the namespace

◆ SetCoordinateSystem()

USDRI_API void SetCoordinateSystem ( const std::string &  coordSysName)

Sets the "ri:coordinateSystem" attribute to the given string value, creating the attribute if needed.

That identifies this prim as providing a coordinate system, which can be retrieved via UsdGeomXformable::GetTransformAttr(). Also adds the owning prim to the ri:modelCoordinateSystems relationship targets on its parent leaf model prim, if it exists. If this prim is not under a leaf model, no relationship targets will be authored.

◆ SetScopedCoordinateSystem()

USDRI_API void SetScopedCoordinateSystem ( const std::string &  coordSysName)

Sets the "ri:scopedCoordinateSystem" attribute to the given string value, creating the attribute if needed.

That identifies this prim as providing a coordinate system, which can be retrieved via UsdGeomXformable::GetTransformAttr(). Such coordinate systems are local to the RI attribute stack state, but does get updated properly for instances when defined inside an object master. Also adds the owning prim to the ri:modelScopedCoordinateSystems relationship targets on its parent leaf model prim, if it exists. If this prim is not under a leaf model, no relationship targets will be authored.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI
static

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

See also
UsdSchemaKind

Definition at line 75 of file statementsAPI.h.


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