GEO_PrimVolume Class Reference

#include <GEO_PrimVolume.h>

Inheritance diagram for GEO_PrimVolume:

List of all members.

Classes

class serialize

Public Member Functions

GEO_PrimVolume (GEO_Detail *d, GA_Offset offset=GA_INVALID_OFFSET)

virtual ~GEO_PrimVolume ()

virtual int getBBox (UT_BoundingBox *bbox) const

virtual void addToBSphere (UT_BoundingSphere *bsphere) const

virtual void enlargePointBounds (UT_BoundingBox &box) const

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

virtual UT_Vector3 baryCenter () const

For a volume the barycenter is the same as the point.

virtual UT_Vector3 computeNormal () const

Return a normal vector for the primitive.

virtual bool saveH9 (ostream &os, bool binary, const UT_RefArray< GA_AttribSaveDataH9 > &prim_attribs, const UT_RefArray< GA_AttribSaveDataH9 > &vtx_attribs) const

virtual bool loadH9 (UT_IStream &is, const UT_RefArray< GA_AttribLoadDataH9 > &prim_attribs, const UT_RefArray< GA_AttribLoadDataH9 > &vtx_attribs)

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 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)

virtual void transform (const UT_Matrix4 &mat)

virtual void untransform (void)

virtual GEO_Primitive * copy (int preserve_shared_pts=0) const

virtual void copyPrimitive (const GEO_Primitive *src, GEO_Point **ptredirect)

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

virtual void addPointRefToGroup (GA_PointGroup &grp) const

virtual int vertexApply (int(*a)(GEO_Vertex, void *), void *)

virtual int vertexApply (int(*a)(const GEO_Vertex &, void *), void *) const

virtual void reverse (void)

Reverse the order of vertices.

virtual GA_Size getVertexCount () const

Return the number of vertices used by this primitive.

virtual GA_Offset getVertexOffset (GA_Size index) 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)

virtual bool isDegenerate () const

Is the primitive degenerate.

virtual void unitLengthToUnitPair (float ulength, float vlength, float &uparm, float &vparm) const

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

virtual fpreal calcVolume (const UT_Vector3 &refpt) const

virtual fpreal calcArea () const

void setVertex (GEO_Point *ppt)

void setVertexPoint (GA_Offset pt)

void assignVertex (GA_Offset new_vtx, bool update_topology)

virtual void stashed (int onoff, GA_Offset offset=GA_INVALID_OFFSET)

const UT_Matrix3 & getTransform (void) 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)

const UT_Matrix3 & getInverseTransform () const

Converts from world space to local space.

void getInverseTransform4 (UT_Matrix4 &matx) const

float getTaperX (void) const

void setTaperX (float t)

float getTaperY (void) const

void setTaperY (float t)

bool isAligned (const GEO_PrimVolume *vol) const

GEO_PrimVolumeXform getSpaceTransform () const

UT_Vector3 toVoxelSpace (const UT_Vector3 &pos) const

Converts from world space to 0..1 voxel space.

UT_Vector3 fromVoxelSpace (const UT_Vector3 &pos) const

Converts from 0..1 voxel space to world space.

void toVoxelSpace (UT_BoundingBox &box) const

Converts from world space to 0..1 voxel space.

void fromVoxelSpace (UT_BoundingBox &box) const

Converts from 0..1 voxel space to world space.

void setVoxels (const UT_VoxelArrayF *vox)

Copies the given voxel array and makes it our own voxel array.

void setVoxels (UT_VoxelArrayHandleF handle)

void stealVoxels (UT_VoxelArrayF *vox)

UT_VoxelArrayHandleF getVoxelHandle () const

UT_VoxelArrayWriteHandleF getVoxelWriteHandle ()

This is a handle that you can write to and affect the volume.

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

void findexToPos (UT_Vector3 index, UT_Vector3 &pos) const

bool isInside (UT_Vector3 pos) const

bool isInsideStrict (UT_Vector3 pos) const

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

fpreal getValue (const UT_Vector3 &pos) const

Evaluate the voxel value at the given world space position.

UT_Vector3 getGradient (const UT_Vector3 &pos) const

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

fpreal getValueAtIndex (int ix, int iy, int iz) const

Evaluate the specific voxel indexed from 0,0,0.

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

Returns the resolution of the voxel array.

fpreal getVoxelDiameter () const

UT_Vector3 getVoxelSize () const

Returns the length of the voxel when you take an x, y, and z step.

fpreal calcPositiveDensity () const

fpreal calcMinimum () const

