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

#include <GEO_Face.h>

+ Inheritance diagram for GEO_Face:

Public Member Functions

UT_Vector3 computeNormal () const override
 Return a normal vector for the primitive. More...
 
void normal (NormalComp &output) const override
 
bool saveH9 (std::ostream &os, bool binary, const UT_Array< GA_AttribSaveDataH9 > &prim_attribs, const UT_Array< GA_AttribSaveDataH9 > &vtx_attribs) const override
 
bool loadH9 (UT_IStream &is, const UT_Array< GA_AttribLoadDataH9 > &prim_attribs, const UT_Array< GA_AttribLoadDataH9 > &vtx_attribs) override
 
void copyPrimitive (const GEO_Primitive *src) override
 
GEO_Primitivecopy (int preserve_shared_pts=0) const override
 
void copyUnwiredForMerge (const GA_Primitive *src, const GA_MergeMap &map) override
 
bool isDegenerate () const override
 Is the primitive degenerate. More...
 
virtual unsigned getOrder (void) const =0
 
void realToUnitPair (float ureal, float vreal, float &uunit, float &vunit) const override
 
void unitToRealPair (float uunit, float vunit, float &ureal, float &vreal) const override
 
void unitLengthToUnitPair (float ulength, float vlength, float &uparm, float &vparm) const override
 
void unitLengthToUnitPair (float ulength, float vlength, float &uparm, float &vparm, float tolerance) const override
 
void unitToUnitLengthPair (float uparm, float vparm, float &ulength, float &vlength) const override
 
bool evaluate (fpreal u, GEO_Vertex result, GEO_AttributeHandleList &gah, int du=0, int uOffset=-1) const
 
bool evaluate (fpreal u, GA_Offset result_vtx, GA_AttributeRefMap &gah, int du=0, int uOffset=-1) const
 
int evaluate (float u, UT_Vector4 &pos, unsigned du=0, int uOffset=-1) const
 
int evaluateNormalVector (UT_Vector3 &nml, float u, float v=0, float w=0) const override
 
virtual int evaluateFrenetFrame (UT_Vector3 &x, UT_Vector3 &t, UT_Vector3 &m, UT_Vector3 &b, float u, int accurate=1, int uoffset=-1) const
 
void fillBreakParameters (UT_FloatArray &uvals, int ustartidx, int ustopidx, int ulod) const
 
virtual bool evaluateMesh (const UT_FloatArray &uvals, GA_Offset *results, GA_AttributeRefMap &hlist, unsigned du=0) const
 
virtual bool evaluateMesh (const UT_FloatArray &uvals, UT_Vector4 *pos, unsigned du=0) const
 
virtual int evaluateBreakpoint (int uidx, UT_Vector4 &pos, int du=0) const =0
 
virtual float breakSegmIndexToDomain (int ustartidx, int ustopidx, int lod, int index) const
 
virtual GA_Size removeRepeatedVertices (bool check_order=false, bool count_only=false, bool deleteOrphanedPoints=false)
 
virtual GA_Size removeRepeatedPoints (float tol=0.001F, bool check_order=false, bool count_only=false, bool deleteOrphanedPoints=false)
 
virtual int unroll (int append_pts=1)
 
virtual int loft (int newcount, int start=-1, int stop=-1)=0
 
int subdivide (float u, GA_AttributeRefMap &map)
 
int subdivide (float u)
 
virtual int warp (float u, const UT_Vector3 &delta, GA_AttributeRefMap &map, float sharpness=0.0f, float bias=-1.0f)=0
 
int warpAlongNormal (float u, float distance, GA_AttributeRefMap &map, float sharpness, float bias)
 
virtual int attach (const GEO_Face &face, int blend=1, float bias=0.5f, float tolerance=1.0f, int unrefine=1, GA_PointGroup *ptgroup=0)=0
 
virtual GD_Faceplanar (GD_Detail &dgdp, int copyxy=0) const =0
 
virtual float unitToRealDomain (float u_unit) const
 
virtual float realToUnitDomain (float u_real) const
 
virtual float unitLengthToUnitDomain (float ulength, float tolerance=1e-04F) const
 
virtual float unitToUnitLengthDomain (float uparm) const
 
