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

#include <GU_PackedUSD.h>

+ Inheritance diagram for GusdGU_PackedUSD:

Public Types

enum  PivotLocation : int { PivotLocation::Origin = 0, PivotLocation::Centroid }
 
- Public Types inherited from GU_PackedImpl
typedef fpreal(GU_PackedImpl::* FloatGetter )(const GU_PrimPacked *) const
 
typedef void(GU_PackedImpl::* FloatSetter )(const GU_PrimPacked *, fpreal)
 
typedef GA_Size(GU_PackedImpl::* IntGetter )(const GU_PrimPacked *) const
 
typedef void(GU_PackedImpl::* IntSetter )(GU_PrimPacked *, GA_Size)
 
typedef bool(GU_PackedImpl::* BoolGetter )(const GU_PrimPacked *) const
 
typedef void(GU_PackedImpl::* BoolSetter )(GU_PrimPacked *, bool)
 
typedef const char
*(GU_PackedImpl::* 
StringGetter )(const GU_PrimPacked *) const
 
typedef void(GU_PackedImpl::* StringSetter )(GU_PrimPacked *, const char *)
 
typedef UT_OptionsHolder(GU_PackedImpl::* DictGetter )(const GU_PrimPacked *) const
 
typedef void(GU_PackedImpl::* DictSetter )(GU_PrimPacked *, const UT_OptionsHolder &)
 
typedef std::string(GU_PackedImpl::* StdStringGetter )(const GU_PrimPacked *) const
 
typedef void(GU_PackedImpl::* StdStringSetter )(GU_PrimPacked *, const std::string &)
 
typedef UT_StringHolder(GU_PackedImpl::* StringHolderGetter )(const GU_PrimPacked *) const
 
typedef void(GU_PackedImpl::* StringHolderSetter )(GU_PrimPacked *, const UT_StringHolder &)
 
typedef fpreal(GU_PackedImpl::* FloatTupleGetter )(const GU_PrimPacked *, exint) const
 
typedef void(GU_PackedImpl::* FloatTupleSetter )(GU_PrimPacked *, exint, fpreal)
 
typedef GA_Size(GU_PackedImpl::* IntTupleGetter )(const GU_PrimPacked *, exint) const
 
typedef void(GU_PackedImpl::* IntTupleSetter )(GU_PrimPacked *, exint, GA_Size)
 
typedef bool(GU_PackedImpl::* BoolTupleGetter )(const GU_PrimPacked *, exint) const
 
typedef void(GU_PackedImpl::* BoolTupleSetter )(GU_PrimPacked *, exint, bool)
 
typedef const char
*(GU_PackedImpl::* 
StringTupleGetter )(const GU_PrimPacked *, exint) const
 
typedef void(GU_PackedImpl::* StringTupleSetter )(GU_PrimPacked *, exint, const char *)
 
typedef UT_OptionsHolder(GU_PackedImpl::* DictTupleGetter )(const GU_PrimPacked *, exint) const
 
typedef void(GU_PackedImpl::* DictTupleSetter )(GU_PrimPacked *, exint, const UT_OptionsHolder &)
 
typedef const std::string
&(GU_PackedImpl::* 
StdStringTupleGetter )(const GU_PrimPacked *, exint) const
 
typedef void(GU_PackedImpl::* StdStringTupleSetter )(GU_PrimPacked *, exint, const std::string &)
 
typedef const UT_StringHolder
&(GU_PackedImpl::* 
StringHolderTupleGetter )(const GU_PrimPacked *, exint) const
 
typedef void(GU_PackedImpl::* StringHolderTupleSetter )(GU_PrimPacked *, exint, const UT_StringHolder &)
 
typedef void(GU_PackedImpl::* F32VectorGetter )(const GU_PrimPacked *, fpreal32 *, exint) const
 
typedef void(GU_PackedImpl::* F32VectorSetter )(GU_PrimPacked *, const fpreal32 *, exint)
 
typedef void(GU_PackedImpl::* F64VectorGetter )(const GU_PrimPacked *, fpreal64 *, exint) const
 
typedef void(GU_PackedImpl::* F64VectorSetter )(GU_PrimPacked *, const fpreal64 *, exint)
 
typedef void(GU_PackedImpl::* I32VectorGetter )(const GU_PrimPacked *, int32 *, exint) const
 
typedef void(GU_PackedImpl::* I32VectorSetter )(GU_PrimPacked *, const int32 *, exint)
 