Compute useful aggregate properties of the volume.

fpreal calcMaximum () const

fpreal calcAverage () const

bool isSDF () const

void setBorder (GEO_VolumeBorder border, fpreal val)

GEO_VolumeBorder getBorder () const

fpreal getBorderValue () const

fpreal getCompressionTolerance () const

Control the compression of these objects.

void setCompressionTolerance (fpreal tol)

void recompress ()

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

fpreal getVisIso () const

fpreal getVisDensity () const

GEO_VolumeVis getVisualization () const

virtual const GA_PrimitiveJSON * getJSON () const

serialize getSerialize () const

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

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

Static Public Member Functions

static const char * getBorderToken (GEO_VolumeBorder border)

Get the border options in terms of GEO's values.

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.

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

Protected Member Functions

GEO_PrimVolume (const GA_MergeMap &map, GEO_Detail &detail, GA_Offset offset, const GEO_PrimVolume &src)

virtual void swapVertexOffsets (const GA_Defragment &defrag)

Defragmentation.

virtual void copyOffsetPrimitive (const GEO_Primitive *src, int basept)

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

virtual bool loadPrivateH9 (UT_IStream &is)

virtual int isPointUsed (GA_GBPoint *pt) const

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

GA_Offset vertexPoint () const

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

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

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

