HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Macros | Typedefs
accessorHelpers.h File Reference
#include "pxr/pxr.h"
#include "pxr/usd/sdf/schema.h"
#include "pxr/usd/sdf/spec.h"
#include "pxr/usd/sdf/types.h"
#include <type_traits>
+ Include dependency graph for accessorHelpers.h:

Go to the source code of this file.

Classes

struct  Sdf_AccessorHelpers< T, IsForSpec >
 
struct  Sdf_AccessorHelpers< T, true >
 
struct  Sdf_AccessorHelpers< T, false >
 

Macros

#define _GET_KEY_(key_)   key_
 
#define SDF_NO_PREDICATE   true
 
#define _GET_WITH_FALLBACK(key_, heldType_)
 
#define SDF_DEFINE_GET(name_, key_, heldType_)
 
#define SDF_DEFINE_IS(name_, key_)
 
#define SDF_DEFINE_SET(name_, key_, argType_)
 
#define SDF_DEFINE_HAS(name_, key_)
 
#define SDF_DEFINE_CLEAR(name_, key_)
 
#define SDF_DEFINE_GET_PRIVATE(name_, key_, heldType_)
 
#define SDF_DEFINE_DICTIONARY_GET(name_, key_)
 
#define SDF_DEFINE_DICTIONARY_SET(name_, key_)
 
#define SDF_DEFINE_TYPED_GET_SET(name_, key_, getType_, setType_)
 
#define SDF_DEFINE_TYPED_GET_SET_HAS_CLEAR(name_, key_, getType_, setType_)
 
#define SDF_DEFINE_GET_SET(name_, key_, type_)
 
#define SDF_DEFINE_GET_SET_HAS_CLEAR(name_, key_, type_)
 
#define SDF_DEFINE_IS_SET(name_, key_)
 
#define SDF_DEFINE_DICTIONARY_GET_SET(getName_, setName_, key_)
 

Typedefs

template<typename T >
using Sdf_SetParameter = std::conditional< std::is_arithmetic< T >::value, std::add_const_t< T >, std::add_lvalue_reference_t< std::add_const_t< T >>>
 

Macro Definition Documentation

#define _GET_KEY_ (   key_)    key_

Definition at line 57 of file accessorHelpers.h.

#define _GET_WITH_FALLBACK (   key_,
  heldType_ 
)
Value:
{ \
typedef Sdf_AccessorHelpers<SDF_ACCESSOR_CLASS> _Helper; \
const VtValue& value = _Helper::GetField(this, key_); \
if (value.IsEmpty() || !value.IsHolding<heldType_>()) { \
const SdfSchemaBase& schema = _Helper::GetSchema(this); \
return schema.GetFallback(_GET_KEY_(key_)).Get<heldType_>(); \
} \
else { \
return value.Get<heldType_>(); \
} \
}
Sdf_AccessorHelpers
Definition: accessorHelpers.h:216
if
if(num_boxed_items<=0)
Definition: UT_RTreeImpl.h:697
value
Definition: core.h:1131
_GET_KEY_
#define _GET_KEY_(key_)
Definition: accessorHelpers.h:57
VtValue
Definition: value.h:164

Definition at line 60 of file accessorHelpers.h.

#define SDF_DEFINE_CLEAR (   name_,
  key_ 
)
Value:
void \
SDF_ACCESSOR_CLASS::Clear ## name_() \
{ \
typedef Sdf_AccessorHelpers<SDF_ACCESSOR_CLASS> _Helper; \
if (SDF_ACCESSOR_WRITE_PREDICATE(_GET_KEY_(key_))) { \
_Helper::ClearField(this, _GET_KEY_(key_)); \
} \
}
Sdf_AccessorHelpers
Definition: accessorHelpers.h:216
if
if(num_boxed_items<=0)
Definition: UT_RTreeImpl.h:697
_GET_KEY_
#define _GET_KEY_(key_)
Definition: accessorHelpers.h:57

Definition at line 117 of file accessorHelpers.h.

#define SDF_DEFINE_DICTIONARY_GET (   name_,
  key_ 
)
Value:
SdfDictionaryProxy \
SDF_ACCESSOR_CLASS::name_() const \
{ \
typedef Sdf_AccessorHelpers<SDF_ACCESSOR_CLASS> _Helper; \
return SDF_ACCESSOR_READ_PREDICATE(_GET_KEY_(key_)) ? \
SdfDictionaryProxy(_Helper::GetSpecHandle(this), _GET_KEY_(key_)) : \
SdfDictionaryProxy(); \
}
SdfDictionaryProxy
SdfMapEditProxy< VtDictionary > SdfDictionaryProxy
Definition: proxyTypes.h:69
Sdf_AccessorHelpers
Definition: accessorHelpers.h:216
_GET_KEY_
#define _GET_KEY_(key_)
Definition: accessorHelpers.h:57

Definition at line 144 of file accessorHelpers.h.

