HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GEO_Primitive Class Referenceabstract

#include <GEO_Primitive.h>

+ Inheritance diagram for GEO_Primitive:

Classes

class  NormalCompArrayT
 
class  NormalCompAttrT
 
class  NormalCompBufferedT
 
class  NormalCompT
 

Public Types

using NormalComp = NormalCompT< float >
 
using NormalCompArray = NormalCompArrayT< float >
 
using NormalCompAttr = NormalCompAttrT< float >
 
using NormalCompBuffered = NormalCompBufferedT< float >
 
using NormalCompD = NormalCompT< double >
 
using NormalCompArrayD = NormalCompArrayT< double >
 
using NormalCompAttrD = NormalCompAttrT< double >
 
using NormalCompBufferedD = NormalCompBufferedT< double >
 
- Public Types inherited from GA_Primitive
enum  GA_DereferenceStatus { GA_DEREFERENCE_FAIL, GA_DEREFERENCE_OK, GA_DEREFERENCE_DEGENERATE, GA_DEREFERENCE_DESTROY }
 

Public Member Functions

GA_PrimCompat::TypeMask getPrimitiveId () const override
 
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 unitLengthToUnitPair (float ulength, float vlength, float &uparm, float &vparm, float tolerance) 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_Array< float > &weightlist, fpreal u, fpreal v, fpreal w) const
 
SYS_FORCE_INLINE GEO_DetailgetParent () const
 
virtual bool getBBox (UT_BoundingBox *bbox) const =0
 
virtual bool getVisibleBBox (UT_BoundingBox *bbox) const
 
bool enlargeVisibleBoundingBox (UT_BoundingBox &b, const GA_Attribute *P) const override
 
virtual UT_Vector3 computeNormal () const =0
 Return a normal vector for the primitive. More...
 
virtual UT_Vector3D computeNormalD () const =0
 
void reverse () override=0
 Reverse the order of vertices. More...
 
virtual UT_Vector3 baryCenter () const
 
virtual UT_Vector3D baryCenterD () const
 
template<typename T >
UT_Vector3T< TbaryCenterT () const
 
virtual void addToBSphere (UT_BoundingSphere *bsphere) const
 
virtual void isolate ()
 Method to isolate a pasted surface. More...
 
virtual int detachPoints (GA_PointGroup &grp)=0
 
bool hasEdge (const GA_Edge &edge) const override
 Method to determine if a primitive has an edge (undirected). More...
 
virtual bool vertexApply (bool(*apply)(GA_Offset vtx, void *), void *data=0) const
 
GEO_Vertex getVertexElement (GA_Size i) const
 
virtual GEO_MetaPrimcastToMetaPrim ()
 
