Defines an arrow to be used on by a plot object. More...

Inheritance diagram for fplot_core::plot_arrow:

Public Member Functions
procedure, public	get_is_visible par_get_is_visible
	Gets a value determining if the arrow is visible.

procedure, public	set_is_visible par_set_is_visible
	Sets a value determining if the arrow is visible.

procedure, public	get_tail_location par_get_tail
	Gets the coordinates of the arrow's tail.

generic, public	set_tail_location par_set_tail_1
	Sets the location of the arrow's tail.

generic, public	set_tail_location par_set_tail_2
	Sets the location of the arrow's tail.

generic, public	set_tail_location par_set_tail_3
	Sets the location of the arrow's tail.

procedure, public	get_head_location par_get_head
	Gets the coordinates of the arrow's head.

generic, public	set_head_location par_set_head_1
	Sets the location of the arrow's head.

generic, public	set_head_location par_set_head_2
	Sets the location of the arrow's head.

generic, public	set_head_location par_set_head_3
	Sets the location of the arrow's head.

procedure, public	get_color par_get_color
	Gets the color of the arrow.

procedure, public	set_color par_set_color
	Sets the color of the arrow.

procedure, public	get_line_style par_get_line_style
	Gets the line style used to draw the arrow.

procedure, public	set_line_style par_set_line_style
	Sets the line style used to draw the arrow.

procedure, public	get_line_width par_get_line_width
	Gets the width of the lines used to draw the arrow.

procedure, public	set_line_width par_set_line_width
	Sets the width of the lines used to draw the arrow.

procedure, public	get_head_type par_get_head_type
	Gets the type of arrow head.

procedure, public	set_head_type par_set_head_type
	Sets the type of arrow head.

procedure, public	get_head_fill par_get_fill
	Gets a flag denoting the head fill type.

procedure, public	set_head_fill par_set_fill
	Sets a flag denoting the head fill type.

procedure, public	get_move_to_front par_get_move_to_front
	Gets a value determining if the arrow should be moved to the front.

procedure, public	set_move_to_front par_set_move_to_front
	Sets a value determining if the arrow should be moved to the front.

procedure, public	get_head_size par_get_head_size
	Gets the size of the arrow head.

procedure, public	set_head_size par_set_head_size
	Sets the size of the arrow head.

procedure, public	get_head_angle par_get_head_angle
	Gets the angle of the arrow head.

procedure, public	set_head_angle par_set_head_angle
	Sets the angle of the arrow head.

procedure, public	get_head_back_angle par_get_head_back_angle
	Gets the angle of the back of the arrow head.

procedure, public	set_head_back_angle par_set_head_back_angle
	Sets the angle of the back of the arrow head.

procedure, public	get_use_default_size par_get_use_default_size
	Gets a value determining if arrow head sizing defaults should be used.

procedure, public	set_use_default_size par_set_use_default_size
	Sets a value determining if arrow head sizing defaults should be used.

procedure, public	get_command_string par_get_cmd
	Returns the appropriate GNUPLOT command string to establish appropriate parameters.

Public Attributes
real(real32), dimension(3)	m_tail = [0.0, 0.0, 0.0]

real(real32), dimension(3)	m_head = [0.0, 0.0, 0.0]

type(color)	m_color = CLR_BLACK

integer(int32)	m_linestyle = LINE_SOLID

real(real32)	m_linewidth = 1.0

integer(int32)	m_head_type = ARROW_HEAD

integer(int32)	m_filling = ARROW_FILLED

logical	m_front = .true.

real(real32)	m_size = 0.375

real(real32)	m_angle = 10.0

real(real32)	m_backangle = 90.0

logical	m_use_default_size = .true.

Private Member Functions
procedure, private	par_set_tail_1 par_set_tail_1

procedure, private	par_set_tail_2 par_set_tail_2

procedure, private	par_set_tail_3 par_set_tail_3

procedure, private	par_set_head_1 par_set_head_1

procedure, private	par_set_head_2 par_set_head_2

procedure, private	par_set_head_3 par_set_head_3

Private Attributes
logical, private	m_visible = .true.

Detailed Description

Defines an arrow to be used on by a plot object.

Definition at line 648 of file fplot_core.f90.

Member Function/Subroutine Documentation

◆ get_color()

procedure, public fplot_core::plot_arrow::get_color

Gets the color of the arrow.

Syntax: pure type(color) function get_color(class(arrow) this)

Parameters

[in] this The plot_arrow object.

Returns: The color.

Definition at line 795 of file fplot_core.f90.

◆ get_command_string()

