aabb_object – FOSSIL

type, public :: aabb_object

FOSSIL Axis-Aligned Bounding Box (AABB) class.

Inherited By

Components

Type	Visibility	Attributes		Name		Initial
type(vector_R8P),	public		::	bmin			Minimum point of AABB.
type(vector_R8P),	public		::	bmax			Maximum point of AABB.
integer(kind=I4P),	public		::	facets_number	=	0	Facets number.
type(facet_object),	public,	allocatable	::	facet(:)			Facets.

Type-Bound Procedures

procedure, public, pass(self) :: add_facets

Add facets to AABB.

private subroutine add_facets(self, facet)

Add facets to AABB.

Arguments

Type	Intent	Optional	Attributes		Name
class(aabb_object),	intent(inout)			::	self	AABB.
type(facet_object),	intent(inout),		allocatable	::	facet(:)	Facets list.

procedure, public, pass(self) :: closest_point

Return closest point on AABB from point reference.

private pure function closest_point(self, point) result(closest)

Return closest point on (or in) AABB from point reference.

Arguments

Type	Intent	Optional	Attributes		Name
class(aabb_object),	intent(in)			::	self	AABB.
type(vector_R8P),	intent(in)			::	point	Point reference.

Return Value type(vector_R8P)

Closest point on (on in) aabb to point.

procedure, public, pass(self) :: compute_octants

Compute AABB octants.

private pure subroutine compute_octants(self, octant)

Return AABB octants.

Arguments

Type	Intent	Optional	Attributes		Name
class(aabb_object),	intent(in)			::	self	AABB.
type(aabb_object),	intent(out)			::	octant(8)	AABB octants.

procedure, public, pass(self) :: destroy

Destroy AABB.

private elemental subroutine destroy(self)

Destroy AABB.

Arguments

Type Intent Optional Attributes Name

class(aabb_object), intent(inout) :: self
AABB.

procedure, public, pass(self) :: distance

Return the (square) distance from point to AABB.

private pure function distance(self, point)

Return the (square) distance from point to AABB.

Arguments

Type	Intent	Optional	Attributes		Name
class(aabb_object),	intent(in)			::	self	AABB.
type(vector_R8P),	intent(in)			::	point	Point reference.

Return Value real(kind=R8P)

Distance from point to AABB.

procedure, public, pass(self) :: distance_from_facets

Return the (square) distance from point to AABB's facets.

private pure function distance_from_facets(self, point) result(distance)

Return the (square) distance from point to AABB's facets.

Arguments

Type	Intent	Optional	Attributes		Name
class(aabb_object),	intent(in)			::	self	AABB.
type(vector_R8P),	intent(in)			::	point	Point reference.

Return Value real(kind=R8P)

Distance from point to AABB's facets.

procedure, public, pass(self) :: do_ray_intersect

Return true if AABB is intersected by ray.

private pure function do_ray_intersect(self, ray_origin, ray_direction) result(do_intersect)

Return true if AABB is intersected by ray from origin and oriented as ray direction vector.

Arguments

Type	Intent		Name
class(aabb_object),	intent(in)	::	self	AABB box.
type(vector_R8P),	intent(in)	::	ray_origin	Ray origin.
type(vector_R8P),	intent(in)	::	ray_direction	Ray direction.

Return Value logical

Test result.

procedure, public, pass(self) :: has_facets

Return true if AABB has facets.

private pure function has_facets(self)

Return true if AABB has facets.

Arguments

Type Intent Optional Attributes Name

class(aabb_object), intent(in) :: self
AABB box.

Return Value logical

Check result.

procedure, public, pass(self) :: initialize

Initialize AABB.

private pure subroutine initialize(self, facet, bmin, bmax)

Initialize AABB.

Arguments