virtual bool evaluateInteriorPointRefMap (GA_Offset result, 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

virtual int localIntrinsicTupleSize (const GA_IntrinsicEval &eval) const

virtual int localGetIntrinsicS (const GA_IntrinsicEval &eval, UT_String &value) const

virtual int localGetIntrinsicSA (const GA_IntrinsicEval &eval, UT_StringArray &value) const

virtual int localGetIntrinsicI (const GA_IntrinsicEval &eval, int64 *value, GA_Size size) const

virtual int localGetIntrinsicF (const GA_IntrinsicEval &eval, fpreal *value, GA_Size size) const

virtual int localSetIntrinsicSA (const GA_IntrinsicEval &eval, const UT_StringArray &value)

virtual int localSetIntrinsicSS (const GA_IntrinsicEval &eval, const char **value, GA_Size size)

virtual int localSetIntrinsicI (const GA_IntrinsicEval &eval, const int64 *value, GA_Size size)

virtual int localSetIntrinsicF (const GA_IntrinsicEval &eval, const fpreal *value, GA_Size size)

Static Protected Member Functions

static GA_PrimitiveFamilyMask buildFamilyMask ()

static
GA_IntrinsicManager::Registrar registerIntrinsics (GA_PrimitiveDefinition &defn)

Protected Attributes

UT_VoxelArrayHandleF myVoxelHandle

Friends

ostream & operator<< (ostream &os, const GEO_PrimVolume &d)

Detailed Description

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

Definition at line 165 of file GEO_PrimVolume.h.

Constructor & Destructor Documentation

GEO_PrimVolume::GEO_PrimVolume	(	GEO_Detail *	d,
		GA_Offset	offset = `GA_INVALID_OFFSET`
	)

virtual GEO_PrimVolume::~GEO_PrimVolume ( ) [virtual]

GEO_PrimVolume::GEO_PrimVolume	(	const GA_MergeMap &	map,
		GEO_Detail &	detail,
		GA_Offset	offset,
		const GEO_PrimVolume &	src
	)			`[protected]`

Member Function Documentation

virtual void GEO_PrimVolume::addPointRefToGroup ( GA_PointGroup & grp ) const [virtual]

Add all points referenced by the primitive to the given group. This defaults to iterating over the vertices and adding their referenced points.

Reimplemented from GEO_Primitive.

virtual void GEO_PrimVolume::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.

void GEO_PrimVolume::assignVertex	(	GA_Offset	new_vtx,
		bool	update_topology
	)

This method assigns a preallocated vertex to the quadric, optionally creating the topological link between the primitive and new vertex.

virtual UT_Vector3 GEO_PrimVolume::baryCenter ( ) const [virtual]

For a volume the barycenter is the same as the point.

Reimplemented from GEO_Primitive.

static GA_PrimitiveFamilyMask GEO_PrimVolume::buildFamilyMask ( ) [inline, static, protected]

Definition at line 511 of file GEO_PrimVolume.h.

virtual fpreal GEO_PrimVolume::calcArea ( ) const [virtual]

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

Reimplemented from GEO_Primitive.

fpreal GEO_PrimVolume::calcAverage ( ) const

fpreal GEO_PrimVolume::calcMaximum ( ) const

fpreal GEO_PrimVolume::calcMinimum ( ) const

Compute useful aggregate properties of the volume.

fpreal GEO_PrimVolume::calcPositiveDensity ( ) const

Computes the total density of the volume, scaled by the volume's size. Negative values will be ignored.

virtual fpreal GEO_PrimVolume::calcVolume ( const UT_Vector3 & ) const [virtual]

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

Reimplemented from GEO_Primitive.

virtual UT_Vector3 GEO_PrimVolume::computeNormal ( ) const [virtual]

Return a normal vector for the primitive.

Implements GEO_Primitive.

virtual GEO_Primitive* GEO_PrimVolume::copy ( int preserve_shared_pts = 0 ) const [virtual]

Reimplemented from GEO_Primitive.

virtual void GEO_PrimVolume::copyOffsetPrimitive	(	const GEO_Primitive *	src,
		int	basept
	)			`[protected, virtual]`

Implements GEO_Primitive.

virtual void GEO_PrimVolume::copyPrimitive	(	const GEO_Primitive *	src,
		GEO_Point **	ptredirect
	)			`[virtual]`

Implements GEO_Primitive.

virtual void GEO_PrimVolume::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

Implements GA_Primitive.

virtual GA_DereferenceStatus GEO_PrimVolume::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_PrimVolume::dereferencePoints	(	const GA_RangeMemberQuery &	pt_q,
		bool	dry_run = `false`
	)			`[virtual]`

Implements GA_Primitive.

virtual int GEO_PrimVolume::detachPoints ( GA_PointGroup & grp ) [virtual]

Implements GEO_Primitive.

virtual bool GEO_PrimVolume::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. For any attribute other than the position these methods simply enlarge the bounding box based on the vertex.

Reimplemented from GEO_Primitive.

virtual bool GEO_PrimVolume::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. For any attribute other than the position these methods simply enlarge the bounding box based on the vertex.

Reimplemented from GEO_Primitive.

virtual bool GEO_PrimVolume::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. For any attribute other than the position this method simply enlarges the sphere based on the vertex.

Reimplemented from GA_Primitive.

virtual void GEO_PrimVolume::enlargePointBounds ( UT_BoundingBox & box ) const [virtual]

Enlarge a point bounding box for implicit primitive bounds. If a primitive (such as a sphere) has a bounding box larger than its point hull, then it should implement this method. Otherwise, it can rely on the default behaviour.

Reimplemented from GA_Primitive.

virtual bool GEO_PrimVolume::evaluateBaryCenterRefMap	(	GA_Offset	result,
		GA_AttributeRefMap &	map
	)			const `[protected, virtual]`

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_PrimVolume::evaluateInteriorPointRefMap	(	GA_Offset	result,
		GA_AttributeRefMap &	map,
		fpreal	u,
		fpreal	v,
		fpreal	w = `0`
	)			const `[protected, virtual]`

Reimplemented from GEO_Primitive.

virtual int GEO_PrimVolume::evaluateInteriorPointV4	(	UT_Vector4 &	pos,
		fpreal	u,
		fpreal	v,
		fpreal	w = `0`
	)			const `[protected, virtual]`

Reimplemented from GEO_Primitive.

virtual bool GEO_PrimVolume::evaluatePointRefMap	(	GA_Offset	result_vtx,
		GA_AttributeRefMap &	hlist,
		fpreal	u,
		fpreal	v,
		uint	du,
		uint	dv
	)			const `[protected, virtual]`

Implements GEO_Primitive.

virtual int GEO_PrimVolume::evaluatePointV4	(	UT_Vector4 &	pos,
		float	u,
		float	v = `0`,
		unsigned	du = `0`,
		unsigned	dv = `0`
	)			const `[inline, protected, virtual]`

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

Reimplemented from GEO_Primitive.

Definition at line 563 of file GEO_PrimVolume.h.

void GEO_PrimVolume::findexToPos	(	UT_Vector3	index,
		UT_Vector3 &	pos
	)			const

void GEO_PrimVolume::fromVoxelSpace ( UT_BoundingBox & box ) const

Converts from 0..1 voxel space to world space.

UT_Vector3 GEO_PrimVolume::fromVoxelSpace ( const UT_Vector3 & pos ) const

Converts from 0..1 voxel space to world space.

Examples:: field3d/f3d_io.C.

virtual int GEO_PrimVolume::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.

Examples:: SOP/SOP_Surface.C.

GEO_VolumeBorder GEO_PrimVolume::getBorder ( ) const

static GEO_VolumeBorder GEO_PrimVolume::getBorderEnum	(	const char *	token,
		GEO_VolumeBorder	def = `GEO_VOLUMEBORDER_STREAK`
	)			`[static]`

static const char* GEO_PrimVolume::getBorderToken ( GEO_VolumeBorder border ) [static]

Get the border options in terms of GEO's values.

fpreal GEO_PrimVolume::getBorderValue ( ) const

fpreal GEO_PrimVolume::getCompressionTolerance ( ) const

Control the compression of these objects.

UT_Vector3 GEO_PrimVolume::getGradient ( const UT_Vector3 & pos ) const

const UT_Matrix3& GEO_PrimVolume::getInverseTransform ( ) const [inline]

Converts from world space to local space.

Definition at line 308 of file GEO_PrimVolume.h.

void GEO_PrimVolume::getInverseTransform4 ( UT_Matrix4 & matx ) const

virtual const GA_PrimitiveJSON* GEO_PrimVolume::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.

void GEO_PrimVolume::getRes	(	int &	rx,
		int &	ry,
		int &	rz
	)			const

Returns the resolution of the voxel array.

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

serialize GEO_PrimVolume::getSerialize ( ) const [inline]

Definition at line 504 of file GEO_PrimVolume.h.

GEO_PrimVolumeXform GEO_PrimVolume::getSpaceTransform ( ) const

Returns the POD class which can convert to and from voxel space.

float GEO_PrimVolume::getTaperX ( void ) const [inline]

Examples:: field3d/f3d_io.C.

Definition at line 311 of file GEO_PrimVolume.h.

float GEO_PrimVolume::getTaperY ( void ) const [inline]

Examples:: field3d/f3d_io.C.

Definition at line 313 of file GEO_PrimVolume.h.

const UT_Matrix3& GEO_PrimVolume::getTransform ( void ) const [inline]

Definition at line 295 of file GEO_PrimVolume.h.

void GEO_PrimVolume::getTransform4 ( UT_DMatrix4 & matx ) const

void GEO_PrimVolume::getTransform4 ( UT_Matrix4 & matx ) const

Examples:: field3d/f3d_io.C.

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

By passing in a specific read handle and inverse transform we can accelerate the getValue()

fpreal GEO_PrimVolume::getValue ( const UT_Vector3 & pos ) const

Evaluate the voxel value at the given world space position.

fpreal GEO_PrimVolume::getValueAtIndex	(	int	ix,
		int	iy,
		int	iz
	)			const

Evaluate the specific voxel indexed from 0,0,0.

virtual GA_Size GEO_PrimVolume::getVertexCount ( ) const [virtual]

Return the number of vertices used by this primitive.

Implements GA_Primitive.

virtual GA_Offset GEO_PrimVolume::getVertexOffset ( GA_Size index ) const [virtual]

Given an vertex number (into the primitive's vertex list), return the vertex offset.

Implements GA_Primitive.

fpreal GEO_PrimVolume::getVisDensity ( ) const [inline]

Definition at line 422 of file GEO_PrimVolume.h.

fpreal GEO_PrimVolume::getVisIso ( ) const [inline]

Definition at line 421 of file GEO_PrimVolume.h.

GEO_VolumeVis GEO_PrimVolume::getVisualization ( ) const [inline]

Definition at line 423 of file GEO_PrimVolume.h.

static GEO_VolumeVis GEO_PrimVolume::getVisualizationEnum	(	const char *	vis,
		GEO_VolumeVis	def = `GEO_VOLUMEVIS_SMOKE`
	)			`[static]`

static const char* GEO_PrimVolume::getVisualizationToken ( GEO_VolumeVis vis ) [static]

Control how we display this in the viewport.

fpreal GEO_PrimVolume::getVoxelDiameter ( ) const

Computes the voxel diameter by taking a step in x, y, and z converting to world space and taking the length of that vector.

UT_VoxelArrayHandleF GEO_PrimVolume::getVoxelHandle ( ) const

Returns a handle to a voxel array containing our data. This is should be thought of a copy of the data - changing it will not change the underlying data, casting this to a write handle will write to the newly created handle, not the one stored in this volume.

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

UT_Vector3 GEO_PrimVolume::getVoxelSize ( ) const

Returns the length of the voxel when you take an x, y, and z step.

UT_VoxelArrayWriteHandleF GEO_PrimVolume::getVoxelWriteHandle ( )

This is a handle that you can write to and affect the volume.

Examples:: field3d/f3d_io.C, and standalone/gengeovolume.C.

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

Convert an index in the voxel array into the corresponidng worldspace location

Examples:: GEO/GEO_VoxelTranslator.C, and standalone/geo2voxel.C.

bool GEO_PrimVolume::isAligned ( const GEO_PrimVolume * vol ) const

True if the two volumes have same resolution and map the same indices to the same positions.

virtual bool GEO_PrimVolume::isDegenerate ( ) const [virtual]

Is the primitive degenerate.

Implements GA_Primitive.

bool GEO_PrimVolume::isInside ( UT_Vector3 pos ) const

Returns true if the given point is entirely inside the volume's definition, ie, if posToIndex would return true.

bool GEO_PrimVolume::isInsideStrict ( UT_Vector3 pos ) const

Returns true only if strictly inside. This means only actual voxel samples will be used for interpolation, so the boundary conditions will be unused

virtual int GEO_PrimVolume::isPointUsed ( GA_GBPoint * pt ) const [protected, virtual]

bool GEO_PrimVolume::isSDF ( ) const [inline]

Determines if we should be treated as an SDF. This means our function will continue to increase outside of the bounding box according to the distance to the bounding box.

Definition at line 401 of file GEO_PrimVolume.h.

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

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

virtual bool GEO_PrimVolume::loadH9	(	UT_IStream &	is,
		const UT_RefArray< GA_AttribLoadDataH9 > &	prim_attribs,
		const UT_RefArray< GA_AttribLoadDataH9 > &	vtx_attribs
	)			`[virtual]`

Reimplemented from GA_Primitive.

virtual bool GEO_PrimVolume::loadPrivateH9 ( UT_IStream & is ) [protected, virtual]

bool GEO_PrimVolume::loadRes ( const UT_JSONValue & jval )

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

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

bool GEO_PrimVolume::loadVoxelDataH9	(	UT_IStream &	is,
		UT_VoxelArrayWriteHandleF	voxels,
		int	version
	)			`[protected]`

virtual int GEO_PrimVolume::localGetIntrinsicF	(	const GA_IntrinsicEval &	eval,
		fpreal *	value,
		GA_Size	size
	)			const `[protected, virtual]`

Evaluate intrinsics

Reimplemented from GA_Primitive.

virtual int GEO_PrimVolume::localGetIntrinsicI	(	const GA_IntrinsicEval &	eval,
		int64 *	value,
		GA_Size	size
	)			const `[protected, virtual]`

Evaluate intrinsics

Reimplemented from GA_Primitive.

virtual int GEO_PrimVolume::localGetIntrinsicS	(	const GA_IntrinsicEval &	eval,
		UT_String &	value
	)			const `[protected, virtual]`

Evaluate intrinsics

Reimplemented from GA_Primitive.

virtual int GEO_PrimVolume::localGetIntrinsicSA	(	const GA_IntrinsicEval &	eval,
		UT_StringArray &	value
	)			const `[protected, virtual]`

Evaluate intrinsics

Reimplemented from GA_Primitive.

virtual int GEO_PrimVolume::localIntrinsicTupleSize ( const GA_IntrinsicEval & eval ) const [protected, virtual]

Evaluate intrinsics

Reimplemented from GA_Primitive.

virtual int GEO_PrimVolume::localSetIntrinsicF	(	const GA_IntrinsicEval &	eval,
		const fpreal *	value,
		GA_Size	size
	)			`[protected, virtual]`

Evaluate intrinsics

Reimplemented from GA_Primitive.

virtual int GEO_PrimVolume::localSetIntrinsicI	(	const GA_IntrinsicEval &	eval,
		const int64 *	value,
		GA_Size	size
	)			`[protected, virtual]`

Evaluate intrinsics

Reimplemented from GA_Primitive.

virtual int GEO_PrimVolume::localSetIntrinsicSA	(	const GA_IntrinsicEval &	eval,
		const UT_StringArray &	value
	)			`[protected, virtual]`

Evaluate intrinsics

Reimplemented from GA_Primitive.

virtual int GEO_PrimVolume::localSetIntrinsicSS	(	const GA_IntrinsicEval &	eval,
		const char **	value,
		GA_Size	size
	)			`[protected, virtual]`

Evaluate intrinsics

Reimplemented from GA_Primitive.

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

Convert a 3d position into the closest index value. Returns false if the resulting index was out of range (but still sets it)

void GEO_PrimVolume::recompress ( )

static GA_IntrinsicManager::Registrar GEO_PrimVolume::registerIntrinsics ( GA_PrimitiveDefinition & defn ) [static, protected]

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

See also:: GA_IntrinsicManager

Reimplemented from GEO_Primitive.

virtual void GEO_PrimVolume::reverse ( void ) [virtual]

Reverse the order of vertices.

Implements GEO_Primitive.

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

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

virtual bool GEO_PrimVolume::saveH9	(	ostream &	os,
		bool	binary,
		const UT_RefArray< GA_AttribSaveDataH9 > &	prim_attribs,
		const UT_RefArray< GA_AttribSaveDataH9 > &	vtx_attribs
	)			const `[virtual]`

Reimplemented from GA_Primitive.

virtual bool GEO_PrimVolume::savePrivateH9	(	ostream &	os,
		bool	binary
	)			const `[protected, virtual]`

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

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

void GEO_PrimVolume::setBorder	(	GEO_VolumeBorder	border,
		fpreal	val
	)

void GEO_PrimVolume::setCompressionTolerance ( fpreal tol )

void GEO_PrimVolume::setTaperX ( float t ) [inline]

Examples:: field3d/f3d_io.C.

Definition at line 312 of file GEO_PrimVolume.h.

void GEO_PrimVolume::setTaperY ( float t ) [inline]

Examples:: field3d/f3d_io.C.

Definition at line 314 of file GEO_PrimVolume.h.

void GEO_PrimVolume::setTransform ( const UT_Matrix3 & m ) [inline]

Examples:: ROP/ROP_DopField.C.

Definition at line 296 of file GEO_PrimVolume.h.

void GEO_PrimVolume::setTransform4 ( const UT_DMatrix4 & matx )

void GEO_PrimVolume::setTransform4 ( const UT_Matrix4 & matx )

Examples:: field3d/f3d_io.C.

void GEO_PrimVolume::setVertex ( GEO_Point * ppt ) [inline]

Definition at line 277 of file GEO_PrimVolume.h.

void GEO_PrimVolume::setVertexPoint ( GA_Offset pt ) [inline]

Definition at line 282 of file GEO_PrimVolume.h.

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

void GEO_PrimVolume::setVoxels ( UT_VoxelArrayHandleF handle )

void GEO_PrimVolume::setVoxels ( const UT_VoxelArrayF * vox )

Copies the given voxel array and makes it our own voxel array.

virtual void GEO_PrimVolume::stashed	(	int	onoff,
		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 GEO_Primitive.

void GEO_PrimVolume::stealVoxels ( UT_VoxelArrayF * vox )

Takes ownership of the voxel array, caller should not refer to vox any more.

Examples:: ROP/ROP_DopField.C.

virtual void GEO_PrimVolume::swapVertexOffsets ( const GA_Defragment & defrag ) [protected, virtual]

Defragmentation.

Implements GA_Primitive.

void GEO_PrimVolume::toVoxelSpace ( UT_BoundingBox & box ) const

Converts from world space to 0..1 voxel space.

UT_Vector3 GEO_PrimVolume::toVoxelSpace ( const UT_Vector3 & pos ) const

Converts from world space to 0..1 voxel space.

virtual void GEO_PrimVolume::transform ( const UT_Matrix4 & mat ) [virtual]

Reimplemented from GEO_Primitive.

virtual void GEO_PrimVolume::unitLengthToUnitPair	(	float	ulength,
		float	vlength,
		float &	uparm,
		float &	vparm
	)			const `[virtual]`

Reimplemented from GEO_Primitive.

virtual void GEO_PrimVolume::unitToUnitLengthPair	(	float	uparm,
		float	vparm,
		float &	ulength,
		float &	vlength
	)			const `[virtual]`

Reimplemented from GEO_Primitive.

virtual void GEO_PrimVolume::untransform ( void ) [virtual]

virtual int GEO_PrimVolume::vertexApply	(	int()(const GEO_Vertex &, void )	a,
		void *
	)			const `[virtual]`

virtual int GEO_PrimVolume::vertexApply	(	int()(GEO_Vertex, void )	a,
		void *
	)			`[virtual]`

GA_Offset GEO_PrimVolume::vertexPoint ( ) const [inline, protected]

Definition at line 555 of file GEO_PrimVolume.h.

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	os,
		const GEO_PrimVolume &	d
	)			`[friend]`

Definition at line 593 of file GEO_PrimVolume.h.

Member Data Documentation

UT_VoxelArrayHandleF GEO_PrimVolume::myVoxelHandle [protected]

Definition at line 558 of file GEO_PrimVolume.h.

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

GEO/GEO_PrimVolume.h


Classes
class	serialize
Public Member Functions
	GEO_PrimVolume (GEO_Detail *d, GA_Offset offset=GA_INVALID_OFFSET)
virtual	~GEO_PrimVolume ()
virtual int	getBBox (UT_BoundingBox *bbox) const
virtual void	addToBSphere (UT_BoundingSphere *bsphere) const
virtual void	enlargePointBounds (UT_BoundingBox &box) const
virtual bool	enlargeBoundingSphere (UT_BoundingSphere &b, const GA_Attribute *P) const
virtual UT_Vector3	baryCenter () const
	For a volume the barycenter is the same as the point.
virtual UT_Vector3	computeNormal () const
	Return a normal vector for the primitive.
virtual bool	saveH9 (ostream &os, bool binary, const UT_RefArray< GA_AttribSaveDataH9 > &prim_attribs, const UT_RefArray< GA_AttribSaveDataH9 > &vtx_attribs) const
virtual bool	loadH9 (UT_IStream &is, const UT_RefArray< GA_AttribLoadDataH9 > &prim_attribs, const UT_RefArray< GA_AttribLoadDataH9 > &vtx_attribs)
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	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)
virtual void	transform (const UT_Matrix4 &mat)
virtual void	untransform (void)
virtual GEO_Primitive *	copy (int preserve_shared_pts=0) const
virtual void	copyPrimitive (const GEO_Primitive src, GEO_Point *ptredirect)
virtual void	copyUnwiredForMerge (const GA_Primitive *src, const GA_MergeMap &map)
virtual void	addPointRefToGroup (GA_PointGroup &grp) const
virtual int	vertexApply (int(a)(GEO_Vertex, void ), void *)
virtual int	vertexApply (int(a)(const GEO_Vertex &, void ), void *) const
virtual void	reverse (void)
	Reverse the order of vertices.
virtual GA_Size	getVertexCount () const
	Return the number of vertices used by this primitive.
virtual GA_Offset	getVertexOffset (GA_Size index) 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)
virtual bool	isDegenerate () const
	Is the primitive degenerate.