procedure, public fplot_core::plot_arrow::get_command_string

virtual

Returns the appropriate GNUPLOT command string to establish appropriate parameters.

Syntax: character(len = :) function, allocatable get_command_string(class(plot_arrow) this)

Parameters

[in] this The plot_arrow object.

Returns: The GNUPLOT command string.

Implements fplot_core::plot_object.

Definition at line 1026 of file fplot_core.f90.

◆ get_head_angle()

procedure, public fplot_core::plot_arrow::get_head_angle

Gets the angle of the arrow head.

Syntax: pure real(real32) function get_head_angle(class(plot_arrow) this)

Parameters

[in] this The plot_arrow object.

Returns: The angle, in degrees.

Definition at line 963 of file fplot_core.f90.

◆ get_head_back_angle()

procedure, public fplot_core::plot_arrow::get_head_back_angle

Gets the angle of the back of the arrow head.

Syntax: pure real(real32) function get_head_back_angle(class(plot_arrow) this)

Parameters

[in] this The plot_arrow object.

Returns: The angle, in degrees.

Definition at line 983 of file fplot_core.f90.

◆ get_head_fill()

procedure, public fplot_core::plot_arrow::get_head_fill

Gets a flag denoting the head fill type.

Syntax: pure integer(int32) function get_head_fill(class(plot_arrow) this)

Parameters

[in] this The plot_arrow object.

Returns

The flag denoting head fill. It will be one of the following constants.

ARROW_FILLED
ARROW_EMPTY
ARROW_NO_BORDER
ARROW_NO_FILL

Definition at line 895 of file fplot_core.f90.

◆ get_head_location()

procedure, public fplot_core::plot_arrow::get_head_location

Gets the coordinates of the arrow's head.

Syntax: pure real(real32)(3) function get_head_location(class(plot_arrow) this)

Parameters

[in] this The plot_arrow object.

Returns: A 3-element array containing the x, y, and z coordinates of the arrow's head.

Definition at line 751 of file fplot_core.f90.

◆ get_head_size()

procedure, public fplot_core::plot_arrow::get_head_size

Gets the size of the arrow head.

Syntax: pure real(real32) function get_head_size(class(plot_arrow) this)

Parameters

[in] this The plot_arrow object.

Returns: The head size.

Definition at line 943 of file fplot_core.f90.

◆ get_head_type()

procedure, public fplot_core::plot_arrow::get_head_type

Gets the type of arrow head.

Syntax: pure integer(int32) function get_head_type(class(plot_arrow) this)

Parameters

[in] this The plot_arrow object.

Returns

The arrow head type. It is one of the following constants.

ARROW_HEAD
ARROW_BACKHEAD
ARROW_HEADS
ARROW_NO_HEAD

Definition at line 865 of file fplot_core.f90.

◆ get_is_visible()

procedure, public fplot_core::plot_arrow::get_is_visible

Gets a value determining if the arrow is visible.

Syntax: pure logical function get_is_visible(class(plot_arrow) this)

Parameters

[in] this The plot_arrow object.

Returns: True if the arrow is visible; else, false.

Definition at line 685 of file fplot_core.f90.

◆ get_line_style()

procedure, public fplot_core::plot_arrow::get_line_style

Gets the line style used to draw the arrow.

Syntax: pure integer(int32) function get_line_style(class(plot_arrow) this)

Parameters

[in] this The plot_arrow object.

Returns: The line style.

Definition at line 815 of file fplot_core.f90.

◆ get_line_width()

procedure, public fplot_core::plot_arrow::get_line_width

Gets the width of the lines used to draw the arrow.

Syntax: pure real(real32) function get_line_width(class(plot_arrow) this)

Parameters

[in] this The plot_arrow object.

Returns: The width of the line.

Definition at line 841 of file fplot_core.f90.

◆ get_move_to_front()

procedure, public fplot_core::plot_arrow::get_move_to_front

Gets a value determining if the arrow should be moved to the front.

Syntax: pure logical function get_move_to_front(class(plot_arrow) this)

Parameters

[in] this The plot_arrow object.

Returns: True if the arrow should be moved to the front; else, false.

Definition at line 921 of file fplot_core.f90.

◆ get_tail_location()

procedure, public fplot_core::plot_arrow::get_tail_location

Gets the coordinates of the arrow's tail.

Syntax: pure real(real32)(3) function get_tail_location(class(plot_arrow) this)

Parameters

[in] this The plot_arrow object.

Returns: A 3-element array containing the x, y, and z coordinates of the arrow's tail.

Definition at line 706 of file fplot_core.f90.