#define SDF_DEFINE_DICTIONARY_GET_SET (   getName_,
  setName_,
  key_ 
)
Value:
SDF_DEFINE_DICTIONARY_GET(getName_, key_) \
SDF_DEFINE_DICTIONARY_SET(setName_, key_)
SDF_DEFINE_DICTIONARY_SET
#define SDF_DEFINE_DICTIONARY_SET(name_, key_)
Definition: accessorHelpers.h:154
SDF_DEFINE_DICTIONARY_GET
#define SDF_DEFINE_DICTIONARY_GET(name_, key_)
Definition: accessorHelpers.h:144

Definition at line 203 of file accessorHelpers.h.

#define SDF_DEFINE_DICTIONARY_SET (   name_,
  key_ 
)
Value:
void \
SDF_ACCESSOR_CLASS::name_( \
const std::string& name, \
const VtValue& value) \
{ \
typedef Sdf_AccessorHelpers<SDF_ACCESSOR_CLASS> _Helper; \
if (SDF_ACCESSOR_WRITE_PREDICATE(_GET_KEY_(key_))) { \
SdfDictionaryProxy proxy( \
_Helper::GetSpecHandle(this), _GET_KEY_(key_)); \
if (value.IsEmpty()) { \
proxy.erase(name); \
} \
else { \
proxy[name] = value; \
} \
} \
}
string
GLsizei const GLchar *const * string
Definition: glcorearb.h:814
value
GLsizei const GLfloat * value
Definition: glcorearb.h:824
SdfDictionaryProxy
SdfMapEditProxy< VtDictionary > SdfDictionaryProxy
Definition: proxyTypes.h:69
name
GLuint const GLchar * name
Definition: glcorearb.h:786
Sdf_AccessorHelpers
Definition: accessorHelpers.h:216
if
if(num_boxed_items<=0)
Definition: UT_RTreeImpl.h:697
value
Definition: core.h:1131
_GET_KEY_
#define _GET_KEY_(key_)
Definition: accessorHelpers.h:57
VtValue
Definition: value.h:164

Definition at line 154 of file accessorHelpers.h.

#define SDF_DEFINE_GET (   name_,
  key_,
  heldType_ 
)
Value:
heldType_ \
SDF_ACCESSOR_CLASS::Get ## name_() const \
{ \
if (SDF_ACCESSOR_READ_PREDICATE(_GET_KEY_(key_))) { \
/* Empty clause needed to prevent compiler complaints */ \
} \
\
_GET_WITH_FALLBACK(key_, heldType_); \
}
_GET_WITH_FALLBACK
#define _GET_WITH_FALLBACK(key_, heldType_)
Definition: accessorHelpers.h:60
if
if(num_boxed_items<=0)
Definition: UT_RTreeImpl.h:697
_GET_KEY_
#define _GET_KEY_(key_)
Definition: accessorHelpers.h:57

Definition at line 76 of file accessorHelpers.h.

#define SDF_DEFINE_GET_PRIVATE (   name_,
  key_,
  heldType_ 
)
Value:
heldType_ \
SDF_ACCESSOR_CLASS::_Get ## name_() const \
{ \
if (SDF_ACCESSOR_READ_PREDICATE(_GET_KEY_(key_))) { \
/* Empty clause needed to prevent compiler complaints */ \
} \
\
_GET_WITH_FALLBACK(key_, heldType_); \
}
_GET_WITH_FALLBACK
#define _GET_WITH_FALLBACK(key_, heldType_)
Definition: accessorHelpers.h:60
if
if(num_boxed_items<=0)
Definition: UT_RTreeImpl.h:697
_GET_KEY_
#define _GET_KEY_(key_)
Definition: accessorHelpers.h:57

Definition at line 130 of file accessorHelpers.h.

#define SDF_DEFINE_GET_SET (   name_,
  key_,
  type_ 
)
Value:
SDF_DEFINE_TYPED_GET_SET(name_, key_, type_, \
Sdf_SetParameter<type_>::type)
SDF_DEFINE_TYPED_GET_SET
#define SDF_DEFINE_TYPED_GET_SET(name_, key_, getType_, setType_)
Definition: accessorHelpers.h:182
Sdf_SetParameter
std::conditional< std::is_arithmetic< T >::value, std::add_const_t< T >, std::add_lvalue_reference_t< std::add_const_t< T >>> Sdf_SetParameter
Definition: accessorHelpers.h:180

Definition at line 191 of file accessorHelpers.h.

#define SDF_DEFINE_GET_SET_HAS_CLEAR (   name_,
  key_,
  type_ 
)
Value:
SDF_DEFINE_TYPED_GET_SET_HAS_CLEAR(name_, key_, type_, \
Sdf_SetParameter<type_>::type)
SDF_DEFINE_TYPED_GET_SET_HAS_CLEAR
#define SDF_DEFINE_TYPED_GET_SET_HAS_CLEAR(name_, key_, getType_, setType_)
Definition: accessorHelpers.h:186
Sdf_SetParameter
std::conditional< std::is_arithmetic< T >::value, std::add_const_t< T >, std::add_lvalue_reference_t< std::add_const_t< T >>> Sdf_SetParameter
Definition: accessorHelpers.h:180

