#include <GU_PrimVolume.h>

Inheritance diagram for GU_PrimVolume:

Public Types
typedef float(*	VolumeSampler )(const UT_Vector3 &, void *, const UT_JobInfo &)

Public Types inherited from GEO_PrimVolume
enum	StorageType { VOLUME_TYPE_INTEGER, VOLUME_TYPE_FLOAT, VOLUME_TYPE_VECTOR2, VOLUME_TYPE_VECTOR3, VOLUME_TYPE_VECTOR4 }

using	serialize = serializeT< float >

Public Types inherited from GEO_Primitive
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
	GU_PrimVolume (GU_Detail *gdp, GA_Offset offset=GA_INVALID_OFFSET)
	NOTE: This constructor should only be called via GU_PrimitiveFactory. More...

const GA_PrimitiveDefinition &	getTypeDef () const override

int64	getMemoryUsage () const override
	Report approximate memory usage. More...

void	countMemory (UT_MemoryCounter &counter) const override

GEO_Primitive *	convert (GEO_ConvertParms &parms, GA_PointGroup *usedpts=0) override

GEO_Primitive *	convertNew (GEO_ConvertParms &parms) override

void	normal (NormalComp &output) const override

void	normal (NormalCompD &output) const override

bool	writeVoxelsToLayer (IMX_Layer &layer) const

Public Member Functions inherited from GEO_PrimVolume
int	evaluateNormalVector (UT_Vector3 &nml, float u, float v=0, float w=0) const override

bool	getBBox (UT_BoundingBox *bbox) const override

void	addToBSphere (UT_BoundingSphere *bsphere) const override

void	enlargePointBounds (UT_BoundingBox &box) const override

bool	enlargeBoundingSphere (UT_BoundingSphere &b, const GA_Attribute *P) const override

UT_Vector3	baryCenter () const override
	For a volume the barycenter is the same as the point. More...

UT_Vector3	computeNormal () const override
	Return a normal vector for the primitive. More...

UT_Vector3D	computeNormalD () 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

bool	saveVoxelArray (UT_JSONWriter &w, const GA_SaveMap &map) const

bool	loadVoxelArray (UT_JSONParser &p, const GA_LoadMap &map)

bool	loadRes (const UT_JSONValue &jval)

bool	loadStorageType (const char *storagename)

bool	saveBorder (UT_JSONWriter &w, const GA_SaveMap &map) const

bool	loadBorder (UT_JSONParser &p, const GA_LoadMap &map)

bool	saveCompression (UT_JSONWriter &w, const GA_SaveMap &map) const

bool	loadCompression (UT_JSONParser &p, const GA_LoadMap &map)

bool	saveVisualization (UT_JSONWriter &w, const GA_SaveMap &map) const

bool	loadVisualization (UT_JSONParser &p, const GA_LoadMap &map)

void	transform (const UT_Matrix4 &mat) override

void	reverse () override
	Reverse the order of vertices. More...

GEO_Primitive *	copy (int preserve_shared_pts=0) const override

void	copyPrimitive (const GEO_Primitive *src) override

void	copySubclassData (const GA_Primitive *source) override

SYS_FORCE_INLINE GA_Offset	getVertexOffset () const

SYS_FORCE_INLINE GA_Offset	getPointOffset () const

SYS_FORCE_INLINE UT_Vector3	getPos3 () const

SYS_FORCE_INLINE void	setPos3 (const UT_Vector3 &pos)

int	detachPoints (GA_PointGroup &grp) override

GA_DereferenceStatus	dereferencePoint (GA_Offset point, bool dry_run=false) override

GA_DereferenceStatus	dereferencePoints (const GA_RangeMemberQuery &pt_q, bool dry_run=false) override

bool	isDegenerate () const override
	Is the primitive degenerate. More...

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

fpreal	calcVolume (const UT_Vector3 &refpt) const override

fpreal	calcArea () const override

void	setVertexPoint (GA_Offset pt)

void	assignVertex (GA_Offset new_vtx, bool update_topology)

void	stashed (bool beingstashed, GA_Offset offset=GA_INVALID_OFFSET) override