virtual void unitToRealSequence (float *uunit, float *ureal, int ulen) const
 
virtual void validInterval (int &a, int &b) const
 
virtual void validRange (float &ua, float &ub) const
 
SYS_FORCE_INLINE bool isClosed () const
 
SYS_FORCE_INLINE void setClosed (bool isclosed)
 
virtual void close (int rounded=1, int preserveShape=0)
 
virtual void open (int preserveShape=0, int safe=0)
 
bool hasEdge (const GA_Edge &edge) const override
 Method to determine if a primitive has an edge (undirected). More...
 
void iterateEdges (GA_IterateEdgesFunc apply_func) const override
 
void iterateEdgesByVertex (GA_IterateEdgesByVertexFunc apply_func) const override
 
int getEdgeCount () const
 
void reverse () override
 Reverse the order of vertices. More...
 
void sampleEnds (int n)
 
virtual int cycle (int amount, int=1)
 
float radius () const
 
bool findEdgePoints (GA_Offset pta, GA_Offset ptb, GA_Size &pidx0, GA_Size &pidx1) const
 
bool findEdgePoints (const GA_Edge &edge, GA_Size &pidx0, GA_Size &pidx1) const
 
bool hasDEdge (GA_Offset a, GA_Offset b) const
 
bool isBridge (GA_Offset a, GA_Offset b) const
 
int refine (float k, GA_AttributeRefMap &gah, int r=1)
 
int refine (float k, int r=1)
 
virtual int pointInFace (const UT_Vector3 &pos, const UT_Vector3 *normal) const
 
float uvDist (float u1, float v1, float u2, float v2) const override
 
virtual void weights (unsigned short onOff)
 
virtual int breakCount () const =0
 
fpreal calcVolume (const UT_Vector3 &refpt) const override
 
fpreal calcArea () const override
 
fpreal calcPerimeter () const override
 
virtual int intersect (const GEO_Primitive &prim, UT_Array< GU_RayInfoHit > &hitList, float tol=0.01F, int ignoretrim=1) const =0
 
virtual void computeInteriorPointWeights (UT_Array< GA_Offset > &vtxlist, UT_Array< float > &weightlist, fpreal u, fpreal v, fpreal w) const override
 
- Public Member Functions inherited from GEO_TriMesh
virtual int getBBox (UT_BoundingBox *bbox) const
 
virtual void addToBSphere (UT_BoundingSphere *bsphere) const
 
virtual UT_Vector3 baryCenter () const
 
virtual void addPointRefToGroup (GA_PointGroup &grp) const final
 
virtual bool changePointRef (GA_Offset from, GA_Offset to)
 
void setSize (GA_Size sz)
 
virtual int detachPoints (GA_PointGroup &grp)
 
virtual GA_DereferenceStatus dereferencePoint (GA_Offset point, bool dry_run=false)
 
virtual GA_DereferenceStatus dereferencePoints (const GA_RangeMemberQuery &pt_q, bool dry_run=false)
 
virtual GA_Size insertVertex (GA_Offset ppt, GA_Size where=0)
 
virtual GA_Size appendVertex (GA_Offset ppt)
 
virtual int deleteVertex (GA_Size num)
 
virtual void deleteVertices (const UT_Array< GA_Size > &nums)
 
GA_Size findVertex (GA_Offset vtx) const
 return the index of a vertex within our vertex list More...
 
virtual GA_Size stealVertex (GA_Offset vtx, GA_Offset insert_before_vtx=GA_INVALID_OFFSET)
 
virtual GA_Size getVertexCount () const final
 
SYS_FORCE_INLINE GA_Size getFastVertexCount () const
 
virtual GA_Offset getVertexOffset (GA_Size index) const final
 
SYS_FORCE_INLINE GA_Offset getFastVertexOffset (GA_Size index) const
 
SYS_FORCE_INLINE GA_Index getVertexIndex (GA_Size i) const
 
SYS_FORCE_INLINE GA_Offset getPointOffset (GA_Size i) const
 
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
 
bool isVertexListTrivial () const
 
bool isPointListTrivial () const
 
virtual void beginVertex (const_iterator &i) const final
 
