plot_arrow Derived Type

type, public, extends(plot_object) :: plot_arrow

Defines an arrow that can be drawn on a plot.


Contents

Type-Bound Procedures


Type-Bound Procedures

procedure, public :: get_color => par_get_color

  • private pure function par_get_color(this) result(rst)

    Gets the color of the arrow.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(in) :: this

    The plot_arrow object.

    Return Value type(color)

    The color.

procedure, public :: get_command_string => par_get_cmd

  • private function par_get_cmd(this) result(rst)

    Returns the appropriate GNUPLOT command string to establish appropriate parameters.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(in) :: this

    The plot_arrow object.

    Return Value character(len=:), allocatable

    The GNUPLOT command string.

procedure, public :: get_head_angle => par_get_head_angle

  • private pure function par_get_head_angle(this) result(rst)

    Gets the angle of the arrow head.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(in) :: this

    The plot_arrow object.

    Return Value real(kind=real32)

    The angle, in degrees.

procedure, public :: get_head_back_angle => par_get_head_back_angle

  • private pure function par_get_head_back_angle(this) result(rst)

    Gets the angle of the back of the arrow head.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(in) :: this

    The plot_arrow object.

    Return Value real(kind=real32)

    The angle, in degrees.

procedure, public :: get_head_fill => par_get_fill

  • private pure function par_get_fill(this) result(rst)

    Gets a flag denoting the head fill type.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(in) :: this

    The plot_arrow object.

    Return Value integer(kind=int32)

    The flag denoting head fill.

procedure, public :: get_head_location => par_get_head

  • private pure function par_get_head(this) result(rst)

    Gets the coordinates of the arrow's head.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(in) :: this

    The plot_arrow object.

    Return Value real(kind=real32), dimension(3)

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

procedure, public :: get_head_size => par_get_head_size

  • private pure function par_get_head_size(this) result(rst)

    Gets the size of the arrow head.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(in) :: this

    The plot_arrow object.

    Return Value real(kind=real32)

    The head size.

procedure, public :: get_head_type => par_get_head_type

  • private pure function par_get_head_type(this) result(rst)

    Gets the type of arrow head.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(in) :: this

    The plot_arrow object.

    Return Value integer(kind=int32)

    The arrow head type.

procedure, public :: get_is_visible => par_get_is_visible

  • private pure function par_get_is_visible(this) result(rst)

    Gets a value determining if the arrow is visible.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(in) :: this

    The plot_arrow object.

    Return Value logical

    True if the arrow is visible; else, false.

procedure, public :: get_line_style => par_get_line_style

  • private pure function par_get_line_style(this) result(rst)

    Gets the line style used to draw the arrow.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(in) :: this

    The plot_arrow object.

    Return Value integer(kind=int32)

    The line style.

procedure, public :: get_line_width => par_get_line_width

  • private pure function par_get_line_width(this) result(rst)

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

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(in) :: this

    The plot_arrow object.

    Return Value real(kind=real32)

    The width of the line.

procedure, public :: get_move_to_front => par_get_move_to_front

  • private pure function par_get_move_to_front(this) result(rst)

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

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(in) :: this

    The plot_arrow object.

    Return Value logical

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

procedure, public :: get_tail_location => par_get_tail

  • private pure function par_get_tail(this) result(rst)

    Gets the coordinates of the arrow's tail.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(in) :: this

    The plot_arrow object.

    Return Value real(kind=real32), dimension(3)

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

procedure, public :: get_use_default_size => par_get_use_default_size

  • private pure function par_get_use_default_size(this) result(rst)

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

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(in) :: this

    The plot_arrow object.

    Return Value logical

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

procedure, public :: set_color => par_set_color

  • private subroutine par_set_color(this, x)

    Sets the color of the arrow.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    type(color), intent(in) :: x

    The color.

procedure, public :: set_head_angle => par_set_head_angle

  • private subroutine par_set_head_angle(this, x)

    Sets the angle of the arrow head.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    real(kind=real32), intent(in) :: x

    The angle, in degrees.

