pyopenvdb.BoolGrid.ConstAccessor

Module pyopenvdb :: Class BoolGrid :: Class ConstAccessor |
[hide private]
[frames] | no frames]

# Class ConstAccessor

     object --+
              |
    ??.instance --+
                  |
                 BoolGrid.ConstAccessor

Read-only access by (i, j, k) index coordinates to the voxels of a BoolGrid

Instance Methods | [hide private]
__init__(...) Raises an exception This class cannot be instantiated from Python |
__reduce__(...) helper for pickle |
clear() Clear this accessor of all cached data. |
ConstAccessor |
copy() Return a copy of this accessor. |
bool |
getValue(ijk) Return the value of the voxel at coordinates (i, j, k). |
int |
getValueDepth(ijk) Return the tree depth (0 = root) at which the value of voxel (i, j, k) resides. |
bool |
isCached(ijk) Return True if this accessor has cached the path to voxel (i, j, k). |
bool |
isValueOn(ijk) Return the active state of the voxel at coordinates (i, j, k). |
bool |
isVoxel(ijk) Return True if voxel (i, j, k) resides at the leaf level of the tree. |
value, bool |
probeValue(ijk) Return the value of the voxel at coordinates (i, j, k) together with the voxel's active state. |
setActiveState(ijk, on) Mark voxel (i, j, k) as either active or inactive (True or False), but don't change its value. |
setValueOff(ijk, value=None) Mark voxel (i, j, k) as inactive and, if the given value is not None, set the voxel's value. |
setValueOn(ijk, value=None) Mark voxel (i, j, k) as active and, if the given value is not None, set the voxel's value. |
setValueOnly(ijk, value) Set the value of voxel (i, j, k), but don't change its active state. |
Inherited from `unreachable.instance`: `__new__` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__reduce_ex__`, `__repr__`, `__setattr__`, `__sizeof__`, `__str__`, `__subclasshook__`

Properties | [hide private]
| parent this accessor's parent BoolGrid
Inherited from `object`: `__class__`

Method Details | [hide private]

### __init__(...) (Constructor) |
Raises an exception This class cannot be instantiated from Python Overrides: object.__init__

### __reduce__(...) |
helper for pickle Overrides: object.__reduce__ (inherited documentation)

### getValueDepth(ijk) |
Return the tree depth (0 = root) at which the value of voxel (i, j, k) resides. If (i, j, k) isn't explicitly represented in the tree (i.e., it is implicitly a background voxel), return -1. Returns: int

Property Details | [hide private]

### parent this accessor's parent BoolGrid Get Method: unreachable(...)