virtual void nextVertex (const_iterator &i) const final
 
GA_Size find (GA_Offset pt) const
 
const GEO_Vertex operator() (GA_Size i) const
 
GEO_Vertex operator() (GA_Size i)
 
const GEO_Vertex operator[] (GA_Size i) const
 
GEO_Vertex operator[] (GA_Size i)
 
void setVertexPoint (GA_Size i, GA_Offset pt)
 
virtual void stashed (bool beingstashed, GA_Offset offset=GA_INVALID_OFFSET)
 
virtual bool vertexApply (bool(*apply)(GA_Offset vtx, void *), void *data=0) const final
 
void assignVertexList (const GA_OffsetList &list, bool destroy_existing=true, bool update_topology=true)
 
virtual bool jsonSaveBasis (UT_JSONWriter &w) const
 
virtual bool jsonSaveBasis (UT_JSONValue &v) const
 
virtual bool jsonLoadBasis (UT_JSONParser &p)
 
virtual bool jsonLoadBasis (UT_JSONParser &p, const UT_JSONValue &v)
 
bool saveVertexArray (UT_JSONWriter &w, const GA_SaveMap &map) const
 
bool loadVertexArray (UT_JSONParser &p, const GA_LoadMap &map)
 
- 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 transform (const UT_Matrix4 &)
 
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
 
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
 
SYS_FORCE_INLINE GEO_DetailgetParent () const
 
virtual void isolate ()
 Method to isolate a pasted surface. 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)
 
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 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
 
- 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 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
 
bool findEdgePoints (GA_Offset ptoff0, GA_Offset ptoff1, GA_Size &vtx0, GA_Size &vtx1) const
 
virtual bool enlargeBoundingSphere (UT_BoundingSphere &b, const GA_Attribute *P) const
 
virtual void enlargePointBounds (UT_BoundingBox &box) const
 
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)
 
const GA_IntrinsicManagergetIntrinsicManager () const
 
virtual void getAdjacentBoundaryVertices (GA_Offset vtx, GA_Offset &prev_vtx, GA_Offset &next_vtx) const
 
virtual bool supportsHedge () const
 
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 flushCEWriteCaches ()
 Copy any modified caches from the GPU back to CPU cache. More...
 
virtual void flushCECaches ()
 
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)
 

Static Public Member Functions

static void unitToRealAdjust (float *uunit, float *ureal, int ulen, int num)
 
static fpreal getIndices (fpreal c, int &c1, int &c2, int maxIndex, int wrap)
 
static void fillBreakVals (const GA_Basis &ub, UT_FloatArray &uvals, int ustartidx, int ustopidx, int ulod, bool wrap)
 
static bool getUniformStep (const UT_FloatArray &vals, int idx, int nextidx, fpreal &step)
 
- Static Public Member Functions inherited from GEO_Primitive
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)
 

Protected Member Functions

SYS_FORCE_INLINE GEO_Face (GA_Detail *d, GA_Offset offset=GA_INVALID_OFFSET)
 
virtual ~GEO_Face ()
 
 GA_DECLARE_INTRINSICS (override)
 
bool savePrivateH9 (std::ostream &os, bool binary) const override=0
 
bool loadPrivateH9 (UT_IStream &is) override=0
 
bool validate () const override
 
GA_Size getMinVertexCount () const override
 
bool evaluatePointRefMap (GA_Offset result_vtx, GA_AttributeRefMap &vtxdata, fpreal u, fpreal v=0, uint du=0, uint dv=0) const override
 
int evaluatePointV4 (UT_Vector4 &pos, float u_unit, float=0, unsigned du=0, unsigned dv=0) const override
 
virtual bool evaluateRefMap (fpreal u, GA_Offset result_vtx, GA_AttributeRefMap &gah, int du=0, int uOffset=-1) const
 
virtual int evaluateV4 (float u, UT_Vector4 &pos, unsigned du=0, int uOffset=-1) const
 
virtual int subdivideRefMap (float u, GA_AttributeRefMap &map)
 
virtual int subdivideFloat (float u)
 
virtual int refineRefMap (float k, GA_AttributeRefMap &gah, int r=1)
 
virtual int refineInt (float k, int r=1)
 
