All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GEO_VolumeElement Class Referenceabstract

#include <GEO_VolumeElement.h>

+ Inheritance diagram for GEO_VolumeElement:

Public Member Functions

SYS_FORCE_INLINE GEO_VolumeElement (GA_Detail *d, GA_Offset offset=GA_INVALID_OFFSET)
virtual GA_Size getFaceCount () const =0
 The number of faces that make up this volume. More...
virtual int getFaceIndices (GA_Size faceno, UT_IntArray &vtxlist) const =0
 Returns the indices to the vertices, not the vertex offsets! More...
virtual GA_Offset findSharedFace (GA_Size faceno) const =0
virtual GA_Size getEdgeCount () const =0
 The number of edges in this volume. More...
virtual void getEdgeIndices (GA_Size edgeno, int &e0, int &e1) const =0
virtual int getBBox (UT_BoundingBox *bbox) const
virtual void addToBSphere (UT_BoundingSphere *bsphere) const
virtual UT_Vector3 baryCenter () const
virtual UT_Vector3 computeNormal () const
 Return a normal vector for the primitive. More...
virtual void addPointRefToGroup (GA_PointGroup &grp) const
virtual bool vertexApply (bool(*apply)(GA_Offset vtx, void *), void *data=0) const
- Public Member Functions inherited from GEO_Primitive
virtual GA_PrimCompat::TypeMask getPrimitiveId () const
void copyAttributesAndGroups (const GEO_Primitive &src, bool copy_groups=true)
void copyAttributesAndGroups (const GEO_Primitive &src, GA_AttributeRefMap &gah, bool copy_groups=true)
void copyAttributesAndGroups (const GEO_Primitive &src, GA_PrimitiveWrangler &wrangler, bool copy_groups=true)
 NOTE: The copying of groups only works if src is in the same detail. More...
void copyAttributeData (const GEO_Primitive &src)
void copyAttributeData (const GEO_Primitive &src, GA_AttributeRefMap &gah)
void copyAttributeData (const GEO_Primitive &src, GA_PrimitiveWrangler &wrangler)
void copyAttributeValues (const GEO_Primitive &src, GA_PrimitiveWrangler &wrangler)
void copyGroupMembership (const GEO_Primitive &src)
virtual void copyPrimitive (const GEO_Primitive *src)=0
virtual GEO_Primitivecopy (int preserve_shared_pts=0) const
virtual void transform (const UT_Matrix4 &)
virtual void realToUnitPair (float ureal, float vreal, float &uunit, float &vunit) const
virtual void unitToRealPair (float uunit, float vunit, float &ureal, float &vreal) const
virtual void unitLengthToUnitPair (float ulength, float vlength, float &uparm, float &vparm) const
virtual void unitToUnitLengthPair (float uparm, float vparm, float &ulength, float &vlength) const
bool evaluateBaryCenter (GA_Offset result_vtx, GA_AttributeRefMap &map) const
bool evaluatePoint (GA_Offset result_vtx, GA_AttributeRefMap &map, fpreal u, fpreal v=0, uint du=0, uint dv=0) const
int evaluatePoint (UT_Vector4 &pos, float u, float v=0, unsigned du=0, unsigned dv=0) const
virtual int evaluateNormalVector (UT_Vector3 &nml, float u, float v=0, float w=0) const
bool evaluateInteriorPoint (GA_Offset result_vtx, GA_AttributeRefMap &map, fpreal u, fpreal v, fpreal w=0) const
int evaluateInteriorPoint (UT_Vector4 &pos, fpreal u, fpreal v, fpreal w=0) const
virtual void computeInteriorPointWeights (UT_Array< GA_Offset > &vtxlist, UT_FloatArray &weightlist, fpreal u, fpreal v, fpreal w) const
SYS_FORCE_INLINE GEO_DetailgetParent () const
virtual void reverse ()=0
 Reverse the order of vertices. More...
virtual void isolate ()
 Method to isolate a pasted surface. More...
virtual int detachPoints (GA_PointGroup &grp)=0
virtual bool hasEdge (const GA_Edge &edge) const
 Method to determine if a primitive has an edge (undirected). More...