Type	Intent	Optional		Name
class(aabb_object),	intent(inout)		::	self	AABB.
type(facet_object),	intent(in),	optional	::	facet(:)	Facets list.
type(vector_R8P),	intent(in),	optional	::	bmin	Minimum point of AABB.
type(vector_R8P),	intent(in),	optional	::	bmax	Maximum point of AABB.

procedure, public, pass(self) :: is_inside

Return the true if point is inside ABB.

private pure function is_inside(self, point)

Return the true if point is inside ABB.

Arguments

Type	Intent	Optional	Attributes		Name
class(aabb_object),	intent(in)			::	self	AABB.
type(vector_R8P),	intent(in)			::	point	Point reference.

Return Value logical

Check result.

procedure, public, pass(self) :: ray_intersections_number

Return ray intersections number.

private pure function ray_intersections_number(self, ray_origin, ray_direction) result(intersections_number)

Return ray intersections number.

Arguments

Type	Intent		Name
class(aabb_object),	intent(in)	::	self	AABB.
type(vector_R8P),	intent(in)	::	ray_origin	Ray origin.
type(vector_R8P),	intent(in)	::	ray_direction	Ray direction.

Return Value integer(kind=I4P)

Intersection number.

procedure, public, pass(self) :: save_geometry_tecplot_ascii

Save AABB geometry into Tecplot ascii file.

private subroutine save_geometry_tecplot_ascii(self, file_unit, aabb_name)

Save AABB geometry into Tecplot ascii file.

Arguments

Type	Intent	Optional		Name
class(aabb_object),	intent(in)		::	self	AABB.
integer(kind=I4P),	intent(in)		::	file_unit	File unit.
character(len=*),	intent(in),	optional	::	aabb_name	Name of AABB.

procedure, public, pass(self) :: save_facets_into_file_stl

Save facets into file STL.

private subroutine save_facets_into_file_stl(self, file_name, is_ascii)

Save facets into file STL.

Arguments

Type	Intent		Name
class(aabb_object),	intent(in)	::	self	AABB.
character(len=*),	intent(in)	::	file_name	File name.
logical,	intent(in)	::	is_ascii	Sentinel to check if file is ASCII.

procedure, public, pass(self) :: update_extents

Update AABB bounding box extents.

private pure subroutine update_extents(self)

Update AABB bounding box extents.

Arguments

Type Intent Optional Attributes Name

class(aabb_object), intent(inout) :: self
AABB.

procedure, public, pass(self) :: vertex

Return AABB vertices.

private pure function vertex(self)

Return AABB vertices.

Arguments

Type Intent Optional Attributes Name

class(aabb_object), intent(in) :: self
AABB.

Return Value type(vector_R8P) (8)

AABB vertices.

generic, public :: assignment(=) => aabb_assign_aabb

Overload =.

private pure subroutine aabb_assign_aabb(lhs, rhs)

Operator =.

Arguments

Type	Intent	Optional	Attributes		Name
class(aabb_object),	intent(inout)			::	lhs	Left hand side.
type(aabb_object),	intent(in)			::	rhs	Right hand side.

procedure, private, pass(lhs) :: aabb_assign_aabb

Operator =.

private pure subroutine aabb_assign_aabb(lhs, rhs)

Operator =.

Arguments

Type	Intent	Optional	Attributes		Name
class(aabb_object),	intent(inout)			::	lhs	Left hand side.
type(aabb_object),	intent(in)			::	rhs	Right hand side.

Source Code