Definition at line 195 of file accessorHelpers.h.

#define SDF_DEFINE_HAS (   name_,
  key_ 
)
Value:
bool \
SDF_ACCESSOR_CLASS::Has ## name_() const \
{ \
typedef Sdf_AccessorHelpers<SDF_ACCESSOR_CLASS> _Helper; \
return SDF_ACCESSOR_READ_PREDICATE(_GET_KEY_(key_)) ? \
_Helper::HasField(this, _GET_KEY_(key_)) : false; \
}
Sdf_AccessorHelpers
Definition: accessorHelpers.h:216
_GET_KEY_
#define _GET_KEY_(key_)
Definition: accessorHelpers.h:57

Definition at line 108 of file accessorHelpers.h.

#define SDF_DEFINE_IS (   name_,
  key_ 
)
Value:
bool \
SDF_ACCESSOR_CLASS::Is ## name_() const \
{ \
if (!SDF_ACCESSOR_READ_PREDICATE(_GET_KEY_(key_))) { \
return false; \
} \
\
_GET_WITH_FALLBACK(key_, bool); \
}
_GET_WITH_FALLBACK
#define _GET_WITH_FALLBACK(key_, heldType_)
Definition: accessorHelpers.h:60
if
if(num_boxed_items<=0)
Definition: UT_RTreeImpl.h:697
_GET_KEY_
#define _GET_KEY_(key_)
Definition: accessorHelpers.h:57

Definition at line 87 of file accessorHelpers.h.

#define SDF_DEFINE_IS_SET (   name_,
  key_ 
)
Value:
SDF_DEFINE_IS(name_, key_) \
SDF_DEFINE_SET(name_, key_, bool)
SDF_DEFINE_SET
#define SDF_DEFINE_SET(name_, key_, argType_)
Definition: accessorHelpers.h:98
SDF_DEFINE_IS
#define SDF_DEFINE_IS(name_, key_)
Definition: accessorHelpers.h:87

Definition at line 199 of file accessorHelpers.h.

#define SDF_DEFINE_SET (   name_,
  key_,
  argType_ 
)
Value:
void \
SDF_ACCESSOR_CLASS::Set ## name_(argType_ value) \
{ \
if (SDF_ACCESSOR_WRITE_PREDICATE(_GET_KEY_(key_))) { \
typedef Sdf_AccessorHelpers<SDF_ACCESSOR_CLASS> _Helper; \
_Helper::SetField(this, _GET_KEY_(key_), value); \
} \
}
Sdf_AccessorHelpers
Definition: accessorHelpers.h:216
if
if(num_boxed_items<=0)
Definition: UT_RTreeImpl.h:697
value
Definition: core.h:1131
_GET_KEY_
#define _GET_KEY_(key_)
Definition: accessorHelpers.h:57

Definition at line 98 of file accessorHelpers.h.

#define SDF_DEFINE_TYPED_GET_SET (   name_,
  key_,
  getType_,
  setType_ 
)
Value:
SDF_DEFINE_GET(name_, key_, getType_) \
SDF_DEFINE_SET(name_, key_, setType_)
SDF_DEFINE_GET
#define SDF_DEFINE_GET(name_, key_, heldType_)
Definition: accessorHelpers.h:76
SDF_DEFINE_SET
#define SDF_DEFINE_SET(name_, key_, argType_)
Definition: accessorHelpers.h:98

Definition at line 182 of file accessorHelpers.h.

#define SDF_DEFINE_TYPED_GET_SET_HAS_CLEAR (   name_,
  key_,
  getType_,
  setType_ 
)
Value:
SDF_DEFINE_TYPED_GET_SET(name_, key_, getType_, setType_) \
SDF_DEFINE_HAS(name_, key_) \
SDF_DEFINE_CLEAR(name_, key_)
SDF_DEFINE_CLEAR
#define SDF_DEFINE_CLEAR(name_, key_)
Definition: accessorHelpers.h:117
SDF_DEFINE_HAS
#define SDF_DEFINE_HAS(name_, key_)
Definition: accessorHelpers.h:108
SDF_DEFINE_TYPED_GET_SET
#define SDF_DEFINE_TYPED_GET_SET(name_, key_, getType_, setType_)
Definition: accessorHelpers.h:182

Definition at line 186 of file accessorHelpers.h.

#define SDF_NO_PREDICATE   true

Definition at line 58 of file accessorHelpers.h.

Typedef Documentation

template<typename T >
using Sdf_SetParameter = std::conditional< std::is_arithmetic<T>::value, std::add_const_t<T>, std::add_lvalue_reference_t<std::add_const_t<T>>>

Definition at line 180 of file accessorHelpers.h.