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

Single Alembic shape (non-instanced) More...

#include <GABC_PackedGT.h>

+ Inheritance diagram for GABC_NAMESPACE::GABC_PackedAlembic:

Public Member Functions

 GABC_PackedAlembic (const GU_ConstDetailHandle &prim_gdh, const GU_PrimPacked *prim, const GT_DataArrayHandle &vp_mat, const GT_DataArrayHandle &vp_remap, bool build_packed_attribs=false)
 
 GABC_PackedAlembic (const GABC_PackedAlembic &src)
 
 ~GABC_PackedAlembic () override
 
void initVisAnim () override
 
const char * className () const override
 
GT_PrimitiveHandle doSoftCopy () const override
 
GT_PrimitiveHandle getPointCloud (const GT_RefineParms *p, bool &xform) const override
 
GT_PrimitiveHandle getFullGeometry (const GT_RefineParms *p, bool &xform) const override
 
GT_PrimitiveHandle getBoxGeometry (const GT_RefineParms *p) const override
 
GT_PrimitiveHandle getCentroidGeometry (const GT_RefineParms *p) const override
 
bool canInstance () const override
 
bool getInstanceKey (UT_Options &options) const override
 
GT_PrimitiveHandle getInstanceGeometry (const GT_RefineParms *p, bool ignore_visibility=false) const override
 
GT_TransformHandle getInstanceTransform () const override
 
bool isVisible () override
 
bool refine (GT_Refine &refiner, const GT_RefineParms *parms=NULL) const override
 
bool getCachedGeometry (GT_PrimitiveHandle &ph) const override
 
void getCachedTransform (GT_TransformHandle &ph) const override
 
void getCachedVisibility (bool &visible) const override
 
bool updateGeoPrim (const GU_ConstDetailHandle &dtl, const GT_RefineParms &refine) override
 update any cached data for geometry and its attributes More...
 
- Public Member Functions inherited from GT_PackedAlembic
 GT_PackedAlembic (const GU_ConstDetailHandle &prim_gdh, const GU_PrimPacked *prim, const GT_DataArrayHandle &vp_mat, const GT_DataArrayHandle &vp_remap, bool build_packed_attribs)
 
 GT_PackedAlembic (const GT_PackedAlembic &src)
 
 ~GT_PackedAlembic () override
 
int getPrimitiveType () const override
 
bool hasChanged () const
 
void changeProcessed ()
 
bool needsInit () const
 
void initProcessed ()
 
GT_TransformHandle fullCachedTransform ()
 
bool getUniqueID (int64 &id) const override
 
void setAnimationType (GEO_AnimationType t)
 
GEO_AnimationType animationType () const
 
void setVisibilityAnimated (bool anim)
 
bool visibilityAnimated () const
 
GT_TransformHandle applyPrimTransform (const GT_TransformHandle &th) const
 
int64 alembicVersion () const
 
void setAlembicVersion (int64 v)
 
const GT_AttributeListHandlegetDetailAttributes () const override
 
- Public Member Functions inherited from GT_GEOPrimPacked
 GT_GEOPrimPacked (const GU_ConstDetailHandle &prim_gdh, const GU_PrimPacked *prim, bool transformed=true, bool include_packed_attribs=false)
 
 GT_GEOPrimPacked (const GT_GEOPrimPacked &src)
 
 ~GT_GEOPrimPacked () override
 
bool refine (GT_Refine &refiner, const GT_RefineParms *parms=NULL) const override
 
void geometryAndTransform (const GT_RefineParms *parms, GT_PrimitiveHandle &result, GT_TransformHandle &xform) const
 
bool getViewportTransform (UT_Matrix4D &xform) const
 
virtual GT_AttributeListHandle getInstanceAttributes () const
 
GT_TransformHandle getFullTransform () const
 
const GU_PrimPackedgetPrim () const
 Accessor to the primitive. More...
 
const GU_PackedImplgetImplementation () const
 Accessor to the packed implementation. More...
 
virtual GU_ConstDetailHandle getPackedDetail () const
 
const char * className () const override
 
void enlargeBounds (UT_BoundingBox boxes[], int nseg) const override
 
void enlargeRenderBounds (UT_BoundingBox boxes[], int nseg) const override
 
void getVelocityRange (UT_Vector3 &vmin, UT_Vector3 &vmax, const UT_StringRef &attribute_name) const override
 
int getMotionSegments () const override
 
