HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdBasisCurvesSchema Class Reference

#include <basisCurvesSchema.h>

+ Inheritance diagram for HdBasisCurvesSchema:

Classes

class  Builder
 

Public Member Functions

 HdBasisCurvesSchema (HdContainerDataSourceHandle container)
 
HD_API HdBasisCurvesTopologySchema GetTopology ()
 
HD_API HdGeomSubsetsSchema GetGeomSubsets ()
 
- Public Member Functions inherited from HdSchema
 HdSchema (HdContainerDataSourceHandle container)
 
HD_API HdContainerDataSourceHandle GetContainer ()
 Returns the container data source that this schema is interpreting. More...
 
HD_API bool IsDefined () const
 
 operator bool () const
 

Static Public Member Functions

static HD_API
HdContainerDataSourceHandle 
BuildRetained (const HdContainerDataSourceHandle &topology, const HdContainerDataSourceHandle &geomSubsets)
 
static HD_API HdBasisCurvesSchema GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
 
static HD_API const TfTokenGetSchemaToken ()
 
static HD_API const
HdDataSourceLocator
GetDefaultLocator ()
 
static HD_API const
HdDataSourceLocator
GetTopologyLocator ()
 Prim-level relative data source locator to locate topology. More...
 
static HD_API const
HdDataSourceLocator
GetGeomSubsetsLocator ()
 Prim-level relative data source locator to locate geomSubsets. More...
 

Additional Inherited Members

- Public Types inherited from HdSchema
using UnderlyingDataSource = HdContainerDataSource
 
- Protected Member Functions inherited from HdSchema
template<typename T >
T::Handle _GetTypedDataSource (TfToken name)
 
- Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle _container
 

Detailed Description

Definition at line 65 of file basisCurvesSchema.h.

Constructor & Destructor Documentation

HdBasisCurvesSchema::HdBasisCurvesSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 68 of file basisCurvesSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdBasisCurvesSchema::BuildRetained ( const HdContainerDataSourceHandle &  topology,
const HdContainerDataSourceHandle &  geomSubsets 
)
static

Builds a container data source which includes the provided child data sources. Parameters with nullptr values are excluded. This is a low-level interface. For cases in which it's desired to define the container with a sparse set of child fields, the Builder class is often more convenient and readable.

static HD_API const HdDataSourceLocator& HdBasisCurvesSchema::GetDefaultLocator ( )
static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.

static HD_API HdBasisCurvesSchema HdBasisCurvesSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer)
static

Retrieves a container data source with the schema's default name token "basisCurves" from the parent container and constructs a HdBasisCurvesSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

HD_API HdGeomSubsetsSchema HdBasisCurvesSchema::GetGeomSubsets ( )
static HD_API const HdDataSourceLocator& HdBasisCurvesSchema::GetGeomSubsetsLocator ( )
static

Prim-level relative data source locator to locate geomSubsets.

static HD_API const TfToken& HdBasisCurvesSchema::GetSchemaToken ( )
static

Returns a token where the container representing this schema is found in a container by default.

HD_API HdBasisCurvesTopologySchema HdBasisCurvesSchema::GetTopology ( )
static HD_API const HdDataSourceLocator& HdBasisCurvesSchema::GetTopologyLocator ( )
static

Prim-level relative data source locator to locate topology.


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