GEO_Vertex getVertexElement (GA_Size i) const
virtual GEO_MetaPrimcastToMetaPrim (void)
virtual const GEO_MetaPrimcastToMetaPrim (void) const
virtual int parametricBBox (float u, float v, float *u0, float *u1, float *v0, float *v1)
virtual float uvDist (float u1, float v1, float u2, float v2) const
int bboxIntersectRay (const UT_Vector3 &rayorig, const UT_Vector3 &raydir, int maxtries=10, float tmax=1E17F, float *distance=0, UT_Vector3 *nml=0) const
virtual bool isQuadric () const
virtual void normal (NormalComp &output) const =0
virtual GEO_Primitiveconvert (GEO_ConvertParms &parms, GA_PointGroup *usedpts=0)=0
virtual GEO_PrimitiveconvertNew (GEO_ConvertParms &parms)=0
virtual void clip (UT_Vector3 normal, float distance=0, GA_PrimitiveGroup *clipgrp=NULL)
virtual int intersectRay (const UT_Vector3 &o, const UT_Vector3 &d, float tmax=1E17F, float tol=1E-12F, float *distance=0, UT_Vector3 *pos=0, UT_Vector3 *nml=0, int accurate=0, float *u=0, float *v=0, int ignoretrim=1) const
virtual bool enlargeBoundingBox (UT_BoundingRect &b, const GA_Attribute *P) const
virtual bool enlargeBoundingBox (UT_BoundingBox &b, const GA_Attribute *P) const
virtual bool hasGuideEdge (int edgeid, UT_Vector3 &a, UT_Vector3 &b) const
virtual bool hasXsectPoint (int pointid, UT_Vector3 &p) const
virtual fpreal calcVolume (const UT_Vector3 &) const
virtual fpreal calcArea () const
virtual fpreal calcPerimeter () const
- Public Member Functions inherited from GA_Primitive
virtual ~GA_Primitive ()
virtual const
getTypeDef () const =0
const char * getTypeName () const
SYS_FORCE_INLINE GA_DetailgetDetail () const
SYS_FORCE_INLINE GA_Offset getMapOffset () const
 Gets the offset of this primitive in the detail containing it. More...
SYS_FORCE_INLINE GA_Index getMapIndex () const
 Gets the index of this primitive in the detail containing it. More...
getIndexMap () const
 Gets the index map for primitives in the detail containing this primitive. More...
GA_Index getNum () const
void swapOffsetValue (const GA_Defragment &defrag)
 For defragmentation, we need to update the offset. More...
bool isPrimary () const
getTypeId () const
GA_PrimitiveFamilyMask getFamilyMask () const
bool isFamily (unsigned family_mask) const
bool hasLocalTransform () const
 Whether the primitive has a transform associated with it. More...
virtual void getLocalTransform (UT_Matrix3D &matrix) const
virtual void getLocalTransform4 (UT_Matrix4D &matrix) const
virtual void setLocalTransform (const UT_Matrix3D &matrix)
 Set the local transform. The default implementation does nothing. More...
virtual int64 getMemoryUsage () const
virtual void countMemory (UT_MemoryCounter &counter) const
SYS_FORCE_INLINE GA_Size getVertexCount () const
 Return the number of vertices used by this primitive. More...
SYS_FORCE_INLINE GA_Offset getVertexOffset (GA_Size primvertexnum) const
SYS_FORCE_INLINE GA_Index getVertexIndex (GA_Size primvertexnum) const
SYS_FORCE_INLINE GA_Offset getPointOffset (GA_Size i) const
SYS_FORCE_INLINE void setPointOffset (GA_Size i, GA_Offset ptoff)
SYS_FORCE_INLINE GA_Index getPointIndex (GA_Size i) const
SYS_FORCE_INLINE UT_Vector3 getPos3 (GA_Size i) const
SYS_FORCE_INLINE void setPos3 (GA_Size i, const UT_Vector3 &pos) const
SYS_FORCE_INLINE UT_Vector4 getPos4 (GA_Size i) const
SYS_FORCE_INLINE void setPos4 (GA_Size i, const UT_Vector4 &pos) const
GA_Range getVertexRange (bool harden=false) const
 Get a range of all the vertices accessed by the primitive. More...
