UsdImagingGeomModelSchema Class Reference

#include <geomModelSchema.h>

Inheritance diagram for UsdImagingGeomModelSchema:

Classes
class	Builder

Public Member Functions
Member accessor
USDIMAGING_API HdTokenDataSourceHandle	GetDrawMode () const
USDIMAGING_API HdBoolDataSourceHandle	GetApplyDrawMode () const
USDIMAGING_API HdVec3fDataSourceHandle	GetDrawModeColor () const
USDIMAGING_API HdTokenDataSourceHandle	GetCardGeometry () const
USDIMAGING_API HdAssetPathDataSourceHandle	GetCardTextureXPos () const
USDIMAGING_API HdAssetPathDataSourceHandle	GetCardTextureYPos () const
USDIMAGING_API HdAssetPathDataSourceHandle	GetCardTextureZPos () const
USDIMAGING_API HdAssetPathDataSourceHandle	GetCardTextureXNeg () const
USDIMAGING_API HdAssetPathDataSourceHandle	GetCardTextureYNeg () const
USDIMAGING_API HdAssetPathDataSourceHandle	GetCardTextureZNeg () const
Public Member Functions inherited from HdSchema
	HdSchema (HdContainerDataSourceHandle container)
HD_API HdContainerDataSourceHandle	GetContainer () const
	Returns the container data source that this schema is interpreting. More...
HD_API bool	IsDefined () const
	operator bool () const

Static Public Member Functions
Schema location
static USDIMAGING_API const TfToken &	GetSchemaToken ()
static USDIMAGING_API const HdDataSourceLocator &	GetDefaultLocator ()
Data source locators for members
The following methods return an HdDataSourceLocator (relative to the prim-level data source) where the data source for a member can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
static USDIMAGING_API const HdDataSourceLocator &	GetDrawModeLocator ()
	Prim-level relative data source locator to locate drawMode. More...
Schema construction
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 HdTokenDataSourceHandle	BuildDrawModeDataSource (const TfToken &drawMode)
static USDIMAGING_API HdTokenDataSourceHandle	BuildCardGeometryDataSource (const TfToken &cardGeometry)

Schema retrieval
	UsdImagingGeomModelSchema (HdContainerDataSourceHandle container)
static USDIMAGING_API UsdImagingGeomModelSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)

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) const
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Definition at line 62 of file geomModelSchema.h.

Constructor & Destructor Documentation

UsdImagingGeomModelSchema::UsdImagingGeomModelSchema ( HdContainerDataSourceHandle  container )

inline

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.

Definition at line 68 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.

The following values will be stored statically and reused for future calls:

• UsdImagingGeomModelSchemaTokens->cross
• UsdImagingGeomModelSchemaTokens->box
• UsdImagingGeomModelSchemaTokens->fromTexture

static USDIMAGING_API HdTokenDataSourceHandle UsdImagingGeomModelSchema::BuildDrawModeDataSource ( const TfToken &  drawMode )

static

Returns token data source for use as drawMode value.

The following values will be stored statically and reused for future calls:

• UsdImagingGeomModelSchemaTokens->default_
• UsdImagingGeomModelSchemaTokens->origin
• UsdImagingGeomModelSchemaTokens->bounds
• UsdImagingGeomModelSchemaTokens->cards
• UsdImagingGeomModelSchemaTokens->inherited

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

Deprecated:

Use Builder instead.

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

(

)

const

USDIMAGING_API HdTokenDataSourceHandle UsdImagingGeomModelSchema::GetCardGeometry

(

)

const

USDIMAGING_API HdAssetPathDataSourceHandle UsdImagingGeomModelSchema::GetCardTextureXNeg

(

)

const

USDIMAGING_API HdAssetPathDataSourceHandle UsdImagingGeomModelSchema::GetCardTextureXPos

(

)

const

USDIMAGING_API HdAssetPathDataSourceHandle UsdImagingGeomModelSchema::GetCardTextureYNeg

(

)

const

USDIMAGING_API HdAssetPathDataSourceHandle UsdImagingGeomModelSchema::GetCardTextureYPos

(

)

const

USDIMAGING_API HdAssetPathDataSourceHandle UsdImagingGeomModelSchema::GetCardTextureZNeg

(

)

const

USDIMAGING_API HdAssetPathDataSourceHandle UsdImagingGeomModelSchema::GetCardTextureZPos

(

)

const

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

(

)

const

USDIMAGING_API HdVec3fDataSourceHandle UsdImagingGeomModelSchema::GetDrawModeColor

(

)

const

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