UsdImagingGeomModelSchema Class Reference

#include <geomModelSchema.h>

Inheritance diagram for UsdImagingGeomModelSchema:

Classes
class	Builder

Public Member Functions
	UsdImagingGeomModelSchema (HdContainerDataSourceHandle container)
USDIMAGING_API HdTokenDataSourceHandle	GetDrawMode ()
USDIMAGING_API HdBoolDataSourceHandle	GetApplyDrawMode ()
USDIMAGING_API HdVec3fDataSourceHandle	GetDrawModeColor ()
USDIMAGING_API HdTokenDataSourceHandle	GetCardGeometry ()
USDIMAGING_API HdAssetPathDataSourceHandle	GetCardTextureXPos ()
USDIMAGING_API HdAssetPathDataSourceHandle	GetCardTextureYPos ()
USDIMAGING_API HdAssetPathDataSourceHandle	GetCardTextureZPos ()
USDIMAGING_API HdAssetPathDataSourceHandle	GetCardTextureXNeg ()
USDIMAGING_API HdAssetPathDataSourceHandle	GetCardTextureYNeg ()
USDIMAGING_API HdAssetPathDataSourceHandle	GetCardTextureZNeg ()
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 USDIMAGING_API HdContainerDataSourceHandle	BuildRetained (const HdTokenDataSourceHandle &drawMode, const HdBoolDataSourceHandle &applyDrawMode, const HdVec3fDataSourceHandle &drawModeColor, const HdTokenDataSourceHandle &cardGeometry, const HdAssetPathDataSourceHandle &cardTextureXPos, const HdAssetPathDataSourceHandle &cardTextureYPos, const HdAssetPathDataSourceHandle &cardTextureZPos, const HdAssetPathDataSourceHandle &cardTextureXNeg, const HdAssetPathDataSourceHandle &cardTextureYNeg, const HdAssetPathDataSourceHandle &cardTextureZNeg)
static USDIMAGING_API UsdImagingGeomModelSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
static USDIMAGING_API const TfToken &	GetSchemaToken ()
static USDIMAGING_API const HdDataSourceLocator &	GetDefaultLocator ()
static USDIMAGING_API const HdDataSourceLocator &	GetDrawModeLocator ()
	Prim-level relative data source locator to locate drawMode. More...
static USDIMAGING_API HdTokenDataSourceHandle	BuildDrawmodeDataSource (const TfToken &drawmode)
static USDIMAGING_API HdTokenDataSourceHandle	BuildCardgeometryDataSource (const TfToken &cardgeometry)

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 79 of file geomModelSchema.h.

Constructor & Destructor Documentation

UsdImagingGeomModelSchema::UsdImagingGeomModelSchema ( HdContainerDataSourceHandle  container )

inline

Definition at line 82 of file geomModelSchema.h.

Member Function Documentation

static USDIMAGING_API HdTokenDataSourceHandle UsdImagingGeomModelSchema::BuildCardgeometryDataSource ( const TfToken &  cardgeometry )

static

Returns token data source for use as cardgeometry value. Values of...

• UsdImagingGeomModelSchemaTokens->cross
• UsdImagingGeomModelSchemaTokens->box
• UsdImagingGeomModelSchemaTokens->fromTexture ...will be stored statically and reused for future calls.

static USDIMAGING_API HdTokenDataSourceHandle UsdImagingGeomModelSchema::BuildDrawmodeDataSource ( const TfToken &  drawmode )

static

Returns token data source for use as drawmode value. Values of...

• UsdImagingGeomModelSchemaTokens->default_
• UsdImagingGeomModelSchemaTokens->origin
• UsdImagingGeomModelSchemaTokens->bounds
• UsdImagingGeomModelSchemaTokens->cards
• UsdImagingGeomModelSchemaTokens->inherited ...will be stored statically and reused for future calls.

static USDIMAGING_API HdContainerDataSourceHandle UsdImagingGeomModelSchema::BuildRetained ( const HdTokenDataSourceHandle &  drawMode, const HdBoolDataSourceHandle &  applyDrawMode, const HdVec3fDataSourceHandle &  drawModeColor, const HdTokenDataSourceHandle &  cardGeometry, const HdAssetPathDataSourceHandle &  cardTextureXPos, const HdAssetPathDataSourceHandle &  cardTextureYPos, const HdAssetPathDataSourceHandle &  cardTextureZPos, const HdAssetPathDataSourceHandle &  cardTextureXNeg, const HdAssetPathDataSourceHandle &  cardTextureYNeg, const HdAssetPathDataSourceHandle &  cardTextureZNeg  )

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.

USDIMAGING_API HdBoolDataSourceHandle UsdImagingGeomModelSchema::GetApplyDrawMode

(

)

USDIMAGING_API HdTokenDataSourceHandle UsdImagingGeomModelSchema::GetCardGeometry

(

)

USDIMAGING_API HdAssetPathDataSourceHandle UsdImagingGeomModelSchema::GetCardTextureXNeg

(

)

USDIMAGING_API HdAssetPathDataSourceHandle UsdImagingGeomModelSchema::GetCardTextureXPos

(

)

USDIMAGING_API HdAssetPathDataSourceHandle UsdImagingGeomModelSchema::GetCardTextureYNeg

(

)

USDIMAGING_API HdAssetPathDataSourceHandle UsdImagingGeomModelSchema::GetCardTextureYPos

(

)

USDIMAGING_API HdAssetPathDataSourceHandle UsdImagingGeomModelSchema::GetCardTextureZNeg

(

)

USDIMAGING_API HdAssetPathDataSourceHandle UsdImagingGeomModelSchema::GetCardTextureZPos

(

)

static USDIMAGING_API const HdDataSourceLocator& UsdImagingGeomModelSchema::GetDefaultLocator ( )

static

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

USDIMAGING_API HdTokenDataSourceHandle UsdImagingGeomModelSchema::GetDrawMode

(

)

USDIMAGING_API HdVec3fDataSourceHandle UsdImagingGeomModelSchema::GetDrawModeColor

(

)

static USDIMAGING_API const HdDataSourceLocator& UsdImagingGeomModelSchema::GetDrawModeLocator ( )

static

Prim-level relative data source locator to locate drawMode.

static USDIMAGING_API UsdImagingGeomModelSchema UsdImagingGeomModelSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

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

static USDIMAGING_API const TfToken& UsdImagingGeomModelSchema::GetSchemaToken ( )

static

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

---

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

• pxr/usdImaging/usdImaging/geomModelSchema.h