Go to: Synopsis. Return value. Keywords. Flags. Python examples.
fluidVoxelInfo([checkBounds=boolean], [inBounds=[int, int, int]], [objectSpace=boolean], [radius=float], [voxel=[float, float, float]], [voxelCenter=boolean], [xIndex=int], [yIndex=int], [zIndex=int])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
fluidVoxelInfo is NOT undoable, NOT queryable, and NOT editable.
Provides basic information about the mapping of a fluid voxel grid into world- or object space of the fluid. Use this command to determine the center point of a voxel, or to find the voxel containing a given point, among other things.
None
fluid
checkBounds, inBounds, objectSpace, radius, voxel, voxelCenter, xIndex, yIndex, zIndex
| Long name (short name) |
Argument types |
Properties |
checkBounds(cb)
|
boolean
|
|
|
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.)
|
|
objectSpace(os)
|
boolean
|
|
|
Whether the queried value should be returned in object space (TRUE),
or world space (FALSE, the default).
|
|
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.
|
|
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.
|
|
voxelCenter(vc)
|
boolean
|
|
|
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.)
|
|
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
|
|
|
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 have multiple arguments, passed either as a tuple or a list.
|
import maya.cmds as cmds
# fluid3D is a 10x10x5 three-dimensional fluid.
# fluid2D is a 9x9 two-dimensional fluid.
#
# Are the given indices within the bounds of the fluids?
#
cmds.fluidVoxelInfo( 'fluid2D', inBounds=( 9, 9, 0) )
# Result: false
cmds.fluidVoxelInfo( 'fluid2D', inBounds=( 8, 8, 0) )
# Result: true
cmds.fluidVoxelInfo( 'fluid3D', inBounds=( 2, 3, 4 ) )
# Result: true
cmds.fluidVoxelInfo( 'fluid3D', inBounds=( 12, 9, 2) )
# Result: false