Oriented bounding box. More...

#include <OrientedBox.hpp>

Collaboration diagram for moab::OrientedBox:

Classes
struct	CovarienceData

Public Member Functions
	OrientedBox ()

	OrientedBox (const Matrix3 &axes_mat, const CartVect &center)

	OrientedBox (const CartVect axes_in[3], const CartVect &center)

double	inner_radius () const
	radius of inscribed sphere More...

double	outer_radius () const
	radius of circumscribed sphere More...

double	outer_radius_squared (const double reps) const
	square of (radius+at least epsilon) of circumsphere More...

double	inner_radius_squared (const double reps) const
	square of (radius-epsilon) of inscribed sphere More...

double	volume () const
	volume of box More...

CartVect	dimensions () const
	number of dimensions for which box is not flat More...

double	area () const
	largest side area More...

CartVect	axis (int index) const
	get unit vector in direction of axis More...

CartVect	scaled_axis (int index) const
	get vector in direction of axis, scaled to its true length More...

bool	contained (const CartVect &point, double tolerance) const

bool	intersect_ray (const CartVect &ray_start_point, const CartVect &ray_unit_direction, const double distance_tolerance, const double nonnegatve_ray_len=0, const double negative_ray_len=0) const

void	closest_location_in_box (const CartVect &input_position, CartVect &output_position) const
	Find closest position on/within box to input position. More...

ErrorCode	make_hex (EntityHandle &hex, Interface *instance)
	Construct a hexahedral element with the same shape as this box. More...

Static Public Member Functions
static ErrorCode	tag_handle (Tag &handle_out, Interface instance, const char name)
	get tag handle for storing oriented box More...

static ErrorCode	compute_from_vertices (OrientedBox &result, Interface *instance, const Range &vertices)
	Calculate an oriented box from a set of vertices. More...

static ErrorCode	compute_from_2d_cells (OrientedBox &result, Interface *instance, const Range &elements)
	Calculate an oriented box from a set of 2D elements. More...

static ErrorCode	covariance_data_from_tris (CovarienceData &result, Interface *moab_instance, const Range &elements)

static ErrorCode	compute_from_covariance_data (OrientedBox &result, Interface moab_instance, const CovarienceData orient_array, unsigned orient_array_length, const Range &vertices)

static ErrorCode	compute_from_covariance_data (OrientedBox &result, Interface *moab_instance, CovarienceData &orientation_data, const Range &vertices)

Public Attributes
CartVect	center
	Box center. More...

Matrix3	axes
	Box axes, unit vectors sorted by extent of box along axis. More...

CartVect	length
	distance from center to plane along each axis More...

double	radius
	outer radius (1/2 diagonal length) of box More...

Private Member Functions
void	order_axes_by_length (double ax1_len, double ax2_len, double ax3_len)
	orders the box axes by the given lengths for each axis More...

Detailed Description

Oriented bounding box.

Definition at line 40 of file OrientedBox.hpp.

Constructor & Destructor Documentation

◆ OrientedBox() [1/3]

moab::OrientedBox::OrientedBox ( )

inline

Definition at line 57 of file OrientedBox.hpp.

57 : radius( 0.0 ) {}

Referenced by compute_from_covariance_data().

◆ OrientedBox() [2/3]

moab::OrientedBox::OrientedBox	(	const Matrix3 &	axes_mat,
		const CartVect &	center
	)

Definition at line 129 of file OrientedBox.cpp.

                                                                        : center( mid ), axes( axes_mat )
 {
     order_axes_by_length( axes.col( 0 ).length(), axes.col( 1 ).length(), axes.col( 2 ).length() );
 }

References axes, moab::Matrix3::col(), moab::CartVect::length(), and order_axes_by_length().

◆ OrientedBox() [3/3]

moab::OrientedBox::OrientedBox	(	const CartVect	axes_in[3],
		const CartVect &	center
	)

Definition at line 121 of file OrientedBox.cpp.

                                                                          : center( mid )
 {
  
     axes = Matrix3( axes_in[0], axes_in[1], axes_in[2], false );
  
     order_axes_by_length( axes_in[0].length(), axes_in[1].length(), axes_in[2].length() );
 }

References axes, length, and order_axes_by_length().

Member Function Documentation

◆ area()

double moab::OrientedBox::area ( ) const

inline

