HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Typedefs | Enumerations | Functions
declare.h File Reference
#include "pxr/pxr.h"
#include "pxr/usd/sdr/api.h"
#include "pxr/usd/ndr/declare.h"
#include "pxr/base/tf/token.h"
#include <memory>
#include <string>
#include <unordered_map>
#include <unordered_set>
#include <vector>
+ Include dependency graph for declare.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  SdrVersion
 SdrVersion. More...
 

Typedefs

typedef TfToken SdrIdentifier
 Common typedefs that are used throughout the SDR library. More...
 
typedef TfToken::HashFunctor SdrIdentifierHashFunctor
 
typedef std::vector
< SdrIdentifier > 		SdrIdentifierVec
 
typedef std::unordered_set
< SdrIdentifier,
SdrIdentifierHashFunctor > 		SdrIdentifierSet
 
typedef std::vector< TfToken > SdrTokenVec
 
typedef std::unordered_map
< TfToken, std::string,
TfToken::HashFunctor > 		SdrTokenMap
 
typedef SdrShaderNode * SdrShaderNodePtr
 
typedef SdrShaderNode const * SdrShaderNodeConstPtr
 
typedef std::unique_ptr
< SdrShaderNode > 		SdrShaderNodeUniquePtr
 
typedef std::vector
< SdrShaderNodeConstPtr > 		SdrShaderNodeConstPtrVec
 
typedef SdrShaderNodeConstPtrVec SdrShaderNodePtrVec
 
typedef std::vector
< SdrShaderNodeUniquePtr > 		SdrShaderNodeUniquePtrVec
 
typedef SdrShaderProperty * SdrShaderPropertyPtr
 
typedef SdrShaderProperty const * SdrShaderPropertyConstPtr
 
typedef std::unique_ptr
< SdrShaderProperty > 		SdrShaderPropertyUniquePtr
 
typedef std::vector
< SdrShaderPropertyUniquePtr > 		SdrShaderPropertyUniquePtrVec
 
typedef std::unordered_map
< TfToken,
SdrShaderPropertyConstPtr,
TfToken::HashFunctor > 		SdrShaderPropertyMap
 
typedef SdrShaderPropertyMap SdrPropertyMap
 
typedef std::vector< std::string > SdrStringVec
 
typedef std::pair< TfToken,
TfToken > 		SdrOption
 
typedef std::vector< SdrOption > SdrOptionVec
 
typedef std::unordered_set
< std::string > 		SdrStringSet
 

Enumerations

enum  SdrVersionFilter { SdrVersionFilterDefaultOnly, SdrVersionFilterAllVersions, SdrNumVersionFilters }
 Enumeration used to select nodes by version. More...
 

Functions

const std::string & SdrGetIdentifierString (const SdrIdentifier &id)
 
SDR_API NdrVersionFilter SdrVersionFilterToNdr (SdrVersionFilter filter)
 
SDR_API NdrVersion SdrToNdrVersion (SdrVersion version)
 
SDR_API SdrVersion NdrToSdrVersion (NdrVersion version)
 

Detailed Description

Note
All Ndr objects are deprecated in favor of the corresponding Sdr objects in this file. All existing pxr/usd/ndr implementations will be moved to pxr/usd/sdr.

Definition in file declare.h.

Typedef Documentation

typedef TfToken SdrIdentifier

Common typedefs that are used throughout the SDR library.

Definition at line 32 of file declare.h.

typedef TfToken::HashFunctor SdrIdentifierHashFunctor

Definition at line 37 of file declare.h.

typedef std::unordered_set<SdrIdentifier, SdrIdentifierHashFunctor> SdrIdentifierSet

Definition at line 42 of file declare.h.

typedef std::vector<SdrIdentifier> SdrIdentifierVec

Definition at line 40 of file declare.h.

typedef std::pair<TfToken, TfToken> SdrOption

Definition at line 68 of file declare.h.

typedef std::vector<SdrOption> SdrOptionVec

Definition at line 69 of file declare.h.

typedef SdrShaderPropertyMap SdrPropertyMap

Definition at line 64 of file declare.h.

typedef SdrShaderNode const* SdrShaderNodeConstPtr

Definition at line 51 of file declare.h.

typedef std::vector<SdrShaderNodeConstPtr> SdrShaderNodeConstPtrVec

Definition at line 53 of file declare.h.

typedef SdrShaderNode* SdrShaderNodePtr

Definition at line 50 of file declare.h.

typedef SdrShaderNodeConstPtrVec SdrShaderNodePtrVec

Definition at line 54 of file declare.h.

typedef std::unique_ptr<SdrShaderNode> SdrShaderNodeUniquePtr

Definition at line 52 of file declare.h.

typedef std::vector<SdrShaderNodeUniquePtr> SdrShaderNodeUniquePtrVec

Definition at line 55 of file declare.h.

typedef SdrShaderProperty const* SdrShaderPropertyConstPtr

Definition at line 59 of file declare.h.

typedef std::unordered_map<TfToken, SdrShaderPropertyConstPtr, TfToken::HashFunctor> SdrShaderPropertyMap

Definition at line 63 of file declare.h.

typedef SdrShaderProperty* SdrShaderPropertyPtr

Definition at line 58 of file declare.h.

typedef std::unique_ptr<SdrShaderProperty> SdrShaderPropertyUniquePtr

Definition at line 60 of file declare.h.

typedef std::vector<SdrShaderPropertyUniquePtr> SdrShaderPropertyUniquePtrVec

Definition at line 61 of file declare.h.

typedef std::unordered_set<std::string> SdrStringSet

Definition at line 70 of file declare.h.

typedef std::vector<std::string> SdrStringVec

Definition at line 67 of file declare.h.

typedef std::unordered_map<TfToken, std::string, TfToken::HashFunctor> SdrTokenMap

Definition at line 47 of file declare.h.

typedef std::vector<TfToken> SdrTokenVec

Definition at line 45 of file declare.h.

Enumeration Type Documentation

enum SdrVersionFilter

Enumeration used to select nodes by version.

Enumerator
SdrVersionFilterDefaultOnly 
SdrVersionFilterAllVersions 
SdrNumVersionFilters 

Definition at line 190 of file declare.h.

Function Documentation

SDR_API SdrVersion NdrToSdrVersion ( NdrVersion  version)

Helper function to translate NdrVersion to SdrVersion

Deprecated:
This function is deprecated and will be removed with the removal of the Ndr library.
const std::string& SdrGetIdentifierString ( const SdrIdentifier &  id)
inline

Definition at line 39 of file declare.h.

SDR_API NdrVersion SdrToNdrVersion ( SdrVersion  version)

Helper function to translate SdrVersion to NdrVersion

Deprecated:
This function is deprecated and will be removed with the removal of the Ndr library.
SDR_API NdrVersionFilter SdrVersionFilterToNdr ( SdrVersionFilter  filter)

Helper function to translate SdrVersionFilter values to NdrVersionFilter values.

Deprecated:
This function is deprecated and will be removed with the removal of the Ndr library.