void	setTupleSize (int comps)

int	getTupleSize () const
	Returns the number of components (or the tuple size) for this volume. More...

void	setStoresIntegers (bool ints)

bool	getStoresIntegers () const
	Returns true if this volume stores integers. More...

StorageType	getStorageType () const
	Return the current storage type of the volume. More...

void	setStorageType (StorageType store)

bool	isScalarVolume () const
	True if this is a traditional scalar volume. More...

const UT_Matrix3 &	getTransform () const

void	setTransform (const UT_Matrix3 &m)

void	getTransform4 (UT_Matrix4 &matx) const

void	getTransform4 (UT_DMatrix4 &matx) const

void	setTransform4 (const UT_Matrix4 &matx)

void	setTransform4 (const UT_DMatrix4 &matx)

void	getLocalTransform (UT_Matrix3D &x) const override

void	setLocalTransform (const UT_Matrix3D &x) override
	Set the local transform. The default implementation does nothing. More...

const UT_Matrix3 &	getInverseTransform () const
	Converts from world space to local space. More...

void	getInverseTransform4 (UT_Matrix4 &matx) const

float	getTaperX () const

void	setTaperX (float t)

float	getTaperY () const

void	setTaperY (float t)

bool	isAligned (const GEO_PrimVolume *vol) const

bool	isWorldAxisAligned () const

GEO_PrimVolumeXform	getSpaceTransform () const

void	setSpaceTransform (GEO_PrimVolumeXform xform)

GEO_PrimVolumeXform	getIndexSpaceTransform () const

template<typename T >
GEO_PrimVolumeXform	getIndexSpaceTransform (const UT_VoxelArray< T > &vox) const

UT_Vector3	toVoxelSpace (const UT_Vector3 &pos) const
	Converts from world space to 0..1 voxel space. More...

UT_Vector3	fromVoxelSpace (const UT_Vector3 &pos) const
	Converts from 0..1 voxel space to world space. More...

void	toVoxelSpace (UT_BoundingBox &box) const
	Converts from world space to 0..1 voxel space. More...

void	fromVoxelSpace (UT_BoundingBox &box) const
	Converts from 0..1 voxel space to world space. More...

void	setVoxels (const UT_VoxelArrayF *vox)
	Copies the given voxel array and makes it our own voxel array. More...

void	setVoxels (const UT_VoxelArrayV2 *vox)

void	setVoxels (const UT_VoxelArrayV3 *vox)

void	setVoxels (const UT_VoxelArrayV4 *vox)

void	setVoxels (const UT_VoxelArrayI *vox)

void	setVoxels (UT_VoxelArrayHandleF handle)

void	setVoxels (UT_VoxelArrayHandleV2 handle)

void	setVoxels (UT_VoxelArrayHandleV3 handle)

void	setVoxels (UT_VoxelArrayHandleV4 handle)

void	setVoxels (UT_VoxelArrayHandleI handle)

void	stealVoxels (UT_VoxelArrayF *vox)

void	stealVoxels (UT_VoxelArrayV2 *vox)

void	stealVoxels (UT_VoxelArrayV3 *vox)

void	stealVoxels (UT_VoxelArrayV4 *vox)

void	stealVoxels (UT_VoxelArrayI *vox)

UT_VoxelArrayHandleF	getVoxelHandle () const

UT_VoxelArrayHandleF	getVoxelHandleF () const

UT_VoxelArrayHandleV2	getVoxelHandleV2 () const

UT_VoxelArrayHandleV3	getVoxelHandleV3 () const

UT_VoxelArrayHandleV4	getVoxelHandleV4 () const

UT_VoxelArrayHandleI	getVoxelHandleI () const

template<typename BASE >
UT_COWHandle< UT_VoxelArray < BASE > >	getVoxelHandleByType () const

template<typename BASE >
UT_COWWriteHandle < UT_VoxelArray< BASE > >	getVoxelWriteHandleByType ()

template<typename BASE = float>
UT_COWHandle< UT_VoxelArray < BASE > >	getHandleToVoxelsWithoutLoading () const