GA_Range getPointRange (bool harden=false) const
bool isPointUsed (GA_Offset ptoff) const
void addPointRefToGroup (GA_PointGroup &grp) const
void edgeApply (GA_EdgeApplyFunc apply, void *data=nullptr) const
void edgeApplyIndex (GA_EdgeApplyIndexFunc apply, void *data=nullptr) const
virtual void iterateEdges (GA_IterateEdgesFunc apply_func) const
virtual void iterateEdgesByVertex (GA_IterateEdgesByVertexFunc apply_func) const
bool findEdgePoints (GA_Offset ptoff0, GA_Offset ptoff1, GA_Size &vtx0, GA_Size &vtx1) const
virtual GA_DereferenceStatus dereferencePoint (GA_Offset point, bool dry_run=false)=0
virtual GA_DereferenceStatus dereferencePoints (const GA_RangeMemberQuery &pt_q, bool dry_run=false)=0
virtual bool enlargeBoundingSphere (UT_BoundingSphere &b, const GA_Attribute *P) const
virtual void enlargePointBounds (UT_BoundingBox &box) const
virtual bool isDegenerate () const =0
 Is the primitive degenerate. More...
virtual void copyUnwiredForMerge (const GA_Primitive *src, const GA_MergeMap &map)
virtual const GA_PrimitiveJSONgetJSON () const =0
virtual bool saveSharedLoadData (UT_JSONWriter &w, GA_SaveMap &save, GA_GeometryIndex *geometryIndex) const
virtual bool registerSharedLoadData (int load_data_type, GA_SharedDataHandlePtr item)
virtual bool loadH9 (UT_IStream &is, const UT_Array< GA_AttribLoadDataH9 > &prim_attribs, const UT_Array< GA_AttribLoadDataH9 > &vtx_attribs)
virtual bool saveH9 (std::ostream &os, bool binary, const UT_Array< GA_AttribSaveDataH9 > &prim_attribs, const UT_Array< GA_AttribSaveDataH9 > &vtx_attribs) const
const GA_IntrinsicManagergetIntrinsicManager () const
virtual void clearForDeletion ()
virtual void getAdjacentBoundaryVertices (GA_Offset vtx, GA_Offset &prev_vtx, GA_Offset &next_vtx) const
virtual bool supportsHedge () const
virtual GA_Offset releaseVertex (GA_Offset vtx)
virtual int isVisible () const
virtual unsigned getNumSecondaryDetails () const
 A primitive may support any number of secondary details. More...
virtual const GA_DetailgetSecondaryDetail (GA_Index i) const
virtual GA_DetailgetSecondaryDetail (GA_Index i)
GA_Index getNumSecondary (GA_Index detail) const
const GA_PrimitivegetSecondaryByIndex (GA_Index detail, GA_Index i) const
GA_PrimitivegetSecondaryByIndex (GA_Index detail, GA_Index i)
const GA_PrimitivegetSecondaryByOffset (GA_Index detail, GA_Offset o) const
GA_PrimitivegetSecondaryByOffset (GA_Index detail, GA_Offset o)
SYS_FORCE_INLINE bool isVertexListTrivial () const
bool isPointListTrivial () const
template<typename FUNCTOR >
SYS_FORCE_INLINE void forEachVertex (FUNCTOR &&functor) const
template<typename FUNCTOR >
SYS_FORCE_INLINE void forEachPoint (FUNCTOR &&functor) const
bool vertexApply (bool(*apply)(GA_Offset vtx, void *), void *data=nullptr) const
virtual void stashed (bool beingstashed, GA_Offset offset=GA_INVALID_OFFSET)
virtual void flushCEWriteCaches ()
 Copy any modified caches from the GPU back to CPU cache. More...
