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

#include <GEO_PrimPart.h>

+ Inheritance diagram for GEO_PrimParticle:

Public Member Functions

virtual bool saveH9 (std::ostream &os, bool binary, const UT_Array< GA_AttribSaveDataH9 > &prim_attribs, const UT_Array< GA_AttribSaveDataH9 > &vtx_attribs) const
 
virtual bool loadH9 (UT_IStream &is, const UT_Array< GA_AttribLoadDataH9 > &prim_attribs, const UT_Array< GA_AttribLoadDataH9 > &vtx_attribs)
 
virtual int getBBox (UT_BoundingBox *bbox) const
 
virtual void addToBSphere (UT_BoundingSphere *bsphere) const
 
virtual bool enlargeBoundingSphere (UT_BoundingSphere &b, const GA_Attribute *P) const
 
virtual UT_Vector3 computeNormal () const
 Return a normal vector for the primitive. More...
 
virtual UT_Vector3 baryCenter () const
 
virtual void reverse ()
 Reverse the order of vertices. More...
 
virtual void copyPrimitive (const GEO_Primitive *src)
 
virtual GEO_Primitivecopy (int preserve_shared_pts=0) const
 
virtual void copyUnwiredForMerge (const GA_Primitive *src, const GA_MergeMap &map)
 
virtual bool isDegenerate () const
 Is the primitive degenerate. More...
 
virtual void addPointRefToGroup (GA_PointGroup &grp) const
 
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)
 
int getPointBBox (UT_BoundingBox &bbox) const
 
GA_Offset appendParticle (GA_Offset pt)
 Append a new particle. More...
 
void deleteParticleByPoint (GA_Offset pt)
 
void deleteParticle (GA_Offset vtxoff)
 
GA_Offset giveBirth ()
 Resurrect a particle or give birth to a new one. More...
 
void deadParticle (GEO_ParticleVertexIndex vtxindex)
 
void deleteDead ()
 Delete all dead particles. More...
 
int getNumParticles () const
 Returns the number of live particles. More...
 
virtual bool vertexApply (bool(*apply)(GA_Offset vtx, void *), void *data=0) const
 
virtual GA_Size getVertexCount () const
 
virtual GA_Offset getVertexOffset (GA_Size index) const
 
void setVertexPoint (unsigned int i, GA_Offset pt)
 
virtual void beginVertex (const_iterator &i) const
 
virtual void nextVertex (const_iterator &i) const
 
void clearAndDestroy ()
 
virtual void stashed (bool beingstashed, GA_Offset offset=GA_INVALID_OFFSET)
 
virtual const GA_PrimitiveJSONgetJSON () const
 
GA_Offset vertexPoint (GA_Size i) const
 
const GA_OffsetListgetVertexList () const
 
bool saveVertexArray (UT_JSONWriter &w, const GA_SaveMap &map) const
 
bool loadVertexArray (UT_JSONParser &p, const GA_LoadMap &map)
 
bool saveRenderProperties (UT_JSONWriter &w, const GA_SaveMap &map) const
 
bool saveRenderProperties (UT_JSONValue &v, const GA_SaveMap &map) const
 
bool loadRenderProperties (UT_JSONParser &p, const GA_LoadMap &map)
 
bool loadRenderProperties (UT_JSONParser &p, const UT_JSONValue &v, const GA_LoadMap &map)
 
bool areRenderPropertiesEqual (const GEO_PrimParticle &src) const
 
virtual bool enlargeBoundingBox (UT_BoundingRect &b, const GA_Attribute *P) const
 
virtual bool enlargeBoundingBox (UT_BoundingBox &b, const GA_Attribute *P) const
 
GEO_PartRendergetRenderAttribs ()
 
const GEO_PartRendergetRenderAttribs () 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 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 void isolate ()
 Method to isolate a pasted surface. More...
 
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 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
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
 
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 void enlargePointBounds (UT_BoundingBox &box) const
 
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 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 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)
 

Protected Member Functions

 GEO_PrimParticle (GA_Detail *d, GA_Offset offset=GA_INVALID_OFFSET)
 
