stl_file – stl-fortran

type, public :: stl_file

the main class for STL file I/O.

Inherits

Help

Components

Type	Visibility	Attributes		Name		Initial
integer,	private		::	n_plates	=	0	number of plates
integer,	private		::	chunk_size	=	1000	expand `plates` array in chunks of this size
type(plate),	private,	dimension(:), allocatable	::	plates			the array of plates

Type-Bound Procedures

procedure, public :: write_ascii_stl_file

private subroutine write_ascii_stl_file(me, filename, modelname, istat, bounding_box)

Generate an ascii STL file.

Arguments

Type	Intent	Optional		Name
class(stl_file),	intent(in)		::	me
character(len=*),	intent(in)		::	filename	STL file name
character(len=*),	intent(in)		::	modelname	the solid name (should not contain spaces)
integer,	intent(out)		::	istat	`iostat` code (=0 if no errors)
real(kind=wp),	intent(in),	optional	::	bounding_box	scale vertices so that model fits in a box of this size (if <=0, no scaling is done)

procedure, public :: write_binary_stl_file

private subroutine write_binary_stl_file(me, filename, istat, bounding_box)

Generate a binary STL file.

Arguments

Type	Intent	Optional		Name
class(stl_file),	intent(in)		::	me
character(len=*),	intent(in)		::	filename	STL file name
integer,	intent(out)		::	istat	`iostat` code (=0 if no errors)
real(kind=wp),	intent(in),	optional	::	bounding_box	scale vertices so that model fits in a box of this size (if <=0, no scaling is done)

procedure, public :: read => read_binary_stl_file

private subroutine read_binary_stl_file(me, filename, istat)

Read a binary STL file.

Arguments

Type	Intent		Name
class(stl_file),	intent(out)	::	me
character(len=*),	intent(in)	::	filename	STL file name
integer,	intent(out)	::	istat	`iostat` code (=0 if no errors)

procedure, public :: read_tab_file

private subroutine read_tab_file(me, filename, istat)

Read a text vertex-facet file.

Arguments

Type	Intent		Name
class(stl_file),	intent(out)	::	me
character(len=*),	intent(in)	::	filename	Vertex-facet file name
integer,	intent(out)	::	istat	`iostat` code (=0 if no errors)

procedure, public :: destroy => destroy_stl_file

private subroutine destroy_stl_file(me)

Destroy an stl_file.

Arguments

Type	Intent	Optional	Attributes		Name
class(stl_file),	intent(inout)			::	me

procedure, public :: add_plate

private subroutine add_plate(me, v1, v2, v3)

Add a plate to the class.

Arguments

Type	Intent	Attributes		Name
class(stl_file),	intent(inout)		::	me
real(kind=wp),	intent(in),	dimension(3)	::	v1	first vertex
real(kind=wp),	intent(in),	dimension(3)	::	v2	second vertex
real(kind=wp),	intent(in),	dimension(3)	::	v3	third vertex

procedure, public :: add_sphere

private subroutine add_sphere(me, center, radius, num_lat_points, num_lon_points)

Add a sphere to an STL file.

Arguments

Type	Intent	Attributes		Name
class(stl_file),	intent(inout)		::	me
real(kind=wp),	intent(in),	dimension(3)	::	center	coordinates of sphere center [x,y,z]
real(kind=wp),	intent(in)		::	radius	radius of the sphere
integer,	intent(in)		::	num_lat_points	number of latitude points (not counting poles)
integer,	intent(in)		::	num_lon_points	number of longitude points

procedure, public :: add_cylinder

private subroutine add_cylinder(me, v1, v2, radius, num_points, initial_cap, final_cap, initial_normal, final_normal, final_normal_used, initial_vector, final_initial_vector_used)

Add a cylinder to an STL file.

Arguments

Type	Intent	Optional	Attributes		Name
class(stl_file),	intent(inout)			::	me
real(kind=wp),	intent(in),		dimension(3)	::	v1	coordinates of initial point
real(kind=wp),	intent(in),		dimension(3)	::	v2	coordinates of final point
real(kind=wp),	intent(in)			::	radius	radius of the cylinder
integer,	intent(in)			::	num_points	number of point on the circle (>=3)
logical,	intent(in)			::	initial_cap	add a cap plate to the initial point
logical,	intent(in)			::	final_cap	add a cap plate to the final point
real(kind=wp),	intent(in),	optional,	dimension(3)	::	initial_normal	outward normal vector for initial circle
real(kind=wp),	intent(in),	optional,	dimension(3)	::	final_normal	outward normal vector for final circle
real(kind=wp),	intent(out),	optional,	dimension(3)	::	final_normal_used	outward normal vector for final circle actually used
real(kind=wp),	intent(in),	optional,	dimension(3)	::	initial_vector	vector to use to generate the initial circle (x_unit by default)
real(kind=wp),	intent(out),	optional,	dimension(3)	::	final_initial_vector_used	the initial vector used for the final cap to generate the points