procedure, public :: set_head_back_angle => par_set_head_back_angle

  • private subroutine par_set_head_back_angle(this, x)

    Sets the angle of the back of the arrow head.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    real(kind=real32), intent(in) :: x

    The angle, in degrees.

procedure, public :: set_head_fill => par_set_fill

  • private subroutine par_set_fill(this, x)

    Sets a flag denoting the head fill type.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    integer(kind=int32), intent(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

    If the value is not one of the above, the command is ignored.

generic, public :: set_head_location => par_set_head_1, par_set_head_2, par_set_head_3

  • private subroutine par_set_head_1(this, x)

    Sets the location of the arrow's head.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    real(kind=real32), intent(in) :: x(3)

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

  • private subroutine par_set_head_2(this, x, y)

    Sets the location of the arrow's head.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    real(kind=real32), intent(in) :: x

    The x-coordinate of the arrow's head.
    real(kind=real32), intent(in) :: y

    The y-coordinate of the arrow's head.

  • private subroutine par_set_head_3(this, x, y, z)

    Sets the location of the arrow's head.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    real(kind=real32), intent(in) :: x

    The x-coordinate of the arrow's head.
    real(kind=real32), intent(in) :: y

    The y-coordinate of the arrow's head.
    real(kind=real32), intent(in) :: z

    The z-coordinate of the arrow's head.

procedure, public :: set_head_size => par_set_head_size

  • private subroutine par_set_head_size(this, x)

    Sets the size of the arrow head.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    real(kind=real32), intent(in) :: x

    The head size.

procedure, public :: set_head_type => par_set_head_type

  • private subroutine par_set_head_type(this, x)

    Sets the type of arrow head.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    integer(kind=int32), intent(in) :: x

    The arrow head type. It must be one of the following constants.

    • ARROW_HEAD

    • ARROW_BACKHEAD

    • ARROW_HEADS

    • ARROW_NO_HEAD

    If the value is not one of the above, the command is ignored.

procedure, public :: set_is_visible => par_set_is_visible

  • private subroutine par_set_is_visible(this, x)

    Sets a value determining if the arrow is visible.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    logical, intent(in) :: x

    True if the arrow is visible; else, false.

procedure, public :: set_line_style => par_set_line_style

  • private subroutine par_set_line_style(this, x)

    Sets the line style used to draw the arrow.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    integer(kind=int32), intent(in) :: x

    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.

procedure, public :: set_line_width => par_set_line_width

  • private subroutine par_set_line_width(this, x)

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

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    real(kind=real32), intent(in) :: x

    The width of the line.

procedure, public :: set_move_to_front => par_set_move_to_front

  • private subroutine par_set_move_to_front(this, x)

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

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    logical, intent(in) :: x

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

generic, public :: set_tail_location => par_set_tail_1, par_set_tail_2, par_set_tail_3

  • private subroutine par_set_tail_1(this, x)

    Sets the coordinates of the arrow's tail.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    real(kind=real32), intent(in) :: x(3)

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

  • private subroutine par_set_tail_2(this, x, y)

    Sets the coordinates of the arrow's tail.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    real(kind=real32), intent(in) :: x

    The x-coordinate of the arrow's tail.
    real(kind=real32), intent(in) :: y

    !! The y-coordinate of the arrow's tail.

  • private subroutine par_set_tail_3(this, x, y, z)

    Sets the coordinates of the arrow's tail.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    real(kind=real32), intent(in) :: x

    The x-coordinate of the arrow's tail.
    real(kind=real32), intent(in) :: y

    The y-coordinate of the arrow's tail.
    real(kind=real32), intent(in) :: z

    The z-coordinate of the arrow's tail.

procedure, public :: set_use_default_size => par_set_use_default_size

  • private subroutine par_set_use_default_size(this, x)

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

    Arguments

    Type IntentOptional Attributes Name
    class(plot_arrow), intent(inout) :: this

    The plot_arrow object.
    logical, intent(in) :: x

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