mrmeshpy.Box3i Class Reference

Public Member Functions
bool	__eq__ (self, Box3i a)
Vector3i	__getitem__ (self, int e)
Vector3i	__getitem__ (self, int e)
None	__init__ (self)
None	__init__ (self, Vector3i min, Vector3i max)
None	__init__ (self, Box3i a)
None	__init__ (self, Box3i arg0)
bool	__ne__ (self, Box3i a)
str	__repr__ (self)
None	__setitem__ (self, int arg0, Vector3i arg1)
Vector3i	center (self)
bool	contains (self, Vector3i pt)
bool	contains (self, Box3i otherbox)
Vector3i	corner (self, Vector3b c)
int	diagonal (self)
Box3i	expanded (self, Vector3i expansion)
Vector3i	getBoxClosestPointTo (self, Vector3i pt)
int	getDistanceSq (self, Box3i b)
int	getDistanceSq (self, Vector3i pt)
Vector3i	getProjection (self, Vector3i pt)
None	include (self, Vector3i pt)
None	include (self, Box3i b)
Box3i	insignificantlyExpanded (self)
Box3i	intersect (self, Box3i b)
Box3i	intersection (self, Box3i b)
bool	intersects (self, Box3i b)
Vector3i	size (self)
bool	valid (self)
int	volume (self)

Static Public Member Functions
None	__init__ (*args, **kwargs)
None	__init__ (*args, **kwargs)
Box3i	fromMinAndSize (Vector3i min, Vector3i size)
Vector3b	getMaxBoxCorner (Vector3i n)
Vector3b	getMinBoxCorner (Vector3i n)
Box3i	operator (*args, **kwargs)
Box3i	operator (*args, **kwargs)

Static Public Attributes
typing	elements = 3

Static Protected Attributes
typing	_offsetof_max = 12
typing	_offsetof_min = 0

Detailed Description

Generated from:  MR::Box3i

Box given by its min- and max- corners

Constructor & Destructor Documentation

__init__() [1/6]

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

static

If the compiler supports `requires`, use that instead of `std::enable_if` here.
Not (only) because it looks cooler, but because of a bug in our binding generator that makes it choke on it: https://github.com/MeshInspector/mrbind/issues/19

__init__() [2/6]

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

static

__init__() [3/6]

None mrmeshpy.Box3i.__init__

(

self

)

create invalid box by default

__init__() [4/6]

None mrmeshpy.Box3i.__init__	(		self,
		Vector3i	min,
		Vector3i	max )

__init__() [5/6]

None mrmeshpy.Box3i.__init__	(		self,
		Box3i	a )

__init__() [6/6]

None mrmeshpy.Box3i.__init__	(		self,
		Box3i	arg0 )

Implicit copy constructor.

Member Function Documentation

__eq__()

bool mrmeshpy.Box3i.__eq__	(		self,
		Box3i	a )

__getitem__() [1/2]

Vector3i mrmeshpy.Box3i.__getitem__	(		self,
		int	e )

min/max access by 0/1 index

__getitem__() [2/2]

Vector3i mrmeshpy.Box3i.__getitem__	(		self,
		int	e )

__ne__()

bool mrmeshpy.Box3i.__ne__	(		self,
		Box3i	a )

__repr__()

str mrmeshpy.Box3i.__repr__

(

self

)

__setitem__()

None mrmeshpy.Box3i.__setitem__	(		self,
		int	arg0,
		Vector3i	arg1 )

center()

Vector3i mrmeshpy.Box3i.center

(

self

)

computes center of the box

contains() [1/2]

bool mrmeshpy.Box3i.contains	(		self,
		Box3i	otherbox )

checks whether given box is fully inside (the surfaces may touch) of this box

contains() [2/2]

bool mrmeshpy.Box3i.contains	(		self,
		Vector3i	pt )

checks whether given point is inside (including the surface) of this box

corner()

Vector3i mrmeshpy.Box3i.corner	(		self,
		Vector3b	c )

returns the corner of this box as specified by given bool-vector:
0 element in (c) means take min's coordinate,
1 element in (c) means take max's coordinate

diagonal()

int mrmeshpy.Box3i.diagonal

(

self

)

computes length from min to max

expanded()

Box3i mrmeshpy.Box3i.expanded	(		self,
		Vector3i	expansion )

decreases min and increased max on given value

fromMinAndSize()

Box3i mrmeshpy.Box3i.fromMinAndSize ( Vector3i min, Vector3i size )

static

getBoxClosestPointTo()

Vector3i mrmeshpy.Box3i.getBoxClosestPointTo	(		self,
		Vector3i	pt )

returns closest point in the box to given point

getDistanceSq() [1/2]

int mrmeshpy.Box3i.getDistanceSq	(		self,
		Box3i	b )

returns squared distance between this box and given one;
returns zero if the boxes touch or intersect

getDistanceSq() [2/2]

int mrmeshpy.Box3i.getDistanceSq	(		self,
		Vector3i	pt )

returns squared distance between this box and given point;
returns zero if the point is inside or on the boundary of the box

getMaxBoxCorner()

Vector3b mrmeshpy.Box3i.getMaxBoxCorner ( Vector3i n )

static

considering all planes with given normal and arbitrary shift: dot(n,x) = d
finds the box's corner for which d is maximal

getMinBoxCorner()

Vector3b mrmeshpy.Box3i.getMinBoxCorner ( Vector3i n )

static

considering all planes with given normal and arbitrary shift: dot(n,x) = d
finds the box's corner for which d is minimal

getProjection()

Vector3i mrmeshpy.Box3i.getProjection	(		self,
		Vector3i	pt )

returns the closest point on the box to the given point
for points outside the box this is equivalent to getBoxClosestPointTo

include() [1/2]

None mrmeshpy.Box3i.include	(		self,
		Box3i	b )

minimally increases the box to include another box

include() [2/2]

None mrmeshpy.Box3i.include	(		self,
		Vector3i	pt )

minimally increases the box to include given point

insignificantlyExpanded()

Box3i mrmeshpy.Box3i.insignificantlyExpanded

(

self

)

decreases min and increases max to their closest representable value

intersect()

Box3i mrmeshpy.Box3i.intersect	(		self,
		Box3i	b )

intersection()

Box3i mrmeshpy.Box3i.intersection	(		self,
		Box3i	b )

computes intersection between this and other box

intersects()

bool mrmeshpy.Box3i.intersects	(		self,
		Box3i	b )

checks whether this box intersects or touches given box

operator() [1/2]

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

static

operator() [2/2]

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

static

size()

Vector3i mrmeshpy.Box3i.size

(

self

)

computes size of the box in all dimensions

valid()

bool mrmeshpy.Box3i.valid

(

self

)

true if the box contains at least one point

volume()

int mrmeshpy.Box3i.volume

(

self

)

computes the volume of this box

Member Data Documentation

_offsetof_max

typing mrmeshpy.Box3i._offsetof_max = 12

staticprotected

_offsetof_min

typing mrmeshpy.Box3i._offsetof_min = 0

staticprotected

elements

typing mrmeshpy.Box3i.elements = 3

static

---

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

• mrmeshpy.pyi