largest side area

Definition at line 228 of file OrientedBox.hpp.

 {
 #if MB_ORIENTED_BOX_UNIT_VECTORS
     return 4 * length[1] * length[2];
 #else
     return 4 * ( axes.col( 1 ) * axes.col( 2 ) ).length();
 #endif
 }

References axes, moab::Matrix3::col(), and length.

Referenced by moab::OrientedBoxTreeTool::recursive_stats().

◆ axis()

CartVect moab::OrientedBox::axis ( int index ) const

inline

get unit vector in direction of axis

Definition at line 237 of file OrientedBox.hpp.

 {
     return axes.col( index );
 }

References axes, and moab::Matrix3::col().

Referenced by moab::TreeNodePrinter::print_geometry().

◆ closest_location_in_box()

void moab::OrientedBox::closest_location_in_box	(	const CartVect &	input_position,
		CartVect &	output_position
	)		const

Find closest position on/within box to input position.

Find the closest position in the solid box to the input position. If the input position is on or within the box, then the output position will be the same as the input position. If the input position is outside the box, the outside position will be the closest point on the box boundary to the input position.

Definition at line 658 of file OrientedBox.cpp.

 {
     // get coordinates on box axes
     const CartVect from_center = input_position - center;
  
 #if MB_ORIENTED_BOX_UNIT_VECTORS
     CartVect local( from_center % axes.col( 0 ), from_center % axes.col( 1 ), from_center % axes.col( 2 ) );
  
     for( int i = 0; i < 3; ++i )
     {
         if( local[i] < -length[i] )
             local[i] = -length[i];
         else if( local[i] > length[i] )
             local[i] = length[i];
     }
 #else
     CartVect local( ( from_center % axes.col( 0 ) ) / ( axes.col( 0 ) % axes.col( 0 ) ),
                     ( from_center % axes.col( 1 ) ) / ( axes.col( 1 ) % axes.col( 1 ) ),
                     ( from_center % axes.col( 2 ) ) / ( axes.col( 2 ) % axes.col( 2 ) ) );
  
     for( int i = 0; i < 3; ++i )
     {
         if( local[i] < -1.0 )
             local[i] = -1.0;
         else if( local[i] > 1.0 )
             local[i] = 1.0;
     }
 #endif
  
     output_position = center + local[0] * axes.col( 0 ) + local[1] * axes.col( 1 ) + local[2] * axes.col( 2 );
 }

References axes, center, moab::Matrix3::col(), and length.

Referenced by moab::OrientedBoxTreeTool::closest_to_location(), and moab::OrientedBoxTreeTool::sphere_intersect_triangles().

◆ compute_from_2d_cells()

ErrorCode moab::OrientedBox::compute_from_2d_cells	(	OrientedBox &	result,
		Interface *	instance,
		const Range &	elements
	)

static

Calculate an oriented box from a set of 2D elements.

Definition at line 311 of file OrientedBox.cpp.

 {
     // Get orientation data from elements
     CovarienceData data;
     ErrorCode rval = covariance_data_from_tris( data, instance, elements );
     if( MB_SUCCESS != rval ) return rval;
  
     // get vertices from elements
     Range points;
     rval = instance->get_adjacencies( elements, 0, false, points, Interface::UNION );
     if( MB_SUCCESS != rval ) return rval;
  
     // Calculate box given points and orientation data
     return compute_from_covariance_data( result, instance, data, points );
 }

References compute_from_covariance_data(), covariance_data_from_tris(), ErrorCode, moab::Interface::get_adjacencies(), MB_SUCCESS, and moab::Interface::UNION.

Referenced by moab::OrientedBoxTreeTool::build_tree().

◆ compute_from_covariance_data() [1/2]

ErrorCode moab::OrientedBox::compute_from_covariance_data	(	OrientedBox &	result,
		Interface *	moab_instance,
		const CovarienceData *	orient_array,
		unsigned	orient_array_length,
		const Range &	vertices
	)

static

Calculate an OrientedBox given an array of CovarienceData and the list of vertices the box is to bound.

Definition at line 372 of file OrientedBox.cpp.

 {
     // Sum input CovarienceData structures
     CovarienceData data_sum( Matrix3( 0.0 ), CartVect( 0.0 ), 0.0 );
     for( const CovarienceData* const end = data + data_length; data != end; ++data )
     {
         data_sum.matrix += data->matrix;
         data_sum.center += data->center;
         data_sum.area += data->area;
     }
     // Compute box from sum of structs
     return compute_from_covariance_data( result, moab_instance, data_sum, vertices );
 }