◆ get_use_default_size()

procedure, public fplot_core::plot_arrow::get_use_default_size

Gets a value determining if arrow head sizing defaults should be used.

Syntax: pure logical function get_use_default_size(class(plot_arrow) this)

Parameters

[in] this The plot_arrow object.

Returns: True if the defaults should be used; else, false.

Definition at line 1004 of file fplot_core.f90.

◆ par_set_head_1()

procedure, private fplot_core::plot_arrow::par_set_head_1

private

Definition at line 783 of file fplot_core.f90.

◆ par_set_head_2()

procedure, private fplot_core::plot_arrow::par_set_head_2

private

Definition at line 784 of file fplot_core.f90.

◆ par_set_head_3()

procedure, private fplot_core::plot_arrow::par_set_head_3

private

Definition at line 785 of file fplot_core.f90.

◆ par_set_tail_1()

procedure, private fplot_core::plot_arrow::par_set_tail_1

private

Definition at line 738 of file fplot_core.f90.

◆ par_set_tail_2()

procedure, private fplot_core::plot_arrow::par_set_tail_2

private

Definition at line 739 of file fplot_core.f90.

◆ par_set_tail_3()

procedure, private fplot_core::plot_arrow::par_set_tail_3

private

Definition at line 740 of file fplot_core.f90.

◆ set_color()

procedure, public fplot_core::plot_arrow::set_color

Sets the color of the arrow.

Syntax: subroutine set_color(class(arrow) this, type(color) x)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The color.

Definition at line 805 of file fplot_core.f90.

◆ set_head_angle()

procedure, public fplot_core::plot_arrow::set_head_angle

Sets the angle of the arrow head.

Syntax: subroutine set_head_angle(class(plot_arrow) this, real(real32) x)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The angle, in degrees.

Definition at line 973 of file fplot_core.f90.

◆ set_head_back_angle()

procedure, public fplot_core::plot_arrow::set_head_back_angle

Sets the angle of the back of the arrow head.

Syntax: subroutine set_head_back_angle(class(plot_arrow) this, real(real32) x)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The angle, in degrees.

Definition at line 993 of file fplot_core.f90.

◆ set_head_fill()

procedure, public fplot_core::plot_arrow::set_head_fill

Sets a flag denoting the head fill type.

Syntax: subroutine set_head_fill(class(plot_arrow) this, integer(int32) x)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The flag denoting head fill. It must be one of the following constants. ARROW_FILLED ARROW_EMPTY ARROW_NO_BORDER ARROW_NO_FILL

Definition at line 910 of file fplot_core.f90.

◆ set_head_location() [1/3]

generic, public fplot_core::plot_arrow::set_head_location

Sets the location of the arrow's head.

Syntax 1: subroutine set_head_location(class(plot_arrow) this, real(real32) x(3))

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	A 3-element array containing the x, y, and z coordiantes of the arrow's head.

Syntax 2: subroutine set_head_location(class(plot_arrow) this, real(real32) x, real(real32) y)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The x-coordinate of the arrow's head.
[in]	y	The y-coordinate of the arrow's head.

Syntax 3: subroutine set_head_location(class(plot_arrow) this, real(real32) x, real(real32) y, real(real32) z)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The x-coordinate of the arrow's head.
[in]	y	The y-coordinate of the arrow's head.
[in]	z	The z-coordinate of the arrow's head.

Definition at line 781 of file fplot_core.f90.

◆ set_head_location() [2/3]

generic, public fplot_core::plot_arrow::set_head_location

Sets the location of the arrow's head.

Syntax 1: subroutine set_head_location(class(plot_arrow) this, real(real32) x(3))

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	A 3-element array containing the x, y, and z coordiantes of the arrow's head.

Syntax 2: subroutine set_head_location(class(plot_arrow) this, real(real32) x, real(real32) y)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The x-coordinate of the arrow's head.
[in]	y	The y-coordinate of the arrow's head.

Syntax 3: subroutine set_head_location(class(plot_arrow) this, real(real32) x, real(real32) y, real(real32) z)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The x-coordinate of the arrow's head.
[in]	y	The y-coordinate of the arrow's head.
[in]	z	The z-coordinate of the arrow's head.

Definition at line 781 of file fplot_core.f90.

◆ set_head_location() [3/3]

generic, public fplot_core::plot_arrow::set_head_location

Sets the location of the arrow's head.

Syntax 1: subroutine set_head_location(class(plot_arrow) this, real(real32) x(3))

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	A 3-element array containing the x, y, and z coordiantes of the arrow's head.