UT_VoxelArrayWriteHandleF	getVoxelWriteHandle ()
	This is a handle that you can write to and affect the volume. More...

UT_VoxelArrayWriteHandleF	getVoxelWriteHandleF ()

UT_VoxelArrayWriteHandleV2	getVoxelWriteHandleV2 ()

UT_VoxelArrayWriteHandleV3	getVoxelWriteHandleV3 ()

UT_VoxelArrayWriteHandleV4	getVoxelWriteHandleV4 ()

UT_VoxelArrayWriteHandleI	getVoxelWriteHandleI ()

template<typename OP >
void	dispatchToReadHandle (OP &op) const

template<typename OP >
void	dispatchToWriteHandle (OP &op, bool force_load)

template<typename OP >
void	dispatch (const OP &op) const

bool	indexToPos (int x, int y, int z, UT_Vector3 &pos) const

void	findexToPos (UT_Vector3 index, UT_Vector3 &pos) const

bool	indexToPos (exint x, exint y, exint z, UT_Vector3D &pos) const

void	findexToPos (UT_Vector3D index, UT_Vector3D &pos) const

bool	isInside (UT_Vector3 pos) const

bool	isInsideStrict (UT_Vector3 pos) const

template<typename T >
bool	isInsideStrict (const UT_Vector3 &opos, const UT_COWReadHandle< UT_VoxelArray< T >> &vox) const

bool	isIndexInside (int x, int y, int z) const
	Returns true only if index is inside. More...

template<typename T >
bool	isIndexInside (int x, int y, int z, const UT_COWReadHandle< UT_VoxelArray< T >> &vox) const
	By passing in a specific read handle, we can accelerate. More...

bool	posToIndex (UT_Vector3 pos, int &x, int &y, int &z) const

bool	posToIndex (UT_Vector3 pos, UT_Vector3 &index) const

bool	posToIndex (UT_Vector3D pos, exint &x, exint &y, exint &z) const

bool	posToIndex (UT_Vector3D pos, UT_Vector3D &index) const

fpreal	getValue (const UT_Vector3 &pos) const
	Evaluate the voxel value at the given world space position. More...

void	getValues (float f, int stride, const UT_Vector3 p, int num) const

void	getValues (double f, int stride, const UT_Vector3D p, int num) const

void	getValues (UT_Vector2F f, int stride, const UT_Vector3 p, int num) const

void	getValues (UT_Vector2D f, int stride, const UT_Vector3D p, int num) const

void	getValues (UT_Vector3F f, int stride, const UT_Vector3 p, int num) const

void	getValues (UT_Vector3D f, int stride, const UT_Vector3D p, int num) const

void	getValues (UT_Vector4F f, int stride, const UT_Vector3 p, int num) const

void	getValues (UT_Vector4D f, int stride, const UT_Vector3D p, int num) const

void	getValues (int32 f, int stride, const UT_Vector3 p, int num) const

void	getValues (int64 f, int stride, const UT_Vector3D p, int num) const

UT_Vector3	getGradient (const UT_Vector3 &pos) const

UT_Vector3	getGradient (const UT_Vector3 &pos, const UT_VoxelArrayReadHandleF &handle) const

fpreal	getValue (const UT_Vector3 &pos, const UT_VoxelArrayReadHandleF &handle) const

template<typename TYPE >
TYPE	getValueByType (const UT_Vector3 &pos) const

template<typename TYPE >
TYPE	getValueByType (const UT_Vector3 &pos, const UT_VoxelArrayReadHandle< TYPE > &vox) const

fpreal	getValueAtIndex (int ix, int iy, int iz) const
	Evaluate the specific voxel indexed from 0,0,0. More...

void	getValuesAtIndices (float f, int stride, const int ix, const int iy, const int iz, int num) const

void	getValuesAtIndices (int f, int stride, const int ix, const int iy, const int iz, int num) const

void	getValuesAtIndices (double f, int stride, const exint ix, const exint iy, const exint iz, int num) const

void	getValuesAtIndices (exint f, int stride, const exint ix, const exint iy, const exint iz, int num) const

void	getRes (int &rx, int &ry, int &rz) const
	Returns the resolution of the voxel array. More...

