mrmeshpy.VolumeIndexer Class Reference

Public Member Functions
None	__init__ (self, Vector3i dims)
bool	areNeigbors (self, VoxelId v0, VoxelId v1)
bool	areNeigbors (self, Vector3i pos0, Vector3i pos1)
Vector3i	dims (self)
VoxelId	endId (self)
VoxelId	getExistingNeighbor (self, VoxelId v, OutEdge toNei)
VoxelId	getNeighbor (self, VoxelId v, OutEdge toNei)
VoxelId	getNeighbor (self, VoxelId v, Vector3i pos, OutEdge toNei)
VoxelLocation	getNeighbor (self, VoxelLocation loc, OutEdge toNei)
VoxelId	getNeighbor (self, VoxelId v, Vector3i pos, bool bdPos, OutEdge toNei)
bool	hasNeighbour (self, Vector3i pos, OutEdge toNei)
bool	isBdVoxel (self, Vector3i pos)
bool	isInDims (self, Vector3i pos)
int	size (self)
int	sizeXY (self)
VoxelLocation	toLoc (self, VoxelId id)
VoxelLocation	toLoc (self, Vector3i pos)
Vector3i	toPos (self, VoxelId id)
VoxelId	toVoxelId (self, Vector3i pos)

Static Public Member Functions
None	__init__ (*args, **kwargs)
VolumeIndexer	operator (*args, **kwargs)
VolumeIndexer	operator (*args, **kwargs)

Detailed Description

Generated from:  MR::VolumeIndexer

Constructor & Destructor Documentation

__init__() [1/2]

None mrmeshpy.VolumeIndexer.__init__ ( * args, ** kwargs )

static

__init__() [2/2]

None mrmeshpy.VolumeIndexer.__init__	(		self,
		Vector3i	dims )

Member Function Documentation

areNeigbors() [1/2]

bool mrmeshpy.VolumeIndexer.areNeigbors	(		self,
		Vector3i	pos0,
		Vector3i	pos1 )

areNeigbors() [2/2]

bool mrmeshpy.VolumeIndexer.areNeigbors	(		self,
		VoxelId	v0,
		VoxelId	v1 )

returns true if v1 is within at most 6 neighbors of v0

dims()

Vector3i mrmeshpy.VolumeIndexer.dims

(

self

)

endId()

VoxelId mrmeshpy.VolumeIndexer.endId

(

self

)

returns the last plus one voxel Id for defining iteration range

getExistingNeighbor()

VoxelId mrmeshpy.VolumeIndexer.getExistingNeighbor	(		self,
		VoxelId	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.VolumeIndexer.getNeighbor	(		self,
		VoxelId	v,
		OutEdge	toNei )

returns id of v's neighbor specified by the edge

getNeighbor() [2/4]

VoxelId mrmeshpy.VolumeIndexer.getNeighbor	(		self,
		VoxelId	v,
		Vector3i	pos,
		bool	bdPos,
		OutEdge	toNei )

getNeighbor() [3/4]

VoxelId mrmeshpy.VolumeIndexer.getNeighbor	(		self,
		VoxelId	v,
		Vector3i	pos,
		OutEdge	toNei )

getNeighbor() [4/4]

VoxelLocation mrmeshpy.VolumeIndexer.getNeighbor	(		self,
		VoxelLocation	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.VolumeIndexer.hasNeighbour	(		self,
		Vector3i	pos,
		OutEdge	toNei )

given existing voxel at (pos), returns whether it has valid neighbor specified by the edge (toNei)

isBdVoxel()

bool mrmeshpy.VolumeIndexer.isBdVoxel	(		self,
		Vector3i	pos )

returns true if this voxel is on the boundary of the volume

isInDims()

bool mrmeshpy.VolumeIndexer.isInDims	(		self,
		Vector3i	pos )

returns true if this voxel is within dimensions

operator() [1/2]

VolumeIndexer mrmeshpy.VolumeIndexer.operator ( * args, ** kwargs )

static

operator() [2/2]

VolumeIndexer mrmeshpy.VolumeIndexer.operator ( * args, ** kwargs )

static

size()

int mrmeshpy.VolumeIndexer.size

(

self

)

returns the total number of voxels

sizeXY()

int mrmeshpy.VolumeIndexer.sizeXY

(

self

)

toLoc() [1/2]

VoxelLocation mrmeshpy.VolumeIndexer.toLoc	(		self,
		Vector3i	pos )

toLoc() [2/2]

VoxelLocation mrmeshpy.VolumeIndexer.toLoc	(		self,
		VoxelId	id )

toPos()

Vector3i mrmeshpy.VolumeIndexer.toPos	(		self,
		VoxelId	id )

toVoxelId()

VoxelId mrmeshpy.VolumeIndexer.toVoxelId	(		self,
		Vector3i	pos )

---

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

• mrmeshpy.pyi