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

A mesh of linear or cubic patches. More...

#include <GT_PrimPatch.h>

+ Inheritance diagram for GT_PrimPatch:

Public Member Functions

 GT_PrimPatch ()
 
 GT_PrimPatch (const GT_PrimPatch &src)
 
 GT_PrimPatch (const GT_PrimPatch &src, const GT_AttributeListHandle &vertex, const GT_AttributeListHandle &uniform, const GT_AttributeListHandle &detail)
 
 GT_PrimPatch (GT_Basis basis, int nu, bool uwrap, int nv, bool vwrap, const GT_AttributeListHandle &vertex, const GT_AttributeListHandle &uniform, const GT_AttributeListHandle &detail)
 
 ~GT_PrimPatch () override
 
const char * className () const override
 
bool save (UT_JSONWriter &w) const override
 
bool init (GT_Basis basis, int nu, bool uwrap, int nv, bool vwrap, const GT_AttributeListHandle &vertex, const GT_AttributeListHandle &uniform, const GT_AttributeListHandle &detail)
 
GT_PrimitiveHandle doHarden () const override
 Harden all attributes so there are no dangling dependencies. More...
 
GT_PrimitiveHandle doSoftCopy () const override
 
GT_PrimitiveHandle doAttributeMerge (const GT_Primitive &src, const UT_StringMMPattern *vertex, const UT_StringMMPattern *point, const UT_StringMMPattern *uniform, const UT_StringMMPattern *detail) const override
 The virtual implementation of attribute merging. More...
 
bool refineToPolyMesh (GT_Refine &refine, const GT_RefineParms *parms=NULL) const
 Refine to a single polygon mesh. More...
 
void enlargeBounds (UT_BoundingBox boxes[], int nsegments) const override
 
int getPrimitiveType () const override
 
bool refine (GT_Refine &refiner, const GT_RefineParms *parms) const override
 
int getMotionSegments () const override
 
int64 getMemoryUsage () const override
 
GT_Basis getBasis () const
 
int getNu () const
 
int getNv () const
 
bool getUWrap () const
 
bool getVWrap () const
 
const GT_AttributeListHandlegetVertex () const
 
const GT_AttributeListHandlegetUniform () const
 
const GT_AttributeListHandlegetDetail () const
 
int getNuWrapped () const
 
int getNvWrapped () const
 
const GT_AttributeListHandlegetVertexAttributes () const override
 
const GT_AttributeListHandlegetUniformAttributes () const override
 
const GT_AttributeListHandlegetDetailAttributes () const override
 
- Public Member Functions inherited from GT_Primitive
 GT_Primitive ()
 
 GT_Primitive (const GT_Primitive &src)
 
virtual ~GT_Primitive ()
 
virtual bool getUniqueID (int64 &id) const
 
virtual void enlargeRenderBounds (UT_BoundingBox boxes[], int nsegments) const
 
virtual void getVelocityRange (UT_Vector3 &min, UT_Vector3 &max, const UT_StringRef &attribute_name=GA_Names::v) const
 
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
 
virtual bool updateGeoPrim (const GU_ConstDetailHandle &dtl, const GT_RefineParms &parms)
 update any cached data for geometry and its attributes More...
 
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
 
virtual const
GT_ViewportRefineOptions
viewportRefineOptions () 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
 
bool enlargeWidth (UT_BoundingBox boxes[], int nsegments, fpreal defwidth=-1) const
 
virtual const
GT_AttributeListHandle
getPointAttributes () 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...
 
SYS_FORCE_INLINE bool conditionalAddRef () noexcept
 

Static Public Member Functions

static GT_PrimitiveHandle makePatchRows (GT_Basis basis, int nu, bool uwrap, int nv, bool vwrap, const GT_AttributeListHandle &vertex, const GT_AttributeListHandle &detail)
 
static GT_PrimitiveHandle makePatchCols (GT_Basis basis, int nu, bool uwrap, int nv, bool vwrap, const GT_AttributeListHandle &vertex, const GT_AttributeListHandle &detail)
 
static GT_PrimitiveHandle makePatchRowsCols (GT_Basis basis, int nu, bool uwrap, int nv, bool vwrap, const GT_AttributeListHandle &vertex, const GT_AttributeListHandle &detail)
 