- Protected Member Functions inherited from GEO_TriMesh
SYS_FORCE_INLINE GEO_TriMesh (GA_Detail *d, GA_Offset offset=GA_INVALID_OFFSET)
 
virtual ~GEO_TriMesh ()
 
virtual void clearForDeletion ()
 
GA_Size multipleInsert (GA_Size where, GA_Size count, bool appendPoints=true)
 
SYS_FORCE_INLINE GA_Offset vertexPoint (GA_Size i) const
 
void swapVertices (GA_Size i, GA_Size j)
 
virtual void swapVertexOffsets (const GA_Defragment &defrag)
 Defragmentation. More...
 
virtual bool evaluateBaryCenterRefMap (GA_Offset result_vertex, GA_AttributeRefMap &hlist) const
 
virtual GA_Offset releaseVertex (GA_Offset vtx)
 
int64 getBaseMemoryUsage () const
 Report approximate memory usage for myVertexList for subclasses. More...
 
void countBaseMemory (UT_MemoryCounter &counter) 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 ()
 
static GA_Offset buildBlock (GA_PrimitiveTypeId type, GA_Detail *detail, const GA_Offset startpt, const GA_Size npoints, const GEO_PolyCounts &facesizelist, const int *facepointnumbers, const bool closed=true)
 
static GA_Offset buildBlock (GA_PrimitiveTypeId type, GA_Detail *detail, const GA_Offset startpt, const GA_Size npoints, const GA_PolyCounts &facesizelist, const int *facepointnumbers, const bool closed=true)
 
- Static Protected Member Functions inherited from GEO_TriMesh
static GA_PrimitiveFamilyMask buildFamilyMask ()
 
static
GA_IntrinsicManager::Registrar 
registerIntrinsics (GA_PrimitiveDefinition &defn)
 
- Static Protected Member Functions inherited from GEO_Primitive
static
GA_IntrinsicManager::Registrar 
registerIntrinsics (GA_PrimitiveDefinition &defn)
 

Friends

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

Additional Inherited Members

- Public Types inherited from GA_Primitive
enum  GA_DereferenceStatus { GA_DEREFERENCE_FAIL, GA_DEREFERENCE_OK, GA_DEREFERENCE_DEGENERATE, GA_DEREFERENCE_DESTROY }
 
- Static Public Attributes inherited from GEO_Primitive
static const UT_Array
< GA_AttribSaveDataH9 > & 
theEmptySaveAttribs
 Convience objects to pass as arguments to saveH9()/loadH9(). More...
 
- Protected Attributes inherited from GEO_TriMesh
GA_OffsetList myVertexList
 
- Protected Attributes inherited from GA_Primitive
GA_OffsetList myVertexList
 

Detailed Description

Definition at line 35 of file GEO_Face.h.

Constructor & Destructor Documentation

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

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

Definition at line 41 of file GEO_Face.h.

virtual GEO_Face::~GEO_Face ( )
inlineprotectedvirtual

NOTE: The destructor should only be called from subclass destructors.

Definition at line 47 of file GEO_Face.h.

Member Function Documentation

virtual int GEO_Face::attach ( const GEO_Face face,
int  blend = 1,
float  bias = 0.5f,
float  tolerance = 1.0f,
int  unrefine = 1,
GA_PointGroup ptgroup = 0 
)
pure virtual
virtual int GEO_Face::breakCount ( ) const
pure virtual

Implemented in GEO_Curve, and GEO_PrimPoly.

virtual float GEO_Face::breakSegmIndexToDomain ( int  ustartidx,
int  ustopidx,
int  lod,
int  index 
) const
virtual

Reimplemented in GEO_Curve.

static GA_Offset GEO_Face::buildBlock ( GA_PrimitiveTypeId  type,
GA_Detail detail,
const GA_Offset  startpt,
const GA_Size  npoints,
const GEO_PolyCounts facesizelist,
const int facepointnumbers,
const bool  closed = true 
)
staticprotected

Builds faces using the specified range of point offsets, as dictated by facesizelist and facepointnumbers, in parallel. facepointnumbers lists the offsets of the points used by each face MINUS startpt, i.e. they are offsets relative to startpt, not indices relative to startpt. The offset of the first face is returned, and the rest are at consecutive offsets. All facepointnumbers must be between 0 (inclusive) and npoints (exclusive).

NOTE: Existing primitives are allowed to be using the points in the specified range already, and the faces being created do not need to use all of the points in the range. However, these cases may impact performance.

NOTE: If you can guarantee that no other primitives are using the points and that the vertices of these new faces will be using the points starting from startpt in order and continuing contiguously, e.g. with independent curves whose points were allocated with GA_Detail::appendPointBlock, pass in NULL for facepointnumbers. This option should be used with caution.

static GA_Offset GEO_Face::buildBlock ( GA_PrimitiveTypeId  type,
GA_Detail detail,
const GA_Offset  startpt,
const GA_Size  npoints,
const GA_PolyCounts facesizelist,
const int facepointnumbers,
const bool  closed = true 
)
staticprotected

Builds faces using the specified range of point offsets, as dictated by facesizelist and facepointnumbers, in parallel. facepointnumbers lists the offsets of the points used by each face MINUS startpt, i.e. they are offsets relative to startpt, not indices relative to startpt. The offset of the first face is returned, and the rest are at consecutive offsets. All facepointnumbers must be between 0 (inclusive) and npoints (exclusive).

NOTE: Existing primitives are allowed to be using the points in the specified range already, and the faces being created do not need to use all of the points in the range. However, these cases may impact performance.

NOTE: If you can guarantee that no other primitives are using the points and that the vertices of these new faces will be using the points starting from startpt in order and continuing contiguously, e.g. with independent curves whose points were allocated with GA_Detail::appendPointBlock, pass in NULL for facepointnumbers. This option should be used with caution.

static GA_PrimitiveFamilyMask GEO_Face::buildFamilyMask ( )
inlinestaticprotected

Definition at line 396 of file GEO_Face.h.

fpreal GEO_Face::calcArea ( ) const
overridevirtual

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

Reimplemented from GEO_Primitive.

fpreal GEO_Face::calcPerimeter ( ) const
overridevirtual

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

Reimplemented from GEO_Primitive.

Reimplemented in GEO_PrimNURBCurve.

fpreal GEO_Face::calcVolume ( const UT_Vector3 ) const
overridevirtual

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

Reimplemented from GEO_Primitive.

virtual void GEO_Face::close ( int  rounded = 1,
int  preserveShape = 0 
)
virtual

Reimplemented in GEO_PrimNURBCurve, and GEO_PrimRBezCurve.

Examples:
RAY/RAY_DemoSprite.C.
virtual void GEO_Face::computeInteriorPointWeights ( UT_Array< GA_Offset > &  vtxlist,
UT_Array< float > &  weightlist,
fpreal  u,
fpreal  v,
fpreal  w 
) const
overridevirtual

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

Reimplemented in GEO_Curve, and GEO_PrimPoly.

UT_Vector3 GEO_Face::computeNormal ( ) const
overridevirtual

Return a normal vector for the primitive.

Implements GEO_Primitive.

GEO_Primitive* GEO_Face::copy ( int  preserve_shared_pts = 0) const
overridevirtual

Reimplemented from GEO_TriMesh.

void GEO_Face::copyPrimitive ( const GEO_Primitive src)
overridevirtual

Reimplemented from GEO_TriMesh.

void GEO_Face::copyUnwiredForMerge ( const GA_Primitive src,
const GA_MergeMap map 
)
overridevirtual

Copy the specified primitive as part of the merge. The source primitive will be of the same type.

Since the vertex offsets will change for the merged geometry, the map should be used to lookup the new vertex offsets. For example

map.mapDestFromSource( GA_ATTRIB_VERTEX, source_vertex );
See Also
GA_MergeMap

Reimplemented from GEO_TriMesh.

virtual int GEO_Face::cycle ( int  amount,
int  = 1 
)
virtual

Reimplemented in GEO_PrimNURBCurve.

bool GEO_Face::evaluate ( fpreal  u,
GEO_Vertex  result,
GEO_AttributeHandleList gah,
int  du = 0,
int  uOffset = -1 
) const
bool GEO_Face::evaluate ( fpreal  u,
GA_Offset  result_vtx,
GA_AttributeRefMap gah,
int  du = 0,
int  uOffset = -1 
) const
inline

