HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Friends | List of all members
VdfMaskedIterator< IteratorType, mode > Class Template Referencefinal

#include <maskedIterator.h>

+ Inheritance diagram for VdfMaskedIterator< IteratorType, mode >:

Public Types

typedef IteratorType::value_type value_type
 
typedef IteratorType::reference reference
 

Public Member Functions

template<typename... Args>
 VdfMaskedIterator (const VdfContext &context, const VdfMask &visitMask, Args &&...args)
 
VdfMaskedIterator & operator++ ()
 
reference operator* () const
 
bool IsAtEnd () const
 
void AdvanceToEnd ()
 

Friends

int Vdf_GetIteratorIndex (const VdfMaskedIterator &it)
 

Additional Inherited Members

- Protected Member Functions inherited from VdfIterator
 ~VdfIterator ()=default
 
const VdfNode & _GetNode (const VdfContext &context) const
 
const VdfExecutorInterface & _GetExecutor (const VdfContext &context) const
 
VDF_API const VdfVector * _GetInputValue (const VdfContext &context, const VdfConnection &connection, const VdfMask &mask) const
 
VDF_API const VdfVector & _GetRequiredInputValue (const VdfContext &context, const VdfConnection &connection, const VdfMask &mask) const
 
VDF_API const VdfOutput * _GetRequiredOutputForWriting (const VdfContext &context, const TfToken &name) const
 
VDF_API VdfVector * _GetOutputValueForWriting (const VdfContext &context, const VdfOutput &output) const
 
VDF_API bool _GetOutputMasks (const VdfContext &context, const VdfOutput &output, const VdfMask **requestMask, const VdfMask **affectsMask) const
 
VDF_API bool _IsRequiredInput (const VdfContext &context, const VdfConnection &connection) const
 
VDF_API const VdfMask * _GetRequestMask (const VdfContext &context, const VdfOutput &output) const
 
VDF_API void _ForEachScheduledOutput (const VdfContext &context, const VdfNode &node, const VdfScheduledOutputCallback &callback) const
 

Detailed Description

template<class IteratorType, VdfMaskedIteratorMode mode>
class VdfMaskedIterator< IteratorType, mode >

An iterator that can be used to refine the given iterator IteratorType to iterate over a given mask by either visiting or skipping over set bits in the mask.

Definition at line 43 of file maskedIterator.h.

Member Typedef Documentation

template<class IteratorType, VdfMaskedIteratorMode mode>
typedef IteratorType::reference VdfMaskedIterator< IteratorType, mode >::reference

The dereference type of this iterator.

Definition at line 53 of file maskedIterator.h.

template<class IteratorType, VdfMaskedIteratorMode mode>
typedef IteratorType::value_type VdfMaskedIterator< IteratorType, mode >::value_type

The value type of this iterator.

Definition at line 49 of file maskedIterator.h.

Constructor & Destructor Documentation

template<class IteratorType , VdfMaskedIteratorMode mode>
template<typename... Args>
VdfMaskedIterator< IteratorType, mode >::VdfMaskedIterator ( const VdfContext &  context,
const VdfMask &  visitMask,
Args &&...  args 
)

Constructor. Creates a masked iterator using visitMask and args.

Definition at line 104 of file maskedIterator.h.

Member Function Documentation

template<class IteratorType, VdfMaskedIteratorMode mode>
void VdfMaskedIterator< IteratorType, mode >::AdvanceToEnd ( )
inline

Advance the iterator to the end.

Definition at line 79 of file maskedIterator.h.

template<class IteratorType, VdfMaskedIteratorMode mode>
bool VdfMaskedIterator< IteratorType, mode >::IsAtEnd ( ) const
inline

Returns true if the iterator is done iterating and false otherwise.

Definition at line 73 of file maskedIterator.h.

template<class IteratorType, VdfMaskedIteratorMode mode>
reference VdfMaskedIterator< IteratorType, mode >::operator* ( ) const
inline

Returns reference to current element.

Definition at line 67 of file maskedIterator.h.

template<class IteratorType , VdfMaskedIteratorMode mode>
VdfMaskedIterator< IteratorType, mode > & VdfMaskedIterator< IteratorType, mode >::operator++ ( )

Increment operator to point to the next element.

Definition at line 119 of file maskedIterator.h.

Friends And Related Function Documentation

template<class IteratorType, VdfMaskedIteratorMode mode>
int Vdf_GetIteratorIndex ( const VdfMaskedIterator< IteratorType, mode > &  it)
friend

Definition at line 86 of file maskedIterator.h.

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