void	getRes (int64 &rx, int64 &ry, int64 &rz) const

fpreal	getVoxelDiameter () const

UT_Vector3	getVoxelSize () const
	Returns the length of the voxel when you take an x, y, and z step. More...

fpreal	calcPositiveDensity () const

fpreal	calcMinimum () const
	Compute useful aggregate properties of the volume. More...

fpreal	calcMaximum () const

fpreal	calcAverage () const

bool	isSDF () const

bool	computeHeightFieldProperties (int &a1, int &a2, int &axis, fpreal &scale) const

bool	computeHeightFieldProperties (int &a1, int &a2, int &axis, fpreal &scale, const UT_VoxelArrayF &vox, const GEO_PrimVolumeXform &indexxform) const

void	setBorder (GEO_VolumeBorder border, fpreal val, int component=0)

GEO_VolumeBorder	getBorder () const

fpreal	getBorderValue (int component=0) const

fpreal	getCompressionTolerance () const
	Control the compression of these objects. More...

void	setCompressionTolerance (fpreal tol)

void	recompress ()

const GEO_VolumeOptions &	getVisOptions () const

void	setVisOptions (const GEO_VolumeOptions &vis)

void	setVisualization (GEO_VolumeVis vis, fpreal iso, fpreal density)

fpreal	getVisIso () const

fpreal	getVisDensity () const

fpreal	getVisTiles () const

void	setVisTiles (fpreal tiles)

GEO_VolumeVis	getVisualization () const

GEO_VolumeTypeInfo	getTypeInfo () const

void	setTypeInfo (GEO_VolumeTypeInfo info)

const GA_PrimitiveJSON *	getJSON () const override

serialize	getSerialize () const

template<typename T >
serializeT< T >	getSerializeByType () const

CE_Grid *	getCEGrid (bool read, bool write) const

UT_SharedPtr< IMX_Layer >	getIMXLayer (bool read, bool write) const

void	flushCEWriteCaches () override

void	flushCECaches () override

void	stealCEBuffers (const GA_Primitive *src) override
	Steal the underlying CE buffer from the source. More...

void	setBorrowedIMXLayer (const UT_SharedPtr< IMX_Layer > &l)

bool	hasBorrowedIMXLayer () const

void	setBorrowedCEGrid (CE_Grid *grid)

bool	hasBorrowedCEGrid () const

bool	isFullyLoaded () const

bool	enlargeBoundingBox (UT_BoundingRect &b, const GA_Attribute *P) const override

bool	enlargeBoundingBox (UT_BoundingBox &b, const GA_Attribute *P) const override

bool	registerSharedLoadData (int dtype, GA_SharedDataHandlePtr data) override

bool	saveSharedLoadData (UT_JSONWriter &w, GA_SaveMap &save, GA_GeometryIndex *geo_index) const override

bool	getSharedVoxelKey (UT_WorkBuffer &key) const

Public Member Functions inherited from GEO_Primitive
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	realToUnitPair (float ureal, float vreal, float &uunit, float &vunit) const

virtual void	unitToRealPair (float uunit, float vunit, float &ureal, float &vreal) 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

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_Detail *	getParent () const

virtual bool	getVisibleBBox (UT_BoundingBox *bbox) const

bool	enlargeVisibleBoundingBox (UT_BoundingBox &b, const GA_Attribute *P) const override

virtual UT_Vector3D	baryCenterD () const

template<typename T >
UT_Vector3T< T >	baryCenterT () const

virtual void	isolate ()
	Method to isolate a pasted surface. More...

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_MetaPrim *	castToMetaPrim ()

virtual const GEO_MetaPrim *	castToMetaPrim () 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	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

fpreal	calcPerimeter () const override

Public Member Functions inherited from GA_Primitive
virtual	~GA_Primitive ()

const char *	getTypeName () const

