MeshLib Python Docs
Loading...
Searching...
No Matches
Inheritance diagram for mrmeshpy.ConstBox3i:

Public Member Functions

bool __eq__ (self, ConstBox3i a)
ConstVector3i __getitem__ (self, int e)
 __init__ (self, *args, **kwargs)
bool __ne__ (self, ConstBox3i a)
str __repr__ (self)
typing.Any __rlshift__ (self, typing.Any box)
Vector3i center (self)
bool contains (self, ConstVector3i pt)
bool contains (self, ConstBox3i otherbox)
Vector3i corner (self, ConstVector3b c)
int diagonal (self)
Box3i expanded (self, ConstVector3i expansion)
Vector3i getBoxClosestPointTo (self, ConstVector3i pt)
int getDistanceSq (self, ConstBox3i b)
int getDistanceSq (self, ConstVector3i pt)
Vector3i getProjection (self, ConstVector3i pt)
Box3i insignificantlyExpanded (self)
Box3i intersection (self, ConstBox3i b)
bool intersects (self, ConstBox3i b)
Vector3i size (self)
bool valid (self)
int volume (self)
ConstVector3i max (self)
ConstVector3i min (self)

Static Public Member Functions

Box3i fromMinAndSize (ConstVector3i min, ConstVector3i size)
Vector3b getMaxBoxCorner (ConstVector3i n)
Vector3b getMinBoxCorner (ConstVector3i n)

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__()

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

1. __init__(self: meshlib.mrmeshpy.ConstBox3i) -> None

create invalid box by default

2. __init__(self: meshlib.mrmeshpy.ConstBox3i, min: meshlib.mrmeshpy.ConstVector3i, max: meshlib.mrmeshpy.ConstVector3i) -> None

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

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

4. __init__(self: meshlib.mrmeshpy.ConstBox3i, arg0: meshlib.mrmeshpy.Box3i) -> None

Implicit copy constructor.

5. __init__(self: meshlib.mrmeshpy.ConstBox3i, : meshlib.mrmeshpy.Box3i) -> None

Member Function Documentation

◆ __eq__()

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

◆ __getitem__()

ConstVector3i mrmeshpy.ConstBox3i.__getitem__ ( self,
int e )
min/max access by 0/1 index

◆ __ne__()

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

◆ __repr__()

str mrmeshpy.ConstBox3i.__repr__ ( self)

◆ __rlshift__()

typing.Any mrmeshpy.ConstBox3i.__rlshift__ ( self,
typing.Any box )

◆ center()

Vector3i mrmeshpy.ConstBox3i.center ( self)
computes center of the box

◆ contains() [1/2]

bool mrmeshpy.ConstBox3i.contains ( self,
ConstBox3i otherbox )
checks whether given box is fully inside (the surfaces may touch) of this box

◆ contains() [2/2]

bool mrmeshpy.ConstBox3i.contains ( self,
ConstVector3i pt )
checks whether given point is inside (including the surface) of this box

◆ corner()

Vector3i mrmeshpy.ConstBox3i.corner ( self,
ConstVector3b 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.ConstBox3i.diagonal ( self)
computes length from min to max

◆ expanded()

Box3i mrmeshpy.ConstBox3i.expanded ( self,
ConstVector3i expansion )
decreases min and increased max on given value

◆ fromMinAndSize()

Box3i mrmeshpy.ConstBox3i.fromMinAndSize ( ConstVector3i min,
ConstVector3i size )
static

◆ getBoxClosestPointTo()

Vector3i mrmeshpy.ConstBox3i.getBoxClosestPointTo ( self,
ConstVector3i pt )
returns closest point in the box to given point

◆ getDistanceSq() [1/2]

int mrmeshpy.ConstBox3i.getDistanceSq ( self,
ConstBox3i b )
returns squared distance between this box and given one;
returns zero if the boxes touch or intersect

◆ getDistanceSq() [2/2]

int mrmeshpy.ConstBox3i.getDistanceSq ( self,
ConstVector3i 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.ConstBox3i.getMaxBoxCorner ( ConstVector3i 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.ConstBox3i.getMinBoxCorner ( ConstVector3i 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.ConstBox3i.getProjection ( self,
ConstVector3i pt )
returns the closest point on the box to the given point
for points outside the box this is equivalent to getBoxClosestPointTo

◆ insignificantlyExpanded()

Box3i mrmeshpy.ConstBox3i.insignificantlyExpanded ( self)
decreases min and increases max to their closest representable value

◆ intersection()

Box3i mrmeshpy.ConstBox3i.intersection ( self,
ConstBox3i b )
computes intersection between this and other box

◆ intersects()

bool mrmeshpy.ConstBox3i.intersects ( self,
ConstBox3i b )
checks whether this box intersects or touches given box

◆ max()

ConstVector3i mrmeshpy.ConstBox3i.max ( self)

Reimplemented in mrmeshpy.Box3i, and mrmeshpy.Box3i.

◆ min()

ConstVector3i mrmeshpy.ConstBox3i.min ( self)

Reimplemented in mrmeshpy.Box3i, and mrmeshpy.Box3i.

◆ size()

Vector3i mrmeshpy.ConstBox3i.size ( self)
computes size of the box in all dimensions

◆ valid()

bool mrmeshpy.ConstBox3i.valid ( self)
true if the box contains at least one point

◆ volume()

int mrmeshpy.ConstBox3i.volume ( self)
computes the volume of this box

Member Data Documentation

◆ _offsetof_max

typing mrmeshpy.ConstBox3i._offsetof_max = 12
staticprotected

◆ _offsetof_min

typing mrmeshpy.ConstBox3i._offsetof_min = 0
staticprotected

◆ elements

typing mrmeshpy.ConstBox3i.elements = 3
static

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