mrmeshpy.Box2f Class Reference

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

Static Public Member Functions
None	__init__ (*args, **kwargs)
None	__init__ (*args, **kwargs)
Box2f	fromMinAndSize (Vector2f min, Vector2f size)
Vector2b	getMaxBoxCorner (Vector2f n)
Vector2b	getMinBoxCorner (Vector2f n)
Box2f	operator (*args, **kwargs)
Box2f	operator (*args, **kwargs)

Static Public Attributes
typing	elements = 2

Static Protected Attributes
typing	_offsetof_max = 8
typing	_offsetof_min = 0

Detailed Description

Generated from:  MR::Box2f
Aliases:  AABBTreeTraits_UndirectedEdgeTag_Box2f.BoxT, AABBTreeNode_AABBTreeTraits_UndirectedEdgeTag_Box2f.BoxT, AABBTreeBase_AABBTreeTraits_UndirectedEdgeTag_Box2f.BoxT

Box given by its min- and max- corners

Constructor & Destructor Documentation

__init__() [1/6]

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

static

__init__() [3/6]

None mrmeshpy.Box2f.__init__

(

self

)

create invalid box by default

__init__() [4/6]

None mrmeshpy.Box2f.__init__	(		self,
		Vector2f	min,
		Vector2f	max )

__init__() [5/6]

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

__init__() [6/6]

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

Implicit copy constructor.

Member Function Documentation

__eq__()

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

__getitem__() [1/2]

Vector2f mrmeshpy.Box2f.__getitem__	(		self,
		int	e )

min/max access by 0/1 index

__getitem__() [2/2]

Vector2f mrmeshpy.Box2f.__getitem__	(		self,
		int	e )

__ne__()

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

__repr__()

str mrmeshpy.Box2f.__repr__

(

self

)

__setitem__()

None mrmeshpy.Box2f.__setitem__	(		self,
		int	arg0,
		Vector2f	arg1 )

center()

Vector2f mrmeshpy.Box2f.center

(

self

)

computes center of the box

contains() [1/2]

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

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

contains() [2/2]

bool mrmeshpy.Box2f.contains	(		self,
		Vector2f	pt )

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

corner()

Vector2f mrmeshpy.Box2f.corner	(		self,
		Vector2b	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.Box2f.diagonal

(

self

)

computes length from min to max

expanded()

Box2f mrmeshpy.Box2f.expanded	(		self,
		Vector2f	expansion )

decreases min and increased max on given value

fromMinAndSize()

Box2f mrmeshpy.Box2f.fromMinAndSize ( Vector2f min, Vector2f size )

static

getBoxClosestPointTo()

Vector2f mrmeshpy.Box2f.getBoxClosestPointTo	(		self,
		Vector2f	pt )

returns closest point in the box to given point

getDistanceSq() [1/2]

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

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

getDistanceSq() [2/2]

float mrmeshpy.Box2f.getDistanceSq	(		self,
		Vector2f	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()

Vector2b mrmeshpy.Box2f.getMaxBoxCorner ( Vector2f 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()

Vector2b mrmeshpy.Box2f.getMinBoxCorner ( Vector2f 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()

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

minimally increases the box to include another box

include() [2/2]

None mrmeshpy.Box2f.include	(		self,
		Vector2f	pt )

minimally increases the box to include given point

insignificantlyExpanded()

Box2f mrmeshpy.Box2f.insignificantlyExpanded

(

self

)

decreases min and increases max to their closest representable value

intersect()

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

intersection()

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

computes intersection between this and other box

intersects()

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

checks whether this box intersects or touches given box

operator() [1/2]

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

static

operator() [2/2]

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

static

size()

Vector2f mrmeshpy.Box2f.size

(

self

)

computes size of the box in all dimensions

valid()

bool mrmeshpy.Box2f.valid

(

self

)

true if the box contains at least one point

volume()

float mrmeshpy.Box2f.volume

(

self

)

computes the volume of this box

Member Data Documentation

_offsetof_max

typing mrmeshpy.Box2f._offsetof_max = 8

staticprotected

_offsetof_min

typing mrmeshpy.Box2f._offsetof_min = 0

staticprotected

elements

typing mrmeshpy.Box2f.elements = 2

static

---

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

• mrmeshpy.pyi