HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
HdVectorSchema Class Reference

#include <vectorSchema.h>

+ Inheritance diagram for HdVectorSchema:

Public Types

using UnderlyingDataSource = HdVectorDataSource
 

Public Member Functions

 HdVectorSchema (HdVectorDataSourceHandle const &vector)
 
HD_API HdVectorDataSourceHandle GetVector ()
 Returns the vector data source that this schema is interpreting. More...
 
HD_API bool IsDefined () const
 
 operator bool () const
 
HD_API size_t GetNumElements () const
 Number of elements in the vector. More...
 

Static Public Member Functions

static HD_API
HdVectorDataSourceHandle 		BuildRetained (size_t count, const HdDataSourceBaseHandle *values)
 

Protected Member Functions

template<typename T >
T::Handle _GetTyped (const size_t element) const
 

Protected Attributes

HdVectorDataSourceHandle _vector
 

Detailed Description

Base class wrapping a vector data source.

Definition at line 21 of file vectorSchema.h.

Member Typedef Documentation

using HdVectorSchema::UnderlyingDataSource = HdVectorDataSource

Definition at line 47 of file vectorSchema.h.

Constructor & Destructor Documentation

HdVectorSchema::HdVectorSchema ( HdVectorDataSourceHandle const &  vector)
inline

Definition at line 24 of file vectorSchema.h.

Member Function Documentation

template<typename T >
T::Handle HdVectorSchema::_GetTyped ( const size_t  element) const
inlineprotected

Definition at line 51 of file vectorSchema.h.

static HD_API HdVectorDataSourceHandle HdVectorSchema::BuildRetained ( size_t  count,
const HdDataSourceBaseHandle *  values 
)
static
HD_API size_t HdVectorSchema::GetNumElements ( ) const

Number of elements in the vector.

HD_API HdVectorDataSourceHandle HdVectorSchema::GetVector ( )

Returns the vector data source that this schema is interpreting.

HD_API bool HdVectorSchema::IsDefined ( ) const
HdVectorSchema::operator bool ( ) const
inlineexplicit

Returns true if this schema is applied on top of a non-null vector.

Definition at line 41 of file vectorSchema.h.

Member Data Documentation

HdVectorDataSourceHandle HdVectorSchema::_vector
protected

Definition at line 58 of file vectorSchema.h.

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