MeshLib Python Docs
Loading...
Searching...
No Matches
mrmeshpy.ConstVolumeIndexer Class Reference
Inheritance diagram for mrmeshpy.ConstVolumeIndexer:

Public Member Functions

 __init__ (self, *args, **kwargs)
bool areNeigbors (self, ConstVoxelId v0, ConstVoxelId v1)
bool areNeigbors (self, ConstVector3i pos0, ConstVector3i pos1)
ConstVector3i dims (self)
VoxelId endId (self)
VoxelId getExistingNeighbor (self, ConstVoxelId v, OutEdge toNei)
VoxelId getNeighbor (self, ConstVoxelId v, OutEdge toNei)
VoxelId getNeighbor (self, ConstVoxelId v, ConstVector3i pos, OutEdge toNei)
VoxelLocation getNeighbor (self, ConstVoxelLocation loc, OutEdge toNei)
VoxelId getNeighbor (self, ConstVoxelId v, ConstVector3i pos, bool bdPos, OutEdge toNei)
bool hasNeighbour (self, ConstVector3i pos, OutEdge toNei)
bool isBdVoxel (self, ConstVector3i pos)
bool isInDims (self, ConstVector3i pos)
int size (self)
int sizeXY (self)
VoxelLocation toLoc (self, ConstVoxelId id)
VoxelLocation toLoc (self, ConstVector3i pos)
Vector3i toPos (self, ConstVoxelId id)
VoxelId toVoxelId (self, ConstVector3i pos)

Detailed Description

Generated from:  MR::VolumeIndexer

Constructor & Destructor Documentation

◆ __init__()

mrmeshpy.ConstVolumeIndexer.__init__ ( self,
* args,
** kwargs )
__init__(*args, **kwargs)
Overloaded function.

1. __init__(self: meshlib.mrmeshpy.ConstVolumeIndexer, dims: meshlib.mrmeshpy.ConstVector3i) -> None

2. __init__(self: meshlib.mrmeshpy.ConstVolumeIndexer, arg0: meshlib.mrmeshpy.ConstVolumeIndexer) -> None

Implicit copy constructor.

3. __init__(self: meshlib.mrmeshpy.ConstVolumeIndexer, : meshlib.mrmeshpy.ConstVolumeIndexer) -> None

Member Function Documentation

◆ areNeigbors() [1/2]

bool mrmeshpy.ConstVolumeIndexer.areNeigbors ( self,
ConstVector3i pos0,
ConstVector3i pos1 )

◆ areNeigbors() [2/2]

bool mrmeshpy.ConstVolumeIndexer.areNeigbors ( self,
ConstVoxelId v0,
ConstVoxelId v1 )
returns true if v1 is within at most 6 neighbors of v0

◆ dims()

ConstVector3i mrmeshpy.ConstVolumeIndexer.dims ( self)

◆ endId()

VoxelId mrmeshpy.ConstVolumeIndexer.endId ( self)
returns the last plus one voxel Id for defining iteration range

◆ getExistingNeighbor()

VoxelId mrmeshpy.ConstVolumeIndexer.getExistingNeighbor ( self,
ConstVoxelId v,
OutEdge toNei )
returns id of v's neighbor specified by the edge, which is known to exist (so skipping a lot of checks)

◆ getNeighbor() [1/4]

VoxelId mrmeshpy.ConstVolumeIndexer.getNeighbor ( self,
ConstVoxelId v,
ConstVector3i pos,
bool bdPos,
OutEdge toNei )

◆ getNeighbor() [2/4]

VoxelId mrmeshpy.ConstVolumeIndexer.getNeighbor ( self,
ConstVoxelId v,
ConstVector3i pos,
OutEdge toNei )

◆ getNeighbor() [3/4]

VoxelId mrmeshpy.ConstVolumeIndexer.getNeighbor ( self,
ConstVoxelId v,
OutEdge toNei )
returns id of v's neighbor specified by the edge

◆ getNeighbor() [4/4]

VoxelLocation mrmeshpy.ConstVolumeIndexer.getNeighbor ( self,
ConstVoxelLocation loc,
OutEdge toNei )
given existing voxel at (loc), returns its neighbor specified by the edge (toNei);
if the neighbour does not exist (loc is on boundary), returns invalid VoxelLocation

◆ hasNeighbour()

bool mrmeshpy.ConstVolumeIndexer.hasNeighbour ( self,
ConstVector3i pos,
OutEdge toNei )
given existing voxel at (pos), returns whether it has valid neighbor specified by the edge (toNei)

◆ isBdVoxel()

bool mrmeshpy.ConstVolumeIndexer.isBdVoxel ( self,
ConstVector3i pos )
returns true if this voxel is on the boundary of the volume

◆ isInDims()

bool mrmeshpy.ConstVolumeIndexer.isInDims ( self,
ConstVector3i pos )
returns true if this voxel is within dimensions

◆ size()

int mrmeshpy.ConstVolumeIndexer.size ( self)
returns the total number of voxels

◆ sizeXY()

int mrmeshpy.ConstVolumeIndexer.sizeXY ( self)

◆ toLoc() [1/2]

VoxelLocation mrmeshpy.ConstVolumeIndexer.toLoc ( self,
ConstVector3i pos )

◆ toLoc() [2/2]

VoxelLocation mrmeshpy.ConstVolumeIndexer.toLoc ( self,
ConstVoxelId id )

◆ toPos()

Vector3i mrmeshpy.ConstVolumeIndexer.toPos ( self,
ConstVoxelId id )

◆ toVoxelId()

VoxelId mrmeshpy.ConstVolumeIndexer.toVoxelId ( self,
ConstVector3i pos )

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