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

A tapered tube primitive (mapping to GEO_PrimTube) More...

#include <GT_PrimTube.h>

+ Inheritance diagram for GT_PrimTube:

Public Member Functions

 GT_PrimTube ()
 Default constructor. More...
 
 GT_PrimTube (const GT_AttributeListHandle &attribs, const GT_TransformHandle &transform, fpreal taper, bool caps)
 Useful constructor. More...
 
 GT_PrimTube (const GT_PrimTube &src)
 Copy constructor. More...
 
virtual ~GT_PrimTube ()
 Destructor. More...
 
virtual const char * className () const
 
virtual bool save (UT_JSONWriter &w) const
 
bool init (const GT_AttributeListHandle &attribs, const GT_TransformHandle &transform, fpreal taper, bool caps)
 
GT_PrimitiveHandle refineToPolygonMesh (const GT_RefineParms *parms) const
 Convenience method to refine to a polygon mesh. More...
 
virtual int getPrimitiveType () const
 
const GT_AttributeListHandlegetAttributes () const
 
const fprealgetTaper () const
 
const bool & getCaps () const
 
virtual const
GT_AttributeListHandle
getDetailAttributes () const
 
virtual void enlargeBounds (UT_BoundingBox boxes[], int nsegments) const
 
virtual int getMotionSegments () const
 
virtual int64 getMemoryUsage () const
 
virtual bool refine (GT_Refine &refiner, const GT_RefineParms *parms) const
 
virtual GT_PrimitiveHandle doHarden () const
 
virtual GT_PrimitiveHandle doSoftCopy () const
 
- 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
 
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
getPointAttributes () 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 ()
 Default constructor: Sets counter to 0. More...
 
SYS_FORCE_INLINE UT_IntrusiveRefCounter (const UT_IntrusiveRefCounter &)
 Copy constructor: Sets counter to 0. More...
 
UT_IntrusiveRefCounteroperator= (const UT_IntrusiveRefCounter &)
 Assignment operator: Does not modify counter. More...
 
SYS_FORCE_INLINE uint32 use_count () const
 Return current counter. More...
 

Static Public Member Functions

static GT_PrimitiveHandle makePolygonMesh (const GT_RefineParms *parms, fpreal taper=1.0f)
 
- 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 Attributes

GT_AttributeListHandle myAttributes
 
fpreal myTaper
 
bool myCaps
 

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 tapered tube primitive (mapping to GEO_PrimTube)

The tube primitive represents a tapered tube along the Z axis. Unlike the GEO counterpart, this primitive's axis is aligned along the Z axis (not the Y axis).

Definition at line 24 of file GT_PrimTube.h.

Constructor & Destructor Documentation

GT_PrimTube::GT_PrimTube ( )
inline

Default constructor.

Definition at line 28 of file GT_PrimTube.h.

GT_PrimTube::GT_PrimTube ( const GT_AttributeListHandle attribs,
const GT_TransformHandle transform,
fpreal  taper,
bool  caps 
)
inline

Useful constructor.

Definition at line 31 of file GT_PrimTube.h.

GT_PrimTube::GT_PrimTube ( const GT_PrimTube src)
inline

Copy constructor.

Definition at line 41 of file GT_PrimTube.h.

virtual GT_PrimTube::~GT_PrimTube ( )
virtual

Destructor.

Member Function Documentation

virtual const char* GT_PrimTube::className ( void  ) const
inlinevirtual

Implements GT_Primitive.

Definition at line 51 of file GT_PrimTube.h.

virtual GT_PrimitiveHandle GT_PrimTube::doHarden ( ) const
virtual

Methods defined on GT_Primitive

Reimplemented from GT_Primitive.

virtual GT_PrimitiveHandle GT_PrimTube::doSoftCopy ( ) const
inlinevirtual

Methods defined on GT_Primitive

Implements GT_Primitive.

Definition at line 107 of file GT_PrimTube.h.

virtual void GT_PrimTube::enlargeBounds ( UT_BoundingBox  boxes[],
int  nsegments 
) const
virtual

Methods defined on GT_Primitive

Implements GT_Primitive.

const GT_AttributeListHandle& GT_PrimTube::getAttributes ( ) const
inline

Accessors

Definition at line 84 of file GT_PrimTube.h.

const bool& GT_PrimTube::getCaps ( ) const
inline

Accessors

Definition at line 88 of file GT_PrimTube.h.

virtual const GT_AttributeListHandle& GT_PrimTube::getDetailAttributes ( ) const
inlinevirtual

Access attributes

Reimplemented from GT_Primitive.

Definition at line 94 of file GT_PrimTube.h.

virtual int64 GT_PrimTube::getMemoryUsage ( ) const
virtual

Methods defined on GT_Primitive

Implements GT_Primitive.

virtual int GT_PrimTube::getMotionSegments ( ) const
virtual

Methods defined on GT_Primitive

Implements GT_Primitive.

virtual int GT_PrimTube::getPrimitiveType ( ) const
virtual

Methods defined on GT_Primitive

Reimplemented from GT_Primitive.

const fpreal& GT_PrimTube::getTaper ( void  ) const
inline

Accessors

Definition at line 86 of file GT_PrimTube.h.

bool GT_PrimTube::init ( const GT_AttributeListHandle attribs,
const GT_TransformHandle transform,
fpreal  taper,
bool  caps 
)
inline

Initialize a tube with

  • attribs
    Attributes defined on the tube
  • transform
    The transform attribute list should contain a single transform representing the 4x4 transform of the tube.

Definition at line 65 of file GT_PrimTube.h.

static GT_PrimitiveHandle GT_PrimTube::makePolygonMesh ( const GT_RefineParms parms,
fpreal  taper = 1.0f 
)
static

Get a tesselation of a tube with a given set of refinement parameters.

virtual bool GT_PrimTube::refine ( GT_Refine refiner,
const GT_RefineParms parms 
) const
virtual

Methods defined on GT_Primitive

Reimplemented from GT_Primitive.

GT_PrimitiveHandle GT_PrimTube::refineToPolygonMesh ( const GT_RefineParms parms) const

Convenience method to refine to a polygon mesh.

virtual bool GT_PrimTube::save ( UT_JSONWriter w) const
virtual

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

Reimplemented from GT_Primitive.

Member Data Documentation

GT_AttributeListHandle GT_PrimTube::myAttributes
protected

Definition at line 116 of file GT_PrimTube.h.

bool GT_PrimTube::myCaps
protected

Definition at line 118 of file GT_PrimTube.h.

fpreal GT_PrimTube::myTaper
protected

Definition at line 117 of file GT_PrimTube.h.


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