virtual ~GEO_PrimParticle ()
 
virtual void clearForDeletion ()
 
virtual void swapVertexOffsets (const GA_Defragment &defrag)
 Defragmentation. More...
 
void setSize (GA_Size sz)
 Resize our vertex array. More...
 
virtual bool evaluatePointRefMap (GA_Offset result_vtx, GA_AttributeRefMap &hlist, fpreal u, fpreal v, unsigned du, unsigned dv) const
 
virtual int evaluatePointV4 (UT_Vector4 &pos, float u_unit, float=0, unsigned du=0, unsigned=0) const
 
virtual bool evaluateBaryCenterRefMap (GA_Offset result_vertex, GA_AttributeRefMap &hlist) const
 
int64 getBaseMemoryUsage () const
 
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 evaluatePointRefMap (GA_Offset result_vtx, GA_AttributeRefMap &map, fpreal u, fpreal v=0, uint du=0, uint dv=0) const =0
 
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 Protected Member Functions inherited from GEO_Primitive
static
GA_IntrinsicManager::Registrar 
registerIntrinsics (GA_PrimitiveDefinition &defn)
 

Friends

std::ostream & operator<< (std::ostream &os, const GEO_PrimParticle &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 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)
 
- 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 GA_Primitive
GA_OffsetList myVertexList
 

Detailed Description

A GEO_PrimParticle represents a particle system, though a simulation may consist of more than a single primitive. Each particle in the system is a vertex in the primitive.

Examples:
SOP/SOP_SParticle.C, and SOP/SOP_SParticle.h.

Definition at line 55 of file GEO_PrimPart.h.

Constructor & Destructor Documentation

GEO_PrimParticle::GEO_PrimParticle ( GA_Detail d,
GA_Offset  offset = GA_INVALID_OFFSET 
)
inlineprotected

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

Definition at line 60 of file GEO_PrimPart.h.

virtual GEO_PrimParticle::~GEO_PrimParticle ( )
inlineprotectedvirtual

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

Definition at line 66 of file GEO_PrimPart.h.

Member Function Documentation

virtual void GEO_PrimParticle::addPointRefToGroup ( GA_PointGroup grp) const
virtual
virtual void GEO_PrimParticle::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 from GEO_Primitive.

GA_Offset GEO_PrimParticle::appendParticle ( GA_Offset  pt)

Append a new particle.

See Also
giveBirth()
Examples:
SIM/SNOW_Solver.C.
bool GEO_PrimParticle::areRenderPropertiesEqual ( const GEO_PrimParticle src) const

Save/load render properties to a JSON stream

virtual UT_Vector3 GEO_PrimParticle::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 from GEO_Primitive.

virtual void GEO_PrimParticle::beginVertex ( const_iterator &  i) const
virtual
static GA_PrimitiveFamilyMask GEO_PrimParticle::buildFamilyMask ( )
inlinestaticprotected

Definition at line 233 of file GEO_PrimPart.h.

void GEO_PrimParticle::clearAndDestroy ( void  )
inline
Examples:
SOP/SOP_SParticle.C.

Definition at line 212 of file GEO_PrimPart.h.

virtual void GEO_PrimParticle::clearForDeletion ( )
protectedvirtual

Private interface The clearForDeletion() method is called just prior to the detail being cleared out. This allows the primitive to simplify its data structures, knowing that topology doesn't need to be maintained (i.e. unwiring all vertices);

Reimplemented from GA_Primitive.

virtual UT_Vector3 GEO_PrimParticle::computeNormal ( ) const
virtual

Return a normal vector for the primitive.

Implements GEO_Primitive.

virtual GEO_Primitive* GEO_PrimParticle::copy ( int  preserve_shared_pts = 0) const
virtual

Reimplemented from GEO_Primitive.

virtual void GEO_PrimParticle::copyPrimitive ( const GEO_Primitive src)
virtual

Implements GEO_Primitive.

virtual void GEO_PrimParticle::copyUnwiredForMerge ( const GA_Primitive src,
const GA_MergeMap map 
)
virtual

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

