Defines a three-dimensional plot data set. More...

Inheritance diagram for fplot_core::plot_data_3d:

Public Member Functions
procedure, public	get_count pd3d_get_data_count
	Gets the number of data points.

procedure, public	get_x pd3d_get_x_data
	Gets the requested X data point.

procedure, public	set_x pd3d_set_x_data
	Sets the requested X data point.

procedure, public	get_y pd3d_get_y_data
	Gets the requested Y data point.

procedure, public	set_y pd3d_set_y_data
	Sets the requested Y data point.

procedure, public	get_z pd3d_get_z_data
	Gets the requested Z data point.

procedure, public	set_z pd3d_set_z_data
	Sets the requested Z data point.

procedure, public	get_axes_string pd3d_get_axes_cmd
	Gets the GNUPLOT command string defining which axes the data is to be plotted against.

procedure, public	get_data_string pd3d_get_data_cmd
	Gets the GNUPLOT command string containing the actual data to plot.

procedure, public	define_data pd3d_set_data_1
	Defines the data set.

procedure, public	get_x_data pd3d_get_x_array
	Gets the stored X data array.

procedure, public	get_y_data pd3d_get_y_array
	Gets the stored Y data array.

procedure, public	get_z_data pd3d_get_z_array
	Gets the stored Z data array.

procedure, public	get_color_data pd3d_get_c_array
	Gets the stored color scaling data array.

procedure, public	get_point_size_data pd3d_get_c_array
	Gets the stored point scaling data array.

Public Member Functions inherited from fplot_core::scatter_plot_data
procedure, public	get_command_string spd_get_cmd
	Gets the GNUPLOT command string to represent this scatter_plot_data object.

procedure, public	get_line_width spd_get_line_width
	Gets the width of the line, in pixels.

procedure, public	set_line_width spd_set_line_width
	Sets the width of the line, in pixels.

procedure, public	get_line_style spd_get_line_style
	Gets the line style.

procedure, public	set_line_style spd_set_line_style
	Sets the line style.

procedure, public	get_draw_line spd_get_draw_line
	Gets a value determining if a line should be drawn.

procedure, public	set_draw_line spd_set_draw_line
	Sets a value determining if a line should be drawn.

procedure, public	get_draw_markers spd_get_draw_markers
	Gets a value determining if data point markers should be drawn.

procedure, public	set_draw_markers spd_set_draw_markers
	Sets a value determining if data point markers should be drawn.

procedure, public	get_marker_style spd_get_marker_style
	Gets the marker style.

procedure, public	set_marker_style spd_set_marker_style
	Sets the marker style.

procedure, public	get_marker_scaling spd_get_marker_scaling
	Gets the marker scaling.

procedure, public	set_marker_scaling spd_set_marker_scaling
	Sets the marker scaling.

procedure, public	get_marker_frequency spd_get_marker_frequency
	Gets the marker frequency.

procedure, public	set_marker_frequency spd_set_marker_frequency
	Sets the marker frequency.

procedure, public	get_simplify_data spd_get_simplify_data
	Gets a value determining if the stored data should be simplified (reduced) before passing to GNUPLOT.

procedure, public	set_simplify_data spd_set_simplify_data
	Sets a value determining if the stored data should be simplified (reduced) before passing to GNUPLOT.

procedure, public	get_simplification_factor spd_get_simplify_factor
	Gets a factor used to establish the simplification tolerance.

procedure, public	set_simplification_factor spd_set_simplify_factor
	Sets a factor used to establish the simplification tolerance. The tolerance is established by multplying this factor by the range of the dependent variable data.

procedure, public	get_use_data_dependent_colors spd_get_data_dependent_colors
	Gets a value determing if data-dependent colors should be used.

procedure, public	set_use_data_dependent_colors spd_set_data_dependent_colors
	Sets a value determing if data dependent colors should be used.

procedure, public	get_fill_curve spd_get_filled
	Gets a logical value determining if a filled curve should be drawn.

procedure, public	set_fill_curve spd_set_filled
	Sets a logical value determining if a filled curve should be drawn.

procedure, public	get_use_variable_size_points spd_get_use_var_point_size
	Gets a logical value determining if variable sized data points should be used. The default is false, such that points will be of a constant size.

procedure, public	set_use_variable_size_points spd_set_use_var_point_size
	Sets a logical value determining if variable sized data points should be used. The default is false, such that points will be of a constant size.

Public Member Functions inherited from fplot_core::plot_data_colored
procedure, public	get_line_color pdc_get_line_color
	Gets the line color.