typedef void(GU_PackedImpl::* I64VectorGetter )(const GU_PrimPacked *, int64 *, exint) const
 
typedef void(GU_PackedImpl::* I64VectorSetter )(GU_PrimPacked *, const int64 *, exint)
 
typedef void(GU_PackedImpl::* BVectorGetter )(const GU_PrimPacked *, bool *, exint) const
 
typedef void(GU_PackedImpl::* BVectorSetter )(GU_PrimPacked *, const bool *, exint)
 
typedef void(GU_PackedImpl::* StringArrayGetter )(const GU_PrimPacked *, UT_StringArray &) const
 
typedef void(GU_PackedImpl::* StringArraySetter )(GU_PrimPacked *, const UT_StringArray &)
 
typedef void(GU_PackedImpl::* DictArrayGetter )(const GU_PrimPacked *, UT_Array< UT_OptionsHolder > &) const
 
typedef void(GU_PackedImpl::* DictArraySetter )(GU_PrimPacked *, const UT_Array< UT_OptionsHolder > &)
 

Public Member Functions

 GusdGU_PackedUSD ()
 
 GusdGU_PackedUSD (const GusdGU_PackedUSD &src)
 
 ~GusdGU_PackedUSD () override
 
const UT_StringHolderfileName () const
 
UT_StringHolder intrinsicFileName () const
 
UT_StringHolder intrinsicFileName (const GU_PrimPacked *prim) const
 
void setFileName (GU_PrimPacked *prim, const UT_StringHolder &fileName)
 
const UT_StringHolderaltFileName () const
 
UT_StringHolder intrinsicAltFileName () const
 
void setAltFileName (const UT_StringHolder &fileName)
 
UT_StringHolder intrinsicAltFileName (const GU_PrimPacked *prim) const
 
void setAltFileName (GU_PrimPacked *prim, const UT_StringHolder &fileName)
 
const SdfPathprimPath () const
 
UT_StringHolder intrinsicPrimPath () const
 
UT_StringHolder intrinsicPrimPath (const GU_PrimPacked *prim) const
 
void setPrimPath (GU_PrimPacked *prim, const UT_StringHolder &p)
 
void setPrimPath (GU_PrimPacked *prim, const SdfPath &p)
 
const SdfPathsrcPrimPath () const
 
UT_StringHolder intrinsicSrcPrimPath () const
 
void setSrcPrimPath (const UT_StringHolder &p)
 
void setSrcPrimPath (const SdfPath &primPath)
 
UT_StringHolder intrinsicSrcPrimPath (const GU_PrimPacked *prim) const
 
void setSrcPrimPath (GU_PrimPacked *prim, const UT_StringHolder &p)
 
exint index () const
 
void setIndex (exint i)
 
exint index (const GU_PrimPacked *prim) const
 
void setIndex (GU_PrimPacked *prim, exint i)
 
bool isPointInstance () const
 
UT_StringHolder intrinsicType () const
 
UT_StringHolder intrinsicType (const GU_PrimPacked *prim) const
 
GA_Size usdLocalToWorldTransformSize () const
 
void usdLocalToWorldTransform (fpreal64 *val, exint size) const
 
GA_Size usdLocalToWorldTransformSize (const GU_PrimPacked *prim) const
 
void usdLocalToWorldTransform (const GU_PrimPacked *prim, fpreal64 *val, exint size) const
 
UsdTimeCode frame () const
 
fpreal intrinsicFrame () const
 
fpreal intrinsicFrame (const GU_PrimPacked *prim) const
 
void setFrame (GU_PrimPacked *prim, fpreal frame)
 
void setFrame (GU_PrimPacked *prim, UsdTimeCode frame)
 
GusdPurposeSet getPurposes () const
 
void setPurposes (GU_PrimPacked *prim, GusdPurposeSet purposes)
 
exint getNumPurposes () const
 
void getIntrinsicPurposes (UT_StringArray &purposes) const
 
exint getNumPurposes (const GU_PrimPacked *prim) const
 
void getIntrinsicPurposes (const GU_PrimPacked *prim, UT_StringArray &purposes) const
 
void setIntrinsicPurposes (GU_PrimPacked *prim, const UT_StringArray &purposes)
 
GU_PackedFactorygetFactory () const override
 Get the factory associated with this procedural. More...
 
GU_PackedImplcopy () const override
 Create a copy of this resolver. More...
 
void clearData () override
 