virtual void	unitLengthToUnitPair (float ulength, float vlength, float &uparm, float &vparm) const
virtual void	unitToUnitLengthPair (float uparm, float vparm, float &ulength, float &vlength) const
virtual fpreal	calcVolume (const UT_Vector3 &refpt) const
virtual fpreal	calcArea () const
void	setVertex (GEO_Point *ppt)
void	setVertexPoint (GA_Offset pt)
void	assignVertex (GA_Offset new_vtx, bool update_topology)
virtual void	stashed (int onoff, GA_Offset offset=GA_INVALID_OFFSET)
const UT_Matrix3 &	getTransform (void) 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)
const UT_Matrix3 &	getInverseTransform () const
	Converts from world space to local space.
void	getInverseTransform4 (UT_Matrix4 &matx) const
float	getTaperX (void) const
void	setTaperX (float t)
float	getTaperY (void) const
void	setTaperY (float t)
bool	isAligned (const GEO_PrimVolume *vol) const
GEO_PrimVolumeXform	getSpaceTransform () const
UT_Vector3	toVoxelSpace (const UT_Vector3 &pos) const
	Converts from world space to 0..1 voxel space.
UT_Vector3	fromVoxelSpace (const UT_Vector3 &pos) const
	Converts from 0..1 voxel space to world space.