void GEO_PrimParticle::countBaseMemory ( UT_MemoryCounter counter) const
protected
void GEO_PrimParticle::deadParticle ( GEO_ParticleVertexIndex  vtxindex)

Move the specified particle to the dead list.

Precondition
vtx belongs to this particle primitive Does not actually remove from our vertex list! This builds a list of all vertices that should be deleted so deleteDead() can do a single pass over them. vtxindex is the index into our vertex list, not a vertex offset.
Examples:
SOP/SOP_SParticle.C.
void GEO_PrimParticle::deleteDead ( )

Delete all dead particles.

Examples:
SOP/SOP_SParticle.C.
void GEO_PrimParticle::deleteParticle ( GA_Offset  vtxoff)

Delete the specified particle.

Precondition
vtx belongs to this particle primitive and is not currently on the dead list.
See Also
deadParticle()
void GEO_PrimParticle::deleteParticleByPoint ( GA_Offset  pt)

Delete all particles not on the dead list that reference the supplied point.

virtual GA_DereferenceStatus GEO_PrimParticle::dereferencePoint ( GA_Offset  point,
bool  dry_run = false 
)
virtual

Before a point is deleted, all primitives using the point will be notified. The method should return "false" if it's impossible to delete the point. Otherwise, the vertices should be removed.

Implements GA_Primitive.

virtual GA_DereferenceStatus GEO_PrimParticle::dereferencePoints ( const GA_RangeMemberQuery pt_q,
bool  dry_run = false 
)
virtual

Implements GA_Primitive.

virtual int GEO_PrimParticle::detachPoints ( GA_PointGroup grp)
virtual

Implements GEO_Primitive.

virtual bool GEO_PrimParticle::enlargeBoundingBox ( UT_BoundingRect b,
const GA_Attribute P 
) const
virtual

Enlarge a bounding box by the bounding box of the primitive. A return value of false indicates an error in the operation, most likely an invalid P. Unlike getBBox(), velocity is ignored.

Reimplemented from GEO_Primitive.

virtual bool GEO_PrimParticle::enlargeBoundingBox ( UT_BoundingBox b,
const GA_Attribute P 
) const
virtual

Enlarge a bounding box by the bounding box of the primitive. A return value of false indicates an error in the operation, most likely an invalid P. Unlike getBBox(), velocity is ignored.

Reimplemented from GEO_Primitive.

virtual bool GEO_PrimParticle::enlargeBoundingSphere ( UT_BoundingSphere b,
const GA_Attribute P 
) const
virtual

Enlarge a bounding sphere to encompass the primitive. A return value of false indicates an error in the operation, most likely an invalid P. Unlike getBBox(), velocity is ignored.

Reimplemented from GA_Primitive.

virtual bool GEO_PrimParticle::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 from GEO_Primitive.

virtual bool GEO_PrimParticle::evaluatePointRefMap ( GA_Offset  result_vtx,
GA_AttributeRefMap hlist,
fpreal  u,
fpreal  v,
unsigned  du,
unsigned  dv 
) const
protectedvirtual
virtual int GEO_PrimParticle::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 from GEO_Primitive.

int64 GEO_PrimParticle::getBaseMemoryUsage ( ) const
protected
virtual int GEO_PrimParticle::getBBox ( UT_BoundingBox bbox) const
virtual

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

Implements GEO_Primitive.

virtual const GA_PrimitiveJSON* GEO_PrimParticle::getJSON ( ) const
virtual

This method returns the JSON interface for saving/loading the primitive If the method returns a NULL pointer, then the primitive will not be saved to geometry files (and thus cannot be loaded).

Implements GA_Primitive.

int GEO_PrimParticle::getNumParticles ( ) const
inline

Returns the number of live particles.

Examples:
SOP/SOP_SParticle.C.

Definition at line 187 of file GEO_PrimPart.h.

int GEO_PrimParticle::getPointBBox ( UT_BoundingBox bbox) const
GEO_PartRender& GEO_PrimParticle::getRenderAttribs ( )
inline

Retrieve the object specifying how this particle system should be rendered.

