Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
HdVectorSchema Class Reference

Base class wrapping a vector data source. More...

#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.
 
HD_API bool IsDefined () const
 
 operator bool () const
 Returns true if this schema is applied on top of a non-null vector.
 
HD_API size_t GetNumElements () const
 Number of elements in the vector.
 

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 38 of file vectorSchema.h.

Member Typedef Documentation

◆ UnderlyingDataSource

using UnderlyingDataSource = HdVectorDataSource

Definition at line 64 of file vectorSchema.h.

Constructor & Destructor Documentation

◆ HdVectorSchema()

HdVectorSchema ( HdVectorDataSourceHandle const &  vector)
inline

Definition at line 41 of file vectorSchema.h.

Member Function Documentation

◆ _GetTyped()

T::Handle _GetTyped ( const size_t  element) const
inlineprotected

Definition at line 68 of file vectorSchema.h.

◆ GetNumElements()

HD_API size_t GetNumElements ( ) const

Number of elements in the vector.

◆ GetVector()

HD_API HdVectorDataSourceHandle GetVector ( )

Returns the vector data source that this schema is interpreting.

◆ operator bool()

operator bool ( ) const
inlineexplicit

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

Definition at line 58 of file vectorSchema.h.

Member Data Documentation

◆ _vector

HdVectorDataSourceHandle _vector
protected

Definition at line 75 of file vectorSchema.h.

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