type :: aabb_object
   !< FOSSIL Axis-Aligned Bounding Box (AABB) class.
   type(vector_R8P)                :: bmin            !< Minimum point of AABB.
   type(vector_R8P)                :: bmax            !< Maximum point of AABB.
   integer(I4P)                    :: facets_number=0 !< Facets number.
   type(facet_object), allocatable :: facet(:)        !< Facets.
   contains
      ! public methods
      procedure, pass(self) :: add_facets                  !< Add facets to AABB.
      procedure, pass(self) :: closest_point               !< Return closest point on AABB from point reference.
      procedure, pass(self) :: compute_octants             !< Compute AABB octants.
      procedure, pass(self) :: destroy                     !< Destroy AABB.
      procedure, pass(self) :: distance                    !< Return the (square) distance from point to AABB.
      procedure, pass(self) :: distance_from_facets        !< Return the (square) distance from point to AABB's facets.
      procedure, pass(self) :: do_ray_intersect            !< Return true if AABB is intersected by ray.
      procedure, pass(self) :: has_facets                  !< Return true if AABB has facets.
      procedure, pass(self) :: initialize                  !< Initialize AABB.
      procedure, pass(self) :: is_inside                   !< Return the true if point is inside ABB.
      procedure, pass(self) :: ray_intersections_number    !< Return ray intersections number.
      procedure, pass(self) :: save_geometry_tecplot_ascii !< Save AABB geometry into Tecplot ascii file.
      procedure, pass(self) :: save_facets_into_file_stl   !< Save facets into file STL.
      procedure, pass(self) :: update_extents              !< Update AABB bounding box extents.
      procedure, pass(self) :: vertex                      !< Return AABB vertices.
      ! operators
      generic :: assignment(=) => aabb_assign_aabb      !< Overload `=`.
      procedure, pass(lhs), private :: aabb_assign_aabb !< Operator `=`.
endtype aabb_object

aabb_object Derived Type

Variables

Type-Bound Procedures

Source Code

All Derived Types

type, public :: aabb_object

Inherited By

Variables

Type-Bound Procedures

Source Code

Components

Type-Bound Procedures

procedure, public, pass(self) :: add_facets

private subroutine add_facets(self, facet)

Arguments

procedure, public, pass(self) :: closest_point

private pure function closest_point(self, point) result(closest)

Arguments

Return Value type(vector_R8P)

procedure, public, pass(self) :: compute_octants

private pure subroutine compute_octants(self, octant)

Arguments

procedure, public, pass(self) :: destroy

private elemental subroutine destroy(self)

Arguments

procedure, public, pass(self) :: distance

private pure function distance(self, point)

Arguments

Return Value real(kind=R8P)

procedure, public, pass(self) :: distance_from_facets

private pure function distance_from_facets(self, point) result(distance)

Arguments

Return Value real(kind=R8P)

procedure, public, pass(self) :: do_ray_intersect

private pure function do_ray_intersect(self, ray_origin, ray_direction) result(do_intersect)

Arguments

Return Value logical

procedure, public, pass(self) :: has_facets

private pure function has_facets(self)

Arguments

Return Value logical

procedure, public, pass(self) :: initialize

private pure subroutine initialize(self, facet, bmin, bmax)

Arguments

procedure, public, pass(self) :: is_inside

private pure function is_inside(self, point)

Arguments

Return Value logical

procedure, public, pass(self) :: ray_intersections_number

private pure function ray_intersections_number(self, ray_origin, ray_direction) result(intersections_number)

Arguments

Return Value integer(kind=I4P)

procedure, public, pass(self) :: save_geometry_tecplot_ascii

private subroutine save_geometry_tecplot_ascii(self, file_unit, aabb_name)

Arguments

procedure, public, pass(self) :: save_facets_into_file_stl

private subroutine save_facets_into_file_stl(self, file_name, is_ascii)

Arguments

procedure, public, pass(self) :: update_extents

private pure subroutine update_extents(self)

Arguments

procedure, public, pass(self) :: vertex

private pure function vertex(self)

Arguments

Return Value type(vector_R8P) (8)

generic, public :: assignment(=) => aabb_assign_aabb

private pure subroutine aabb_assign_aabb(lhs, rhs)

Arguments

procedure, private, pass(lhs) :: aabb_assign_aabb

private pure subroutine aabb_assign_aabb(lhs, rhs)

Arguments

Source Code

All Derived Types