References moab::OrientedBox::CovarienceData::area, moab::OrientedBox::CovarienceData::center, and moab::OrientedBox::CovarienceData::matrix.

Referenced by moab::OrientedBoxTreeTool::build_sets(), and compute_from_2d_cells().

◆ compute_from_covariance_data() [2/2]

ErrorCode moab::OrientedBox::compute_from_covariance_data	(	OrientedBox &	result,
		Interface *	moab_instance,
		CovarienceData &	orientation_data,
		const Range &	vertices
	)

static

Calculate an OrientedBox given a CovarienceData struct and the list of points the box is to bound.

Definition at line 327 of file OrientedBox.cpp.

 {
     if( data.area <= 0.0 )
     {
         Matrix3 empty_axes( 0.0 );
         result = OrientedBox( empty_axes, CartVect( 0. ) );
         return MB_SUCCESS;
     }
  
     // get center from sum
     result.center = data.center / data.area;
  
     // get covariance matrix from moments
     data.matrix /= 12 * data.area;
     data.matrix -= outer_product( result.center, result.center );
  
     // get axes (Eigenvectors) from covariance matrix
     CartVect lambda;
     data.matrix.eigen_decomposition( lambda, result.axes );
  
     // We now have only the axes.  Calculate proper center
     // and extents for enclosed points.
     return box_from_axes( result, instance, vertices );
 }

References moab::OrientedBox::CovarienceData::area, axes, moab::box_from_axes(), center, moab::OrientedBox::CovarienceData::center, moab::Matrix3::eigen_decomposition(), moab::OrientedBox::CovarienceData::matrix, MB_SUCCESS, OrientedBox(), and moab::outer_product().

◆ compute_from_vertices()

ErrorCode moab::OrientedBox::compute_from_vertices	(	OrientedBox &	result,
		Interface *	instance,
		const Range &	vertices
	)

static

Calculate an oriented box from a set of vertices.

Definition at line 231 of file OrientedBox.cpp.

 {
     const Range::iterator begin = vertices.lower_bound( MBVERTEX );
     const Range::iterator end   = vertices.upper_bound( MBVERTEX );
     size_t count                = 0;
  
     // compute mean
     CartVect v;
     result.center = CartVect( 0, 0, 0 );
     for( Range::iterator i = begin; i != end; ++i )
     {
         ErrorCode rval = instance->get_coords( &*i, 1, v.array() );
         if( MB_SUCCESS != rval ) return rval;
         result.center += v;
         ++count;
     }
     result.center /= count;
  
     // compute covariance matrix
     Matrix3 a( 0.0 );
     for( Range::iterator i = begin; i != end; ++i )
     {
         ErrorCode rval = instance->get_coords( &*i, 1, v.array() );
         if( MB_SUCCESS != rval ) return rval;
  
         v -= result.center;
         a += outer_product( v, v );
     }
     a /= count;
  
     // Get axes (Eigenvectors) from covariance matrix
     CartVect lambda;
     a.eigen_decomposition( lambda, result.axes );
  
     // Calculate center and extents of box given orientation defined by axes
     return box_from_axes( result, instance, vertices );
 }

References moab::CartVect::array(), axes, moab::box_from_axes(), center, moab::Matrix3::eigen_decomposition(), ErrorCode, moab::Interface::get_coords(), moab::Range::lower_bound(), MB_SUCCESS, MBVERTEX, moab::outer_product(), and moab::Range::upper_bound().

◆ contained()

bool moab::OrientedBox::contained	(	const CartVect &	point,
		double	tolerance
	)		const

Test if point is contained in box

Definition at line 355 of file OrientedBox.cpp.

 {
     CartVect from_center = point - center;
 #if MB_ORIENTED_BOX_UNIT_VECTORS
     return fabs( from_center % axes.col( 0 ) ) - length[0] <= tol &&
            fabs( from_center % axes.col( 1 ) ) - length[1] <= tol &&
            fabs( from_center % axes.col( 2 ) ) - length[2] <= tol;
 #else
     for( int i = 0; i < 3; ++i )
     {
         double length = axes.col( i ).length();
         if( fabs( from_center % axes.col( i ) ) - length * length > length * tol ) return false;
     }
     return true;
 #endif
 }

