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

Private data for each non-root invocation of PxrUsdIn. More...

Inherits GeolibPrivateData.

Classes

struct  MaterialHierarchy
 Material specialization hierarchy for Usd shading. More...
 
struct  UsdKatanaTimePair
 Pair for associating a USD time with a Katana time. More...
 

Public Member Functions

 PxrUsdKatanaUsdInPrivateData (const UsdPrim &prim, PxrUsdKatanaUsdInArgsRefPtr usdInArgs, const PxrUsdKatanaUsdInPrivateData *parentData=NULL)
 
const UsdPrimGetUsdPrim () const
 
const PxrUsdKatanaUsdInArgsRefPtr GetUsdInArgs () const
 
const SdfPathGetInstancePath () const
 
const SdfPathGetMasterPath () const
 
const double GetCurrentTime () const
 
const double GetShutterOpen () const
 
const double GetShutterClose () const
 
const bool IsMotionBackward () const
 Return true if motion blur is backward. More...
 
const std::vector< double > GetMotionSampleTimes (const UsdAttribute &attr=UsdAttribute(), bool fallBackToShutterBoundary=false) const
 Return frame-relative sample times based on how the given attribute is sampled with respect to the shutter range. More...
 
std::vector< UsdKatanaTimePairGetUsdAndKatanaTimes (const UsdAttribute &attr=UsdAttribute()) const
 Returns a list of <usd, katana> times for use in clients that wish to multi-sample USD data and build corresponding Katana attributes. More...
 
void setExtensionOpArg (const std::string &name, FnAttribute::Attribute attr) const
 Allows a registered op or location decorator function to set share and accumulate state during traversal. More...
 
FnAttribute::Attribute getExtensionOpArg (const std::string &name, FnAttribute::GroupAttribute opArgs) const
 Allows a registered op or location decorator function to retrieve state accumulated during traversal. More...
 
FnAttribute::GroupAttribute updateExtensionOpArgs (FnAttribute::GroupAttribute opArgs) const
 Called by the hosting op to flush the results of setExtensionOpArg and apply back onto the provided opArgs. More...
 
UsdShadeMaterialBindingAPI::CollectionQueryCacheGetCollectionQueryCache () const
 Access to shared caches relevant to efficient binding of materials across the hierarchy. More...
 
UsdShadeMaterialBindingAPI::BindingsCacheGetBindingsCache () const
 

Static Public Member Functions

static
PxrUsdKatanaUsdInPrivateData
GetPrivateData (const FnKat::GeolibCookInterface &interface)
 extract private data from either the interface (its natural location) with room for future growth More...
 

Detailed Description

Private data for each non-root invocation of PxrUsdIn.

See Also
PxrUsdKatanaUsdInArgs

Definition at line 42 of file usdInPrivateData.h.


Class Documentation

struct PxrUsdKatanaUsdInPrivateData::MaterialHierarchy

Material specialization hierarchy for Usd shading.

Definition at line 47 of file usdInPrivateData.h.

Class Members
map< SdfPath, SdfPath > baseMaterialPath
map< SdfPath, vector< SdfPath > > derivedMaterialPaths

Member Function Documentation

UsdShadeMaterialBindingAPI::CollectionQueryCache* GetCollectionQueryCache ( ) const

Access to shared caches relevant to efficient binding of materials across the hierarchy.

FnAttribute::Attribute getExtensionOpArg ( const std::string &  name,
FnAttribute::GroupAttribute  opArgs 
) const

Allows a registered op or location decorator function to retrieve state accumulated during traversal.

Arguments set via previous consumer's calls to setExtensionOpArg are visible as part of the opArgs sent in the op or function.

const std::vector<double> GetMotionSampleTimes ( const UsdAttribute attr = UsdAttribute(),
bool  fallBackToShutterBoundary = false 
) const

Return frame-relative sample times based on how the given attribute is sampled with respect to the shutter range.

   If an attribute is not provided, the motion sample times
   specified at a parent location or the default motion sample
   times as specified via the usdInArgs will be used.

If motion is desired and the given attribute does not have samples authored within the shutter range, the closest samples to the shutter boundary will be used for determining the result. If no closest samples could be found, a single sample time (no motion) will be returned, unless fallBackToShutterBoundary is true, in which case the shutter start time and/or end time will be used.

This utility respects the notion of motion sample times overrides as specified in the usdInArgs' session data. Motion sample times overrides take precedence over any of the aforementioned logic.

static PxrUsdKatanaUsdInPrivateData* GetPrivateData ( const FnKat::GeolibCookInterface &  interface)
static

extract private data from either the interface (its natural location) with room for future growth

std::vector<UsdKatanaTimePair> GetUsdAndKatanaTimes ( const UsdAttribute attr = UsdAttribute()) const

Returns a list of <usd, katana> times for use in clients that wish to multi-sample USD data and build corresponding Katana attributes.

const bool IsMotionBackward ( ) const

Return true if motion blur is backward.

PxrUsdIn supports both forward and backward motion blur. Motion blur is considered backward if multiple samples are requested and the first specified sample is later than the last sample.

void setExtensionOpArg ( const std::string &  name,
FnAttribute::Attribute  attr 
) const

Allows a registered op or location decorator function to set share and accumulate state during traversal.

FnAttribute::GroupAttribute updateExtensionOpArgs ( FnAttribute::GroupAttribute  opArgs) const

Called by the hosting op to flush the results of setExtensionOpArg and apply back onto the provided opArgs.

NOTE: This should not be called by an executed op or function as it's intended for use the callers of those.


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