Definition at line 155 of file GEO_PrimPart.h.

const GEO_PartRender& GEO_PrimParticle::getRenderAttribs ( ) const
inline

Retrieve the object specifying how this particle system should be rendered.

Definition at line 156 of file GEO_PrimPart.h.

virtual GA_Size GEO_PrimParticle::getVertexCount ( ) const
virtual
Note
getVertexCount() includes dead particles.
const GA_OffsetList& GEO_PrimParticle::getVertexList ( ) const
inline

Definition at line 225 of file GEO_PrimPart.h.

virtual GA_Offset GEO_PrimParticle::getVertexOffset ( GA_Size  index) const
virtual
Warning
Traverses the linked list of vertices.
GA_Offset GEO_PrimParticle::giveBirth ( )

Resurrect a particle or give birth to a new one.

Examples:
SOP/SOP_SParticle.C.
virtual bool GEO_PrimParticle::isDegenerate ( ) const
virtual

Is the primitive degenerate.

Implements GA_Primitive.

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

Reimplemented from GA_Primitive.

bool GEO_PrimParticle::loadRenderProperties ( UT_JSONParser p,
const GA_LoadMap map 
)

Save/load render properties to a JSON stream

bool GEO_PrimParticle::loadRenderProperties ( UT_JSONParser p,
const UT_JSONValue v,
const GA_LoadMap map 
)

Save/load render properties to a JSON stream

bool GEO_PrimParticle::loadVertexArray ( UT_JSONParser p,
const GA_LoadMap map 
)

Save/Load vertex list to a JSON stream

virtual void GEO_PrimParticle::nextVertex ( const_iterator &  i) const
virtual
virtual void GEO_PrimParticle::reverse ( )
virtual

Reverse the order of vertices.

Implements GEO_Primitive.

virtual bool GEO_PrimParticle::saveH9 ( std::ostream &  os,
bool  binary,
const UT_Array< GA_AttribSaveDataH9 > &  prim_attribs,
const UT_Array< GA_AttribSaveDataH9 > &  vtx_attribs 
) const
virtual

Reimplemented from GA_Primitive.

bool GEO_PrimParticle::saveRenderProperties ( UT_JSONWriter w,
const GA_SaveMap map 
) const

Save/load render properties to a JSON stream

bool GEO_PrimParticle::saveRenderProperties ( UT_JSONValue v,
const GA_SaveMap map 
) const

Save/load render properties to a JSON stream

bool GEO_PrimParticle::saveVertexArray ( UT_JSONWriter w,
const GA_SaveMap map 
) const

Save/Load vertex list to a JSON stream

void GEO_PrimParticle::setSize ( GA_Size  sz)
protected

Resize our vertex array.

void GEO_PrimParticle::setVertexPoint ( unsigned int  i,
GA_Offset  pt 
)
inline

Definition at line 202 of file GEO_PrimPart.h.

virtual void GEO_PrimParticle::stashed ( bool  beingstashed,
GA_Offset  offset = GA_INVALID_OFFSET 
)
virtual

Stash (deactivate) or unstash (reactivate) the primitive.

Stashing a primitive will set its offset to that specified, typically GA_INVALID_OFFSET. Primitives are only stashed as part of clearing a detail, so there is no need to explicitly deallocate vertices. It is safe to delete a stashed primitive.

Unstashing a primitive will re-register that primitive with its parent detail at the specified offset (or a new offset if GA_INVALID_OFFSET).

Reimplemented from GA_Primitive.

virtual void GEO_PrimParticle::swapVertexOffsets ( const GA_Defragment defrag)
protectedvirtual

Defragmentation.

Reimplemented from GA_Primitive.

virtual bool GEO_PrimParticle::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 from GEO_Primitive.

GA_Offset GEO_PrimParticle::vertexPoint ( GA_Size  i) const
inline
Warning
vertexPoint() doesn't check the bounds. Use with caution.
Examples:
SOP/SOP_SParticle.C.

Definition at line 222 of file GEO_PrimPart.h.

Friends And Related Function Documentation

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

Definition at line 281 of file GEO_PrimPart.h.


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