SYS_FORCE_INLINE GA_Detail &	getDetail () 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	getLocalTransform4 (UT_Matrix4D &matrix) 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< T >	getPos3T (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

void	copyUnwiredForMerge (const GA_Primitive *src, const GA_MergeMap &map)

const GA_IntrinsicManager &	getIntrinsicManager () 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_Detail *	getSecondaryDetail (GA_Index i) const

virtual GA_Detail *	getSecondaryDetail (GA_Index i)

GA_Index	getNumSecondary (GA_Index detail) const

const GA_Primitive *	getSecondaryByIndex (GA_Index detail, GA_Index i) const

GA_Primitive *	getSecondaryByIndex (GA_Index detail, GA_Index i)

const GA_Primitive *	getSecondaryByOffset (GA_Index detail, GA_Offset o) const

GA_Primitive *	getSecondaryByOffset (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

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

bool	getIntrinsicCollapseSingletons (GA_LocalIntrinsic h) const

GA_StorageClass	getIntrinsicStorage (GA_LocalIntrinsic h) const

bool	getIntrinsicReadOnly (GA_LocalIntrinsic h) const

const UT_Options *	getIntrinsicOptions (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 GEO_PrimVolume *	build (GU_Detail *gdp, bool integers=false, int comps=1)

static GEO_PrimVolume *	buildFromFunction (GU_Detail gdp, float(valAtPoint)(const UT_Vector3 &, void data), void data, const UT_BoundingBox &bbox, int xres, int yres, int zres)

static GEO_PrimVolume *	buildFromLayer (GU_Detail *gdp, UT_SharedPtr< IMX_Layer > layer)

static GEO_PrimVolume *	buildFromLayer (GU_Detail *gdp, UT_SharedPtr< const IMX_Layer > layer)

static GEO_PrimVolume *	buildFromFunction (GU_Detail gdp, float(valAtPoint)(const UT_Vector3 &, void , const UT_JobInfo &), void data, const UT_BoundingBox &bbox, int xres, int yres, int zres, bool allowthreading=true)

Static Public Member Functions inherited from GEO_PrimVolume
template<typename OP >
static void	dispatch (StorageType storage, const OP &op)

static const char *	getBorderToken (GEO_VolumeBorder border)
	Get the border options in terms of GEO's values. More...

static GEO_VolumeBorder	getBorderEnum (const char *token, GEO_VolumeBorder def=GEO_VOLUMEBORDER_STREAK)

static const char *	getVisualizationToken (GEO_VolumeVis vis)
	Control how we display this in the viewport. More...

static GEO_VolumeVis	getVisualizationEnum (const char *vis, GEO_VolumeVis def=GEO_VOLUMEVIS_SMOKE)

static GA_PrimitiveDefinition::SharedDataLoader *	allocateSharedDataLoader ()

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
	~GU_PrimVolume () override

	THREADED_METHOD5 (GU_PrimVolume, vox->numTiles() > 1, buildFromFunctionInternal, UT_VoxelArrayF , vox, const UT_Matrix3 &, xform, const UT_Vector3 &, center, VolumeSampler, valAtPoint, void , data) void buildFromFunctionInternalPartial(UT_VoxelArrayF *vox

Protected Member Functions inherited from GEO_PrimVolume
	GEO_PrimVolume (GEO_Detail *d, GA_Offset offset=GA_INVALID_OFFSET)

	~GEO_PrimVolume () override

virtual void	clearForDeletion ()

virtual void	swapVertexOffsets (const GA_Defragment &defrag)
	Defragmentation. More...

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

virtual bool	loadPrivateH9 (UT_IStream &is)

bool	loadVoxelDataH9 (UT_IStream &is, UT_VoxelArrayWriteHandleF voxels, int version)

void	resetAndAllocateHandles ()

GA_Offset	vertexPoint () const

UT_VoxelArrayHandleF &	getMyVoxelHandleF () const
	Gets the handle to our voxels. More...

UT_VoxelArrayHandleV2 &	getMyVoxelHandleV2 () const

UT_VoxelArrayHandleV3 &	getMyVoxelHandleV3 () const

UT_VoxelArrayHandleV4 &	getMyVoxelHandleV4 () const

UT_VoxelArrayHandleI &	getMyVoxelHandleI () const

bool	evaluatePointRefMap (GA_Offset result_vtx, GA_AttributeRefMap &hlist, fpreal u, fpreal v, uint du, uint dv) const override

int	evaluatePointV4 (UT_Vector4 &pos, float u, float v=0, unsigned du=0, unsigned dv=0) const override

bool	evaluateBaryCenterRefMap (GA_Offset result_vertex, GA_AttributeRefMap &hlist) const override

bool	evaluateInteriorPointRefMap (GA_Offset result_vtx, GA_AttributeRefMap &map, fpreal u, fpreal v, fpreal w=0) const override

int	evaluateInteriorPointV4 (UT_Vector4 &pos, fpreal u, fpreal v, fpreal w=0) const override

Protected Member Functions inherited from GEO_Primitive
SYS_FORCE_INLINE	GEO_Primitive (GA_Detail *d, GA_Offset offset=GA_INVALID_OFFSET)

	~GEO_Primitive () override

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)

Protected Attributes
const UT_Matrix3 &	xform

const UT_Matrix3 const UT_Vector3 &	center

const UT_Matrix3 const UT_Vector3 VolumeSampler	valAtPoint

const UT_Matrix3 const UT_Vector3 VolumeSampler void *	data

const UT_Matrix3 const UT_Vector3 VolumeSampler void const UT_JobInfo &	info

Protected Attributes inherited from GEO_PrimVolume
bool	myStoreIntegers

int	myChannelCount

UT_VoxelArrayHandleF	myVoxelHandleF

UT_VoxelArrayHandleV2	myVoxelHandleU

UT_VoxelArrayHandleV3	myVoxelHandleV

UT_VoxelArrayHandleV4	myVoxelHandleP

UT_VoxelArrayHandleI	myVoxelHandleI

GA_SharedDataHandlePtr	mySharedVoxelData

UT_Lock	mySharedDataLock

bool	mySharedDataHandleLoaded

CE_Grid *	myCEGrid

bool	myCEGridAuthorative

bool	myCEGridIsOwned

UT_SharedPtr< IMX_Layer >	myIMXLayer

bool	myIMXLayerAuthorative

bool	myIMXLayerIsOwned

Protected Attributes inherited from GA_Primitive
GA_OffsetList	myVertexList

Friends
class	GU_PrimitiveFactory

Additional Inherited Members
Static Public Attributes inherited from GEO_PrimVolume
static const int	theSharedVoxelMagic =('V'<<24)\|('o'<<16)\|('x'<<8)\|('l')

Static Public Attributes inherited from GEO_Primitive
static const UT_Array < GA_AttribSaveDataH9 > &	theEmptySaveAttribs
	Convience objects to pass as arguments to saveH9()/loadH9(). More...

Static Protected Member Functions inherited from GEO_PrimVolume
static GA_PrimitiveFamilyMask	buildFamilyMask ()

Static Protected Member Functions inherited from GEO_Primitive
static GA_IntrinsicManager::Registrar	registerIntrinsics (GA_PrimitiveDefinition &defn)

Detailed Description

Examples:: field3d/f3d_io.C, GEO/GEO_VoxelTranslator.C, standalone/gengeovolume.C, and standalone/geo2voxel.C.

Definition at line 27 of file GU_PrimVolume.h.

Member Typedef Documentation

typedef float(* GU_PrimVolume::VolumeSampler)(const UT_Vector3 &, void *, const UT_JobInfo &)

Definition at line 106 of file GU_PrimVolume.h.

Constructor & Destructor Documentation

GU_PrimVolume::~GU_PrimVolume ( )

inlineoverrideprotected

NOTE: Primitives should not be deleted directly. They are managed by the GA_PrimitiveList and the stash.

Definition at line 32 of file GU_PrimVolume.h.

GU_PrimVolume::GU_PrimVolume	(	GU_Detail *	gdp,
		GA_Offset	offset = `GA_INVALID_OFFSET`
	)

inline

NOTE: This constructor should only be called via GU_PrimitiveFactory.

Definition at line 36 of file GU_PrimVolume.h.

Member Function Documentation

static GEO_PrimVolume* GU_PrimVolume::build	(	GU_Detail *	gdp,
		bool	integers = `false`,
		int	comps = `1`
	)

static

Examples:: field3d/f3d_io.C, GEO/GEO_VoxelTranslator.C, standalone/gengeovolume.C, and standalone/geo2voxel.C.

static GEO_PrimVolume* GU_PrimVolume::buildFromFunction	(	GU_Detail *	gdp,
		float()(const UT_Vector3 &, void data)	valAtPoint,
		void *	data,
		const UT_BoundingBox &	bbox,
		int	xres,
		int	yres,
		int	zres
	)

static

static GEO_PrimVolume* GU_PrimVolume::buildFromFunction	(	GU_Detail *	gdp,
		float()(const UT_Vector3 &, void , const UT_JobInfo &)	valAtPoint,
		void *	data,
		const UT_BoundingBox &	bbox,
		int	xres,
		int	yres,
		int	zres,
		bool	allowthreading = `true`
	)

static

static GEO_PrimVolume* GU_PrimVolume::buildFromLayer	(	GU_Detail *	gdp,
		UT_SharedPtr< IMX_Layer >	layer
	)

static

static GEO_PrimVolume* GU_PrimVolume::buildFromLayer	(	GU_Detail *	gdp,
		UT_SharedPtr< const IMX_Layer >	layer
	)

static

GEO_Primitive* GU_PrimVolume::convert	(	GEO_ConvertParms &	parms,
		GA_PointGroup *	usedpts = `0`
	)

overridevirtual

Implements GEO_Primitive.

GEO_Primitive* GU_PrimVolume::convertNew ( GEO_ConvertParms & parms )

overridevirtual

Implements GEO_Primitive.

void GU_PrimVolume::countMemory ( UT_MemoryCounter & counter ) const

overridevirtual

Count memory usage using a UT_MemoryCounter in order to count shared memory correctly. NOTE: This should always include sizeof(*this).

Reimplemented from GA_Primitive.

int64 GU_PrimVolume::getMemoryUsage ( ) const

overridevirtual

Report approximate memory usage.

Reimplemented from GA_Primitive.

const GA_PrimitiveDefinition& GU_PrimVolume::getTypeDef ( ) const

inlineoverridevirtual

Implements GA_Primitive.

Definition at line 40 of file GU_PrimVolume.h.

void GU_PrimVolume::normal ( NormalComp & output ) const

inlineoverridevirtual

Implements GEO_Primitive.

Definition at line 59 of file GU_PrimVolume.h.

void GU_PrimVolume::normal ( NormalCompD & output ) const

inlineoverridevirtual

Implements GEO_Primitive.

Definition at line 60 of file GU_PrimVolume.h.

GU_PrimVolume::THREADED_METHOD5	(	GU_PrimVolume	,
		vox->	numTiles(),
		1	,
		buildFromFunctionInternal	,
		UT_VoxelArrayF *	,
		vox	,
		const UT_Matrix3 &	,
		xform	,
		const UT_Vector3 &	,
		center	,
		VolumeSampler	,
		valAtPoint	,
		void *	,
		data
	)

protected

bool GU_PrimVolume::writeVoxelsToLayer ( IMX_Layer & layer ) const

Friends And Related Function Documentation

friend class GU_PrimitiveFactory

friend

Definition at line 126 of file GU_PrimVolume.h.

Member Data Documentation

const UT_Matrix3 const UT_Vector3& GU_PrimVolume::center

protected

Definition at line 118 of file GU_PrimVolume.h.

const UT_Matrix3 const UT_Vector3 VolumeSampler void* GU_PrimVolume::data

protected

Definition at line 118 of file GU_PrimVolume.h.

const UT_Matrix3 const UT_Vector3 VolumeSampler void const UT_JobInfo& GU_PrimVolume::info

protected

Definition at line 118 of file GU_PrimVolume.h.

const UT_Matrix3 const UT_Vector3 VolumeSampler GU_PrimVolume::valAtPoint

protected

Definition at line 118 of file GU_PrimVolume.h.

const UT_Matrix3& GU_PrimVolume::xform

protected

Definition at line 118 of file GU_PrimVolume.h.

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

GU/GU_PrimVolume.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation