HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Enumerations | Functions
purpose.h File Reference
#include <UT/UT_StringArray.h>
#include <UT/UT_StringHolder.h>
#include "pxr/pxr.h"
#include "pxr/usd/usdGeom/tokens.h"
#include "gusd/api.h"
+ Include dependency graph for purpose.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations

enum  GusdPurposeSet {
  GUSD_PURPOSE_NONE = 0x00, GUSD_PURPOSE_DEFAULT = 0x01, GUSD_PURPOSE_PROXY = 0x02, GUSD_PURPOSE_RENDER = 0x04,
  GUSD_PURPOSE_GUIDE = 0x08
}
 

Functions

GUSD_API GusdPurposeSet GusdPurposeSetFromName (const UT_StringRef &name)
 
GUSD_API GusdPurposeSet GusdPurposeSetFromName (const TfToken &name)
 
GUSD_API bool GusdPurposeInSet (const TfToken &name, GusdPurposeSet set)
 
GUSD_API TfTokenVector GusdPurposeSetToTokens (GusdPurposeSet purposes)
 Extract an array of tokens for purposes. More...
 
GUSD_API UT_StringArray GusdPurposeSetToStrings (GusdPurposeSet purposes)
 Extract an array of strings for purposes. More...
 
GUSD_API GusdPurposeSet GusdPurposeSetFromMask (const char *mask)
 Return a purpose set from a string providing a mask of purposes. More...
 
GUSD_API GusdPurposeSet GusdPurposeSetFromArray (const UT_StringArray &purposes)
 
GUSD_API GusdPurposeSet GusdPurposeSetFromArray (const TfTokenVector &purposes)
 

Enumeration Type Documentation

enum GusdPurposeSet
Enumerator
GUSD_PURPOSE_NONE 
GUSD_PURPOSE_DEFAULT 
GUSD_PURPOSE_PROXY 
GUSD_PURPOSE_RENDER 
GUSD_PURPOSE_GUIDE 

Definition at line 39 of file purpose.h.

Function Documentation

GUSD_API bool GusdPurposeInSet ( const TfToken &  name,
GusdPurposeSet  set 
)
inline

Definition at line 82 of file purpose.h.

GUSD_API GusdPurposeSet GusdPurposeSetFromArray ( const UT_StringArray &  purposes)

Create a purpose set from an array of purpose strings.

GUSD_API GusdPurposeSet GusdPurposeSetFromArray ( const TfTokenVector &  purposes)

Create a purpose set from an array of purpose strings.

GUSD_API GusdPurposeSet GusdPurposeSetFromMask ( const char *  mask)

Return a purpose set from a string providing a mask of purposes.

GUSD_API GusdPurposeSet GusdPurposeSetFromName ( const UT_StringRef &  name)
inline

Definition at line 50 of file purpose.h.

GUSD_API GusdPurposeSet GusdPurposeSetFromName ( const TfToken &  name)
inline

Definition at line 66 of file purpose.h.

GUSD_API UT_StringArray GusdPurposeSetToStrings ( GusdPurposeSet  purposes)

Extract an array of strings for purposes.

GUSD_API TfTokenVector GusdPurposeSetToTokens ( GusdPurposeSet  purposes)

Extract an array of tokens for purposes.