References axes, center, moab::Matrix3::col(), moab::CartVect::length(), and length.

Referenced by TriCounter::visit().

◆ covariance_data_from_tris()

ErrorCode moab::OrientedBox::covariance_data_from_tris	(	CovarienceData &	result,
		Interface *	moab_instance,
		const Range &	elements
	)

static

Calculate a CovarienceData struct from a list of triangles

Definition at line 269 of file OrientedBox.cpp.

 {
     ErrorCode rval;
     const Range::iterator begin = elements.lower_bound( CN::TypeDimensionMap[2].first );
     const Range::iterator end   = elements.lower_bound( CN::TypeDimensionMap[3].first );
  
     // compute mean and moments
     result.matrix = Matrix3( 0.0 );
     result.center = CartVect( 0.0 );
     result.area   = 0.0;
     for( Range::iterator i = begin; i != end; ++i )
     {
         const EntityHandle* conn = NULL;
         int conn_len             = 0;
         rval                     = instance->get_connectivity( *i, conn, conn_len );
         if( MB_SUCCESS != rval ) return rval;
  
         // for each triangle in the 2-D cell
         for( int j = 2; j < conn_len; ++j )
         {
             EntityHandle vertices[3] = { conn[0], conn[j - 1], conn[j] };
             CartVect coords[3];
             rval = instance->get_coords( vertices, 3, coords[0].array() );
             if( MB_SUCCESS != rval ) return rval;
  
             // edge vectors
             const CartVect edge0    = coords[1] - coords[0];
             const CartVect edge1    = coords[2] - coords[0];
             const CartVect centroid = ( coords[0] + coords[1] + coords[2] ) / 3;
             const double tri_area2  = ( edge0 * edge1 ).length();
             result.area += tri_area2;
             result.center += tri_area2 * centroid;
  
             result.matrix +=
                 tri_area2 * ( 9 * outer_product( centroid, centroid ) + outer_product( coords[0], coords[0] ) +
                               outer_product( coords[1], coords[1] ) + outer_product( coords[2], coords[2] ) );
         }  // for each triangle
     }      // for each element
  
     return MB_SUCCESS;
 }

References moab::OrientedBox::CovarienceData::area, moab::OrientedBox::CovarienceData::center, ErrorCode, moab::GeomUtil::first(), moab::Interface::get_connectivity(), moab::Interface::get_coords(), length, moab::Range::lower_bound(), moab::OrientedBox::CovarienceData::matrix, MB_SUCCESS, moab::outer_product(), and moab::CN::TypeDimensionMap.

Referenced by compute_from_2d_cells(), and moab::OrientedBoxTreeTool::join_trees().

◆ dimensions()

CartVect moab::OrientedBox::dimensions ( ) const

inline

number of dimensions for which box is not flat

Definition at line 219 of file OrientedBox.hpp.

 {
 #if MB_ORIENTED_BOX_UNIT_VECTORS
     return 2.0 * length;
 #else
     return 2.0 * CartVect( axes.col( 0 ).length(), axes.col( 1 ).length(), axes.col( 2 ).length() );
 #endif
 }

References axes, moab::Matrix3::col(), moab::CartVect::length(), and length.

Referenced by moab::TreeNodePrinter::print_geometry(), and moab::OrientedBoxTreeTool::recursive_stats().

◆ inner_radius()

double moab::OrientedBox::inner_radius ( ) const

inline

radius of inscribed sphere

Definition at line 163 of file OrientedBox.hpp.

 {
 #if MB_ORIENTED_BOX_UNIT_VECTORS
     return length[0];
 #else
     return axes.col( 0 ).length();
 #endif
 }

References axes, moab::Matrix3::col(), moab::CartVect::length(), and length.

Referenced by moab::TreeNodePrinter::print_geometry(), and moab::OrientedBoxTreeTool::recursive_stats().

◆ inner_radius_squared()

double moab::OrientedBox::inner_radius_squared ( const double reps ) const

inline

square of (radius-epsilon) of inscribed sphere

Definition at line 199 of file OrientedBox.hpp.

 {
 #if MB_ORIENTED_BOX_UNIT_VECTORS
     return ( length[0] - reps ) * ( length[0] - reps );
 #else
     CartVect tmp = axes.col( 0 );
     tmp -= CartVect( reps, reps, reps );
     return ( tmp % tmp );
 #endif
 }

References axes, moab::Matrix3::col(), and length.

Referenced by intersect_ray().

◆ intersect_ray()

bool moab::OrientedBox::intersect_ray	(	const CartVect &	ray_start_point,
		const CartVect &	ray_unit_direction,
		const double	distance_tolerance,
		const double *	nonnegatve_ray_len = `0`,
		const double *	negative_ray_len = `0`
	)		const

Test for intersection of a ray (or line segment) with this box. Ray length limits are used to optimize Monte Carlo particle tracking.

Parameters

ray_start_point	The base point of the ray
ray_unit_direction	The direction of the ray (must be unit length)
distance_tolerance	Tolerance to use in intersection checks
nonnegative_ray_len	Optional length of ray in forward direction
negative_ray_len	Optional length of ray in reverse direction

Definition at line 498 of file OrientedBox.cpp.

 {
     // test distance from box center to line
     const CartVect cx       = center - ray_origin;
     const double dist_s     = cx % ray_direction;
     const double dist_sq    = cx % cx - ( dist_s * dist_s );
     const double max_diagsq = outer_radius_squared( reps );
  
     // For the largest sphere, no intersections exist if discriminant is negative.
     // Geometrically, if distance from box center to line is greater than the
     // longest diagonal, there is no intersection.
     // manipulate the discriminant: 0 > dist_s*dist_s - cx%cx + max_diagsq
     if( dist_sq > max_diagsq ) return false;
  
     // If the closest possible intersection must be closer than nonneg_ray_len. Be
     // careful with absolute value, squaring distances, and subtracting squared
     // distances.
     if( nonneg_ray_len )
     {
         assert( 0 <= *nonneg_ray_len );
         double max_len;
         if( neg_ray_len )
         {
             assert( 0 >= *neg_ray_len );
             max_len = std::max( *nonneg_ray_len, -( *neg_ray_len ) );
         }
         else
         {
             max_len = *nonneg_ray_len;
         }
         const double temp = fabs( dist_s ) - max_len;
         if( 0.0 < temp && temp * temp > max_diagsq ) return false;
     }
  
     // if smaller than shortest diagonal, we do hit
     if( dist_sq < inner_radius_squared( reps ) )
     {
         // nonnegative direction
         if( dist_s >= 0.0 )
         {
             if( nonneg_ray_len )
             {
                 if( *nonneg_ray_len > dist_s ) return true;
             }
             else
             {
                 return true;
             }
             // negative direction
         }
         else
         {
             if( neg_ray_len && *neg_ray_len < dist_s ) return true;
         }
     }
  
     // get transpose of axes
     Matrix3 B = axes.transpose();
  
     // transform ray to box coordintae system
     CartVect par_pos = B * ( ray_origin - center );
     CartVect par_dir = B * ray_direction;
  
     // Fast Rejection Test: Ray will not intersect if it is going away from the box.
     // This will not work for rays with neg_ray_len. length[0] is half of box width
     // along axes.col(0).
     const double half_x = length[0] + reps;
     const double half_y = length[1] + reps;
     const double half_z = length[2] + reps;
     if( !neg_ray_len )
     {
         if( ( par_pos[0] > half_x && par_dir[0] >= 0 ) || ( par_pos[0] < -half_x && par_dir[0] <= 0 ) ) return false;
  
         if( ( par_pos[1] > half_y && par_dir[1] >= 0 ) || ( par_pos[1] < -half_y && par_dir[1] <= 0 ) ) return false;
  
         if( ( par_pos[2] > half_z && par_dir[2] >= 0 ) || ( par_pos[2] < -half_z && par_dir[2] <= 0 ) ) return false;
     }
  
     // test if ray_origin is inside box
     if( par_pos[0] <= half_x && par_pos[0] >= -half_x && par_pos[1] <= half_y && par_pos[1] >= -half_y &&
         par_pos[2] <= half_z && par_pos[2] >= -half_z )
         return true;
  
     // test two xy plane
     if( fabs( par_dir[0] * ( half_z - par_pos[2] ) + par_dir[2] * par_pos[0] ) <=
             fabs( par_dir[2] * half_x ) &&  // test against x extents using z
         fabs( par_dir[1] * ( half_z - par_pos[2] ) + par_dir[2] * par_pos[1] ) <=
             fabs( par_dir[2] * half_y ) &&  // test against y extents using z
         check_ray_limits( par_pos[2], par_dir[2], half_z, nonneg_ray_len, neg_ray_len ) )
         return true;
     if( fabs( par_dir[0] * ( -half_z - par_pos[2] ) + par_dir[2] * par_pos[0] ) <= fabs( par_dir[2] * half_x ) &&
         fabs( par_dir[1] * ( -half_z - par_pos[2] ) + par_dir[2] * par_pos[1] ) <= fabs( par_dir[2] * half_y ) &&
         check_ray_limits( par_pos[2], par_dir[2], -half_z, nonneg_ray_len, neg_ray_len ) )
         return true;
  
     // test two xz plane
     if( fabs( par_dir[0] * ( half_y - par_pos[1] ) + par_dir[1] * par_pos[0] ) <= fabs( par_dir[1] * half_x ) &&
         fabs( par_dir[2] * ( half_y - par_pos[1] ) + par_dir[1] * par_pos[2] ) <= fabs( par_dir[1] * half_z ) &&
         check_ray_limits( par_pos[1], par_dir[1], half_y, nonneg_ray_len, neg_ray_len ) )
         return true;
     if( fabs( par_dir[0] * ( -half_y - par_pos[1] ) + par_dir[1] * par_pos[0] ) <= fabs( par_dir[1] * half_x ) &&
         fabs( par_dir[2] * ( -half_y - par_pos[1] ) + par_dir[1] * par_pos[2] ) <= fabs( par_dir[1] * half_z ) &&
         check_ray_limits( par_pos[1], par_dir[1], -half_y, nonneg_ray_len, neg_ray_len ) )
         return true;
  
     // test two yz plane
     if( fabs( par_dir[1] * ( half_x - par_pos[0] ) + par_dir[0] * par_pos[1] ) <= fabs( par_dir[0] * half_y ) &&
         fabs( par_dir[2] * ( half_x - par_pos[0] ) + par_dir[0] * par_pos[2] ) <= fabs( par_dir[0] * half_z ) &&
         check_ray_limits( par_pos[0], par_dir[0], half_x, nonneg_ray_len, neg_ray_len ) )
         return true;
     if( fabs( par_dir[1] * ( -half_x - par_pos[0] ) + par_dir[0] * par_pos[1] ) <= fabs( par_dir[0] * half_y ) &&
         fabs( par_dir[2] * ( -half_x - par_pos[0] ) + par_dir[0] * par_pos[2] ) <= fabs( par_dir[0] * half_z ) &&
         check_ray_limits( par_pos[0], par_dir[0], -half_x, nonneg_ray_len, neg_ray_len ) )
         return true;
  
     return false;
 }

References axes, center, moab::check_ray_limits(), inner_radius_squared(), length, outer_radius_squared(), and moab::Matrix3::transpose().

◆ make_hex()

ErrorCode moab::OrientedBox::make_hex	(	EntityHandle &	hex,
		Interface *	instance
	)

Construct a hexahedral element with the same shape as this box.

Definition at line 620 of file OrientedBox.cpp.

 {
     ErrorCode rval;
     int signs[8][3] = { { -1, -1, -1 }, { 1, -1, -1 }, { 1, 1, -1 }, { -1, 1, -1 },
                         { -1, -1, 1 },  { 1, -1, 1 },  { 1, 1, 1 },  { -1, 1, 1 } };
  
     std::vector< EntityHandle > vertices;
     for( int i = 0; i < 8; ++i )
     {
         CartVect coords( center );
         for( int j = 0; j < 3; ++j )
         {
 #if MB_ORIENTED_BOX_UNIT_VECTORS
             coords += signs[i][j] * ( axes.col( j ) * length[j] );
 #else
             coords += signs[i][j] * axes.col( j );
 #endif
         }
         EntityHandle handle;
         rval = instance->create_vertex( coords.array(), handle );
         if( MB_SUCCESS != rval )
         {
             instance->delete_entities( &vertices[0], vertices.size() );
             return rval;
         }
         vertices.push_back( handle );
     }
  
     rval = instance->create_element( MBHEX, &vertices[0], vertices.size(), hex );
     if( MB_SUCCESS != rval )
     {
         instance->delete_entities( &vertices[0], vertices.size() );
         return rval;
     }
  
     return MB_SUCCESS;
 }

References moab::CartVect::array(), axes, center, moab::Matrix3::col(), moab::Interface::create_element(), moab::Interface::create_vertex(), moab::Interface::delete_entities(), ErrorCode, length, MB_SUCCESS, and MBHEX.

◆ order_axes_by_length()

void moab::OrientedBox::order_axes_by_length	(	double	ax1_len,
		double	ax2_len,
		double	ax3_len
	)

private

orders the box axes by the given lengths for each axis

Definition at line 85 of file OrientedBox.cpp.

 {
  
     CartVect len( ax1_len, ax2_len, ax3_len );
  
     if( len[2] < len[1] )
     {
         if( len[2] < len[0] )
         {
             std::swap( len[0], len[2] );
             axes.swapcol( 0, 2 );
         }
     }
     else if( len[1] < len[0] )
     {
         std::swap( len[0], len[1] );
         axes.swapcol( 0, 1 );
     }
     if( len[1] > len[2] )
     {
         std::swap( len[1], len[2] );
         axes.swapcol( 1, 2 );
     }
  
 #if MB_ORIENTED_BOX_UNIT_VECTORS
     length = len;
     if( len[0] > 0.0 ) axes.colscale( 0, 1.0 / len[0] );
     if( len[1] > 0.0 ) axes.colscale( 1, 1.0 / len[1] );
     if( len[2] > 0.0 ) axes.colscale( 2, 1.0 / len[2] );
 #endif
  
 #if MB_ORIENTED_BOX_OUTER_RADIUS
     radius = len.length();
 #endif
 }

References axes, moab::Matrix3::colscale(), moab::CartVect::length(), length, radius, and moab::Matrix3::swapcol().

Referenced by OrientedBox().

◆ outer_radius()

double moab::OrientedBox::outer_radius ( ) const

inline

radius of circumscribed sphere

Definition at line 172 of file OrientedBox.hpp.

 {
 #if MB_ORIENTED_BOX_OUTER_RADIUS
     return radius;
 #elif MB_ORIENTED_BOX_UNIT_VECTORS
     return length.length();
 #else
     return ( axes.col( 0 ) + axes.col( 1 ) + axes.col( 2 ) ).length();
 #endif
 }

References axes, moab::Matrix3::col(), moab::CartVect::length(), length, and radius.

Referenced by moab::TreeNodePrinter::print_geometry(), and moab::OrientedBoxTreeTool::recursive_stats().

◆ outer_radius_squared()

double moab::OrientedBox::outer_radius_squared ( const double reps ) const

inline

square of (radius+at least epsilon) of circumsphere

Definition at line 184 of file OrientedBox.hpp.

 {
 #if MB_ORIENTED_BOX_OUTER_RADIUS
     return ( radius + reps ) * ( radius + reps );
 #elif MB_ORIENTED_BOX_UNIT_VECTORS
     CartVect tmp( length[0] + reps, length[1] + reps, length[2] + reps );
     return tmp % tmp;
 #else
     CartVect half_diag = axes.col( 0 ) + axes.col( 1 ) + axes.col( 2 );
     half_diag += CartVect( reps, reps, reps );
     return half_diag % half_diag;
 #endif
 }

References axes, moab::Matrix3::col(), length, and radius.

Referenced by intersect_ray().

◆ scaled_axis()

CartVect moab::OrientedBox::scaled_axis ( int index ) const

inline

get vector in direction of axis, scaled to its true length

Definition at line 242 of file OrientedBox.hpp.

 {
 #if MB_ORIENTED_BOX_UNIT_VECTORS
     return length[index] * axes.col( index );
 #else
     return axes.col( index );
 #endif
 }

References axes, moab::Matrix3::col(), and length.

Referenced by moab::OrientedBoxTreeTool::box().

◆ tag_handle()

ErrorCode moab::OrientedBox::tag_handle	(	Tag &	handle_out,
		Interface *	instance,
		const char *	name
	)

static

get tag handle for storing oriented box

Get the handle for the tag with the specified name and check that the tag is appropriate for storing instances of OrientedBox. The resulting tag may be used to store instances of OrientedBox directly.

Parameters

handle_out	The TagHandle, passed back to caller
name	The tag name
create	If true, tag will be created if it does not exist

Definition at line 134 of file OrientedBox.cpp.

 {
     // We're going to assume this when mapping the OrientedBox
     // to tag data, so assert it.
 #if MB_ORIENTED_BOX_OUTER_RADIUS
     const int rad_size = 1;
 #else
     const int rad_size = 0;
 #endif
 #if MB_ORIENTED_BOX_UNIT_VECTORS
     const int SIZE = rad_size + 15;
 #else
     const int SIZE     = rad_size + 12;
 #endif
     assert( sizeof( OrientedBox ) == SIZE * sizeof( double ) );
  
     return instance->tag_get_handle( name, SIZE, MB_TYPE_DOUBLE, handle_out, MB_TAG_DENSE | MB_TAG_CREAT );
 }

References MB_TAG_CREAT, MB_TAG_DENSE, MB_TYPE_DOUBLE, and moab::Interface::tag_get_handle().

Referenced by moab::OrientedBoxTreeTool::OrientedBoxTreeTool().

◆ volume()

double moab::OrientedBox::volume ( ) const

inline

volume of box

Definition at line 210 of file OrientedBox.hpp.

 {
 #if MB_ORIENTED_BOX_UNIT_VECTORS
     return 8 * length[0] * length[1] * length[2];
 #else
     return fabs( 8 * axes.col( 0 ) % ( axes.col( 1 ) * axes.col( 2 ) ) );
 #endif
 }

References axes, moab::Matrix3::col(), and length.

Referenced by TriStats::leaf(), moab::OrientedBoxTreeTool::recursive_stats(), and TriStats::TriStats().

Member Data Documentation

◆ axes

Matrix3 moab::OrientedBox::axes

Box axes, unit vectors sorted by extent of box along axis.

Definition at line 49 of file OrientedBox.hpp.

Referenced by area(), axis(), moab::box_from_axes(), closest_location_in_box(), compute_from_covariance_data(), compute_from_vertices(), contained(), dimensions(), inner_radius(), inner_radius_squared(), intersect_ray(), make_hex(), moab::operator<<(), order_axes_by_length(), OrientedBox(), outer_radius(), outer_radius_squared(), scaled_axis(), and volume().

◆ center

CartVect moab::OrientedBox::center

Box center.

Definition at line 48 of file OrientedBox.hpp.

Referenced by moab::OrientedBoxTreeTool::box(), moab::box_from_axes(), closest_location_in_box(), compute_from_covariance_data(), compute_from_vertices(), contained(), intersect_ray(), make_hex(), moab::operator<<(), and moab::TreeNodePrinter::print_geometry().

◆ length

CartVect moab::OrientedBox::length

distance from center to plane along each axis

Definition at line 51 of file OrientedBox.hpp.

Referenced by area(), moab::box_from_axes(), closest_location_in_box(), contained(), covariance_data_from_tris(), dimensions(), inner_radius(), inner_radius_squared(), intersect_ray(), make_hex(), moab::operator<<(), order_axes_by_length(), OrientedBox(), outer_radius(), outer_radius_squared(), scaled_axis(), and volume().

◆ radius

double moab::OrientedBox::radius

outer radius (1/2 diagonal length) of box

Definition at line 54 of file OrientedBox.hpp.

Referenced by moab::box_from_axes(), order_axes_by_length(), outer_radius(), and outer_radius_squared().

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

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ OrientedBox() [1/3]

◆ OrientedBox() [2/3]

◆ OrientedBox() [3/3]

Member Function Documentation

◆ area()

◆ axis()

◆ closest_location_in_box()

◆ compute_from_2d_cells()

◆ compute_from_covariance_data() [1/2]

◆ compute_from_covariance_data() [2/2]

◆ compute_from_vertices()

◆ contained()

◆ covariance_data_from_tris()

◆ dimensions()

◆ inner_radius()

◆ inner_radius_squared()

◆ intersect_ray()

◆ make_hex()

◆ order_axes_by_length()

◆ outer_radius()

◆ outer_radius_squared()

◆ scaled_axis()

◆ tag_handle()

◆ volume()

Member Data Documentation

◆ axes

◆ center

◆ length

◆ radius