procedure, public	set_line_color pdc_set_line_color
	Sets the line color.

Public Member Functions inherited from fplot_core::plot_data
procedure, public	get_name pd_get_name
	Gets the name to associate with this data set.

procedure, public	set_name pd_set_name
	Sets the name to associate with this data set.

Private Attributes
real(real64), dimension(:,:), allocatable	m_data
	An N-by-3 matrix containing the x, y, and z data points.

Additional Inherited Members
Public Attributes inherited from fplot_core::scatter_plot_data
logical	m_drawmarkers = .false.
	Draw the markers?

integer(int32)	m_markerfrequency = 1
	Marker frequency.

real(real32)	m_linewidth = 1.0
	Line width.

integer(int32)	m_linestyle = LINE_SOLID
	Line style.

integer(int32)	m_markertype = MARKER_X
	Marker type.

real(real32)	m_markersize = 1.0
	Marker size multiplier.

logical	m_simplifydata = .true.
	True if large data sets should be simplified before sending to GNUPLOT.

real(real64)	m_simplifyfactor = 1.0d-3
	A scaling factor used to establish the simplification tolerance. The simplification tolerance is established by multiplying this factor by the range in the dependent variable data.

logical	m_datadependentcolors = .false.
	Determines if the data should utilize data-dependent colors.

logical	m_filledcurve = .false.
	Fill the curve?

logical	m_usevariablesizepoints = .false.
	Use variable size data points?

Public Attributes inherited from fplot_core::plot_data_colored
logical	m_useautocolor = .true.
	Let the object choose colors automatically.

integer(int32)	m_colorindex = 1
	The color index to use, assuming we're using auto color.

Detailed Description

Defines a three-dimensional plot data set.

Definition at line 4334 of file fplot_core.f90.

Member Function/Subroutine Documentation

◆ define_data()

procedure, public fplot_core::plot_data_3d::define_data

Defines the data set.

Syntax: subroutine define_data(class(plot_data_3d) this, real(real64) x(:), real(real64) y(:), real(real64) z(:), optional class(errors) err)

Parameters

[in,out]	this	The plot_data_2d object.
[in]	x	An N-element array containing the x coordinate data.
[in]	y	An N-element array containing the y coordinate data.
[in]	z	An N-element array containing the z coordinate data.
[out]	err	An optional errors-based object that if provided can be used to retrieve information relating to any errors encountered during execution. If not provided, a default implementation of the errors class is used internally to provide error handling. Possible errors and warning messages that may be encountered are as follows. PLOT_OUT_OF_MEMORY_ERROR: Occurs if insufficient memory is available. PLOT_ARRAY_SIZE_MISMATCH_ERROR: Occurs if `x`, `y`, and `z` are not the same size.

Definition at line 4456 of file fplot_core.f90.

◆ get_axes_string()

procedure, public fplot_core::plot_data_3d::get_axes_string

virtual

Gets the GNUPLOT command string defining which axes the data is to be plotted against.

Syntax: character(len = :) function, allocatable :: get_axes_string(class(plot_data_3d) this)

Parameters

[in] this The plot_data_3d object.

Returns: The command string.

Implements fplot_core::scatter_plot_data.

Definition at line 4425 of file fplot_core.f90.

◆ get_color_data()

procedure, public fplot_core::plot_data_3d::get_color_data

Gets the stored color scaling data array.

Syntax: real(real64)(:) function get_color_data(class(plot_data_3d) this)

Parameters

[in] this The plot_data_3d object.

Returns: A copy of the stored data array.

Definition at line 4496 of file fplot_core.f90.

◆ get_count()

procedure, public fplot_core::plot_data_3d::get_count

virtual

Gets the number of data points.

Syntax: pure integer(int32) function get_count(class(plot_data_3d) this)

Parameters

[in] this The plot_data_3d object.

Returns: The number of data points.

Implements fplot_core::scatter_plot_data.

Definition at line 4348 of file fplot_core.f90.

◆ get_data_string()

procedure, public fplot_core::plot_data_3d::get_data_string

virtual

Gets the GNUPLOT command string containing the actual data to plot.

Syntax: character(len = :) function, allocatable :: get_data_string(class(plot_data_3d) this)

Parameters

[in] this The plot_data_3d object.

Returns: The command string.

Implements fplot_core::plot_data.

Definition at line 4436 of file fplot_core.f90.

◆ get_point_size_data()

procedure, public fplot_core::plot_data_3d::get_point_size_data

Gets the stored point scaling data array.

Syntax: real(real64)(:) function get_point_size_data(class(plot_data_3d) this)

Parameters

[in] this The plot_data_3d object.

Returns: A copy of the stored data array.

Definition at line 4506 of file fplot_core.f90.

◆ get_x()

procedure, public fplot_core::plot_data_3d::get_x

virtual

Gets the requested X data point.

Syntax: pure real(real64) function get_x(class(plot_data_3d), this, integer(int32) index)

Parameters

[in]	this	The plot_data_3d object.
[in]	index	The index of the data point to retrieve.

Returns: The requested data point.

Implements fplot_core::scatter_plot_data.

Definition at line 4359 of file fplot_core.f90.

◆ get_x_data()

procedure, public fplot_core::plot_data_3d::get_x_data

Gets the stored X data array.

Syntax: real(real64)(:) function get_x_data(class(plot_data_3d) this)

Parameters

[in] this The plot_data_3d object.

Returns: A copy of the stored data array.

Definition at line 4466 of file fplot_core.f90.

◆ get_y()

procedure, public fplot_core::plot_data_3d::get_y

virtual

Gets the requested Y data point.

Syntax: pure real(real64) function get_y(class(plot_data_3d) this, this, integer(int32) index)

Parameters

[in]	this	The plot_data_3d object.
[in]	index	The index of the data point to retrieve.

Returns: The requested data point.

Implements fplot_core::scatter_plot_data.

Definition at line 4381 of file fplot_core.f90.

◆ get_y_data()

procedure, public fplot_core::plot_data_3d::get_y_data

Gets the stored Y data array.

Syntax: real(real64)(:) function get_y_data(class(plot_data_3d) this)

Parameters

[in] this The plot_data_3d object.

Returns: A copy of the stored data array.

Definition at line 4476 of file fplot_core.f90.

◆ get_z()

procedure, public fplot_core::plot_data_3d::get_z

Gets the requested Z data point.

Syntax: pure real(real64) function get_z(class(plot_data_3d) this, this, integer(int32) index)

Parameters

[in]	this	The plot_data_3d object.
[in]	index	The index of the data point to retrieve.

Returns: The requested data point.

Definition at line 4403 of file fplot_core.f90.

◆ get_z_data()

procedure, public fplot_core::plot_data_3d::get_z_data

Gets the stored Z data array.

Syntax: real(real64)(:) function get_z_data(class(plot_data_3d) this)

Parameters

[in] this The plot_data_3d object.

Returns: A copy of the stored data array.

Definition at line 4486 of file fplot_core.f90.

◆ set_x()

procedure, public fplot_core::plot_data_3d::set_x

virtual

Sets the requested X data point.

Syntax: subroutine set_x(class(plot_data_3d) this, integer(int32) index, real(real64) x)

Parameters

[in,out]	this	The plot_data_3d object.
[in]	index	The index of the data point to replace.
[in]	x	The data point.

Implements fplot_core::scatter_plot_data.

Definition at line 4370 of file fplot_core.f90.

◆ set_y()

procedure, public fplot_core::plot_data_3d::set_y

virtual

Sets the requested Y data point.

Syntax: subroutine set_y(class(plot_data_3d) this, integer(int32) index, real(real64) x)

Parameters

[in,out]	this	The plot_data_3d object.
[in]	index	The index of the data point to replace.
[in]	x	The data point.

Implements fplot_core::scatter_plot_data.

Definition at line 4392 of file fplot_core.f90.

◆ set_z()

procedure, public fplot_core::plot_data_3d::set_z

Sets the requested Z data point.

Syntax: subroutine set_z(class(plot_data_3d) this, integer(int32) index, real(real64) x)

Parameters

[in,out]	this	The plot_data_3d object.
[in]	index	The index of the data point to replace.
[in]	x	The data point.

Definition at line 4414 of file fplot_core.f90.

Member Data Documentation

◆ m_data

real(real64), dimension(:,:), allocatable fplot_core::plot_data_3d::m_data

private

An N-by-3 matrix containing the x, y, and z data points.

Definition at line 4337 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

Private Attributes

Additional Inherited Members

Detailed Description

Member Function/Subroutine Documentation

◆ define_data()

◆ get_axes_string()

◆ get_color_data()

◆ get_count()

◆ get_data_string()

◆ get_point_size_data()

◆ get_x()

◆ get_x_data()

◆ get_y()

◆ get_y_data()

◆ get_z()

◆ get_z_data()

◆ set_x()

◆ set_y()

◆ set_z()

Member Data Documentation

◆ m_data