fplot_core::plot_label Type Reference

Defines a label object for a plot. More...

Inheritance diagram for fplot_core::plot_label:

Public Member Functions
procedure, public	get_command_string lbl_get_cmd
	Gets the GNUPLOT command string for the label.
procedure, public	get_is_visible lbl_get_is_visible
	Gets a value determining if the label is to be drawn.
procedure, public	set_is_visible lbl_set_is_visible
	Sets a value determining if the label is to be drawn.
procedure, public	get_position lbl_get_position
	Gets the position of the label in terms of plot coordinates.
procedure, public	set_position lbl_set_position
	Sets the position of the label in terms of plot coordinates.
procedure, public	get_angle lbl_get_angle
	Gets the angle of the label text, in degrees.
procedure, public	set_angle lbl_set_angle
	Sets the angle of the label text, in degrees.
procedure, public	get_text lbl_get_txt
	Gets the text displayed by the label.
procedure, public	set_text lbl_set_txt
	Sets the text displayed by the label.

Public Attributes
real(real32), dimension(3)	m_position
	The x, y, and z coordinates of the label.
real(real32)	m_angle = 0.0
	The rotation angle of the label.
character(len=plotdata_max_name_length)	m_text
	The label text.

Private Attributes
logical	m_visible = .true.
	Determines if the label is visible.

Detailed Description

Defines a label object for a plot.

Definition at line 469 of file fplot_core.f90.

Member Function/Subroutine Documentation

get_angle()

procedure, public fplot_core::plot_label::get_angle

Gets the angle of the label text, in degrees.

Syntax

pure real(real32) function get_angle(class(plot_label) this)

Parameters

[in]

this

The plot_label object.

Returns

The angle, in degrees.

Definition at line 540 of file fplot_core.f90.

get_command_string()

procedure, public fplot_core::plot_label::get_command_string

virtual

Gets the GNUPLOT command string for the label.

Syntax

character(:) function allocatable get_command_string(class(plot_label) this)

Parameters

[in]

this

The plot_label object.

Returns

The command string.

Implements fplot_core::plot_object.

Definition at line 489 of file fplot_core.f90.

get_is_visible()

procedure, public fplot_core::plot_label::get_is_visible

Gets a value determining if the label is to be drawn.

Syntax

pure logical function get_is_visible(class(plot_label) this)

Parameters

[in]

this

The plot_label object.

Returns

Returns true if the label is to be drawn; else, false.

Definition at line 499 of file fplot_core.f90.

get_position()

procedure, public fplot_core::plot_label::get_position

Gets the position of the label in terms of plot coordinates.

Syntax

pure real(real32) dimension(3) function get_position(class(plot_label) this)

Parameters

[in]

this

The plot_label object.

Returns

A 3-element array containing the X, Y, and Z position of the label.

Definition at line 519 of file fplot_core.f90.

get_text()

procedure, public fplot_core::plot_label::get_text

Gets the text displayed by the label.

Syntax

character(len = :) function allocatable get_text(class(plot_label) this)

Parameters

[in]

this

The plot_label object.

Returns

The string of text to display.

Definition at line 560 of file fplot_core.f90.

set_angle()

procedure, public fplot_core::plot_label::set_angle

Sets the angle of the label text, in degrees.

Syntax

subroutine set_angle(class(plot_label) this, real(real32) x)

Parameters

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

Definition at line 550 of file fplot_core.f90.

set_is_visible()

procedure, public fplot_core::plot_label::set_is_visible

Sets a value determining if the label is to be drawn.

Syntax

subroutine set_is_visible(class(plot_label) this, logical x)

Parameters

[in,out]	this	The plot_label object.
[in]	x	Set to true to draw the label; else, false.

Definition at line 509 of file fplot_core.f90.

set_position()

procedure, public fplot_core::plot_label::set_position

Sets the position of the label in terms of plot coordinates.

Syntax

subroutine set_position(class(plot_label) this, real(real32) x(3))

Parameters

[in,out]	this	The plot_label object.
[in]	x	A 3-element array containing the X, Y, and Z position of the label.

Definition at line 530 of file fplot_core.f90.

set_text()

procedure, public fplot_core::plot_label::set_text

Sets the text displayed by the label.

Syntax

subroutine set_text(class(plot_label) this, character(len = *) x)

Parameters

[in,out]	this	The plot_label object.
[in]	x	The text string to display.

Definition at line 570 of file fplot_core.f90.

Member Data Documentation

m_angle

real(real32) fplot_core::plot_label::m_angle = 0.0

The rotation angle of the label.

Definition at line 476 of file fplot_core.f90.

m_position

real(real32), dimension(3) fplot_core::plot_label::m_position

The x, y, and z coordinates of the label.

Definition at line 474 of file fplot_core.f90.

m_text

character(len = plotdata_max_name_length) fplot_core::plot_label::m_text

The label text.

Definition at line 478 of file fplot_core.f90.

m_visible

logical fplot_core::plot_label::m_visible = .true.

private

Determines if the label is visible.

Definition at line 472 of file fplot_core.f90.

---

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

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