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

#include <drawItem.h>

+ Inheritance diagram for HdDrawItem:

Public Member Functions

 HF_MALLOC_TAG_NEW ("new HdDrawItem")
HD_API HdDrawItem (HdRprimSharedData const *sharedData)
virtual HD_API ~HdDrawItem ()
SdfPath constGetRprimID () const
GfBBox3d constGetBounds () const
GfRange3d constGetExtent () const
GfMatrix4d constGetMatrix () const
HdDrawingCoordGetDrawingCoord ()
bool GetVisible () const
 Returns the authored visibility, expressed by the delegate. More...
TfToken constGetMaterialTag () const
void SetMaterialTag (TfToken const &materialTag)

Protected Member Functions

HdDrawingCoord const_GetDrawingCoord () const
 Returns the drawingCoord. More...
HdRprimSharedData const_GetSharedData () const
 Returns the shared data. More...

Detailed Description

A draw item is a light-weight representation of an HdRprim's resources and material to be used for rendering. The visual representation (HdRepr) of an HdRprim might require multiple draw items.

HdDrawItem(s) are created by the HdRprim (HdMesh, HdBasisCurve, ..) for each HdRepr. The relevant compositional hierarchy is:

HdRprim | +–HdRepr(s) | +–HdDrawItem(s)

HdDrawItem(s) are consumed by HdRenderPass for its HdRprimCollection via HdRenderIndex::GetDrawItems.

Rendering backends may choose to specialize this class.

Definition at line 64 of file drawItem.h.

Constructor & Destructor Documentation

HD_API HdDrawItem::HdDrawItem ( HdRprimSharedData const sharedData)
virtual HD_API HdDrawItem::~HdDrawItem ( )

Member Function Documentation

HdDrawingCoord const& HdDrawItem::_GetDrawingCoord ( ) const

Returns the drawingCoord.

Definition at line 104 of file drawItem.h.

HdRprimSharedData const* HdDrawItem::_GetSharedData ( ) const

Returns the shared data.

Definition at line 109 of file drawItem.h.

GfBBox3d const& HdDrawItem::GetBounds ( ) const

Definition at line 77 of file drawItem.h.

HdDrawingCoord* HdDrawItem::GetDrawingCoord ( )

Definition at line 87 of file drawItem.h.

GfRange3d const& HdDrawItem::GetExtent ( ) const

Definition at line 79 of file drawItem.h.

TfToken const& HdDrawItem::GetMaterialTag ( ) const

Definition at line 94 of file drawItem.h.

GfMatrix4d const& HdDrawItem::GetMatrix ( ) const

Definition at line 83 of file drawItem.h.

SdfPath const& HdDrawItem::GetRprimID ( ) const

Definition at line 75 of file drawItem.h.

bool HdDrawItem::GetVisible ( ) const

Returns the authored visibility, expressed by the delegate.

Definition at line 92 of file drawItem.h.

HdDrawItem::HF_MALLOC_TAG_NEW ( "new HdDrawItem )
void HdDrawItem::SetMaterialTag ( TfToken const materialTag)

Definition at line 98 of file drawItem.h.

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