fluidVoxelInfo

Go to: Synopsis. Return value. Keywords. Flags. MEL examples.

Synopsis

fluidVoxelInfo [-checkBounds] [-inBounds int int int] [-objectSpace boolean] [-radius float] [-voxel float float float] [-voxelCenter] [-xIndex int] [-yIndex int] [-zIndex int]

fluidVoxelInfo is NOT undoable, NOT queryable, and NOT editable.

Return value

None

Keywords

Flags

Long name (short name)	Argument types	Properties
-objectSpace(-os)	boolean
Whether the queried value should be returned in object space (TRUE), or world space (FALSE, the default).
-voxelCenter(-vc)
The center position of the specified voxels. Returns an array of floats (three for each of the indices in the query). (Valid only with the -xIndex, -yIndex, and -zIndex flags.)
-voxel(-v)	float float float
Returns array of three ints representing the x, y, z indices of the voxel within which the given point position is contained. If the checkBounds flag is on, and the point is out of bounds, we return nothing. Otherwise, even if the point is out of bounds, index values are returned. When combined with the -radius flag, returns an array of index triples representing a list of voxels within a given radius of the given point position.
-checkBounds(-cb)
If this flag is on, and the voxel index of a point that is out of bounds is requested, then we return nothing.
-inBounds(-ib)	int int int
Are the three ints representing the x, y, z indices of a voxel within the bounds of the fluid's voxel grid? True if yes, false if not. (For 2D fluids, pass in z=0 for the third argument. See examples.)
-xIndex(-xi)	int
Only return values for cells with this X index
-yIndex(-yi)	int
Only return values for cells with this Y index
-zIndex(-zi)	int
Only return values for cells with this Z index
-radius(-r)	float
Modifier for the -voxel flag. Returns a list of index triples identifying voxels that fall within the given radius of the point specified by the -voxel flag.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can be used more than once in a command.

MEL examples

// fluid3D is a 10x10x5 three-dimensional fluid.
// fluid2D is a 9x9 two-dimensional fluid.
//
// Are the given indices within the bounds of the fluids?
//
fluidVoxelInfo -inBounds 9 9 0 fluid2D;
// Result: false
fluidVoxelInfo -inBounds 8 8 0 fluid2D;
// Result: true
fluidVoxelInfo -inBounds 2 3 4 fluid3D;
// Result: true
fluidVoxelInfo -inBounds 12 9 2 fluid3D;
// Result: false