MeshLib Java Docs
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
meshlib.Box2f Class Reference
Inheritance diagram for meshlib.Box2f:

Public Member Functions

 Box2f (java.lang.foreign.MemorySegment segment, java.lang.Object owner)
Box2f copy ()
void set (Box2f other)
meshlib.Vector2f min ()
void setMin (meshlib.Vector2f value)
meshlib.Vector2f max ()
void setMax (meshlib.Vector2f value)
 Box2f ()
 Box2f (meshlib.Vector2f min, meshlib.Vector2f max)
 Box2f (meshlib.NoInit _1)
meshlib.Vector2f index (int e)
meshlib.Vector2f index_mut (int e)
boolean valid ()
meshlib.Vector2f center ()
meshlib.Vector2f corner (meshlib.Vector2b c)
meshlib.Vector2f size ()
float diagonal ()
float volume ()
void include (meshlib.Vector2f pt)
void include (meshlib.Box2f b)
boolean contains (meshlib.Vector2f pt)
boolean contains (meshlib.Box2f otherbox)
meshlib.Vector2f getBoxClosestPointTo (meshlib.Vector2f pt)
boolean intersects (meshlib.Box2f b)
meshlib.Box2f intersection (meshlib.Box2f b)
meshlib.Box2f intersect (meshlib.Box2f b)
float getDistanceSq (meshlib.Box2f b)
float getDistanceSq (meshlib.Vector2f pt)
meshlib.Vector2f getProjection (meshlib.Vector2f pt)
meshlib.Box2f expanded (meshlib.Vector2f expansion)
meshlib.Box2f insignificantlyExpanded ()
boolean opEqual (meshlib.Box2f a)
boolean opNotEqual (meshlib.Box2f a)
Public Member Functions inherited from meshlib.CppStruct
final java.lang.foreign.MemorySegment rawPointer ()

Static Public Member Functions

static meshlib.Box2f fromMinAndSize (meshlib.Vector2f min, meshlib.Vector2f size)
static meshlib.Vector2b getMinBoxCorner (meshlib.Vector2f n)
static meshlib.Vector2b getMaxBoxCorner (meshlib.Vector2f n)
static int elements ()

Static Public Attributes

static final java.lang.foreign.StructLayout LAYOUT = meshlib.Ffi.structLayout(new java.lang.String[]{"min", "max"}, new java.lang.foreign.MemoryLayout[]{meshlib.Vector2f.LAYOUT, meshlib.Vector2f.LAYOUT})
static final long OFF_min = LAYOUT.byteOffset(java.lang.foreign.MemoryLayout.PathElement.groupElement("min"))
static final long OFF_max = LAYOUT.byteOffset(java.lang.foreign.MemoryLayout.PathElement.groupElement("max"))

Additional Inherited Members

Protected Member Functions inherited from meshlib.CppStruct
 CppStruct (java.lang.foreign.MemorySegment segment, java.lang.Object owner)
Protected Attributes inherited from meshlib.CppStruct
final java.lang.foreign.MemorySegment segment

Detailed Description

Box given by its min- and max- corners Generated from class MR::Box2f.

Has the same layout as the C++ struct, the fields are accessed in place in native memory.

Constructor & Destructor Documentation

◆ Box2f() [1/4]

meshlib.Box2f.Box2f ( java.lang.foreign.MemorySegment segment,
java.lang.Object owner )

Wraps a segment holding the struct. owner is kept alive as long as this wrapper is. Not for normal use.

◆ Box2f() [2/4]

meshlib.Box2f.Box2f ( )

create invalid box by default

Calls MR_Box2f_DefaultConstruct().

◆ Box2f() [3/4]

meshlib.Box2f.Box2f ( meshlib.Vector2f min,
meshlib.Vector2f max )

Generated from constructor MR::Box2f::Box2f. The reference to the parameter min might be preserved in the constructed object. The reference to the parameter max might be preserved in the constructed object.