void	toVoxelSpace (UT_BoundingBox &box) const
	Converts from world space to 0..1 voxel space.
void	fromVoxelSpace (UT_BoundingBox &box) const
	Converts from 0..1 voxel space to world space.
void	setVoxels (const UT_VoxelArrayF *vox)
	Copies the given voxel array and makes it our own voxel array.
void	setVoxels (UT_VoxelArrayHandleF handle)
void	stealVoxels (UT_VoxelArrayF *vox)
UT_VoxelArrayHandleF	getVoxelHandle () const
UT_VoxelArrayWriteHandleF	getVoxelWriteHandle ()
	This is a handle that you can write to and affect the volume.
bool	indexToPos (int x, int y, int z, UT_Vector3 &pos) const
void	findexToPos (UT_Vector3 index, UT_Vector3 &pos) const
bool	isInside (UT_Vector3 pos) const
bool	isInsideStrict (UT_Vector3 pos) const
bool	posToIndex (UT_Vector3 pos, int &x, int &y, int &z) const
fpreal	getValue (const UT_Vector3 &pos) const
	Evaluate the voxel value at the given world space position.
UT_Vector3	getGradient (const UT_Vector3 &pos) const
fpreal	getValue (const UT_Vector3 &pos, const UT_VoxelArrayReadHandleF &handle) const
fpreal	getValueAtIndex (int ix, int iy, int iz) const
	Evaluate the specific voxel indexed from 0,0,0.