procedure, public :: add_curve

private subroutine add_curve(me, x, y, z, radius, num_points, initial_cap, initial_normal, final_cap, final_normal, initial_vector)

Add a curve to an STL file.

Arguments

Type	Intent	Optional	Attributes		Name
class(stl_file),	intent(inout)			::	me
real(kind=wp),	intent(in),		dimension(:)	::	x	x coordinate array
real(kind=wp),	intent(in),		dimension(:)	::	y	y coordinate array
real(kind=wp),	intent(in),		dimension(:)	::	z	z coordinate array
real(kind=wp),	intent(in)			::	radius	radius of the cylinder
integer,	intent(in)			::	num_points	number of point on the cylinder perimeter
logical,	intent(in),	optional		::	initial_cap	add a cap plate to the initial point
real(kind=wp),	intent(in),	optional,	dimension(3)	::	initial_normal	outward normal vector for initial circle
logical,	intent(in),	optional		::	final_cap	add a cap plate to the final point
real(kind=wp),	intent(in),	optional,	dimension(3)	::	final_normal	outward normal vector for final circle
real(kind=wp),	intent(in),	optional,	dimension(3)	::	initial_vector	vector to use to generate the first circle (x_unit by default)

procedure, public :: add_cone

private subroutine add_cone(me, v1, v2, radius, num_points, initial_cap, initial_normal)

Add a cone to an STL file.

Arguments

Type	Intent	Optional	Attributes		Name
class(stl_file),	intent(inout)			::	me
real(kind=wp),	intent(in),		dimension(3)	::	v1	coordinates of initial point (bottom of the cone)
real(kind=wp),	intent(in),		dimension(3)	::	v2	coordinates of final point (point of the cone)
real(kind=wp),	intent(in)			::	radius	radius of the cone (the bottom plate)
integer,	intent(in)			::	num_points	number of point on the circle (>=3)
logical,	intent(in)			::	initial_cap	add a cap plate to the initial point (bottom)
real(kind=wp),	intent(in),	optional,	dimension(3)	::	initial_normal	outward normal vector for initial plate (bottom)

procedure, public :: add_arrow

private subroutine add_arrow(me, origin, v, radius, num_points, arrowhead_radius_factor, arrowhead_length_factor)

Add an arrow to an STL file.

Arguments

Type	Intent	Attributes		Name
class(stl_file),	intent(inout)		::	me
real(kind=wp),	intent(in),	dimension(3)	::	origin	coordinates of the origin of the axes
real(kind=wp),	intent(in),	dimension(3)	::	v	vector
real(kind=wp),	intent(in)		::	radius	radius of the cylinder
integer,	intent(in)		::	num_points	number of point on the circle (>=3)
real(kind=wp),	intent(in)		::	arrowhead_radius_factor	arrowhead cone radius factor (multiple of cylinder radius)
real(kind=wp),	intent(in)		::	arrowhead_length_factor	arrowhead tip length factor (multiple of vector length)

procedure, public :: add_axes

private subroutine add_axes(me, origin, vx, vy, vz, radius, num_points, arrowhead_radius_factor, arrowhead_length_factor)

Add x,y,z axes to an STL file.

Arguments

Type	Intent	Attributes		Name
class(stl_file),	intent(inout)		::	me
real(kind=wp),	intent(in),	dimension(3)	::	origin	coordinates of the origin of the axes
real(kind=wp),	intent(in),	dimension(3)	::	vx	x axis vector
real(kind=wp),	intent(in),	dimension(3)	::	vy	y axis vector
real(kind=wp),	intent(in),	dimension(3)	::	vz	z axis vector
real(kind=wp),	intent(in)		::	radius	radius of the cylinder
integer,	intent(in)		::	num_points	number of point on the circle (>=3)
real(kind=wp),	intent(in)		::	arrowhead_radius_factor	arrowhead cone radius factor (multiple of cylinder radius)
real(kind=wp),	intent(in)		::	arrowhead_length_factor	arrowhead tip length factor (multiple of vector length)

procedure, public :: shift_mesh

private subroutine shift_mesh(me)

Shift the vertex coordinates so that there are no non-positive components.

Arguments

Type	Intent	Optional	Attributes		Name
class(stl_file),	intent(inout)			::	me

procedure, public :: set_chunk_size

private subroutine set_chunk_size(me, chunk_size)

Set the chunk size in the class.

Arguments

Type	Intent	Optional	Attributes		Name
class(stl_file),	intent(inout)			::	me
integer,	intent(in)			::	chunk_size	must be >0

procedure, private :: generate_circle