Calls MR_Box2f_Construct_2().

◆ Box2f() [4/4]

meshlib.Box2f.Box2f ( meshlib.NoInit _1)

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 Generated from constructor MR::Box2f::Box2f. The reference to the parameter _1 might be preserved in the constructed object.

Calls MR_Box2f_Construct_1().

Member Function Documentation

◆ center()

meshlib.Vector2f meshlib.Box2f.center ( )

computes center of the box Generated from method MR::Box2f::center.

Calls MR_Box2f_center().

◆ contains() [1/2]

boolean meshlib.Box2f.contains ( meshlib.Box2f otherbox)

checks whether given box is fully inside (the surfaces may touch) of this box Generated from method MR::Box2f::contains.

Calls MR_Box2f_contains_MR_Box2f().

◆ contains() [2/2]

boolean meshlib.Box2f.contains ( meshlib.Vector2f pt)

checks whether given point is inside (including the surface) of this box Generated from method MR::Box2f::contains.

Calls MR_Box2f_contains_MR_Vector2f().

◆ copy()

Box2f meshlib.Box2f.copy ( )

A copy of the struct, in its own memory.

◆ corner()

meshlib.Vector2f meshlib.Box2f.corner ( meshlib.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 Generated from method MR::Box2f::corner.

Calls MR_Box2f_corner().

◆ diagonal()

float meshlib.Box2f.diagonal ( )

computes length from min to max Generated from method MR::Box2f::diagonal.

Calls MR_Box2f_diagonal().

◆ elements()

int meshlib.Box2f.elements ( )
static

Returns a pointer to a member variable of class MR::Box2f named elements.

Calls MR_Box2f_Get_elements().

◆ expanded()

meshlib.Box2f meshlib.Box2f.expanded ( meshlib.Vector2f expansion)

decreases min and increased max on given value Generated from method MR::Box2f::expanded.

Calls MR_Box2f_expanded().

◆ fromMinAndSize()

meshlib.Box2f meshlib.Box2f.fromMinAndSize ( meshlib.Vector2f min,
meshlib.Vector2f size )
static

Generated from method MR::Box2f::fromMinAndSize.

Calls MR_Box2f_fromMinAndSize().

◆ getBoxClosestPointTo()

meshlib.Vector2f meshlib.Box2f.getBoxClosestPointTo ( meshlib.Vector2f pt)

returns closest point in the box to given point Generated from method MR::Box2f::getBoxClosestPointTo.

Calls MR_Box2f_getBoxClosestPointTo().

◆ getDistanceSq() [1/2]

float meshlib.Box2f.getDistanceSq ( meshlib.Box2f b)

returns squared distance between this box and given one; returns zero if the boxes touch or intersect Generated from method MR::Box2f::getDistanceSq.

Calls MR_Box2f_getDistanceSq_MR_Box2f().

◆ getDistanceSq() [2/2]

float meshlib.Box2f.getDistanceSq ( meshlib.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 Generated from method MR::Box2f::getDistanceSq.

Calls MR_Box2f_getDistanceSq_MR_Vector2f().

◆ getMaxBoxCorner()

meshlib.Vector2b meshlib.Box2f.getMaxBoxCorner ( meshlib.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 Generated from method MR::Box2f::getMaxBoxCorner.

Calls MR_Box2f_getMaxBoxCorner().

◆ getMinBoxCorner()

meshlib.Vector2b meshlib.Box2f.getMinBoxCorner ( meshlib.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 Generated from method MR::Box2f::getMinBoxCorner.

Calls MR_Box2f_getMinBoxCorner().

◆ getProjection()

meshlib.Vector2f meshlib.Box2f.getProjection ( meshlib.Vector2f pt)

returns the closest point on the box to the given point for points outside the box this is equivalent to getBoxClosestPointTo Generated from method MR::Box2f::getProjection.

Calls MR_Box2f_getProjection().

◆ include() [1/2]

void meshlib.Box2f.include ( meshlib.Box2f b)

minimally increases the box to include another box Generated from method MR::Box2f::include.

Calls MR_Box2f_include_MR_Box2f().

◆ include() [2/2]

void meshlib.Box2f.include ( meshlib.Vector2f pt)

minimally increases the box to include given point Generated from method MR::Box2f::include.

Calls MR_Box2f_include_MR_Vector2f().

◆ index()

meshlib.Vector2f meshlib.Box2f.index ( int e)

min/max access by 0/1 index Generated from method MR::Box2f::operator[].

Calls MR_Box2f_index().

◆ index_mut()

meshlib.Vector2f meshlib.Box2f.index_mut ( int e)

Generated from method MR::Box2f::operator[].

Calls MR_Box2f_index_mut().

◆ insignificantlyExpanded()

meshlib.Box2f meshlib.Box2f.insignificantlyExpanded ( )

decreases min and increases max to their closest representable value Generated from method MR::Box2f::insignificantlyExpanded.

Calls MR_Box2f_insignificantlyExpanded().

◆ intersect()

meshlib.Box2f meshlib.Box2f.intersect ( meshlib.Box2f b)

Generated from method MR::Box2f::intersect.

Calls MR_Box2f_intersect().

◆ intersection()

meshlib.Box2f meshlib.Box2f.intersection ( meshlib.Box2f b)

computes intersection between this and other box Generated from method MR::Box2f::intersection.

Calls MR_Box2f_intersection().

◆ intersects()

boolean meshlib.Box2f.intersects ( meshlib.Box2f b)

checks whether this box intersects or touches given box Generated from method MR::Box2f::intersects.

Calls MR_Box2f_intersects().

◆ max()

meshlib.Vector2f meshlib.Box2f.max ( )

◆ min()

meshlib.Vector2f meshlib.Box2f.min ( )

◆ opEqual()

boolean meshlib.Box2f.opEqual ( meshlib.Box2f a)

Generated from method MR::Box2f::operator==.

Calls MR_equal_MR_Box2f().

◆ opNotEqual()

boolean meshlib.Box2f.opNotEqual ( meshlib.Box2f a)

Generated from method MR::Box2f::operator!=.

Calls MR_not_equal_MR_Box2f().

◆ set()

void meshlib.Box2f.set ( Box2f other)

Overwrites the contents with those of another struct.

◆ setMax()

void meshlib.Box2f.setMax ( meshlib.Vector2f value)

◆ setMin()

void meshlib.Box2f.setMin ( meshlib.Vector2f value)

◆ size()

meshlib.Vector2f meshlib.Box2f.size ( )

computes size of the box in all dimensions Generated from method MR::Box2f::size.

Calls MR_Box2f_size().

◆ valid()

boolean meshlib.Box2f.valid ( )

true if the box contains at least one point Generated from method MR::Box2f::valid.

Calls MR_Box2f_valid().

◆ volume()

float meshlib.Box2f.volume ( )

computes the volume of this box Generated from method MR::Box2f::volume.

Calls MR_Box2f_volume().

Member Data Documentation

◆ LAYOUT

final java.lang.foreign.StructLayout meshlib.Box2f.LAYOUT = meshlib.Ffi.structLayout(new java.lang.String[]{"min", "max"}, new java.lang.foreign.MemoryLayout[]{meshlib.Vector2f.LAYOUT, meshlib.Vector2f.LAYOUT})
static

The native layout of the struct.

◆ OFF_max

final long meshlib.Box2f.OFF_max = LAYOUT.byteOffset(java.lang.foreign.MemoryLayout.PathElement.groupElement("max"))
static

◆ OFF_min

final long meshlib.Box2f.OFF_min = LAYOUT.byteOffset(java.lang.foreign.MemoryLayout.PathElement.groupElement("min"))
static
The documentation for this class was generated from the following file: