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

#include <statementsAPI.h>

+ Inheritance diagram for UsdRiStatementsAPI:

Public Member Functions

 UsdRiStatementsAPI (const UsdPrim &prim=UsdPrim())
 
 UsdRiStatementsAPI (const UsdSchemaBase &schemaObj)
 
virtual USDRI_API ~UsdRiStatementsAPI ()
 Destructor. More...
 
USDRI_API UsdAttribute CreateRiAttribute (const TfToken &name, const std::string &riType, const std::string &nameSpace="user")
 
USDRI_API UsdAttribute CreateRiAttribute (const TfToken &name, const TfType &tfType, const std::string &nameSpace="user")
 
USDRI_API UsdAttribute GetRiAttribute (const TfToken &name, const std::string &nameSpace="user")
 
USDRI_API std::vector
< UsdProperty
GetRiAttributes (const std::string &nameSpace="") const
 
USDRI_API void SetCoordinateSystem (const std::string &coordSysName)
 
USDRI_API std::string GetCoordinateSystem () const
 
USDRI_API bool HasCoordinateSystem () const
 
USDRI_API void SetScopedCoordinateSystem (const std::string &coordSysName)
 
USDRI_API std::string GetScopedCoordinateSystem () const
 
USDRI_API bool HasScopedCoordinateSystem () const
 
USDRI_API bool GetModelCoordinateSystems (SdfPathVector *targets) const
 
USDRI_API bool GetModelScopedCoordinateSystems (SdfPathVector *targets) const
 
- Public Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
 
virtual USD_API ~UsdAPISchemaBase ()=0
 Destructor. More...
 
- 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 UsdRiStatementsAPI Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDRI_API UsdRiStatementsAPI Apply (const UsdPrim &prim)
 
static TfToken GetRiAttributeName (const UsdProperty &prop)
 
static USDRI_API TfToken GetRiAttributeNameSpace (const UsdProperty &prop)
 
static USDRI_API bool IsRiAttribute (const UsdProperty &prop)
 
static USDRI_API std::string MakeRiAttributePropertyName (const std::string &attrName)
 
- Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI
 
- Static Public Attributes inherited from UsdAPISchemaBase
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 UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
 
const TfToken_GetInstanceName () const
 
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
 

Additional Inherited Members

- Static Protected Member Functions inherited from UsdAPISchemaBase
template<typename APISchemaType >
static APISchemaType _ApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName)
 
template<typename APISchemaType >
static APISchemaType _MultipleApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName, const TfToken &instanceName)
 

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_WRITE_NEW_ENCODING: Causes StatementsAPI to write attributes to primvars in the "ri:" namespace.
  • USDRI_STATEMENTS_READ_OLD_ENCODING: Causes StatementsAPI to read old-style attributes instead of primvars in the "ri:" namespace.

Definition at line 71 of file statementsAPI.h.

Constructor & Destructor Documentation

UsdRiStatementsAPI::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 83 of file statementsAPI.h.

UsdRiStatementsAPI::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 91 of file statementsAPI.h.

virtual USDRI_API UsdRiStatementsAPI::~UsdRiStatementsAPI ( )
virtual

Destructor.

Member Function Documentation

USDRI_API UsdSchemaType UsdRiStatementsAPI::_GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdAPISchemaBase.

static USDRI_API UsdRiStatementsAPI 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::ApplyAPI()
UsdPrim::RemoveAPI()
USDRI_API UsdAttribute UsdRiStatementsAPI::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.
USDRI_API UsdAttribute UsdRiStatementsAPI::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.

static USDRI_API UsdRiStatementsAPI 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));
USDRI_API std::string UsdRiStatementsAPI::GetCoordinateSystem ( ) const

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

USDRI_API bool UsdRiStatementsAPI::GetModelCoordinateSystems ( SdfPathVector targets) const

Populates the output targets with the authored ri:modelCoordinateSystems, if any. Returns true if the query was successful.

USDRI_API bool UsdRiStatementsAPI::GetModelScopedCoordinateSystems ( SdfPathVector targets) const

Populates the output targets with the authored ri:modelScopedCoordinateSystems, if any. Returns true if the query was successful.

USDRI_API UsdAttribute UsdRiStatementsAPI::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.

static TfToken UsdRiStatementsAPI::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 229 of file statementsAPI.h.

static USDRI_API TfToken UsdRiStatementsAPI::GetRiAttributeNameSpace ( const UsdProperty prop)
static

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

USDRI_API std::vector<UsdProperty> UsdRiStatementsAPI::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.

static USDRI_API const TfTokenVector& UsdRiStatementsAPI::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.

USDRI_API std::string UsdRiStatementsAPI::GetScopedCoordinateSystem ( ) const

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

USDRI_API bool UsdRiStatementsAPI::HasCoordinateSystem ( ) const

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

USDRI_API bool UsdRiStatementsAPI::HasScopedCoordinateSystem ( ) const

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

static USDRI_API bool UsdRiStatementsAPI::IsRiAttribute ( const UsdProperty prop)
static

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

static USDRI_API std::string UsdRiStatementsAPI::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
USDRI_API void UsdRiStatementsAPI::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.

USDRI_API void UsdRiStatementsAPI::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.

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 148 of file statementsAPI.h.

Member Data Documentation

const UsdSchemaType UsdRiStatementsAPI::schemaType = UsdSchemaType::SingleApplyAPI
static

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

See Also
UsdSchemaType

Definition at line 77 of file statementsAPI.h.


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