virtual void flushCECaches ()
virtual void swapVertexOffsets (const GA_Defragment &defrag)
GA_LocalIntrinsic findIntrinsic (const char *nm) const
GA_LocalIntrinsic findIntrinsic (GA_GlobalIntrinsic h) const
GA_GlobalIntrinsic findGlobalIntrinsic (GA_LocalIntrinsic h) const
const char * getIntrinsicName (GA_LocalIntrinsic h) const
GA_Size getIntrinsicTupleSize (GA_LocalIntrinsic h) const
GA_StorageClass getIntrinsicStorage (GA_LocalIntrinsic h) const
bool getIntrinsicReadOnly (GA_LocalIntrinsic h) const
const UT_OptionsgetIntrinsicOptions (GA_LocalIntrinsic h) const
GA_Size getIntrinsic (GA_LocalIntrinsic h, UT_String &val) const
GA_Size getIntrinsic (GA_LocalIntrinsic h, UT_StringArray &val) const
GA_Size getIntrinsic (GA_LocalIntrinsic h, int64 *v, GA_Size size) const
GA_Size getIntrinsic (GA_LocalIntrinsic h, fpreal64 *v, GA_Size sz) const
bool getIntrinsic (GA_LocalIntrinsic h, float &v) const
bool getIntrinsic (GA_LocalIntrinsic h, int &v) const
bool getIntrinsic (GA_LocalIntrinsic h, UT_Vector2 &v) const
bool getIntrinsic (GA_LocalIntrinsic h, UT_Vector3 &v) const
bool getIntrinsic (GA_LocalIntrinsic h, UT_Vector4 &v) const
bool getIntrinsic (GA_LocalIntrinsic h, UT_Matrix2 &v) const
bool getIntrinsic (GA_LocalIntrinsic h, UT_Matrix3 &v) const
bool getIntrinsic (GA_LocalIntrinsic h, UT_Matrix4 &v) const
GA_Size setIntrinsic (GA_LocalIntrinsic h, const char *value)
GA_Size setIntrinsic (GA_LocalIntrinsic h, const UT_StringArray &value)
GA_Size setIntrinsic (GA_LocalIntrinsic h, const char **val, GA_Size s)
GA_Size setIntrinsic (GA_LocalIntrinsic h, const int64 val)
GA_Size setIntrinsic (GA_LocalIntrinsic h, const fpreal64 val)
GA_Size setIntrinsic (GA_LocalIntrinsic h, const int64 *val, GA_Size sz)
GA_Size setIntrinsic (GA_LocalIntrinsic h, const fpreal64 *v, GA_Size sz)

Protected Member Functions

virtual bool evaluatePointRefMap (GA_Offset result_vtx, GA_AttributeRefMap &hlist, fpreal u, fpreal v, uint du, uint dv) const
virtual int evaluatePointV4 (UT_Vector4 &pos, float u, float v=0, unsigned du=0, unsigned dv=0) const
virtual bool evaluateBaryCenterRefMap (GA_Offset result_vertex, GA_AttributeRefMap &hlist) const
- Protected Member Functions inherited from GEO_Primitive
SYS_FORCE_INLINE GEO_Primitive (GA_Detail *d, GA_Offset offset=GA_INVALID_OFFSET)
virtual ~GEO_Primitive ()
virtual bool evaluateInteriorPointRefMap (GA_Offset result_vtx, GA_AttributeRefMap &map, fpreal u, fpreal v, fpreal w=0) const
virtual int evaluateInteriorPointV4 (UT_Vector4 &pos, fpreal u, fpreal v, fpreal w=0) const
- Protected Member Functions inherited from GA_Primitive
SYS_FORCE_INLINE GA_Primitive (GA_Detail &detail, GA_Offset offset=GA_INVALID_OFFSET)
void setNumVertices (GA_Size nvertices)
GA_Offset allocateVertex (GA_Offset point=GA_INVALID_OFFSET)
 allocateVertex() will call wireVertex() if the point given is not -1 More...
void destroyVertex (GA_Offset vertex)
void wireVertex (GA_Offset vertex, GA_Offset point)
void registerVertex (GA_Offset vertex)
SYS_FORCE_INLINE int64 getBaseMemoryUsage () const
 Report approximate memory usage for myVertexList for subclasses. More...
void countBaseMemory (UT_MemoryCounter &counter) const
void copyVertexListForMerge (const GA_OffsetListRef &src_vertices, const GA_MergeMap &map)

Static Protected Member Functions

static GA_PrimitiveFamilyMask buildFamilyMask ()
registerIntrinsics (GA_PrimitiveDefinition &defn)
- Static Protected Member Functions inherited from GEO_Primitive
registerIntrinsics (GA_PrimitiveDefinition &defn)

Additional Inherited Members

- Public Types inherited from GA_Primitive
- Static Public Member Functions inherited from GEO_Primitive
static GA_PrimCompat::TypeMask getPrimitiveMaskH9 (const char *maskstr)
- Static Public Member Functions inherited from GA_Primitive
primCompatMaskFromTypeId (int type_id)
- Static Public Attributes inherited from GEO_Primitive
static const UT_Array
< GA_AttribSaveDataH9 > & 
 Convience objects to pass as arguments to saveH9()/loadH9(). More...
- Protected Attributes inherited from GA_Primitive
GA_OffsetList myVertexList

Detailed Description