static GT_PrimitiveHandle makePatchTriangles (int nu, bool uwrap, int nv, bool vwrap, const GT_AttributeListHandle &vertex, const GT_AttributeListHandle &detail)
 
static GT_PrimitiveHandle makePatchAlternatingTriangles (int nu, bool uwrap, int nv, bool vwrap, const GT_AttributeListHandle &vertex, const GT_AttributeListHandle &detail)
 
static GT_PrimitiveHandle makePatchReverseTriangles (int nu, bool uwrap, int nv, bool vwrap, const GT_AttributeListHandle &vertex, const GT_AttributeListHandle &detail)
 
- 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)
 

Additional Inherited Members

- 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...
 

Detailed Description

A mesh of linear or cubic patches.

Definition at line 18 of file GT_PrimPatch.h.

Constructor & Destructor Documentation

GT_PrimPatch::GT_PrimPatch ( )
GT_PrimPatch::GT_PrimPatch ( const GT_PrimPatch src)
inline

Definition at line 22 of file GT_PrimPatch.h.

GT_PrimPatch::GT_PrimPatch ( const GT_PrimPatch src,
const GT_AttributeListHandle vertex,
const GT_AttributeListHandle uniform,
const GT_AttributeListHandle detail 
)
inline

Definition at line 34 of file GT_PrimPatch.h.

GT_PrimPatch::GT_PrimPatch ( GT_Basis  basis,
int  nu,
bool  uwrap,
int  nv,
bool  vwrap,
const GT_AttributeListHandle vertex,
const GT_AttributeListHandle uniform,
const GT_AttributeListHandle detail 
)
inline

Definition at line 49 of file GT_PrimPatch.h.

GT_PrimPatch::~GT_PrimPatch ( )
override

Member Function Documentation

const char* GT_PrimPatch::className ( ) const
inlineoverridevirtual

Implements GT_Primitive.

Definition at line 58 of file GT_PrimPatch.h.

GT_PrimitiveHandle GT_PrimPatch::doAttributeMerge ( const GT_Primitive src,
const UT_StringMMPattern vertex,
const UT_StringMMPattern point,
const UT_StringMMPattern uniform,
const UT_StringMMPattern detail 
) const
overridevirtual

The virtual implementation of attribute merging.

Reimplemented from GT_Primitive.

GT_PrimitiveHandle GT_PrimPatch::doHarden ( ) const
overridevirtual

Harden all attributes so there are no dangling dependencies.

Reimplemented from GT_Primitive.

GT_PrimitiveHandle GT_PrimPatch::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 140 of file GT_PrimPatch.h.

void GT_PrimPatch::enlargeBounds ( UT_BoundingBox  boxes[],
int  nsegments 
) const
overridevirtual

Methods defined on GT_Primitive

Implements GT_Primitive.

GT_Basis GT_PrimPatch::getBasis ( ) const
inline

Accessor

Definition at line 126 of file GT_PrimPatch.h.

const GT_AttributeListHandle& GT_PrimPatch::getDetail ( ) const
inline

Accessor

Definition at line 133 of file GT_PrimPatch.h.

const GT_AttributeListHandle& GT_PrimPatch::getDetailAttributes ( ) const
inlineoverridevirtual

Access attributes

Reimplemented from GT_Primitive.

Definition at line 158 of file GT_PrimPatch.h.

int64 GT_PrimPatch::getMemoryUsage ( ) const
overridevirtual

Methods defined on GT_Primitive

Implements GT_Primitive.

int GT_PrimPatch::getMotionSegments ( ) const
overridevirtual

Methods defined on GT_Primitive

Implements GT_Primitive.

int GT_PrimPatch::getNu ( ) const
inline

Accessor

Definition at line 127 of file GT_PrimPatch.h.

int GT_PrimPatch::getNuWrapped ( ) const
inline

Accessor

Definition at line 134 of file GT_PrimPatch.h.

int GT_PrimPatch::getNv ( ) const
inline

Accessor

Definition at line 128 of file GT_PrimPatch.h.

int GT_PrimPatch::getNvWrapped ( ) const
inline

Accessor

Definition at line 135 of file GT_PrimPatch.h.

int GT_PrimPatch::getPrimitiveType ( ) const
overridevirtual

Methods defined on GT_Primitive