Definition at line 97 of file GEO_Face.h.

int GEO_Face::evaluate ( float  u,
UT_Vector4 pos,
unsigned  du = 0,
int  uOffset = -1 
) const
inline

Definition at line 102 of file GEO_Face.h.

virtual int GEO_Face::evaluateBreakpoint ( int  uidx,
UT_Vector4 pos,
int  du = 0 
) const
pure virtual
virtual int GEO_Face::evaluateFrenetFrame ( UT_Vector3 x,
UT_Vector3 t,
UT_Vector3 m,
UT_Vector3 b,
float  u,
int  accurate = 1,
int  uoffset = -1 
) const
virtual
virtual bool GEO_Face::evaluateMesh ( const UT_FloatArray uvals,
GA_Offset results,
GA_AttributeRefMap hlist,
unsigned  du = 0 
) const
virtual

Reimplemented in GEO_Curve.

virtual bool GEO_Face::evaluateMesh ( const UT_FloatArray uvals,
UT_Vector4 pos,
unsigned  du = 0 
) const
virtual

Reimplemented in GEO_Curve.

int GEO_Face::evaluateNormalVector ( UT_Vector3 nml,
float  u,
float  v = 0,
float  w = 0 
) const
overridevirtual

Reimplemented from GEO_Primitive.

bool GEO_Face::evaluatePointRefMap ( GA_Offset  result_vtx,
GA_AttributeRefMap vtxdata,
fpreal  u,
fpreal  v = 0,
uint  du = 0,
uint  dv = 0 
) const
overrideprotectedvirtual

Reimplemented from GEO_TriMesh.

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

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

virtual bool GEO_Face::evaluateRefMap ( fpreal  u,
GA_Offset  result_vtx,
GA_AttributeRefMap gah,
int  du = 0,
int  uOffset = -1 
) const
protectedvirtual

Reimplemented in GEO_Curve.

virtual int GEO_Face::evaluateV4 ( float  u,
UT_Vector4 pos,
unsigned  du = 0,
int  uOffset = -1 
) const
protectedvirtual

Reimplemented in GEO_Curve.

void GEO_Face::fillBreakParameters ( UT_FloatArray uvals,
int  ustartidx,
int  ustopidx,
int  ulod 
) const
static void GEO_Face::fillBreakVals ( const GA_Basis ub,
UT_FloatArray uvals,
int  ustartidx,
int  ustopidx,
int  ulod,
bool  wrap 
)
static
bool GEO_Face::findEdgePoints ( GA_Offset  pta,
GA_Offset  ptb,
GA_Size pidx0,
GA_Size pidx1 
) const
bool GEO_Face::findEdgePoints ( const GA_Edge edge,
GA_Size pidx0,
GA_Size pidx1 
) const
GEO_Face::GA_DECLARE_INTRINSICS ( override  )
protected
int GEO_Face::getEdgeCount ( ) const
static fpreal GEO_Face::getIndices ( fpreal  c,
int c1,
int c2,
int  maxIndex,
int  wrap 
)
static
GA_Size GEO_Face::getMinVertexCount ( ) const
inlineoverrideprotectedvirtual

Reimplemented from GEO_TriMesh.

Definition at line 414 of file GEO_Face.h.

virtual unsigned GEO_Face::getOrder ( void  ) const
pure virtual

Implemented in GEO_Curve, and GEO_PrimPoly.

static bool GEO_Face::getUniformStep ( const UT_FloatArray vals,
int  idx,
int  nextidx,
fpreal step 
)
static
bool GEO_Face::hasDEdge ( GA_Offset  a,
GA_Offset  b 
) const
bool GEO_Face::hasEdge ( const GA_Edge edge) const
overridevirtual

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

Reimplemented from GEO_Primitive.

virtual int GEO_Face::intersect ( const GEO_Primitive prim,
UT_Array< GU_RayInfoHit > &  hitList,
float  tol = 0.01F,
int  ignoretrim = 1 
) const
pure virtual
bool GEO_Face::isBridge ( GA_Offset  a,
GA_Offset  b 
) const

