This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
HdDrawItem Class Reference

A draw item is a light-weight representation of an HdRprim's resources and material to be used for rendering. More...

#include <drawItem.h>

Inherited by HdStDrawItem.

Public Member Functions

 HF_MALLOC_TAG_NEW ("new HdDrawItem")
 
HD_API HdDrawItem (HdRprimSharedData const *sharedData)
 
SdfPath const & GetRprimID () const
 
GfBBox3d const & GetBounds () const
 
GfRange3d const & GetExtent () const
 
GfMatrix4d const & GetMatrix () const
 
HdDrawingCoordGetDrawingCoord ()
 
bool GetVisible () const
 Returns the authored visibility, expressed by the delegate.
 
TfToken const & GetMaterialTag () const
 
void SetMaterialTag (TfToken const &materialTag)
 

Protected Member Functions

HdDrawingCoord const & _GetDrawingCoord () const
 Returns the drawingCoord.
 
HdRprimSharedData const * _GetSharedData () const
 Returns the shared data.
 

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.

Note
Rendering backends may choose to specialize this class.

Definition at line 47 of file drawItem.h.

Member Function Documentation

◆ _GetDrawingCoord()

HdDrawingCoord const & _GetDrawingCoord ( ) const
inlineprotected

Returns the drawingCoord.

Definition at line 87 of file drawItem.h.

◆ _GetSharedData()

HdRprimSharedData const * _GetSharedData ( ) const
inlineprotected

Returns the shared data.

Definition at line 92 of file drawItem.h.

◆ GetBounds()

GfBBox3d const & GetBounds ( ) const
inline

Definition at line 60 of file drawItem.h.

◆ GetDrawingCoord()

HdDrawingCoord * GetDrawingCoord ( )
inline

Definition at line 70 of file drawItem.h.

◆ GetExtent()

GfRange3d const & GetExtent ( ) const
inline

Definition at line 62 of file drawItem.h.

◆ GetMaterialTag()

TfToken const & GetMaterialTag ( ) const
inline

Definition at line 77 of file drawItem.h.

◆ GetMatrix()

GfMatrix4d const & GetMatrix ( ) const
inline

Definition at line 66 of file drawItem.h.

◆ GetRprimID()

SdfPath const & GetRprimID ( ) const
inline

Definition at line 58 of file drawItem.h.

◆ GetVisible()

bool GetVisible ( ) const
inline

Returns the authored visibility, expressed by the delegate.

Definition at line 75 of file drawItem.h.

◆ SetMaterialTag()

void SetMaterialTag ( TfToken const &  materialTag)
inline

Definition at line 81 of file drawItem.h.


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