fplot_core::custom_colormap Type Reference

Defines a custom colormap that utilizes the FORCOLORMAP library to provide the map. More...

Inheritance diagram for fplot_core::custom_colormap:

Public Member Functions
procedure, public	get_color_string custom_get_clr
	Gets the GNUPLOT string defining the color distribution.
procedure, public	set_colormap custom_set
	Sets the FORCOLORMAP colormap object.
procedure, public	get_colormap custom_get
	Gets a pointer to the FORCOLORMAP colormap object.
Public Member Functions inherited from fplot_core::colormap
procedure, public	get_command_string cm_get_cmd
	Gets the GNUPLOT command string to represent this colormap object.
procedure, public	get_label cm_get_label
	Gets the label to associate with the colorbar.
procedure, public	set_label cm_set_label
	Sets the label to associate with the colorbar.
procedure, public	get_horizontal cm_get_horizontal
	Gets a logical value determining if the colormap should be drawn horizontally and below the plot.
procedure, public	set_horizontal cm_set_horizontal
	Sets a logical value determining if the colormap should be drawn horizontally and below the plot.
procedure, public	get_draw_border cm_get_draw_border
	Gets a logical value determining if the border should be drawn.
procedure, public	set_draw_border cm_set_draw_border
	Sets a logical value determining if the border should be drawn.
procedure, public	get_show_tics cm_get_show_tics
	Gets a logical value determining if the tic marks should be drawn.
procedure, public	set_show_tics cm_set_show_tics
	Sets a logical value determining if the tic marks should be drawn.

Private Attributes
class(cmap), pointer, private	m_map => null()

Additional Inherited Members
Public Attributes inherited from fplot_core::colormap
logical	m_horizontal = .false.
	The colormap should be drawn horizontally.
logical	m_drawborder = .true.
	Draw the colormap border.
logical	m_showtics = .true.
	Show the tic marks.

Detailed Description

Defines a custom colormap that utilizes the FORCOLORMAP library to provide the map.

Definition at line 2604 of file fplot_core.f90.

Constructor & Destructor Documentation

custom_final()

final fplot_core::custom_colormap::custom_final

final

Definition at line 2607 of file fplot_core.f90.

Member Function/Subroutine Documentation

get_color_string()

procedure, public fplot_core::custom_colormap::get_color_string

virtual

Gets the GNUPLOT string defining the color distribution.

Syntax

character(len = :) function, allocatable get_color_string(class(custom_colormap) this)

Parameters

[in]

this

The custom_colormap object.

Returns

The command string.

Implements fplot_core::colormap.

Definition at line 2617 of file fplot_core.f90.

get_colormap()

procedure, public fplot_core::custom_colormap::get_colormap

Gets a pointer to the FORCOLORMAP colormap object.

Syntax

class(cmap), pointer function get_colormap(class(custom_colormap) this)

Parameters

[in]

this

The custom_colormap object.

Returns

A pointer to the FORCOLORMAP colormap object.

Definition at line 2649 of file fplot_core.f90.

set_colormap()

procedure, public fplot_core::custom_colormap::set_colormap

Sets the FORCOLORMAP colormap object.

Syntax

subroutine set_colormap(class(custom_colormap) this, class(cmap) x, optional class(errors) err)

Parameters

[in,out]	this	The custom_colormap object.
[in]	x	The FORCOLORMAP colormap object. The custom_colormap object stores a copy of this object; therefore, any changes made to x after calls to this routine will not impact the behavior of the custom_colormap object.
[in,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 a memory allocation error occurs.

Definition at line 2639 of file fplot_core.f90.

Member Data Documentation

m_map

class(cmap), pointer, private fplot_core::custom_colormap::m_map => null()

private

Definition at line 2605 of file fplot_core.f90.

---

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

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