Definition at line 24 of file GEO_VolumeElement.h.

Constructor & Destructor Documentation

SYS_FORCE_INLINE GEO_VolumeElement::GEO_VolumeElement ( GA_Detail d,
GA_Offset  offset = GA_INVALID_OFFSET 

Definition at line 28 of file GEO_VolumeElement.h.

Member Function Documentation

virtual void GEO_VolumeElement::addPointRefToGroup ( GA_PointGroup grp) const
virtual void GEO_VolumeElement::addToBSphere ( UT_BoundingSphere bsphere) const

Enlarge the bounding sphere with the primitive's bounds. By default, this will enlarge the bounding sphere by the primitive's bounding box (i.e. getBBox()). It may be possible to have a tighter bound (i.e. the vertex hull for many primitives is a much better metric).

Reimplemented from GEO_Primitive.

virtual UT_Vector3 GEO_VolumeElement::baryCenter ( ) const

Return the center of the primitive. This defaults to the center of the bounding box. A better approximation might be the average value of the vertex positions (which could be different).

Reimplemented from GEO_Primitive.

static GA_PrimitiveFamilyMask GEO_VolumeElement::buildFamilyMask ( )

Definition at line 58 of file GEO_VolumeElement.h.

virtual UT_Vector3 GEO_VolumeElement::computeNormal ( ) const

Return a normal vector for the primitive.

Implements GEO_Primitive.

Reimplemented in GEO_PrimTetrahedron.

virtual bool GEO_VolumeElement::evaluateBaryCenterRefMap ( GA_Offset  result_vtx,
GA_AttributeRefMap map 
) const

By default, this will call evaluateInteriorPointRefMap with u=.5 and v=.5. This is likely not the perfect solution. At the current time, this is only used in POPs to birth points at primitive centers.

Reimplemented from GEO_Primitive.

virtual bool GEO_VolumeElement::evaluatePointRefMap ( GA_Offset  result_vtx,
GA_AttributeRefMap hlist,
fpreal  u,
fpreal  v,
uint  du,
uint  dv 
) const

Implements GEO_Primitive.

virtual int GEO_VolumeElement::evaluatePointV4 ( UT_Vector4 pos,
float  u,
float  v = 0,
unsigned  du = 0,
unsigned  dv = 0 
) const

Evaluate the position for the given parametric coordinates (with the given derivatives). Return 0 if successful, or -1 if failure. The default implementation returns {0,0,0,0};

Reimplemented from GEO_Primitive.

Definition at line 70 of file GEO_VolumeElement.h.

virtual GA_Offset GEO_VolumeElement::findSharedFace ( GA_Size  faceno) const
pure virtual

Implemented in GEO_PrimTetrahedron.

virtual int GEO_VolumeElement::getBBox ( UT_BoundingBox bbox) const

Compute the bounding box of the primitive. Return 0 if unable to compute bounds (1 on successful computation)

Implements GEO_Primitive.

virtual GA_Size GEO_VolumeElement::getEdgeCount ( ) const
pure virtual

The number of edges in this volume.

Implemented in GEO_PrimTetrahedron.

virtual void GEO_VolumeElement::getEdgeIndices ( GA_Size  edgeno,
int e0,
int e1 
) const
pure virtual

Returns the indices of the edge. Note each edge shows up once and due to the nature of volumes, is undirected.

Implemented in GEO_PrimTetrahedron.

virtual GA_Size GEO_VolumeElement::getFaceCount ( ) const
pure virtual

The number of faces that make up this volume.

Implemented in GEO_PrimTetrahedron.

virtual int GEO_VolumeElement::getFaceIndices ( GA_Size  faceno,
UT_IntArray vtxlist 
) const
pure virtual

Returns the indices to the vertices, not the vertex offsets!

Implemented in GEO_PrimTetrahedron.

static GA_IntrinsicManager::Registrar GEO_VolumeElement::registerIntrinsics ( GA_PrimitiveDefinition defn)

All subclasses should call this method to register the intrinsics.

See Also

Definition at line 64 of file GEO_VolumeElement.h.

virtual bool GEO_VolumeElement::vertexApply ( bool(*)(GA_Offset vtx, void *)  apply,
void data = 0 
) const

Apply the function to each vertex of the primitive. Break when the function returns true. Return the value of the last function applied (false if never called).

Reimplemented from GEO_Primitive.

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