True if both the directed edges a->b and b->a are inside this face

SYS_FORCE_INLINE bool GEO_Face::isClosed ( ) const
inline

Definition at line 244 of file GEO_Face.h.

bool GEO_Face::isDegenerate ( ) const
overridevirtual

Is the primitive degenerate.

Reimplemented from GEO_TriMesh.

Reimplemented in GEO_PrimPoly.

void GEO_Face::iterateEdges ( GA_IterateEdgesFunc  apply_func) const
overridevirtual

Calls apply_func for each directed edge on the primitive. If the apply_func function returns false, then the traversal will be stopped.

Reimplemented from GA_Primitive.

void GEO_Face::iterateEdgesByVertex ( GA_IterateEdgesByVertexFunc  apply_func) const
overridevirtual

Calls apply_func for each directed edge on the primitive, passing in the GA_Size primitive vertex index for each point on the edge. If the apply_func function returns false, then the traversal will be stopped.

Reimplemented from GA_Primitive.

bool GEO_Face::loadH9 ( UT_IStream is,
const UT_Array< GA_AttribLoadDataH9 > &  prim_attribs,
const UT_Array< GA_AttribLoadDataH9 > &  vtx_attribs 
)
overridevirtual

Reimplemented from GEO_TriMesh.

bool GEO_Face::loadPrivateH9 ( UT_IStream is)
overrideprotectedpure virtual

Implements GEO_TriMesh.

Implemented in GEO_Curve, and GEO_PrimPoly.

virtual int GEO_Face::loft ( int  newcount,
int  start = -1,
int  stop = -1 
)
pure virtual
void GEO_Face::normal ( NormalComp output) const
overridevirtual

Implements GEO_Primitive.

virtual void GEO_Face::open ( int  preserveShape = 0,
int  safe = 0 
)
virtual

Reimplemented in GEO_PrimNURBCurve, and GEO_PrimRBezCurve.

virtual GD_Face* GEO_Face::planar ( GD_Detail dgdp,
int  copyxy = 0 
) const
pure virtual
virtual int GEO_Face::pointInFace ( const UT_Vector3 pos,
const UT_Vector3 normal 
) const
virtual

This method determines whether the point is inside or outside the polygon. The point is assumed to be on the plane of the polygon. Note that normal is a pointer to this primitive's normal which cannot be NULL. If the point is on the boundary of the face, it is reported as being inside the face with -1 return.

float GEO_Face::radius ( ) const
virtual float GEO_Face::realToUnitDomain ( float  u_real) const
virtual

Reimplemented in GEO_Curve.

void GEO_Face::realToUnitPair ( float  ureal,
float  vreal,
float &  uunit,
float &  vunit 
) const
overridevirtual

Reimplemented from GEO_Primitive.

int GEO_Face::refine ( float  k,
GA_AttributeRefMap gah,
int  r = 1 
)
inline

Definition at line 302 of file GEO_Face.h.

int GEO_Face::refine ( float  k,
int  r = 1 
)
inline

Definition at line 304 of file GEO_Face.h.

virtual int GEO_Face::refineInt ( float  k,
int  r = 1 
)
protectedvirtual

Reimplemented in GEO_PrimNURBCurve, and GEO_PrimRBezCurve.

virtual int GEO_Face::refineRefMap ( float  k,
GA_AttributeRefMap gah,
int  r = 1 
)
protectedvirtual

Reimplemented in GEO_PrimNURBCurve, and GEO_PrimRBezCurve.

virtual GA_Size GEO_Face::removeRepeatedPoints ( float  tol = 0.001F,
bool  check_order = false,
bool  count_only = false,
bool  deleteOrphanedPoints = false 
)
virtual
virtual GA_Size GEO_Face::removeRepeatedVertices ( bool  check_order = false,
bool  count_only = false,
bool  deleteOrphanedPoints = false 
)
virtual

Reimplemented in GEO_PrimRBezCurve.

void GEO_Face::reverse ( )
overridevirtual

Reverse the order of vertices.

Implements GEO_Primitive.

Reimplemented in GEO_PrimNURBCurve, and GEO_PrimRBezCurve.

