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

An object to store attributes. More...

Public Types

typedef boost::upgrade_mutex Mutex
 

Public Member Functions

void SetUSDTimeCode (UsdTimeCode timeCode)
 Configure this object to evaluate USD attributes at the given time. More...
 
PxrUsdKatanaAttrMapSet (const std::string &path, const UsdAttribute &attr)
 Set the katana attribute path by evaluating the given USD attribute attr at the time configured in SetUSDTime(). More...
 
void set (const std::string &path, const Foundry::Katana::Attribute &attr)
 set attr at path. More...
 
void del (const std::string &path)
 delete attribute at path More...
 
FnAttribute::GroupAttribute build ()
 build a group attribute More...
 
void toInterface (Foundry::Katana::GeolibCookInterface &interface)
 sets attrs in attrs onto the interface. More...
 
bool isBuilt ()
 returns true if a call to build has been made prior to any subsequent calls to set or del. More...
 
Mutex & getInstanceMutex ()
 while no locking occurs internal to this class, calling code may wish to manage read/write locks per-instance. More...
 

Detailed Description

An object to store attributes.

The current implementation uses a Foundry::Katana::GroupBuilder behind the scenes, but the dependence on that thus far is somewhat minimal and not all of the behavior of GroupBuilder has been exposed.

This class is here in case we need to have different behavior than the GroupBuilder.

Definition at line 44 of file attrMap.h.

Member Function Documentation

FnAttribute::GroupAttribute build ( )

build a group attribute

void del ( const std::string &  path)

delete attribute at path

Mutex& getInstanceMutex ( )
inline

while no locking occurs internal to this class, calling code may wish to manage read/write locks per-instance.

Definition at line 78 of file attrMap.h.

bool isBuilt ( )

returns true if a call to build has been made prior to any subsequent calls to set or del.

PxrUsdKatanaAttrMap& Set ( const std::string &  path,
const UsdAttribute attr 
)

Set the katana attribute path by evaluating the given USD attribute attr at the time configured in SetUSDTime().

Returns this object by reference so these calls can be chained.

void set ( const std::string &  path,
const Foundry::Katana::Attribute &  attr 
)

set attr at path.

void SetUSDTimeCode ( UsdTimeCode  timeCode)
inline

Configure this object to evaluate USD attributes at the given time.

Definition at line 48 of file attrMap.h.

void toInterface ( Foundry::Katana::GeolibCookInterface &  interface)

sets attrs in attrs onto the interface.


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