void	getRes (int &rx, int &ry, int &rz) const
	Returns the resolution of the voxel array.
fpreal	getVoxelDiameter () const
UT_Vector3	getVoxelSize () const
	Returns the length of the voxel when you take an x, y, and z step.
fpreal	calcPositiveDensity () const
fpreal	calcMinimum () const
	Compute useful aggregate properties of the volume.
fpreal	calcMaximum () const
fpreal	calcAverage () const
bool	isSDF () const
void	setBorder (GEO_VolumeBorder border, fpreal val)
GEO_VolumeBorder	getBorder () const
fpreal	getBorderValue () const
fpreal	getCompressionTolerance () const
	Control the compression of these objects.
void	setCompressionTolerance (fpreal tol)
void	recompress ()
void	setVisualization (GEO_VolumeVis vis, fpreal iso, fpreal density)
fpreal	getVisIso () const
fpreal	getVisDensity () const
GEO_VolumeVis	getVisualization () const
virtual const GA_PrimitiveJSON *	getJSON () const
serialize	getSerialize () const

virtual bool	enlargeBoundingBox (UT_BoundingRect &b, const GA_Attribute *P) const
virtual bool	enlargeBoundingBox (UT_BoundingBox &b, const GA_Attribute *P) const
Static Public Member Functions
static const char *	getBorderToken (GEO_VolumeBorder border)
	Get the border options in terms of GEO's values.
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.
static GEO_VolumeVis	getVisualizationEnum (const char *vis, GEO_VolumeVis def=GEO_VOLUMEVIS_SMOKE)
Protected Member Functions
	GEO_PrimVolume (const GA_MergeMap &map, GEO_Detail &detail, GA_Offset offset, const GEO_PrimVolume &src)