bool isValid () const override
 Test whether the deferred load primitive data is valid. More...
 
bool save (UT_Options &options, const GA_SaveMap &map) const override
 Copy the resolver data into the UT_Options for saving. More...
 
bool load (GU_PrimPacked *prim, const UT_Options &options, const GA_LoadMap &map) override
 Give a UT_Options of load data, create resolver data for the primitive. More...
 
void update (GU_PrimPacked *prim, const UT_Options &options) override
 
bool getBounds (UT_BoundingBox &box) const override
 Get the bounding box for the geometry (not including transforms) More...
 
bool getRenderingBounds (UT_BoundingBox &box) const override
 
void getVelocityRange (UT_Vector3 &min, UT_Vector3 &max) const override
 
void getWidthRange (fpreal &min, fpreal &max) const override
 
bool getLocalTransform (UT_Matrix4D &m) const override
 
bool unpack (GU_Detail &destgdp, const UT_Matrix4D *transform) const override
 
bool unpackUsingPolygons (GU_Detail &destgdp, const GU_PrimPacked *prim) const override
 
bool visibleGT () const
 
GT_PrimitiveHandle fullGT () const
 
bool getInstanceKey (UT_Options &key) const
 
int64 getMemoryUsage (bool inclusive) const override
 Report memory usage (includes all shared memory) More...
 
void countMemory (UT_MemoryCounter &counter, bool inclusive) const override
 
UsdPrim getUsdPrim (UT_ErrorSeverity sev=UT_ERROR_ABORT) const
 
bool unpackGeometry (GU_Detail &destgdp, const GU_Detail *srcgdp, const GA_Offset srcprimoff, const UT_StringRef &primvarPattern, bool importInheritedPrimvars, const UT_StringRef &attributePattern, bool translateSTtoUV, const UT_StringRef &nonTransformingPrimvarPattern, const UT_Matrix4D *transform, const GT_RefineParms *parms=nullptr) const
 
bool unpackGeometry (UT_Array< GU_DetailHandle > &details, const GU_Detail *srcgdp, const GA_Offset srcprimoff, const UT_StringRef &primvarPattern, bool importInheritedPrimvars, const UT_StringRef &attributePattern, bool translateSTtoUV, const UT_StringRef &nonTransformingPrimvarPattern, const UT_Matrix4D *transform, const UT_StringHolder &filePathAttrib, const UT_StringHolder &primPathAttrib, const GT_RefineParms *refineParms=nullptr) const
 
const UT_Matrix4DgetUsdTransform () const
 
- Public Member Functions inherited from GU_PackedImpl
 GU_PackedImpl ()
 
virtual ~GU_PackedImpl ()
 
 GU_PackedImpl (const GU_PackedImpl &src)=default
 
GU_PackedImploperator= (const GU_PackedImpl &src)=default
 
virtual bool supportsJSONLoad () const
 
virtual bool loadFromJSON (GU_PrimPacked *prim, const UT_JSONValueMap &options, const GA_LoadMap &map)
 
virtual bool saveSharedData (UT_JSONWriter &w, GA_SaveMap &map, GA_GeometryIndex *geo_index) const
 
virtual bool loadSharedData (int load_data_type, const GA_SharedLoadData *item)
 
virtual bool loadUnknownToken (const char *token, UT_JSONParser &p, const GA_LoadMap &map)
 
bool getBoundsCached (UT_BoundingBox &box) const
 
virtual bool getVisibleBounds (UT_BoundingBox &box) const
 
bool getVisibleBoundsCached (UT_BoundingBox &box) const
 
virtual void getPrimitiveName (const GU_PrimPacked *prim, UT_WorkBuffer &wbuf) const
 
virtual bool unpackWithContext (GU_Detail &destgdp, GU_PackedContext &context, const GU_PrimPacked *prim) const
 
bool unpack (GU_Detail &destgdp, const GU_PrimPacked *prim) const
 
virtual bool unpackWithStyler (GU_Detail &destgdp, STY_StylerGroup &prim_styler_group, const STY_Styler &parent_styler, const GU_PrimPacked *prim) const
 
virtual void forceLoad () const
 
virtual bool isLoaded () const
 
virtual GU_ConstDetailHandle getPackedDetail (GU_PackedContext *context=0) const
 
bool pointInstanceTransform () const
 
bool intrinsicPointInstanceTransform (const GU_PrimPacked *prim) const
 
void setPointInstanceTransform (GU_PrimPacked *prim, bool b)
 Set whether point instancing should be used. More...
 
virtual bool saveCachedBBox () const
 
virtual void setFacesetAttribute (const UT_StringHolder &s)
 
virtual const UT_StringHolderfacesetAttribute () const
 
virtual void setAttributeNameMap (const GEO_PackedNameMapPtr &m)
 
virtual const
GEO_PackedNameMapPtr
attributeNameMap () const
 
virtual void setSharedNameMapData (GA_SharedDataHandlePtr s)
 
SYS_FORCE_INLINE bool isShared () const
 
SYS_FORCE_INLINE GU_PackedImplcopyIfShared ()
 
int64 intrinsic3Tuple (const GU_PrimPacked *prim) const
 
int64 intrinsic6Tuple (const GU_PrimPacked *prim) const
 
int64 intrinsic9Tuple (const GU_PrimPacked *prim) const
 
int64 intrinsic16Tuple (const GU_PrimPacked *prim) const
 
std::string intrinsicPrimitiveName (const GU_PrimPacked *prim) const
 
const char * intrinsicFactoryName (const GU_PrimPacked *prim) const
 
const char * intrinsicFactoryLabel (const GU_PrimPacked *prim) const
 
void intrinsicPackedBox (const GU_PrimPacked *prim, fpreal64 *vals, exint sz) const
 
void intrinsicPackedRenderBox (const GU_PrimPacked *prim, fpreal64 *vals, exint sz) const
 
void intrinsicPivot (const GU_PrimPacked *prim, fpreal64 *vals, exint sz) const
 
void intrinsicSetPivot (GU_PrimPacked *prim, const fpreal64 *vals, exint sz)
 
void intrinsicPrimTransform (const GU_PrimPacked *prim, fpreal64 *vals, exint sz) const
 
void intrinsicSetPrimTransform (GU_PrimPacked *prim, const fpreal64 *v, exint sz)
 
void intrinsicPackedTransform (const GU_PrimPacked *prim, fpreal64 *v, exint sz) const
 
void intrinsicFullTransform (const GU_PrimPacked *prim, fpreal64 *v, exint sz) const
 
const char * intrinsicViewportLOD (const GU_PrimPacked *prim) const
 
void intrinsicSetViewportLOD (GU_PrimPacked *prim, const char *lod)
 
- Public Member Functions inherited from UT_IntrusiveRefCounter< GU_PackedImpl >
SYS_FORCE_INLINE UT_IntrusiveRefCounter () noexcept
 Default constructor: Sets counter to 0. More...
 
SYS_FORCE_INLINE UT_IntrusiveRefCounter (const UT_IntrusiveRefCounter &) noexcept
 Copy constructor: Sets counter to 0. More...
 
UT_IntrusiveRefCounteroperator= (const UT_IntrusiveRefCounter &) noexcept
 Assignment operator: Does not modify counter. More...
 
SYS_FORCE_INLINE uint32 use_count () const noexcept
 Return current counter. More...
 
SYS_FORCE_INLINE bool conditionalAddRef () noexcept
 

Static Public Member Functions

static GU_PrimPackedBuild (GU_Detail &detail, const UT_StringHolder &fileName, const SdfPath &primPath, UsdTimeCode frame, const char *lod=nullptr, GusdPurposeSet purposes=GUSD_PURPOSE_PROXY, const UsdPrim &prim=UsdPrim(), const UT_Matrix4D *xform=nullptr, PivotLocation pivotloc=PivotLocation::Origin)
 
static GU_PrimPackedBuild (GU_Detail &detail, const UT_StringHolder &fileName, const SdfPath &primPath, const SdfPath &srcPrimPath, int index, UsdTimeCode frame, const char *lod=nullptr, GusdPurposeSet purposes=GUSD_PURPOSE_PROXY, const UsdPrim &prim=UsdPrim(), const UT_Matrix4D *xform=nullptr, PivotLocation pivotloc=PivotLocation::Origin)
 
static GU_PrimPackedBuild (GU_Detail &detail, const UsdPrim &prim, UsdTimeCode frame, const char *lod=nullptr, GusdPurposeSet purpose=GUSD_PURPOSE_PROXY, const UT_Matrix4D *xform=nullptr, PivotLocation pivotloc=PivotLocation::Origin)
 Convenience method for building a packed USD prim for prim. More...
 
static void install (GA_PrimitiveFactory &factory)
 
static GA_PrimitiveTypeId typeId ()
 Get the type ID for the packed USD primitive type. More...
 