private subroutine generate_circle(me, c, radius, n, nc, add_circle, circle, initial_vector, cw)

Generate the points in a circle, and optionally add it as a plate.

Arguments

Type	Intent	Optional	Attributes		Name
class(stl_file),	intent(inout)			::	me
real(kind=wp),	intent(in),		dimension(3)	::	c	center of the circle
real(kind=wp),	intent(in)			::	radius	radius of the cylinder
real(kind=wp),	intent(in),		dimension(3)	::	n	normal vector to the circle
integer,	intent(in)			::	nc	number of points on the circle (must be at least 3)
logical,	intent(in)			::	add_circle	to also add to the circle as a plate
real(kind=wp),	intent(out),		dimension(:,:), allocatable	::	circle	points on the circle
real(kind=wp),	intent(in),	optional,	dimension(3)	::	initial_vector	vector to use to generate the initial circle (x_unit by default)
logical,	intent(in),	optional		::	cw	generate the points in the clockwise direction abound n (default is false)

procedure, private :: compute_vertex_scale

private pure function compute_vertex_scale(me, bounding_box) result(scale)

Compute the scale factor for the vertices (for writing to a file).

Arguments

Type	Intent	Optional	Attributes		Name
class(stl_file),	intent(in)			::	me
real(kind=wp),	intent(in),	optional		::	bounding_box	scale vertices so that model fits in a box of this size (if <=0, no scaling is done)

Return Value real(kind=wp)

scale factor

Source Code

    type,public :: stl_file
        !! the main class for STL file I/O.
        private
        integer :: n_plates = 0       !! number of plates
        integer :: chunk_size = 1000  !! expand `plates` array in chunks of this size
        type(plate),dimension(:),allocatable :: plates !! the array of plates
        contains
        private
        procedure,public :: write_ascii_stl_file
        procedure,public :: write_binary_stl_file
        procedure,public :: read => read_binary_stl_file
        procedure,public :: read_tab_file
        procedure,public :: destroy => destroy_stl_file
        procedure,public :: add_plate
        procedure,public :: add_sphere
        procedure,public :: add_cylinder
        procedure,public :: add_curve
        procedure,public :: add_cone
        procedure,public :: add_arrow
        procedure,public :: add_axes
        procedure,public :: shift_mesh
        procedure,public :: set_chunk_size
        procedure :: generate_circle
        procedure :: compute_vertex_scale
    end type stl_file

stl_file Derived Type

Contents

Variables

Type-Bound Procedures

Source Code

type, public :: stl_file

Inherits

Components

Type-Bound Procedures

procedure, public :: write_ascii_stl_file

private subroutine write_ascii_stl_file(me, filename, modelname, istat, bounding_box)

Arguments

procedure, public :: write_binary_stl_file

private subroutine write_binary_stl_file(me, filename, istat, bounding_box)

Arguments

procedure, public :: read => read_binary_stl_file

private subroutine read_binary_stl_file(me, filename, istat)

Arguments

procedure, public :: read_tab_file

private subroutine read_tab_file(me, filename, istat)

Arguments

procedure, public :: destroy => destroy_stl_file

private subroutine destroy_stl_file(me)

Arguments

procedure, public :: add_plate

private subroutine add_plate(me, v1, v2, v3)

Arguments

procedure, public :: add_sphere

private subroutine add_sphere(me, center, radius, num_lat_points, num_lon_points)

Arguments

procedure, public :: add_cylinder

private subroutine add_cylinder(me, v1, v2, radius, num_points, initial_cap, final_cap, initial_normal, final_normal, final_normal_used, initial_vector, final_initial_vector_used)

Arguments

procedure, public :: add_curve

private subroutine add_curve(me, x, y, z, radius, num_points, initial_cap, initial_normal, final_cap, final_normal, initial_vector)

Arguments

procedure, public :: add_cone

private subroutine add_cone(me, v1, v2, radius, num_points, initial_cap, initial_normal)

Arguments

procedure, public :: add_arrow

private subroutine add_arrow(me, origin, v, radius, num_points, arrowhead_radius_factor, arrowhead_length_factor)

Arguments

procedure, public :: add_axes

private subroutine add_axes(me, origin, vx, vy, vz, radius, num_points, arrowhead_radius_factor, arrowhead_length_factor)

Arguments

procedure, public :: shift_mesh

private subroutine shift_mesh(me)

Arguments

procedure, public :: set_chunk_size

private subroutine set_chunk_size(me, chunk_size)

Arguments

procedure, private :: generate_circle

private subroutine generate_circle(me, c, radius, n, nc, add_circle, circle, initial_vector, cw)

Arguments

procedure, private :: compute_vertex_scale

private pure function compute_vertex_scale(me, bounding_box) result(scale)

Arguments

Return Value real(kind=wp)

Source Code