int64 getMemoryUsage () const override
 
bool save (UT_JSONWriter &w) const override
 
const GT_ViewportRefineOptionsviewportRefineOptions () const override
 
GT_PrimitiveHandle doSoftCopy () const override
 
const GT_AttributeListHandlegetPointAttributes () const override
 
bool transformed () const
 
void setTransformed (bool f)
 
virtual void setViewportLOD (GEO_ViewportLOD, int)
 
virtual GEO_ViewportLOD getViewportLOD (int) const
 
- Public Member Functions inherited from GT_Primitive
 GT_Primitive ()
 
 GT_Primitive (const GT_Primitive &src)
 
virtual ~GT_Primitive ()
 
const GT_TransformHandlegetPrimitiveTransform () const
 
void setPrimitiveTransform (const GT_TransformHandle &x)
 Set the transform for a the primitive. More...
 
GT_PrimitiveHandle clone () const
 
virtual bool hasDataArray (const UT_StringRef &name, GT_Owner owner_scope[], int num_owners, GT_Storage *storage=NULL, GT_Size *tuple_size=NULL) const
 
void setStaticGeometry (bool static_geo)
 Return true if the primitive represents geometry at frame 'fr'. More...
 
bool isStaticGeometry () const
 
bool isFrameInfoAvailable () const
 
bool getDataIdHash (int64 &hash, int segment=0, bool cache_data_id=false) const
 
virtual bool getTopologyVersion (int64 &version) const
 Returns the topology version for the primitive. More...
 
GT_DataArrayHandle findAttribute (const UT_StringRef &name, GT_Owner &owner, int segment) const
 
void dumpAttributeLists (const char *label, bool data_too) const
 print out all attribute lists More...
 
void dumpPrimitive () const
 
bool saveAttributeLists (UT_JSONWriter &w) const
 
GT_PrimitiveHandle harden () const
 
GT_PrimitiveHandle copyTransformed (const GT_TransformHandle &x, bool force=false) const
 
void refineCopyTransformFrom (const GT_Primitive &src)
 
GT_PrimitiveHandle attributeMerge (const GT_Primitive &src, const UT_StringMMPattern *vertex_pattern, const UT_StringMMPattern *point_pattern, const UT_StringMMPattern *uniform_pattern, const UT_StringMMPattern *detail_pattern) const
 
virtual GT_PrimitiveHandle doAttributeMerge (const GT_Primitive &src, const UT_StringMMPattern *vertex, const UT_StringMMPattern *point, const UT_StringMMPattern *uniform, const UT_StringMMPattern *detail) const
 The virtual implementation of attribute merging. More...
 
bool enlargeWidth (UT_BoundingBox boxes[], int nsegments, fpreal defwidth=-1) const
 
virtual const
GT_AttributeListHandle
getVertexAttributes () const
 
virtual const
GT_AttributeListHandle
getUniformAttributes () const
 
const GT_AttributeListHandlegetAttributeList (GT_Owner owner) const
 
virtual const GT_DataArrayHandlegetVertexList () const
 
virtual GT_DataArrayHandle createPointNormals (int segment=0, const UT_StringRef &P=GA_Names::P, bool normalize=true, const fpreal32 *pntdata=NULL, GT_Storage store=GT_STORE_REAL32) const
 
virtual fpreal computePerimeter (int seg=0) const
 
virtual fpreal computeSurfaceArea (int seg=0) const
 
virtual fpreal computeVolume (const UT_Vector3 &ref_P, int seg=0) const
 
- Public Member Functions inherited from UT_IntrusiveRefCounter< GT_Primitive >
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...
 

Additional Inherited Members

- Static Public Member Functions inherited from GT_GEOPrimPacked
static bool useViewportLOD (const GT_RefineParms *parms)
 
- Static Public Member Functions inherited from GT_Primitive
static int createPrimitiveTypeId ()
 
static GT_AttributeListHandle mergeAttributeLists (bool &changed, const GT_AttributeListHandle &src, const GT_AttributeListHandle &merge, const UT_StringMMPattern *pattern, const UT_StringMMPattern *alternate=NULL)
 
static bool computeVelocityRange (UT_Vector3 &vmin, UT_Vector3 &vmax, const GT_DataArrayHandle &v)
 
static GT_PrimitiveHandle refineDetail (const GU_ConstDetailHandle &detail, const GT_RefineParms *parms)
 
static GT_PrimitiveHandle refinePrimitive (const GT_PrimitiveHandle &primh, const GT_RefineParms *parms)
 
static voidoperator new (size_t size)
 
static voidoperator new (size_t size, void *p)
 
static void operator delete (void *p, size_t size)
 
- Protected Member Functions inherited from GT_GEOPrimPacked
virtual bool copyPackedAttributesToGeometry () const
 
GT_PrimitiveHandle buildUntransformedFragment (const GU_ConstDetailHandle &fragment_gdh, const GA_Range &range) const
 
void createPointPrimIDs (bool include_packed_attribs)
 
void appendAttribute (const char *name, const GT_DataArrayHandle &attrib)
 
GT_PrimitiveHandle doHarden () const override
 Hardening a packed primitive will extract the full geometry. More...
 
void setDetailPrim (const GU_ConstDetailHandle &dh, const GU_PrimPacked *prim)
 
- Protected Member Functions inherited from GT_Primitive
void enlargeP (UT_BoundingBox &box, const GT_AttributeListHandle &list, int segment) const
 
void enlargeP (UT_BoundingBox &B, const GT_DataArrayHandle &P) const
 Convenience method to enlarge a bounding box given a position attribute. More...
 
void enlargePw (UT_BoundingBox &B, const GT_DataArrayHandle &P) const
 
- Protected Member Functions inherited from UT_IntrusiveRefCounter< GT_Primitive >
SYS_FORCE_INLINE ~UT_IntrusiveRefCounter ()
 Destructor: Only derived classes can destruct this. More...
 
- Protected Attributes inherited from GT_PackedAlembic
int64 myID
 
GEO_AnimationType myAnimType
 
GEO_ViewportLOD myLOD
 
GT_AttributeListHandle myDetailAttribs
 
int64 myAlembicVersion
 
GA_Offset myOffset
 
float myFrame
 
unsigned myHasChanged: 1
 
unsigned myAnimVis: 1
 
unsigned myVisibleConst: 1
 
unsigned myNeedsInit: 1
 

Detailed Description

Single Alembic shape (non-instanced)

Definition at line 119 of file GABC_PackedGT.h.

Constructor & Destructor Documentation

GABC_NAMESPACE::GABC_PackedAlembic::GABC_PackedAlembic ( const GU_ConstDetailHandle prim_gdh,
const GU_PrimPacked prim,
const GT_DataArrayHandle vp_mat,
const GT_DataArrayHandle vp_remap,
bool  build_packed_attribs = false 
)
GABC_NAMESPACE::GABC_PackedAlembic::GABC_PackedAlembic ( const GABC_PackedAlembic src)
GABC_NAMESPACE::GABC_PackedAlembic::~GABC_PackedAlembic ( )
override

Member Function Documentation

bool GABC_NAMESPACE::GABC_PackedAlembic::canInstance ( ) const
inlineoverridevirtual

Test whether instancing of the underlying geometry can be done Returns false by default. If you return true, you must implement

Reimplemented from GT_GEOPrimPacked.

Definition at line 147 of file GABC_PackedGT.h.

const char* GABC_NAMESPACE::GABC_PackedAlembic::className ( ) const
inlineoverridevirtual

Implements GT_Primitive.

Definition at line 133 of file GABC_PackedGT.h.

GT_PrimitiveHandle GABC_NAMESPACE::GABC_PackedAlembic::doSoftCopy ( ) const
inlineoverridevirtual

Create a copy of the primitive, referencing all the source data This can return a NULL pointer, but it would be better to implement it properly.

Implements GT_Primitive.

Definition at line 136 of file GABC_PackedGT.h.

GT_PrimitiveHandle GABC_NAMESPACE::GABC_PackedAlembic::getBoxGeometry ( const GT_RefineParms parms) const
overridevirtual

Sub-classes may want to override these methods which currently just call the bounding box method and create transformed geometry based on the bounds. The box & centroid should be untransformed.

Reimplemented from GT_GEOPrimPacked.

bool GABC_NAMESPACE::GABC_PackedAlembic::getCachedGeometry ( GT_PrimitiveHandle ph) const
overridevirtual

Implements GT_PackedAlembic.

void GABC_NAMESPACE::GABC_PackedAlembic::getCachedTransform ( GT_TransformHandle ph) const
overridevirtual

Implements GT_PackedAlembic.

void GABC_NAMESPACE::GABC_PackedAlembic::getCachedVisibility ( bool &  visible) const
overridevirtual

Implements GT_PackedAlembic.

GT_PrimitiveHandle GABC_NAMESPACE::GABC_PackedAlembic::getCentroidGeometry ( const GT_RefineParms parms) const
overridevirtual

Sub-classes may want to override these methods which currently just call the bounding box method and create transformed geometry based on the bounds. The box & centroid should be untransformed.

Reimplemented from GT_GEOPrimPacked.

GT_PrimitiveHandle GABC_NAMESPACE::GABC_PackedAlembic::getFullGeometry ( const GT_RefineParms parms,
bool &  requires_transform 
) const
overridevirtual

Sub-classes may want to override these methods which currently just call getPackedDetail() and unpack() to access the geometry. These methods should return the "untransformed" primitives.

Warning
It is important to ensure that the primitive attributes refer to the GU_PrimPacked primitive, vertex, point. For example, in GT_GEODetailList, you'd want to set the primitive id otherwise you'll get crashes in the viewport as it tries to dereference the points/vertices in the base detail (not the packed detail).

If requires_transform is false if the point cloud is in the primitive's transformed space (the same as unpacking). If it's true the packed transform will be applied to the resulting primitive (without modifying the returned geometry). require_transform will be true by default, so it doesn't have to be written in most cases.

Reimplemented from GT_GEOPrimPacked.

GT_PrimitiveHandle GABC_NAMESPACE::GABC_PackedAlembic::getInstanceGeometry ( const GT_RefineParms parms,
bool  ignore_visibility = false 
) const
overridevirtual

Return the geometry the geometry for instancing. This may be different than getFullGeometry() in that

  • The geometry should not be transformed
  • The packed primitive attributes should not be included in the geometry This allows multiple instances to share the geometry unmodified The default method returns a NULL ptr.

Reimplemented from GT_GEOPrimPacked.

bool GABC_NAMESPACE::GABC_PackedAlembic::getInstanceKey ( UT_Options options) const
overridevirtual

If "instancing" is supported by the packed primitive, this method should return true. The options that define the packed primitive should be stored in the UT_Options. Primitives which have matching UT_Options can be considered to be shared.

Reimplemented from GT_GEOPrimPacked.

GT_TransformHandle GABC_NAMESPACE::GABC_PackedAlembic::getInstanceTransform ( ) const
overridevirtual

Return the transform handle for this particular instance. This method should return the transform required to transform the instance geometry to the space of this instance. The default method returns an identity transform.

Reimplemented from GT_GEOPrimPacked.

GT_PrimitiveHandle GABC_NAMESPACE::GABC_PackedAlembic::getPointCloud ( const GT_RefineParms parms,
bool &  requires_transform 
) const
overridevirtual

Sub-classes may want to override these methods which currently just call getPackedDetail() and unpack() to access the geometry. These methods should return the "untransformed" primitives.

Warning
It is important to ensure that the primitive attributes refer to the GU_PrimPacked primitive, vertex, point. For example, in GT_GEODetailList, you'd want to set the primitive id otherwise you'll get crashes in the viewport as it tries to dereference the points/vertices in the base detail (not the packed detail).

If requires_transform is false if the point cloud is in the primitive's transformed space (the same as unpacking). If it's true the packed transform will be applied to the resulting primitive (without modifying the returned geometry). require_transform will be true by default, so it doesn't have to be written in most cases.

Reimplemented from GT_GEOPrimPacked.

void GABC_NAMESPACE::GABC_PackedAlembic::initVisAnim ( )
overridevirtual

Implements GT_PackedAlembic.

bool GABC_NAMESPACE::GABC_PackedAlembic::isVisible ( )
overridevirtual

Implements GT_PackedAlembic.

bool GABC_NAMESPACE::GABC_PackedAlembic::refine ( GT_Refine refiner,
const GT_RefineParms parms = NULL 
) const
overridevirtual

Refine the primitive.

  • refiner
    The refiner object is responsible for processing primitives, and also giving the primitive hints on how to refine itself. The method should returns true if new primitives were added to the refiner.

Reimplemented from GT_Primitive.

bool GABC_NAMESPACE::GABC_PackedAlembic::updateGeoPrim ( const GU_ConstDetailHandle dtl,
const GT_RefineParms parms 
)
overridevirtual

update any cached data for geometry and its attributes

Reimplemented from GT_Primitive.


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