mrmeshpy.Box3f Class Reference

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

Static Public Member Functions
None	__init__ (*args, **kwargs)
None	__init__ (*args, **kwargs)
Box3f	fromMinAndSize (Vector3f min, Vector3f size)
Vector3b	getMaxBoxCorner (Vector3f n)
Vector3b	getMinBoxCorner (Vector3f n)
Box3f	operator (*args, **kwargs)
Box3f	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::Box3f
Aliases:  AABBTreeTraits_UndirectedEdgeTag_Box3f.BoxT, AABBTreeNode_ObjTreeTraits.BoxT, AABBTreeNode_AABBTreeTraits_FaceTag_Box3f.BoxT, AABBTreeBase_ObjTreeTraits.BoxT, AABBTreeBase_AABBTreeTraits_UndirectedEdgeTag_Box3f.BoxT, AABBTreeBase_AABBTreeTraits_FaceTag_Box3f.BoxT, AABBTreeTraits_FaceTag_Box3f.BoxT, ObjTreeTraits.BoxT, AABBTreeNode_AABBTreeTraits_UndirectedEdgeTag_Box3f.BoxT

Box given by its min- and max- corners

Constructor & Destructor Documentation

__init__() [1/6]

None mrmeshpy.Box3f.__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.Box3f.__init__ ( * args, ** kwargs )

static

__init__() [3/6]

None mrmeshpy.Box3f.__init__

(

self

)

create invalid box by default

__init__() [4/6]

None mrmeshpy.Box3f.__init__	(		self,
		Vector3f	min,
		Vector3f	max )

__init__() [5/6]

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

__init__() [6/6]

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

Implicit copy constructor.

Member Function Documentation

__eq__()

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

__getitem__() [1/2]

Vector3f mrmeshpy.Box3f.__getitem__	(		self,
		int	e )

min/max access by 0/1 index

__getitem__() [2/2]

Vector3f mrmeshpy.Box3f.__getitem__	(		self,
		int	e )

__ne__()

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

__repr__()

str mrmeshpy.Box3f.__repr__

(

self

)

__setitem__()

None mrmeshpy.Box3f.__setitem__	(		self,
		int	arg0,
		Vector3f	arg1 )

center()

Vector3f mrmeshpy.Box3f.center

(

self

)

computes center of the box

contains() [1/2]

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

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

contains() [2/2]

bool mrmeshpy.Box3f.contains	(		self,
		Vector3f	pt )

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

corner()

Vector3f mrmeshpy.Box3f.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()

float mrmeshpy.Box3f.diagonal

(

self

)

computes length from min to max

expanded()

Box3f mrmeshpy.Box3f.expanded	(		self,
		Vector3f	expansion )

decreases min and increased max on given value

fromMinAndSize()

Box3f mrmeshpy.Box3f.fromMinAndSize ( Vector3f min, Vector3f size )

static

getBoxClosestPointTo()

Vector3f mrmeshpy.Box3f.getBoxClosestPointTo	(		self,
		Vector3f	pt )

returns closest point in the box to given point

getDistanceSq() [1/2]

float mrmeshpy.Box3f.getDistanceSq	(		self,
		Box3f	b )

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

getDistanceSq() [2/2]

float mrmeshpy.Box3f.getDistanceSq	(		self,
		Vector3f	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.Box3f.getMaxBoxCorner ( Vector3f 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.Box3f.getMinBoxCorner ( Vector3f 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()

Vector3f mrmeshpy.Box3f.getProjection	(		self,
		Vector3f	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.Box3f.include	(		self,
		Box3f	b )

minimally increases the box to include another box

include() [2/2]

None mrmeshpy.Box3f.include	(		self,
		Vector3f	pt )

minimally increases the box to include given point

insignificantlyExpanded()

Box3f mrmeshpy.Box3f.insignificantlyExpanded

(

self

)

decreases min and increases max to their closest representable value

intersect()

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

intersection()

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

computes intersection between this and other box

intersects()

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

checks whether this box intersects or touches given box

operator() [1/2]

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

static

operator() [2/2]

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

static

size()

Vector3f mrmeshpy.Box3f.size

(

self

)

computes size of the box in all dimensions

valid()

bool mrmeshpy.Box3f.valid

(

self

)

true if the box contains at least one point

volume()

float mrmeshpy.Box3f.volume

(

self

)

computes the volume of this box

Member Data Documentation

_offsetof_max

typing mrmeshpy.Box3f._offsetof_max = 12

staticprotected

_offsetof_min

typing mrmeshpy.Box3f._offsetof_min = 0

staticprotected

elements

typing mrmeshpy.Box3f.elements = 3

static

---

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

• mrmeshpy.pyi