static void setPackedUSDTracker (GusdPackedUSDTracker tracker)
 
static void mergeGeometry (GU_Detail &destgdp, UT_Array< GU_DetailHandle > &details)
 
- Static Public Member Functions inherited from GU_PackedImpl
static bool computeVelocityRange (const GU_Detail *gdp, UT_Vector3 &vmin, UT_Vector3 &vmax)
 
static bool computeWidthRange (const GU_Detail *gdp, fpreal &wmin, fpreal &wmax)
 

Protected Member Functions

bool unpackWithPrim (GU_Detail &destgdp, const UT_Matrix4D *transform, const GU_PrimPacked *prim) const override
 
- Protected Member Functions inherited from GU_PackedImpl
const UT_BoundingBoxboxCache () const
 
void setBoxCache (const UT_BoundingBox &b)
 
template<typename T >
void setBoxCache (const T b[6])
 
void clearBoxCache ()
 
bool unpackToDetail (GU_Detail &destgdp, GU_Detail *src, const UT_Matrix4D *transform) const
 
bool unpackToDetail (GU_Detail &destgdp, const GU_Detail *src, const UT_Matrix4D *transform) const
 
bool unpackToDetail (GU_Detail &destgdp, const GU_ConstDetailHandle &gdh, const UT_Matrix4D *transform) const
 Unpack the source detail handle. More...
 
virtual UT_Vector3 getBaryCenter () const
 Optional method to compute centroid (default uses bounding box) More...
 
virtual fpreal computeVolume (const UT_Vector3 &refpt) const
 Optional method to calculate volume (default uses bounding box) More...
 
virtual fpreal computeArea () const
 Optional method to calculate surface area (default uses bounding box) More...
 
virtual fpreal computePerimeter () const
 Optional method to calculate perimeter (default uses bounding box) More...
 
- Protected Member Functions inherited from UT_IntrusiveRefCounter< GU_PackedImpl >
SYS_FORCE_INLINE ~UT_IntrusiveRefCounter ()
 Destructor: Only derived classes can destruct this. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from GU_PackedImpl
static void copyPrimitiveGroups (GU_Detail &dest, const GU_Detail &src, GA_Offset src_offset, bool force=false)
 
template<typename T >
static bool import (const UT_JSONValueMap &options, const UT_StringRef &key, T &value)
 
template<typename T >
static bool import (const UT_Options &options, const UT_StringRef &key, T &value)
 
- Static Protected Attributes inherited from GU_PackedImpl
static const GEO_PackedNameMapPtr theNullPackedNameMapPtr
 

Detailed Description

Definition at line 74 of file GU_PackedUSD.h.

Member Enumeration Documentation

Enumerator
Origin 
Centroid 

Definition at line 78 of file GU_PackedUSD.h.

Constructor & Destructor Documentation

GusdGU_PackedUSD::GusdGU_PackedUSD ( )
GusdGU_PackedUSD::GusdGU_PackedUSD ( const GusdGU_PackedUSD src)
GusdGU_PackedUSD::~GusdGU_PackedUSD ( )
override

Member Function Documentation

const UT_StringHolder& GusdGU_PackedUSD::altFileName ( ) const
inline

Definition at line 145 of file GU_PackedUSD.h.

static GU_PrimPacked* GusdGU_PackedUSD::Build ( GU_Detail detail,
const UT_StringHolder fileName,
const SdfPath primPath,
UsdTimeCode  frame,
const char *  lod = nullptr,
GusdPurposeSet  purposes = GUSD_PURPOSE_PROXY,
const UsdPrim prim = UsdPrim(),
const UT_Matrix4D xform = nullptr,
PivotLocation  pivotloc = PivotLocation::Origin 
)
static
static GU_PrimPacked* GusdGU_PackedUSD::Build ( GU_Detail detail,
const UT_StringHolder fileName,
const SdfPath primPath,
const SdfPath srcPrimPath,
int  index,
UsdTimeCode  frame,
const char *  lod = nullptr,
GusdPurposeSet  purposes = GUSD_PURPOSE_PROXY,
const UsdPrim prim = UsdPrim(),
const UT_Matrix4D xform = nullptr,
PivotLocation  pivotloc = PivotLocation::Origin 
)
static
static GU_PrimPacked* GusdGU_PackedUSD::Build ( GU_Detail detail,
const UsdPrim prim,
UsdTimeCode  frame,
const char *  lod = nullptr,
GusdPurposeSet  purpose = GUSD_PURPOSE_PROXY,
const UT_Matrix4D xform = nullptr,
PivotLocation  pivotloc = PivotLocation::Origin 
)
static

Convenience method for building a packed USD prim for prim.

void GusdGU_PackedUSD::clearData ( )
overridevirtual

The clearData() method is called when the primitives are stashed during the cook of a SOP. See GA_Primitive::stashed(). This gives the primitive to optionally clear some data during the stashing process.

Implements GU_PackedImpl.

GU_PackedImpl* GusdGU_PackedUSD::copy ( ) const
overridevirtual

Create a copy of this resolver.

Implements GU_PackedImpl.

void GusdGU_PackedUSD::countMemory ( UT_MemoryCounter counter,
bool  inclusive 
) const
overridevirtual

Count memory usage using a UT_MemoryCounter in order to count shared memory correctly.

Implements GU_PackedImpl.

const UT_StringHolder& GusdGU_PackedUSD::fileName ( ) const
inline

Definition at line 139 of file GU_PackedUSD.h.

UsdTimeCode GusdGU_PackedUSD::frame ( ) const
inline

Definition at line 196 of file GU_PackedUSD.h.

GT_PrimitiveHandle GusdGU_PackedUSD::fullGT ( ) const
bool GusdGU_PackedUSD::getBounds ( UT_BoundingBox box) const
overridevirtual

Get the bounding box for the geometry (not including transforms)

Implements GU_PackedImpl.

GU_PackedFactory* GusdGU_PackedUSD::getFactory ( ) const
overridevirtual

Get the factory associated with this procedural.

Implements GU_PackedImpl.

bool GusdGU_PackedUSD::getInstanceKey ( UT_Options key) const
void GusdGU_PackedUSD::getIntrinsicPurposes ( UT_StringArray purposes) const
void GusdGU_PackedUSD::getIntrinsicPurposes ( const GU_PrimPacked prim,
UT_StringArray purposes 
) const
inline

Definition at line 213 of file GU_PackedUSD.h.

bool GusdGU_PackedUSD::getLocalTransform ( UT_Matrix4D m) const
overridevirtual

Some procedurals have an "intrinsic" transform. These are combined with the local transform on the geometry primitive.

The default method returns false and leaves the transform unchanged.

Reimplemented from GU_PackedImpl.

int64 GusdGU_PackedUSD::getMemoryUsage ( bool  inclusive) const
overridevirtual

Report memory usage (includes all shared memory)

Implements GU_PackedImpl.

exint GusdGU_PackedUSD::getNumPurposes ( ) const
exint GusdGU_PackedUSD::getNumPurposes ( const GU_PrimPacked prim) const
inline

Definition at line 211 of file GU_PackedUSD.h.

GusdPurposeSet GusdGU_PackedUSD::getPurposes ( ) const
inline

Definition at line 206 of file GU_PackedUSD.h.

bool GusdGU_PackedUSD::getRenderingBounds ( UT_BoundingBox box) const
overridevirtual

Get the rendering bounding box for the geometry (not including transforms). For curve and point geometry, this needs to include any "width" attributes.

Implements GU_PackedImpl.

UsdPrim GusdGU_PackedUSD::getUsdPrim ( UT_ErrorSeverity  sev = UT_ERROR_ABORT) const

Get the underlying UsdPrim for this packed prim. This may involve on-demand loading of a UsdStage to access the prim. Any errors that occur while loading the stage and accessing the prim will be reported on the currently scoped error manager with a severity of sev.

const UT_Matrix4D& GusdGU_PackedUSD::getUsdTransform ( ) const
void GusdGU_PackedUSD::getVelocityRange ( UT_Vector3 min,
UT_Vector3 max 
) const
overridevirtual

When rendering with velocity blur, the renderer needs to know the bounds on velocity to accurately compute the bounding box.

Implements GU_PackedImpl.

void GusdGU_PackedUSD::getWidthRange ( fpreal wmin,
fpreal wmax 
) const
overridevirtual

When rendering points or curves, the renderer needs to know the bounds on the width attribute to accurately compute the bounding box.

Implements GU_PackedImpl.

exint GusdGU_PackedUSD::index ( ) const
inline

Definition at line 173 of file GU_PackedUSD.h.

exint GusdGU_PackedUSD::index ( const GU_PrimPacked prim) const
inline

Definition at line 175 of file GU_PackedUSD.h.

static void GusdGU_PackedUSD::install ( GA_PrimitiveFactory factory)
static
UT_StringHolder GusdGU_PackedUSD::intrinsicAltFileName ( ) const
inline

Definition at line 146 of file GU_PackedUSD.h.

UT_StringHolder GusdGU_PackedUSD::intrinsicAltFileName ( const GU_PrimPacked prim) const
inline

Definition at line 148 of file GU_PackedUSD.h.

UT_StringHolder GusdGU_PackedUSD::intrinsicFileName ( ) const
inline

Definition at line 140 of file GU_PackedUSD.h.

UT_StringHolder GusdGU_PackedUSD::intrinsicFileName ( const GU_PrimPacked prim) const
inline

Definition at line 141 of file GU_PackedUSD.h.

fpreal GusdGU_PackedUSD::intrinsicFrame ( ) const
inline

Definition at line 197 of file GU_PackedUSD.h.

fpreal GusdGU_PackedUSD::intrinsicFrame ( const GU_PrimPacked prim) const
inline

Definition at line 198 of file GU_PackedUSD.h.

UT_StringHolder GusdGU_PackedUSD::intrinsicPrimPath ( ) const
inline

Definition at line 154 of file GU_PackedUSD.h.

UT_StringHolder GusdGU_PackedUSD::intrinsicPrimPath ( const GU_PrimPacked prim) const
inline

Definition at line 155 of file GU_PackedUSD.h.

UT_StringHolder GusdGU_PackedUSD::intrinsicSrcPrimPath ( ) const
inline

Definition at line 163 of file GU_PackedUSD.h.

UT_StringHolder GusdGU_PackedUSD::intrinsicSrcPrimPath ( const GU_PrimPacked prim) const
inline

Definition at line 166 of file GU_PackedUSD.h.

UT_StringHolder GusdGU_PackedUSD::intrinsicType ( ) const
UT_StringHolder GusdGU_PackedUSD::intrinsicType ( const GU_PrimPacked prim) const
inline

Definition at line 185 of file GU_PackedUSD.h.

bool GusdGU_PackedUSD::isPointInstance ( ) const
inline

Definition at line 181 of file GU_PackedUSD.h.

bool GusdGU_PackedUSD::isValid ( ) const
overridevirtual

Test whether the deferred load primitive data is valid.

Implements GU_PackedImpl.

bool GusdGU_PackedUSD::load ( GU_PrimPacked prim,
const UT_Options options,
const GA_LoadMap map 
)
overridevirtual

Give a UT_Options of load data, create resolver data for the primitive.

Implements GU_PackedImpl.

static void GusdGU_PackedUSD::mergeGeometry ( GU_Detail destgdp,
UT_Array< GU_DetailHandle > &  details 
)
static

Merges the details together, and also updates the usdconfigconstantattribs detail attribute.

const SdfPath& GusdGU_PackedUSD::primPath ( ) const
inline

Definition at line 153 of file GU_PackedUSD.h.

bool GusdGU_PackedUSD::save ( UT_Options options,
const GA_SaveMap map 
) const
overridevirtual

Copy the resolver data into the UT_Options for saving.

Implements GU_PackedImpl.

void GusdGU_PackedUSD::setAltFileName ( const UT_StringHolder fileName)
void GusdGU_PackedUSD::setAltFileName ( GU_PrimPacked prim,
const UT_StringHolder fileName 
)
inline

Definition at line 150 of file GU_PackedUSD.h.

void GusdGU_PackedUSD::setFileName ( GU_PrimPacked prim,
const UT_StringHolder fileName 
)
void GusdGU_PackedUSD::setFrame ( GU_PrimPacked prim,
fpreal  frame 
)
void GusdGU_PackedUSD::setFrame ( GU_PrimPacked prim,
UsdTimeCode  frame 
)
void GusdGU_PackedUSD::setIndex ( exint  i)
void GusdGU_PackedUSD::setIndex ( GU_PrimPacked prim,
exint  i 
)
inline

Definition at line 177 of file GU_PackedUSD.h.

void GusdGU_PackedUSD::setIntrinsicPurposes ( GU_PrimPacked prim,
const UT_StringArray purposes 
)
static void GusdGU_PackedUSD::setPackedUSDTracker ( GusdPackedUSDTracker  tracker)
static

Sets a static callback that is used for tracking all packed USD prims. This callback method lives in HUSD_LockedStageRegistry. It holds on to an HUSD_LockedStagePtr for each GU_PackedUSD that exists. When the packed prims are all destroyed, the locked stage can be released.

void GusdGU_PackedUSD::setPrimPath ( GU_PrimPacked prim,
const UT_StringHolder p 
)
void GusdGU_PackedUSD::setPrimPath ( GU_PrimPacked prim,
const SdfPath p 
)
void GusdGU_PackedUSD::setPurposes ( GU_PrimPacked prim,
GusdPurposeSet  purposes 
)
void GusdGU_PackedUSD::setSrcPrimPath ( const UT_StringHolder p)
void GusdGU_PackedUSD::setSrcPrimPath ( const SdfPath primPath)
void GusdGU_PackedUSD::setSrcPrimPath ( GU_PrimPacked prim,
const UT_StringHolder p 
)
inline

Definition at line 168 of file GU_PackedUSD.h.

const SdfPath& GusdGU_PackedUSD::srcPrimPath ( ) const
inline

Definition at line 162 of file GU_PackedUSD.h.

static GA_PrimitiveTypeId GusdGU_PackedUSD::typeId ( )
inlinestatic

Get the type ID for the packed USD primitive type.

Definition at line 128 of file GU_PackedUSD.h.

bool GusdGU_PackedUSD::unpack ( GU_Detail destgdp,
const UT_Matrix4D transform 
) const
overridevirtual

Unpacks this into destgdp, transforming the new geometry by the given transform. If transform is nullptr, no transform will be applied.

Implements GU_PackedImpl.

bool GusdGU_PackedUSD::unpackGeometry ( GU_Detail destgdp,
const GU_Detail srcgdp,
const GA_Offset  srcprimoff,
const UT_StringRef primvarPattern,
bool  importInheritedPrimvars,
const UT_StringRef attributePattern,
bool  translateSTtoUV,
const UT_StringRef nonTransformingPrimvarPattern,
const UT_Matrix4D transform,
const GT_RefineParms parms = nullptr 
) const
bool GusdGU_PackedUSD::unpackGeometry ( UT_Array< GU_DetailHandle > &  details,
const GU_Detail srcgdp,
const GA_Offset  srcprimoff,
const UT_StringRef primvarPattern,
bool  importInheritedPrimvars,
const UT_StringRef attributePattern,
bool  translateSTtoUV,
const UT_StringRef nonTransformingPrimvarPattern,
const UT_Matrix4D transform,
const UT_StringHolder filePathAttrib,
const UT_StringHolder primPathAttrib,
const GT_RefineParms refineParms = nullptr 
) const

Convert the USD geometry into one or more GU_Detail's. Use mergeGeometry() to merge the geometry into a destination detail. This signature can be used when performing the geometry conversion in parallel for many prims.

bool GusdGU_PackedUSD::unpackUsingPolygons ( GU_Detail destgdp,
const GU_PrimPacked prim 
) const
overridevirtual

Unpack the procedural into a GU_Detail using polygons instead of polygon soups. The default method just unpacks, then converts polygon soups to polygons.

Reimplemented from GU_PackedImpl.

bool GusdGU_PackedUSD::unpackWithPrim ( GU_Detail destgdp,
const UT_Matrix4D transform,
const GU_PrimPacked prim 
) const
overrideprotectedvirtual

This signature is just for the questionable purpose of copying primitive group membership from prim, so it might be removed in the future.

Reimplemented from GU_PackedImpl.

void GusdGU_PackedUSD::update ( GU_PrimPacked prim,
const UT_Options options 
)
overridevirtual

Depending on the update, the procedural should call one of:

  • prim->transformDirty()
  • prim->attributeDirty()
  • prim->topologyDirty()

Implements GU_PackedImpl.

void GusdGU_PackedUSD::usdLocalToWorldTransform ( fpreal64 val,
exint  size 
) const
void GusdGU_PackedUSD::usdLocalToWorldTransform ( const GU_PrimPacked prim,
fpreal64 val,
exint  size 
) const
inline

Definition at line 192 of file GU_PackedUSD.h.

GA_Size GusdGU_PackedUSD::usdLocalToWorldTransformSize ( ) const
inline

Definition at line 188 of file GU_PackedUSD.h.

GA_Size GusdGU_PackedUSD::usdLocalToWorldTransformSize ( const GU_PrimPacked prim) const
inline

Definition at line 190 of file GU_PackedUSD.h.

bool GusdGU_PackedUSD::visibleGT ( ) const

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