void GEO_Face::sampleEnds ( int  n)
bool GEO_Face::saveH9 ( std::ostream &  os,
bool  binary,
const UT_Array< GA_AttribSaveDataH9 > &  prim_attribs,
const UT_Array< GA_AttribSaveDataH9 > &  vtx_attribs 
) const
overridevirtual

Reimplemented from GEO_TriMesh.

bool GEO_Face::savePrivateH9 ( std::ostream &  os,
bool  binary 
) const
overrideprotectedpure virtual

Implements GEO_TriMesh.

Implemented in GEO_Curve, and GEO_PrimPoly.

SYS_FORCE_INLINE void GEO_Face::setClosed ( bool  isclosed)
inline

NOTE: This won't update the basis for NURBS/Bezier curves! It just sets the closed flag, so make sure the bases get set afterward!

Definition at line 251 of file GEO_Face.h.

int GEO_Face::subdivide ( float  u,
GA_AttributeRefMap map 
)
inline

Definition at line 178 of file GEO_Face.h.

int GEO_Face::subdivide ( float  u)
inline

Definition at line 180 of file GEO_Face.h.

virtual int GEO_Face::subdivideFloat ( float  u)
protectedvirtual

Reimplemented in GEO_PrimNURBCurve.

virtual int GEO_Face::subdivideRefMap ( float  u,
GA_AttributeRefMap map 
)
protectedvirtual

Reimplemented in GEO_PrimNURBCurve.

virtual float GEO_Face::unitLengthToUnitDomain ( float  ulength,
float  tolerance = 1e-04F 
) const
virtual

Reimplemented in GEO_Curve, and GEO_PrimPoly.

void GEO_Face::unitLengthToUnitPair ( float  ulength,
float  vlength,
float &  uparm,
float &  vparm 
) const
overridevirtual

Reimplemented from GEO_TriMesh.

void GEO_Face::unitLengthToUnitPair ( float  ulength,
float  vlength,
float &  uparm,
float &  vparm,
float  tolerance 
) const
overridevirtual

Reimplemented from GEO_TriMesh.

static void GEO_Face::unitToRealAdjust ( float *  uunit,
float *  ureal,
int  ulen,
int  num 
)
static
virtual float GEO_Face::unitToRealDomain ( float  u_unit) const
virtual

Reimplemented in GEO_Curve.

void GEO_Face::unitToRealPair ( float  uunit,
float  vunit,
float &  ureal,
float &  vreal 
) const
overridevirtual

Reimplemented from GEO_Primitive.

virtual void GEO_Face::unitToRealSequence ( float *  uunit,
float *  ureal,
int  ulen 
) const
virtual

Reimplemented in GEO_Curve.

virtual float GEO_Face::unitToUnitLengthDomain ( float  uparm) const
virtual

Reimplemented in GEO_Curve, and GEO_PrimPoly.

void GEO_Face::unitToUnitLengthPair ( float  uparm,
float  vparm,
float &  ulength,
float &  vlength 
) const
overridevirtual

Reimplemented from GEO_TriMesh.

virtual int GEO_Face::unroll ( int  append_pts = 1)
virtual
float GEO_Face::uvDist ( float  u1,
float  v1,
float  u2,
float  v2 
) const
overridevirtual

Reimplemented from GEO_Primitive.

bool GEO_Face::validate ( ) const
overrideprotectedvirtual

Reimplemented from GEO_TriMesh.

virtual void GEO_Face::validInterval ( int a,
int b 
) const
virtual

Reimplemented in GEO_Curve.

virtual void GEO_Face::validRange ( float &  ua,
float &  ub 
) const
virtual

Reimplemented in GEO_Curve.

virtual int GEO_Face::warp ( float  u,
const UT_Vector3 delta,
GA_AttributeRefMap map,
float  sharpness = 0.0f,
float  bias = -1.0f 
)
pure virtual
int GEO_Face::warpAlongNormal ( float  u,
float  distance,
GA_AttributeRefMap map,
float  sharpness,
float  bias 
)
virtual void GEO_Face::weights ( unsigned short  onOff)
virtual

Reimplemented in GEO_Curve.

Friends And Related Function Documentation

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

Definition at line 437 of file GEO_Face.h.


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