virtual void	swapVertexOffsets (const GA_Defragment &defrag)
	Defragmentation.
virtual void	copyOffsetPrimitive (const GEO_Primitive *src, int basept)
virtual bool	savePrivateH9 (ostream &os, bool binary) const
virtual bool	loadPrivateH9 (UT_IStream &is)
virtual int	isPointUsed (GA_GBPoint *pt) const
bool	loadVoxelDataH9 (UT_IStream &is, UT_VoxelArrayWriteHandleF voxels, int version)
GA_Offset	vertexPoint () const
virtual bool	evaluatePointRefMap (GA_Offset result_vtx, GA_AttributeRefMap &hlist, fpreal u, fpreal v, uint du, uint dv) const
virtual int	evaluatePointV4 (UT_Vector4 &pos, float u, float v=0, unsigned du=0, unsigned dv=0) const
virtual bool	evaluateBaryCenterRefMap (GA_Offset result_vertex, GA_AttributeRefMap &hlist) const
virtual bool	evaluateInteriorPointRefMap (GA_Offset result, 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

virtual int	localIntrinsicTupleSize (const GA_IntrinsicEval &eval) const
virtual int	localGetIntrinsicS (const GA_IntrinsicEval &eval, UT_String &value) const
virtual int	localGetIntrinsicSA (const GA_IntrinsicEval &eval, UT_StringArray &value) const
virtual int	localGetIntrinsicI (const GA_IntrinsicEval &eval, int64 *value, GA_Size size) const
virtual int	localGetIntrinsicF (const GA_IntrinsicEval &eval, fpreal *value, GA_Size size) const
virtual int	localSetIntrinsicSA (const GA_IntrinsicEval &eval, const UT_StringArray &value)
virtual int	localSetIntrinsicSS (const GA_IntrinsicEval &eval, const char **value, GA_Size size)
virtual int	localSetIntrinsicI (const GA_IntrinsicEval &eval, const int64 *value, GA_Size size)
virtual int	localSetIntrinsicF (const GA_IntrinsicEval &eval, const fpreal *value, GA_Size size)
Static Protected Member Functions
static GA_PrimitiveFamilyMask	buildFamilyMask ()
static GA_IntrinsicManager::Registrar	registerIntrinsics (GA_PrimitiveDefinition &defn)
Protected Attributes
UT_VoxelArrayHandleF	myVoxelHandle
Friends
ostream &	operator<< (ostream &os, const GEO_PrimVolume &d)