Reimplemented from GT_Primitive.

const GT_AttributeListHandle& GT_PrimPatch::getUniform ( ) const
inline

Accessor

Definition at line 132 of file GT_PrimPatch.h.

const GT_AttributeListHandle& GT_PrimPatch::getUniformAttributes ( ) const
inlineoverridevirtual

Access attributes

Reimplemented from GT_Primitive.

Definition at line 156 of file GT_PrimPatch.h.

bool GT_PrimPatch::getUWrap ( ) const
inline

Accessor

Definition at line 129 of file GT_PrimPatch.h.

const GT_AttributeListHandle& GT_PrimPatch::getVertex ( ) const
inline

Accessor

Definition at line 131 of file GT_PrimPatch.h.

const GT_AttributeListHandle& GT_PrimPatch::getVertexAttributes ( ) const
inlineoverridevirtual

Access attributes

Reimplemented from GT_Primitive.

Definition at line 154 of file GT_PrimPatch.h.

bool GT_PrimPatch::getVWrap ( ) const
inline

Accessor

Definition at line 130 of file GT_PrimPatch.h.

bool GT_PrimPatch::init ( GT_Basis  basis,
int  nu,
bool  uwrap,
int  nv,
bool  vwrap,
const GT_AttributeListHandle vertex,
const GT_AttributeListHandle uniform,
const GT_AttributeListHandle detail 
)

Construct a simple patch:

  • nu
    Number of columns
  • nv
    Number of rows
  • uwrap
    Whether the patch is connected between the last and first columns.
  • vwrap
    Whether the patch is connected between the last and first rows.
  • vertex
    Attribute data per vertex (nu * nv elements)
  • uniform
    Uniform values for patch faces. The number of entries should be:
    • Linear: (nu + uwrapped - 1) * (nv + vwrapped - 1)
static GT_PrimitiveHandle GT_PrimPatch::makePatchAlternatingTriangles ( int  nu,
bool  uwrap,
int  nv,
bool  vwrap,
const GT_AttributeListHandle vertex,
const GT_AttributeListHandle detail 
)
static

Construct a curve mesh from a patch of vertices

static GT_PrimitiveHandle GT_PrimPatch::makePatchCols ( GT_Basis  basis,
int  nu,
bool  uwrap,
int  nv,
bool  vwrap,
const GT_AttributeListHandle vertex,
const GT_AttributeListHandle detail 
)
static

Construct a curve mesh from a patch of vertices

static GT_PrimitiveHandle GT_PrimPatch::makePatchReverseTriangles ( int  nu,
bool  uwrap,
int  nv,
bool  vwrap,
const GT_AttributeListHandle vertex,
const GT_AttributeListHandle detail 
)
static

Construct a curve mesh from a patch of vertices

static GT_PrimitiveHandle GT_PrimPatch::makePatchRows ( GT_Basis  basis,
int  nu,
bool  uwrap,
int  nv,
bool  vwrap,
const GT_AttributeListHandle vertex,
const GT_AttributeListHandle detail 
)
static

Construct a curve mesh from a patch of vertices

static GT_PrimitiveHandle GT_PrimPatch::makePatchRowsCols ( GT_Basis  basis,
int  nu,
bool  uwrap,
int  nv,
bool  vwrap,
const GT_AttributeListHandle vertex,
const GT_AttributeListHandle detail 
)
static

Construct a curve mesh from a patch of vertices

static GT_PrimitiveHandle GT_PrimPatch::makePatchTriangles ( int  nu,
bool  uwrap,
int  nv,
bool  vwrap,
const GT_AttributeListHandle vertex,
const GT_AttributeListHandle detail 
)
static

Construct a curve mesh from a patch of vertices

bool GT_PrimPatch::refine ( GT_Refine refiner,
const GT_RefineParms parms 
) const
overridevirtual

Methods defined on GT_Primitive

Reimplemented from GT_Primitive.

bool GT_PrimPatch::refineToPolyMesh ( GT_Refine refine,
const GT_RefineParms parms = NULL 
) const

Refine to a single polygon mesh.

bool GT_PrimPatch::save ( UT_JSONWriter w) const
overridevirtual

Save the primitive to a JSON stream. The default method does nothing and returns false.

Reimplemented from GT_Primitive.


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