virtual const GEO_MetaPrimcastToMetaPrim () 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 void normal (NormalCompD &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
 
bool enlargeBoundingBox (UT_BoundingRect &b, const GA_Attribute *p) const override
 
bool enlargeBoundingBox (UT_BoundingBox &b, const GA_Attribute *p) const override
 
virtual bool hasGuideEdge (int edgeid, UT_Vector3 &a, UT_Vector3 &b) const
 
virtual bool hasXsectPoint (int pointid, UT_Vector3 &p) const
 
fpreal calcVolume (const UT_Vector3 &) const override
 
fpreal calcArea () const override
 
fpreal calcPerimeter () const override
 
- Public Member Functions inherited from GA_Primitive
virtual ~GA_Primitive ()
 
virtual const
GA_PrimitiveDefinition
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...
 
SYS_FORCE_INLINE const
GA_IndexMap
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
 
SYS_FORCE_INLINE const
GA_PrimitiveTypeId
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 UT_Vector3D getPos3D (GA_Size i) const
 
template<typename T >
UT_Vector3T< TgetPos3T (GA_Size i) const
 
SYS_FORCE_INLINE void setPos3 (GA_Size i, const UT_Vector3 &pos) const
 
SYS_FORCE_INLINE void setPos3 (GA_Size i, const UT_Vector3D &pos) const
 
SYS_FORCE_INLINE UT_Vector4 getPos4 (GA_Size i) const
 
SYS_FORCE_INLINE UT_Vector4D getPos4D (GA_Size i) const
 
SYS_FORCE_INLINE void setPos4 (GA_Size i, const UT_Vector4 &pos) const
 
SYS_FORCE_INLINE void setPos4 (GA_Size i, const UT_Vector4D &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...
 
void copyUnwiredForMerge (const GA_Primitive *src, const GA_MergeMap &map)
 
virtual void copySubclassData (const GA_Primitive *source)
 
virtual const GA_PrimitiveJSONgetJSON () const =0
 
virtual bool saveSharedLoadData (UT_JSONWriter &w, GA_SaveMap &save, GA_GeometryIndex *geo_index) 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 stealCEBuffers (const GA_Primitive *src)
 Steal the underlying CE buffer from the source. More...
 
virtual void swapVertexOffsets (const GA_Defragment &defrag)
 
GA_LocalIntrinsic findIntrinsic (const UT_StringRef &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, UT_OptionsHolder &val) const
 
GA_Size getIntrinsic (GA_LocalIntrinsic h, UT_Array< UT_OptionsHolder > &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
 
bool getIntrinsic (GA_LocalIntrinsic h, double &v) const
 
bool getIntrinsic (GA_LocalIntrinsic h, int64 &v) const
 
bool getIntrinsic (GA_LocalIntrinsic h, UT_Vector2D &v) const
 
bool getIntrinsic (GA_LocalIntrinsic h, UT_Vector3D &v) const
 
bool getIntrinsic (GA_LocalIntrinsic h, UT_Vector4D &v) const
 
bool getIntrinsic (GA_LocalIntrinsic h, UT_Matrix2D &v) const
 
bool getIntrinsic (GA_LocalIntrinsic h, UT_Matrix3D &v) const
 
bool getIntrinsic (GA_LocalIntrinsic h, UT_Matrix4D &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 UT_OptionsHolder &value)
 
GA_Size setIntrinsic (GA_LocalIntrinsic h, const UT_Array< UT_OptionsHolder > &value)
 
GA_Size setIntrinsic (GA_LocalIntrinsic h, const UT_OptionsHolder *value, 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)
 

Static Public Member Functions

static GA_PrimCompat::TypeMask getPrimitiveMaskH9 (const char *maskstr)
 
- Static Public Member Functions inherited from GA_Primitive
static SYS_FORCE_INLINE
GA_PrimCompat::TypeMask 
primCompatMaskFromTypeId (int type_id)
 

Static Public Attributes

static const UT_Array
< GA_AttribSaveDataH9 > & 
theEmptySaveAttribs
 Convience objects to pass as arguments to saveH9()/loadH9(). More...
 

Protected Member Functions

SYS_FORCE_INLINE GEO_Primitive (GA_Detail *d, GA_Offset offset=GA_INVALID_OFFSET)
 
 ~GEO_Primitive () override
 
virtual bool evaluatePointRefMap (GA_Offset result_vtx, GA_AttributeRefMap &map, fpreal u, fpreal v=0, uint du=0, uint dv=0) const =0
 
virtual int evaluatePointV4 (UT_Vector4 &pos, float u, float v=0, unsigned du=0, unsigned dv=0) const
 
virtual bool evaluateBaryCenterRefMap (GA_Offset result_vtx, GA_AttributeRefMap &map) const
 
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_IntrinsicManager::Registrar 
registerIntrinsics (GA_PrimitiveDefinition &defn)
 

Friends

class GEO_Detail
 
std::ostream & operator<< (std::ostream &os, const GEO_Primitive &d)
 

Additional Inherited Members

- Protected Attributes inherited from GA_Primitive
GA_OffsetList myVertexList
 

Detailed Description

Member Typedef Documentation

Examples:
tetprim/GEO_PrimTetra.h.

Definition at line 443 of file GEO_Primitive.h.

Definition at line 449 of file GEO_Primitive.h.

Definition at line 450 of file GEO_Primitive.h.

Definition at line 451 of file GEO_Primitive.h.

Examples:
tetprim/GEO_PrimTetra.h.

Definition at line 448 of file GEO_Primitive.h.

Constructor & Destructor Documentation

SYS_FORCE_INLINE GEO_Primitive::GEO_Primitive ( GA_Detail d,
GA_Offset  offset = GA_INVALID_OFFSET 
)
inlineprotected

NOTE: The constructor should only be called from subclass constructors.

Definition at line 47 of file GEO_Primitive.h.

GEO_Primitive::~GEO_Primitive ( )
inlineoverrideprotected

NOTE: The destructor should only be called from subclass destructors; only GEO_Detail::destroyStashed() should be calling delete on GEO_Primitive pointers, and GEO_Detail is a friend.

Definition at line 55 of file GEO_Primitive.h.

Member Function Documentation

virtual void GEO_Primitive::addToBSphere ( UT_BoundingSphere bsphere) const
virtual

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 in GEO_PrimVolume, GEO_Hull, GEO_PrimParticle, GEO_VolumeElementBase, GEO_PrimTube, GEO_PrimSphere, GEO_PrimTriBezier, GEO_PrimCircle, and GEO_TriMesh.

virtual UT_Vector3 GEO_Primitive::baryCenter ( ) const
virtual

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 in GEO_PrimVolume, GEO_PrimVDB, GEO_PrimPolySoup, GEO_Hull, GEO_PrimParticle, HDK_Sample::GEO_PrimTetra, GEO_VolumeElementBase, GEO_PrimPacked, GEO_Quadric, GEO_PrimCircle, GEO_PrimTriBezier, GEO_TriMesh, and GEO_PrimChannel.

Examples:
SOP/SOP_PrimVOP.C.
virtual UT_Vector3D GEO_Primitive::baryCenterD ( ) const
virtual
template<typename T >
UT_Vector3T<T> GEO_Primitive::baryCenterT ( ) const
inline

Definition at line 261 of file GEO_Primitive.h.

int GEO_Primitive::bboxIntersectRay ( const UT_Vector3 rayorig,
const UT_Vector3 raydir,
int  maxtries = 10,
float  tmax = 1E17F,
float distance = 0,
UT_Vector3 nml = 0 
) const
fpreal GEO_Primitive::calcArea ( ) const
inlineoverridevirtual

If the method isn't known, or doesn't make sense, we return 0.

Reimplemented from GA_Primitive.

Reimplemented in GEO_PrimVolume, GEO_PrimVDB, GEO_PrimPolySoup, GEO_PrimTube, HDK_Sample::GEO_PrimTetra, GU_PrimPacked, GEO_PrimPacked, GEO_PrimTetrahedron, GEO_PrimSphere, GEO_PrimTriBezier, GEO_PrimTriStrip, and GEO_PrimTriFan.

Definition at line 336 of file GEO_Primitive.h.

fpreal GEO_Primitive::calcPerimeter ( ) const
inlineoverridevirtual

If the method isn't known, or doesn't make sense, we return 0.

Reimplemented from GA_Primitive.

Reimplemented in GEO_PrimNURBCurve, GEO_PrimRBezCurve, GEO_PrimPolySoup, GEO_PrimTube, HDK_Sample::GEO_PrimTetra, GU_PrimPacked, GEO_PrimPacked, GEO_PrimTetrahedron, GEO_PrimSphere, GEO_PrimTriBezier, GEO_PrimTriStrip, and GEO_PrimTriFan.

Definition at line 337 of file GEO_Primitive.h.

fpreal GEO_Primitive::calcVolume ( const UT_Vector3 ) const
inlineoverridevirtual

If the method isn't known, or doesn't make sense, we return 0.

Reimplemented from GA_Primitive.

Reimplemented in GEO_PrimVolume, GEO_PrimVDB, GEO_PrimPolySoup, GEO_PrimTube, HDK_Sample::GEO_PrimTetra, GU_PrimPacked, GEO_PrimPacked, GEO_PrimTetrahedron, GEO_PrimSphere, GEO_PrimTriBezier, GEO_PrimTriStrip, and GEO_PrimTriFan.

Definition at line 334 of file GEO_Primitive.h.

virtual GEO_MetaPrim* GEO_Primitive::castToMetaPrim ( )
virtual

Reimplemented in GEO_PrimMetaBall, and GEO_PrimMetaSQuad.

virtual const GEO_MetaPrim* GEO_Primitive::castToMetaPrim ( ) const
virtual

Reimplemented in GEO_PrimMetaBall, and GEO_PrimMetaSQuad.

virtual void GEO_Primitive::clip ( UT_Vector3  normal,
float  distance = 0,
GA_PrimitiveGroup clipgrp = NULL 
)
virtual

Reimplemented in GEO_PrimPoly, GU_PrimPoly, and GU_PrimParticle.

virtual void GEO_Primitive::computeInteriorPointWeights ( UT_Array< GA_Offset > &  vtxlist,
UT_Array< float > &  weightlist,
fpreal  u,
fpreal  v,
fpreal  w 
) const
virtual

Finds the weightings of the vertices that will compute an interior point given the u,v,w coordinates. The offsets are into the gdp's vertex list, not indices into this primitive's vertex list. Weights are normalized. Note this cannot be used to recover the Position as it often has special case logic (as in spheres, or rational splines), in those cases use evaluateInteriorPoint(UT_Vector4 &pos, ...) It has the advantage over the other evaluateInteriorPoints in that it allows you to avoid creating any temporary vertices. Behaviour for non-sublcassed types is to return the 0th vertex.

Reimplemented in GEO_PrimPolySoup, GEO_Curve, GEO_Face, GEO_PrimTetrahedron, GEO_PrimHexahedron, GEO_PrimTriBezier, GEO_Hull, GEO_TPSurf, and GEO_PrimPoly.

void GEO_Primitive::copyAttributeData ( const GEO_Primitive src)

Copy the attribute data over from the source primitive. Often you will want to call copyAttributesAndGroups() instead.

void GEO_Primitive::copyAttributeData ( const GEO_Primitive src,
GA_AttributeRefMap gah 
)
void GEO_Primitive::copyAttributeData ( const GEO_Primitive src,
GA_PrimitiveWrangler wrangler 
)
void GEO_Primitive::copyAttributesAndGroups ( const GEO_Primitive src,
bool  copy_groups = true 
)
inline

Copy attribute data from the source primitive. Also, copy over all the group membership information from the source primitive.

Definition at line 62 of file GEO_Primitive.h.

void GEO_Primitive::copyAttributesAndGroups ( const GEO_Primitive src,
GA_AttributeRefMap gah,
bool  copy_groups = true 
)
inline

Definition at line 69 of file GEO_Primitive.h.

void GEO_Primitive::copyAttributesAndGroups ( const GEO_Primitive src,
GA_PrimitiveWrangler wrangler,
bool  copy_groups = true 
)
inline

NOTE: The copying of groups only works if src is in the same detail.

Definition at line 78 of file GEO_Primitive.h.

void GEO_Primitive::copyAttributeValues ( const GEO_Primitive src,
GA_PrimitiveWrangler wrangler 
)
void GEO_Primitive::copyGroupMembership ( const GEO_Primitive src)

Copy the group membership from the source primitive to the current primitive. Both primitives must be in the same detail.

bool GEO_Primitive::enlargeBoundingBox ( UT_BoundingRect b,
const GA_Attribute p 
) const
overridevirtual

If the attribute is "P" the base-class will call getBBox()

Reimplemented from GA_Primitive.

Reimplemented in GEO_PrimVolume, GEO_PrimVDB, GEO_PrimParticle, and GEO_Quadric.

bool GEO_Primitive::enlargeBoundingBox ( UT_BoundingBox b,
const GA_Attribute p 
) const
overridevirtual

If the attribute is "P" the base-class will call getBBox()

Reimplemented from GA_Primitive.

Reimplemented in GEO_PrimVolume, GEO_PrimVDB, GEO_PrimParticle, and GEO_Quadric.

bool GEO_Primitive::enlargeVisibleBoundingBox ( UT_BoundingBox b,
const GA_Attribute P 
) const
overridevirtual

Enlarge a bounding box by the visible bounding box of the primitive.

A return value of false indicates an error in the operation, most likely an invalid P. By default, it merely calls enlargeBoundingBox()

Reimplemented from GA_Primitive.

bool GEO_Primitive::evaluateBaryCenter ( GA_Offset  result_vtx,
GA_AttributeRefMap map 
) const
inline

Definition at line 147 of file GEO_Primitive.h.

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

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 in GEO_PrimVolume, GEO_Hull, GEO_PrimParticle, GEO_PrimTriBezier, GEO_TriMesh, GEO_Quadric, and GEO_VolumeElementBase.

bool GEO_Primitive::evaluateInteriorPoint ( GA_Offset  result_vtx,
GA_AttributeRefMap map,
fpreal  u,
fpreal  v,
fpreal  w = 0 
) const
inline

Definition at line 177 of file GEO_Primitive.h.

int GEO_Primitive::evaluateInteriorPoint ( UT_Vector4 pos,
fpreal  u,
fpreal  v,
fpreal  w = 0 
) const
inline

Definition at line 182 of file GEO_Primitive.h.

virtual bool GEO_Primitive::evaluateInteriorPointRefMap ( GA_Offset  result_vtx,
GA_AttributeRefMap map,
fpreal  u,
fpreal  v,
fpreal  w = 0 
) const
protectedvirtual
virtual int GEO_Primitive::evaluateInteriorPointV4 ( UT_Vector4 pos,
fpreal  u,
fpreal  v,
fpreal  w = 0 
) const
protectedvirtual
virtual int GEO_Primitive::evaluateNormalVector ( UT_Vector3 nml,
float  u,
float  v = 0,
float  w = 0 
) const
virtual
bool GEO_Primitive::evaluatePoint ( GA_Offset  result_vtx,
GA_AttributeRefMap map,
fpreal  u,
fpreal  v = 0,
uint  du = 0,
uint  dv = 0 
) const
inline
Examples:
tetprim/GEO_PrimTetra.h.

Definition at line 154 of file GEO_Primitive.h.

int GEO_Primitive::evaluatePoint ( UT_Vector4 pos,
float  u,
float  v = 0,
unsigned  du = 0,
unsigned  dv = 0 
) const
inline

Definition at line 164 of file GEO_Primitive.h.

virtual bool GEO_Primitive::evaluatePointRefMap ( GA_Offset  result_vtx,
GA_AttributeRefMap map,
fpreal  u,
fpreal  v = 0,
uint  du = 0,
uint  dv = 0 
) const
protectedpure virtual
virtual int GEO_Primitive::evaluatePointV4 ( UT_Vector4 pos,
float  u,
float  v = 0,
unsigned  du = 0,
unsigned  dv = 0 
) const
protectedvirtual

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 in GEO_PrimVolume, GEO_TPSurf, GEO_Curve, GEO_Face, GEO_PrimParticle, GEO_PrimTriBezier, GEO_TriMesh, GEO_PrimVDB, GEO_PrimTube, GEO_VolumeElementBase, GEO_PrimMesh, GEO_PrimChannel, GEO_PrimSphere, HDK_Sample::GEO_PrimTetra, GEO_PrimCircle, and GEO_PrimPacked.

virtual bool GEO_Primitive::getBBox ( UT_BoundingBox bbox) const
pure virtual

Compute the bounding box of the primitive. Return 0 if unable to compute bounds (1 on successful computation). This function should always initialize bbox, even if returning false, in which case, the bbox->isValid() may be false, representing an empty bounding box. This function should also not use any initial value of bbox, so it does not need to be initialized beforehand.

Implemented in GEO_PrimVolume, GEO_Hull, GEO_PrimParticle, GEO_VolumeElementBase, GEO_PrimTube, HDK_Sample::GEO_PrimTetra, GEO_PrimMetaBall, GEO_PrimMetaSQuad, GEO_PrimVDB, GEO_PrimSphere, GEO_PrimTriBezier, GEO_PrimCircle, GEO_TriMesh, GEO_PrimNull, GEO_Quadric, GEO_PrimPacked, and GEO_PrimChannel.

SYS_FORCE_INLINE GEO_Detail* GEO_Primitive::getParent ( ) const
inline
Examples:
tetprim/GEO_PrimTetra.C.

Definition at line 202 of file GEO_Primitive.h.

GA_PrimCompat::TypeMask GEO_Primitive::getPrimitiveId ( ) const
overridevirtual
Deprecated:
This method is only for transitional backward compatibility for the HDK and will be removed in a future release. TODO: Should be pure virtual here, overwritten at GEO_Primitive.

Reimplemented from GA_Primitive.

Examples:
field3d/f3d_io.C, and standalone/geo2voxel.C.
static GA_PrimCompat::TypeMask GEO_Primitive::getPrimitiveMaskH9 ( const char *  maskstr)
static
GEO_Vertex GEO_Primitive::getVertexElement ( GA_Size  i) const
virtual bool GEO_Primitive::getVisibleBBox ( UT_BoundingBox bbox) const
virtual

Compute the bounding box of the VISIBLE parts of the primitive. Default implementation delegates to getBBox(). Override this in subclasses for special handling.

This function should always initialize bbox, even if returning false, in which case, the bbox->isValid() may be false, representing an empty bounding box. This function should also not use any initial value of bbox, so it does not need to be initialized beforehand.

Reimplemented in GEO_PrimPacked.

bool GEO_Primitive::hasEdge ( const GA_Edge edge) const
overridevirtual

Method to determine if a primitive has an edge (undirected).

Reimplemented from GA_Primitive.

Reimplemented in GEO_PrimPolySoup, and GEO_VolumeElementBase.

virtual bool GEO_Primitive::hasGuideEdge ( int  edgeid,
UT_Vector3 a,
UT_Vector3 b 
) const
virtual

These functions are only implemented to get guide points/edges for spheres, tubes, and circles. The ID meaning is type-specific.

Reimplemented in GEO_PrimTube, GEO_PrimCircle, and GEO_PrimSphere.

virtual bool GEO_Primitive::hasXsectPoint ( int  pointid,
UT_Vector3 p 
) const
virtual

These functions are only implemented to get guide points/edges for spheres, tubes, and circles. The ID meaning is type-specific.

Reimplemented in GEO_PrimTube, GEO_PrimSphere, and GEO_PrimCircle.

virtual int GEO_Primitive::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
virtual void GEO_Primitive::isolate ( )
inlinevirtual

Method to isolate a pasted surface.

Reimplemented in GEO_TPSurf.

Definition at line 277 of file GEO_Primitive.h.

virtual bool GEO_Primitive::isQuadric ( ) const
inlinevirtual

Reimplemented in GEO_Quadric.

Definition at line 341 of file GEO_Primitive.h.

virtual int GEO_Primitive::parametricBBox ( float  u,
float  v,
float u0,
float u1,
float v0,
float v1 
)
virtual

Reimplemented in GEO_Hull, GEO_TPSurf, and GEO_Curve.

virtual void GEO_Primitive::realToUnitPair ( float  ureal,
float  vreal,
float uunit,
float vunit 
) const
virtual

Reimplemented in GEO_Hull, and GEO_Face.

static GA_IntrinsicManager::Registrar GEO_Primitive::registerIntrinsics ( GA_PrimitiveDefinition defn)
inlinestaticprotected

All subclasses should call this method to register the primitive intrinsics.

See Also
GA_IntrinsicManager
Examples:
tetprim/GEO_PrimTetra.C.

Definition at line 492 of file GEO_Primitive.h.

virtual void GEO_Primitive::transform ( const UT_Matrix4 )
virtual
virtual void GEO_Primitive::unitLengthToUnitPair ( float  ulength,
float  vlength,
float uparm,
float vparm 
) const
virtual

Reimplemented in GEO_PrimVolume, GEO_Quadric, GEO_TriMesh, and GEO_Face.

virtual void GEO_Primitive::unitLengthToUnitPair ( float  ulength,
float  vlength,
float uparm,
float vparm,
float  tolerance 
) const
virtual

Reimplemented in GEO_PrimVolume, GEO_Quadric, GEO_TriMesh, and GEO_Face.

virtual void GEO_Primitive::unitToRealPair ( float  uunit,
float  vunit,
float ureal,
float vreal 
) const
virtual

Reimplemented in GEO_Hull, and GEO_Face.

virtual void GEO_Primitive::unitToUnitLengthPair ( float  uparm,
float  vparm,
float ulength,
float vlength 
) const
virtual

Reimplemented in GEO_PrimVolume, GEO_Quadric, GEO_TriMesh, and GEO_Face.

virtual float GEO_Primitive::uvDist ( float  u1,
float  v1,
float  u2,
float  v2 
) const
virtual

Reimplemented in GEO_Hull, and GEO_Face.

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

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 in GEO_Hull, GEO_PrimParticle, GEO_TriMesh, GEO_PrimTriBezier, and GEO_VolumeElementBase.

Friends And Related Function Documentation

friend class GEO_Detail
friend

Definition at line 519 of file GEO_Primitive.h.

std::ostream& operator<< ( std::ostream &  os,
const GEO_Primitive d 
)
friend

Definition at line 522 of file GEO_Primitive.h.

Member Data Documentation

const UT_Array<GA_AttribSaveDataH9>& GEO_Primitive::theEmptySaveAttribs
static

Convience objects to pass as arguments to saveH9()/loadH9().

Definition at line 485 of file GEO_Primitive.h.


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