Loading...
Searching...
No Matches
HdStField3DAssetSubtextureIdentifier Class Referencefinal

Identifies the grid in a Field3DAsset file. More...

#include <fieldSubtextureIdentifier.h>

+ Inheritance diagram for HdStField3DAssetSubtextureIdentifier:

Public Member Functions

HDST_API HdStField3DAssetSubtextureIdentifier (TfToken const &fieldName, int fieldIndex, TfToken const &fieldPurpose)
 C'tor.
 
HDST_API std::unique_ptr< HdStSubtextureIdentifierClone () const override
 
HDST_API TfToken const & GetFieldPurpose () const
 
- Public Member Functions inherited from HdStFieldBaseSubtextureIdentifier
HDST_API TfToken const & GetFieldName () const
 Get field name.
 
HDST_API int GetFieldIndex () const
 Get field index.
 
virtual HDST_API std::unique_ptr< HdStSubtextureIdentifierClone () const =0
 

Protected Member Functions

HDST_API ID _Hash () const override
 
- Protected Member Functions inherited from HdStFieldBaseSubtextureIdentifier
HDST_API HdStFieldBaseSubtextureIdentifier (TfToken const &fieldName, int fieldIndex)
 
HDST_API ID _Hash () const override
 
virtual ID _Hash () const =0
 

Additional Inherited Members

- Public Types inherited from HdStSubtextureIdentifier
using ID = size_t
 

Detailed Description

Identifies the grid in a Field3DAsset file.

Parallels Field3DAsset in usdVol.

Definition at line 66 of file fieldSubtextureIdentifier.h.

Constructor & Destructor Documentation

◆ HdStField3DAssetSubtextureIdentifier()

HDST_API HdStField3DAssetSubtextureIdentifier ( TfToken const &  fieldName,
int  fieldIndex,
TfToken const &  fieldPurpose 
)
explicit

C'tor.

fieldName corresponds (e.g., density) to the layer/attribute name in the Field3D file fieldIndex corresponds to the partition index fieldPurpose (e.g., BigCloud) corresponds to the partition name/grouping

Member Function Documentation

◆ _Hash()

HDST_API ID _Hash ( ) const
overrideprotectedvirtual

◆ Clone()

HDST_API std::unique_ptr< HdStSubtextureIdentifier > Clone ( ) const
overridevirtual

◆ GetFieldPurpose()

HDST_API TfToken const & GetFieldPurpose ( ) const
inline

Definition at line 89 of file fieldSubtextureIdentifier.h.


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