Syntax 2: subroutine set_head_location(class(plot_arrow) this, real(real32) x, real(real32) y)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The x-coordinate of the arrow's head.
[in]	y	The y-coordinate of the arrow's head.

Syntax 3: subroutine set_head_location(class(plot_arrow) this, real(real32) x, real(real32) y, real(real32) z)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The x-coordinate of the arrow's head.
[in]	y	The y-coordinate of the arrow's head.
[in]	z	The z-coordinate of the arrow's head.

Definition at line 781 of file fplot_core.f90.

◆ set_head_size()

procedure, public fplot_core::plot_arrow::set_head_size

Sets the size of the arrow head.

Syntax: subroutine set_head_size(class(plot_arrow) this, real(real32) x)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The head size.

Definition at line 953 of file fplot_core.f90.

◆ set_head_type()

procedure, public fplot_core::plot_arrow::set_head_type

Sets the type of arrow head.

Syntax: subroutine set_head_type(class(plot_arrow) this, integer(int32) x)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The arrow head type. It must be one of the following constants. ARROW_HEAD ARROW_BACKHEAD ARROW_HEADS ARROW_NO_HEAD

Definition at line 880 of file fplot_core.f90.

◆ set_is_visible()

procedure, public fplot_core::plot_arrow::set_is_visible

Sets a value determining if the arrow is visible.

Syntax: subroutine set_is_visible(class(plot_arrow) this, logical x)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	True if the arrow is visible; else, false.

Definition at line 695 of file fplot_core.f90.

◆ set_line_style()

procedure, public fplot_core::plot_arrow::set_line_style

Sets the line style used to draw the arrow.

Syntax: subroutine set_line_style(class(plot_arrow) this, integer(int32) x)

Parameters

[in,out]	this	The plot_arrow object.
	The	line style. The value must be one of the following. LINE_SOLID LINE_DASHED LINE_DASH_DOTTED LINE_DASH_DOT_DOT LINE_DOTTED If the value is not one of the above, the command is ignored.

Definition at line 831 of file fplot_core.f90.

◆ set_line_width()

procedure, public fplot_core::plot_arrow::set_line_width

Sets the width of the lines used to draw the arrow.

Syntax: subroutine set_line_width(class(plot_arrow) this, real(real32) x)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The width of the line.

Definition at line 851 of file fplot_core.f90.

◆ set_move_to_front()

procedure, public fplot_core::plot_arrow::set_move_to_front

Sets a value determining if the arrow should be moved to the front.

Syntax: subroutine set_move_to_front(class(plot_arrow) this, logical x)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	True if the arrow should be moved to the front; else, false.

Definition at line 933 of file fplot_core.f90.

◆ set_tail_location() [1/3]

generic, public fplot_core::plot_arrow::set_tail_location

Sets the location of the arrow's tail.

Syntax 1: subroutine set_tail_location(class(plot_arrow) this, real(real32) x(3))

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	A 3-element array containing the x, y, and z coordiantes of the arrow's tail.

Syntax 2: subroutine set_tail_location(class(plot_arrow) this, real(real32) x, real(real32) y)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The x-coordinate of the arrow's tail.
[in]	y	The y-coordinate of the arrow's tail.

Syntax 3: subroutine set_tail_location(class(plot_arrow) this, real(real32) x, real(real32) y, real(real32) z)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The x-coordinate of the arrow's tail.
[in]	y	The y-coordinate of the arrow's tail.
[in]	z	The z-coordinate of the arrow's tail.

Definition at line 736 of file fplot_core.f90.

◆ set_tail_location() [2/3]

generic, public fplot_core::plot_arrow::set_tail_location

Sets the location of the arrow's tail.

Syntax 1: subroutine set_tail_location(class(plot_arrow) this, real(real32) x(3))

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	A 3-element array containing the x, y, and z coordiantes of the arrow's tail.

Syntax 2: subroutine set_tail_location(class(plot_arrow) this, real(real32) x, real(real32) y)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The x-coordinate of the arrow's tail.
[in]	y	The y-coordinate of the arrow's tail.

Syntax 3: subroutine set_tail_location(class(plot_arrow) this, real(real32) x, real(real32) y, real(real32) z)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The x-coordinate of the arrow's tail.
[in]	y	The y-coordinate of the arrow's tail.
[in]	z	The z-coordinate of the arrow's tail.

Definition at line 736 of file fplot_core.f90.

◆ set_tail_location() [3/3]

generic, public fplot_core::plot_arrow::set_tail_location

Sets the location of the arrow's tail.

Syntax 1: subroutine set_tail_location(class(plot_arrow) this, real(real32) x(3))

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	A 3-element array containing the x, y, and z coordiantes of the arrow's tail.

Syntax 2: subroutine set_tail_location(class(plot_arrow) this, real(real32) x, real(real32) y)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The x-coordinate of the arrow's tail.
[in]	y	The y-coordinate of the arrow's tail.

Syntax 3: subroutine set_tail_location(class(plot_arrow) this, real(real32) x, real(real32) y, real(real32) z)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	The x-coordinate of the arrow's tail.
[in]	y	The y-coordinate of the arrow's tail.
[in]	z	The z-coordinate of the arrow's tail.

Definition at line 736 of file fplot_core.f90.

◆ set_use_default_size()

procedure, public fplot_core::plot_arrow::set_use_default_size

Sets a value determining if arrow head sizing defaults should be used.

Syntax: subroutine set_use_default_size(class(plot_arrow) this, logical x)

Parameters

[in,out]	this	The plot_arrow object.
[in]	x	True if the defaults should be used; else, false.

Definition at line 1015 of file fplot_core.f90.

Member Data Documentation

◆ m_angle

real(real32) fplot_core::plot_arrow::m_angle = 10.0

Definition at line 670 of file fplot_core.f90.

◆ m_backangle

real(real32) fplot_core::plot_arrow::m_backangle = 90.0

Definition at line 672 of file fplot_core.f90.

◆ m_color

type(color) fplot_core::plot_arrow::m_color = CLR_BLACK

Definition at line 656 of file fplot_core.f90.

◆ m_filling

integer(int32) fplot_core::plot_arrow::m_filling = ARROW_FILLED

Definition at line 664 of file fplot_core.f90.

◆ m_front

logical fplot_core::plot_arrow::m_front = .true.

Definition at line 666 of file fplot_core.f90.

◆ m_head

real(real32), dimension(3) fplot_core::plot_arrow::m_head = [0.0, 0.0, 0.0]

Definition at line 654 of file fplot_core.f90.

◆ m_head_type

integer(int32) fplot_core::plot_arrow::m_head_type = ARROW_HEAD

Definition at line 662 of file fplot_core.f90.

◆ m_linestyle

integer(int32) fplot_core::plot_arrow::m_linestyle = LINE_SOLID

Definition at line 658 of file fplot_core.f90.

◆ m_linewidth

real(real32) fplot_core::plot_arrow::m_linewidth = 1.0

Definition at line 660 of file fplot_core.f90.

◆ m_size

real(real32) fplot_core::plot_arrow::m_size = 0.375

Definition at line 668 of file fplot_core.f90.

◆ m_tail

real(real32), dimension(3) fplot_core::plot_arrow::m_tail = [0.0, 0.0, 0.0]

Definition at line 652 of file fplot_core.f90.

◆ m_use_default_size

logical fplot_core::plot_arrow::m_use_default_size = .true.

Definition at line 674 of file fplot_core.f90.

◆ m_visible

logical, private fplot_core::plot_arrow::m_visible = .true.

private

Definition at line 650 of file fplot_core.f90.

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

D:/Code/fplot-1/src/fplot_core.f90

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ get_color()

◆ get_command_string()

◆ get_head_angle()

◆ get_head_back_angle()

◆ get_head_fill()

◆ get_head_location()

◆ get_head_size()

◆ get_head_type()

◆ get_is_visible()

◆ get_line_style()

◆ get_line_width()

◆ get_move_to_front()

◆ get_tail_location()

◆ get_use_default_size()

◆ par_set_head_1()

◆ par_set_head_2()

◆ par_set_head_3()

◆ par_set_tail_1()

◆ par_set_tail_2()

◆ par_set_tail_3()

◆ set_color()

◆ set_head_angle()

◆ set_head_back_angle()

◆ set_head_fill()

◆ set_head_location() [1/3]

◆ set_head_location() [2/3]

◆ set_head_location() [3/3]

◆ set_head_size()

◆ set_head_type()

◆ set_is_visible()

◆ set_line_style()

◆ set_line_width()

◆ set_move_to_front()

◆ set_tail_location() [1/3]

◆ set_tail_location() [2/3]

◆ set_tail_location() [3/3]

◆ set_use_default_size()

Member Data Documentation

◆ m_angle

◆ m_backangle

◆ m_color

◆ m_filling

◆ m_front

◆ m_head

◆ m_head_type

◆ m_linestyle

◆ m_linewidth

◆ m_size

◆ m_tail

◆ m_use_default_size

◆ m_visible