VectorHandle – vkframes

type, public, extends(DragHandle) :: VectorHandle

An arrow whose tip the mouse drags (see the module documentation).

Inherits

Help

Components

Type	Visibility		Name		Initial
type(c_ptr),	private	::	head	=	c_null_ptr	the transforms of the unit shaft and head
type(c_ptr),	private	::	head_mesh	=	c_null_ptr	the unit shaft and head (colored by their materials)
real(kind=wp),	private	::	head_size_	=	0.0_wp	the head's length (scene units; 0: 0.2 of the arrow)
real(kind=wp),	private	::	scale_	=	1.0_wp	drawn as scale * vector (scene units)
type(c_ptr),	private	::	shaft	=	c_null_ptr	the transforms of the unit shaft and head
type(c_ptr),	private	::	shaft_mesh	=	c_null_ptr	the unit shaft and head (colored by their materials)
type(c_ptr),	private	::	switch	=	c_null_ptr	shows the arrow (not when the vector is 0)
real(kind=wp),	private	::	vector_(3)	=	[1.0_wp, 0.0_wp, 0.0_wp]	the vector (frame coordinates)

Constructor

public interface VectorHandle

The VectorHandle constructor: VectorHandle(...) makes one (see new_vector_handle for its arguments).

private function new_vector_handle(name, vector, color, scale) result(h)

A vector handle (see the module documentation): vector in its frame's coordinates (default [1, 0, 0]), drawn scale times as long (default 1), in color ([r, g, b] or [r, g, b, a]). Its axes and labels are hidden.

Arguments

Type	Intent	Optional		Name
character(len=*),	intent(in)		::	name	the frame's name
real(kind=wp),	intent(in),	optional	::	vector(3)	frame coordinates
real(kind=wp),	intent(in),	optional	::	color(:)	[r, g, b] or [r, g, b, a] (0 to 1)
real(kind=wp),	intent(in),	optional	::	scale	display scale (scene units per vector unit; > 0)

Return Value type(VectorHandle)

Type-Bound Procedures

procedure, public :: add_child

private function add_child(self, child) result(ok)

Add child to this frame's children. Returns false (and does nothing) for this frame itself or an ancestor of it; true if it is already a child.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout),		target	::	self
class(ReferenceFrame),	intent(inout),		target	::	child	the frame to add (not owned)

Return Value logical

procedure, public :: attitude

private pure function attitude(self) result(q)

Attitude relative to the parent frame, a quaternion [x, y, z, w].

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value real(kind=wp), (4)

procedure, public :: axes_labels_shown

private pure function axes_labels_shown(self)

Which axes labels are shown (as axes_shown).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value integer

procedure, public :: axes_shown

private pure function axes_shown(self)

Which axes vectors are shown (NO_AXES, or X_AXIS, Y_AXIS, Z_AXIS combined).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value integer

procedure, public :: axis_label

private function axis_label(self, axis) result(text)

The label text of axis X_AXIS, Y_AXIS or Z_AXIS.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self
integer,	intent(in)			::	axis	X_AXIS, Y_AXIS or Z_AXIS (else: '')

Return Value character(len=:), allocatable

procedure, public :: bound => vector_bound

private subroutine vector_bound(self, center, radius)

The arrow's bounding sphere (frame coordinates).

Arguments

Type	Intent		Name
class(VectorHandle),	intent(in)	::	self
real(kind=wp),	intent(out)	::	center(3)	the bound's center (frame coordinates)
real(kind=wp),	intent(out)	::	radius	its radius (scene units)

procedure, public :: build_contents => vector_build_contents

private subroutine vector_build_contents(self, viewer, group)

The arrow: a unit shaft and head under their transforms, in a switch.

Arguments

Type	Intent		Name
class(VectorHandle),	intent(inout)	::	self
type(c_ptr),	intent(in)	::	viewer	a window's viewer (null: headless)
type(c_ptr),	intent(in)	::	group	the frame's contents group

procedure, public :: child

private function child(self, i) result(c)

Child i (1 to num_children).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self
integer,	intent(in)			::	i	1 to num_children

Return Value class(ReferenceFrame), pointer

procedure, public :: child_index

private function child_index(self, frame)

Index of frame among the children, or 0.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self
class(ReferenceFrame),	intent(in),		target	::	frame	the frame to find

Return Value integer

procedure, public :: color

private pure function color(self) result(c)

The color of the frame's decorations, [r, g, b, a] (0 to 1).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value real(kind=wp), (4)

procedure, public :: constraint

private pure function constraint(self)

The handle's constraint (HANDLE_*).

Arguments

Type	Intent	Optional	Attributes		Name
class(DragHandle),	intent(in)			::	self

Return Value integer

procedure, public :: constraint_axis

private pure function constraint_axis(self) result(axis)

The constraint's normal or direction (unit vector, frame coordinates).

Arguments

Type	Intent	Optional	Attributes		Name
class(DragHandle),	intent(in)			::	self

Return Value real(kind=wp), (3)

procedure, public :: contents_shown

private pure function contents_shown(self)

Whether what the frame draws is shown (show_contents).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value logical

procedure, public :: detach

private subroutine detach(self)

Remove this frame from all its parents and children (before it goes out of scope or is deallocated while in a tree).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout),		target	::	self

procedure, public :: display_scale

private pure function display_scale(self)

The display scale.

Arguments

Type	Intent	Optional	Attributes		Name
class(VectorHandle),	intent(in)			::	self

Return Value real(kind=wp)

procedure, public :: drag

private function drag(self, origin, dir) result(moved)

Drag the grabbed handle to the cursor's ray (origin, unit dir; root frame), held to its constraint. False (and not moved) if it isn't grabbed or the ray doesn't meet the constraint.

Arguments

Type	Intent		Name
class(DragHandle),	intent(inout)	::	self
real(kind=wp),	intent(in)	::	origin(3)	the cursor's ray (root frame)
real(kind=wp),	intent(in)	::	dir(3)	the cursor's ray (root frame)

Return Value logical

procedure, public :: draggable

private pure function draggable(self)

Whether the mouse may grab the handle.

Arguments

Type	Intent	Optional	Attributes		Name
class(DragHandle),	intent(in)			::	self

Return Value logical

procedure, public :: dragged

private pure function dragged(self)

The handle is grabbed (until released).

Arguments

Type	Intent	Optional	Attributes		Name
class(DragHandle),	intent(in)			::	self

Return Value logical

procedure, public :: follow

private subroutine follow(self, traj, data, mode, add, data_frame)

Follow traj (in addition to trajectories already followed, if add is true), with what to follow (data: FOLLOW_POSITION and/or FOLLOW_ATTITUDE; default both) and how (mode: FOLLOW_LOOP, the default, or FOLLOW_LIMIT). traj must stay alive while followed.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
type(Trajectory),	intent(in),		target	::	traj	the trajectory to follow (not owned)
integer,	intent(in),	optional		::	data	FOLLOW_POSITION/FOLLOW_ATTITUDE; FOLLOW_LOOP/FOLLOW_LIMIT
integer,	intent(in),	optional		::	mode	FOLLOW_POSITION/FOLLOW_ATTITUDE; FOLLOW_LOOP/FOLLOW_LIMIT
logical,	intent(in),	optional		::	add	(true: in addition to those followed (default false))
class(ReferenceFrame),	intent(in),	optional,	target	::	data_frame	the frame the data are in (default: the parent)

procedure, public :: follow_frame

private function follow_frame(self) result(f)

The frame the followed data are in (follow's data_frame; null: the parent).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value class(ReferenceFrame), pointer

procedure, public :: follower

private function follower(self) result(f)

The frame's trajectory follower, for finer control (data sources, time offset, ...).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in),		target	::	self

Return Value type(TrajectoryFollower), pointer

procedure, public :: frame_info => vector_frame_info

private function vector_frame_info(self) result(info)

What kind of frame this is: 'VectorHandle'.

Arguments

Type	Intent	Optional	Attributes		Name
class(VectorHandle),	intent(in)			::	self

Return Value character(len=:), allocatable

procedure, public :: frame_string

private recursive function frame_string(self, prefix) result(str)

The tree below this frame, one line per frame ("name (info)"), in OpenFrames' createFrameString format: children are prefixed "|-->".

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self
character(len=*),	intent(in),	optional		::	prefix	before this frame's line (default ' ')

Return Value character(len=:), allocatable

procedure, public :: grab

private function grab(self, origin, dir) result(ok)

Grab the handle with the cursor's ray (origin, unit dir; root frame): its constraint is taken as it is now, and the point's offset from where the ray meets it. False if it isn't draggable.

Arguments

Type	Intent		Name
class(DragHandle),	intent(inout)	::	self
real(kind=wp),	intent(in)	::	origin(3)	the cursor's ray (root frame)
real(kind=wp),	intent(in)	::	dir(3)	the cursor's ray (root frame)

Return Value logical

procedure, public :: handle_point => vector_handle_point

private pure function vector_handle_point(self) result(p)

The point the mouse grabs: the tip.

Arguments

Type	Intent	Optional	Attributes		Name
class(VectorHandle),	intent(in)			::	self

Return Value real(kind=wp), (3)

procedure, public :: has_light_source

private recursive function has_light_source(self) result(has)

Whether this frame or one of its descendants has a light source enabled.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value logical

procedure, public :: head_size

private pure function head_size(self)

The head's length set (0: 0.2 of the arrow's).

Arguments

Type	Intent	Optional	Attributes		Name
class(VectorHandle),	intent(in)			::	self

Return Value real(kind=wp)

procedure, public :: hovered

private pure function hovered(self)

The handle is under the cursor.

Arguments

Type	Intent	Optional	Attributes		Name
class(DragHandle),	intent(in)			::	self

Return Value logical

procedure, public :: is_following

private pure function is_following(self)

Whether the frame follows trajectories (at least one, since follow).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value logical

procedure, public :: label_alignment

private pure function label_alignment(self)

The labels' alignment (ALIGN_*).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value integer

procedure, public :: label_font

private function label_font(self) result(font)

The labels' font as set ('' for the renderer's default).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value character(len=:), allocatable

procedure, public :: label_size

private pure function label_size(self)

The labels' size in pixels.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value integer

procedure, public :: late_update

private recursive subroutine late_update(self, t)

After the whole tree's update for time t (all frames at their positions for t): for contents that depend on other frames' positions, e.g. CustomLineSegments between spacecraft. Here, only the descendants'.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
real(kind=wp),	intent(in)			::	t	simulation time

procedure, public :: light_ambient

private pure function light_ambient(self) result(rgb)

The light source's ambient color [r, g, b].

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value real(kind=wp), (3)

procedure, public :: light_diffuse

private pure function light_diffuse(self) result(rgb)

The light source's diffuse color [r, g, b].

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value real(kind=wp), (3)

procedure, public :: light_source_enabled

private pure function light_source_enabled(self)

Whether this frame carries a light source.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value logical

procedure, public :: light_specular

private pure function light_specular(self) result(rgb)

The light source's specular color [r, g, b].

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value real(kind=wp), (3)

procedure, public :: local_matrix

private pure function local_matrix(self) result(m)

The transform from this frame to its parent (4x4).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value real(kind=wp), (4,4)

procedure, public :: local_matrix_at

private recursive function local_matrix_at(self, t) result(m)

The transform from this frame to its parent at simulation time t: its fixed position and attitude, with what it follows at time t (the followed trajectories' state then, in the parent's coordinates). The same as local_matrix after update at time t, for any t, without changing anything.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self
real(kind=wp),	intent(in)			::	t	simulation time

Return Value real(kind=wp), (4,4)

procedure, public :: motion_key

private recursive subroutine motion_key(self, stamp, data)

What the frame's motion depends on, for drawings that depend on it to know when to redraw: stamp, the latest change of the motion of it and its ancestors (through first parents), and of the frames their followed data are in (poses set, parents changed, what is followed and how); and data, the followed trajectories' revisions summed. Either changes when the frame's motion over time changes.

Arguments

Type	Intent		Name
class(ReferenceFrame),	intent(in)	::	self
integer,	intent(out)	::	stamp	the latest change; the followed data's revisions
integer,	intent(out)	::	data	the latest change; the followed data's revisions

procedure, public :: move_handle_point => vector_move_handle_point

private subroutine vector_move_handle_point(self, p)

The tip dragged to p: the vector p / the display scale.

Arguments

Type	Intent	Optional	Attributes		Name
class(VectorHandle),	intent(inout)			::	self
real(kind=wp),	intent(in)			::	p(3)	the tip's new place (frame coordinates)

procedure, public :: move_x_axis

private subroutine move_x_axis(self, base, length, head_ratio, body_radius, head_radius)

Place the x axis vector: from base, length long, with a head of head_ratio of the length (default 0.3) and body and head radii (default 0.05 and 0.1 of the length); its label is at the tip, 0.4 of the length tall (at most label_size pixels). As OpenFrames' moveXAxis. Set before the frame is first shown.

Arguments

Type	Intent	Optional		Name
class(ReferenceFrame),	intent(inout)		::	self
real(kind=wp),	intent(in)		::	base(3)	(base: frame's coordinates)
real(kind=wp),	intent(in)		::	length	(base: frame's coordinates)
real(kind=wp),	intent(in),	optional	::	head_ratio	defaults: 0.3; 0.05 and 0.1 of the length
real(kind=wp),	intent(in),	optional	::	body_radius	defaults: 0.3; 0.05 and 0.1 of the length
real(kind=wp),	intent(in),	optional	::	head_radius	defaults: 0.3; 0.05 and 0.1 of the length

procedure, public :: move_y_axis

private subroutine move_y_axis(self, base, length, head_ratio, body_radius, head_radius)

Place the y axis vector (as move_x_axis; OpenFrames' moveYAxis).

Arguments

Type	Intent	Optional		Name
class(ReferenceFrame),	intent(inout)		::	self
real(kind=wp),	intent(in)		::	base(3)	(base: frame's coordinates)
real(kind=wp),	intent(in)		::	length	(base: frame's coordinates)
real(kind=wp),	intent(in),	optional	::	head_ratio	defaults: 0.3; 0.05 and 0.1 of the length
real(kind=wp),	intent(in),	optional	::	body_radius	defaults: 0.3; 0.05 and 0.1 of the length
real(kind=wp),	intent(in),	optional	::	head_radius	defaults: 0.3; 0.05 and 0.1 of the length

procedure, public :: move_z_axis

private subroutine move_z_axis(self, base, length, head_ratio, body_radius, head_radius)

Place the z axis vector (as move_x_axis; OpenFrames' moveZAxis).

Arguments

Type	Intent	Optional		Name
class(ReferenceFrame),	intent(inout)		::	self
real(kind=wp),	intent(in)		::	base(3)	(base: frame's coordinates)
real(kind=wp),	intent(in)		::	length	(base: frame's coordinates)
real(kind=wp),	intent(in),	optional	::	head_ratio	defaults: 0.3; 0.05 and 0.1 of the length
real(kind=wp),	intent(in),	optional	::	body_radius	defaults: 0.3; 0.05 and 0.1 of the length
real(kind=wp),	intent(in),	optional	::	head_radius	defaults: 0.3; 0.05 and 0.1 of the length

procedure, public :: name

private function name(self) result(n)

The frame's name ('' if none).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value character(len=:), allocatable

procedure, public :: name_label_on_top

private pure function name_label_on_top(self)

Whether the name label is drawn on top of the scene (set_name_label_on_top).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value logical

procedure, public :: name_label_shown

private pure function name_label_shown(self)

Whether the name label is shown.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value logical

procedure, public :: node

private function node(self) result(n)

The frame's transform node (null until realized).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value type(c_ptr)

procedure, public :: num_children

private pure function num_children(self)

Number of children.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value integer

procedure, public :: num_parents

private pure function num_parents(self)

Number of parents.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value integer

procedure, public :: parent

private function parent(self, i) result(p)

Parent i (1 to num_parents).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self
integer,	intent(in)			::	i	1 to num_parents

Return Value class(ReferenceFrame), pointer

procedure, public :: parent_index

private function parent_index(self, frame)

Index of frame among the parents, or 0.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self
class(ReferenceFrame),	intent(in),		target	::	frame	the frame to find

Return Value integer

procedure, public :: pick => vector_pick

private subroutine vector_pick(self, cam, to_root, hits, n)

Picked at its tip and along its head (within the tolerance, plus a few pixels), as PICK_HANDLE; else the frame's origin.

Arguments

Type	Intent	Attributes		Name
class(VectorHandle),	intent(in),	target	::	self
type(PickCamera),	intent(in)		::	cam	the camera and cursor of the pick
real(kind=wp),	intent(in)		::	to_root(4,4)	the frame's transform to the root frame
type(PickHit),	intent(inout),	allocatable	::	hits(:)	hits so far, in hits(1:n); added to
integer,	intent(inout)		::	n	number of hits

procedure, public :: pickable

private pure function pickable(self)

Whether pick tests what this frame draws (set_pickable).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value logical

procedure, public :: position

private pure function position(self) result(p)

Position relative to the parent frame.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value real(kind=wp), (3)

procedure, public :: position_of

private function position_of(self, other) result(p)

The origin of other (a frame of the same tree) in this frame's coordinates, from both frames' transforms to the root (through their first parents).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self	(other: a frame of the same tree)
class(ReferenceFrame),	intent(in)			::	other	(other: a frame of the same tree)

Return Value real(kind=wp), (3)

procedure, public :: priority

private pure function priority(self)

The handle's priority over others on the same spot.

Arguments

Type	Intent	Optional	Attributes		Name
class(DragHandle),	intent(in)			::	self

Return Value integer

procedure, public :: realize

private recursive subroutine realize(self, viewer)

Create the render nodes of this frame and its descendants (once; for viewer, a window's viewer handle, which some contents need while they are built (not kept); null: headless).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
type(c_ptr),	intent(in)			::	viewer	a window's viewer handle (null: headless)

procedure, public :: release

private subroutine release(self)

Let the handle go.

Arguments

Type	Intent	Optional	Attributes		Name
class(DragHandle),	intent(inout)			::	self

procedure, public :: remove_child

private function remove_child(self, child) result(ok)

Remove child from this frame's children. Returns false if it is not one.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout),		target	::	self
class(ReferenceFrame),	intent(inout),		target	::	child	the child to remove

Return Value logical

procedure, public :: reposition_axes

private subroutine reposition_axes(self)

Place the axes for what the frame draws, when it is first shown (unless move_*_axis was called): at its bound's surface, half the bound's radius long (as OpenFrames' Sphere and Model do); at the origin, 1 long, for a frame that draws nothing.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self

procedure, public :: set_attitude

private subroutine set_attitude(self, q)

Attitude relative to the parent frame, a quaternion [x, y, z, w] (normalized here; overridden by a followed trajectory).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
real(kind=wp),	intent(in)			::	q(4)	attitude quaternion [x, y, z, w] (normalized here)

procedure, public :: set_color => vector_set_color

private subroutine vector_set_color(self, color)

The arrow's color; [r, g, b] or [r, g, b, a].

Arguments

Type	Intent	Optional	Attributes		Name
class(VectorHandle),	intent(inout)			::	self
real(kind=wp),	intent(in)			::	color(:)	[r, g, b] or [r, g, b, a] (0 to 1)

procedure, public :: set_constraint

private subroutine set_constraint(self, constraint, axis)

Where the handle can be dragged (HANDLE_*; see the module documentation), with axis: the plane's normal (HANDLE_PLANE) or the line's direction (HANDLE_LINE), in the frame's coordinates. Taken when the handle is next grabbed.

Arguments

Type	Intent	Optional		Name
class(DragHandle),	intent(inout)		::	self
integer,	intent(in)		::	constraint	HANDLE_*
real(kind=wp),	intent(in),	optional	::	axis(3)	(frame coordinates; any length but 0)

procedure, public :: set_display_scale

private subroutine set_display_scale(self, scale)

Scene units per unit of the vector (> 0; default 1): the arrow is scale * vector.

Arguments

Type	Intent	Optional	Attributes		Name
class(VectorHandle),	intent(inout)			::	self
real(kind=wp),	intent(in)			::	scale	scene units per vector unit (> 0; else ignored)

procedure, public :: set_draggable

private subroutine set_draggable(self, draggable)

Whether the mouse may grab the handle (default true).

Arguments

Type	Intent	Optional	Attributes		Name
class(DragHandle),	intent(inout)			::	self
logical,	intent(in)			::	draggable	true: the mouse may grab it

procedure, public :: set_head_size

private subroutine set_head_size(self, size)

The head's length (scene units; at most half the arrow); 0 (the default): 0.2 of the arrow's length.

Arguments

Type	Intent	Optional	Attributes		Name
class(VectorHandle),	intent(inout)			::	self
real(kind=wp),	intent(in)			::	size	the head's length (scene units; 0: 0.2 of the arrow)

procedure, public :: set_hovered

private subroutine set_hovered(self, hovered)

The handle is under the cursor (set by the window), or not.

Arguments

Type	Intent	Optional	Attributes		Name
class(DragHandle),	intent(inout)			::	self
logical,	intent(in)			::	hovered	true: under the cursor

procedure, public :: set_label_alignment

private subroutine set_label_alignment(self, alignment)

The alignment of the labels relative to their positions (ALIGN_*; default ALIGN_LEFT_BASE_LINE).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
integer,	intent(in)			::	alignment	ALIGN_* (default ALIGN_LEFT_BASE_LINE)

procedure, public :: set_label_font

private subroutine set_label_font(self, font)

The font of the labels: a font file name (found on the data search path) or a full path; default: the renderer's default font.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
character(len=*),	intent(in)			::	font	a font file name (on the data search path) or a full path

procedure, public :: set_label_size

private subroutine set_label_size(self, size)

The size of the labels in pixels (default 20): the name label's size, and the maximum size of the axes labels (which shrink with distance).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
integer,	intent(in)			::	size	pixels (default 20)

procedure, public :: set_light_ambient

private subroutine set_light_ambient(self, rgb)

The light source's ambient, diffuse and specular colors ([r, g, b], 0 to 1; defaults 0.05, 0.8 and 0.05 gray).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
real(kind=wp),	intent(in)			::	rgb(3)	ambient color [r, g, b] (0 to 1; default 0.05 gray)

procedure, public :: set_light_diffuse

private subroutine set_light_diffuse(self, rgb)

The light source's diffuse color (see set_light_ambient).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
real(kind=wp),	intent(in)			::	rgb(3)	diffuse color [r, g, b] (0 to 1; default 0.8 gray)

procedure, public :: set_light_source_enabled

private subroutine set_light_source_enabled(self, enable)

Whether this frame carries a light source: a point light at its origin (e.g. the Sun), not dimmed with distance (default false; OpenFrames' setLightSourceEnabled). While any frame of a window's scene has one, the window's own light (WindowProxy%set_light_*) is off.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
logical,	intent(in)			::	enable	(true: a point light at the frame's origin)

procedure, public :: set_light_specular

private subroutine set_light_specular(self, rgb)

The light source's specular color (see set_light_ambient).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
real(kind=wp),	intent(in)			::	rgb(3)	specular color [r, g, b] (0 to 1; default 0.05 gray)

procedure, public :: set_name

private subroutine set_name(self, name)

The frame's name, shown by its name label (also once shown: e.g. a readout that follows the frame).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
character(len=*),	intent(in)			::	name	the name (shown by the name label)

procedure, public :: set_name_label_on_top

private subroutine set_name_label_on_top(self, on_top)

Draw the name label on top of the scene (true: not hidden by bodies in front of it, as HUD text; e.g. a readout) or depth-tested (false, the default, as OpenFrames').

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
logical,	intent(in)			::	on_top	(true: drawn on top of the scene; false: depth-tested)

procedure, public :: set_pickable

private subroutine set_pickable(self, pickable)

Whether pick tests what this frame draws (default true; e.g. false for an overlay such as a selection marker). Its children are picked or not by their own setting.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
logical,	intent(in)			::	pickable	(true: tested by pick)

procedure, public :: set_position

private subroutine set_position(self, position)

Position relative to the parent frame (overridden by a followed trajectory).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
real(kind=wp),	intent(in)			::	position(3)	parent frame's coordinates

procedure, public :: set_priority

private subroutine set_priority(self, priority)

The handle's priority over others on the same spot of the screen (higher first; default 0, a TimeHandle's 1; see the module documentation).

Arguments

Type	Intent	Optional	Attributes		Name
class(DragHandle),	intent(inout)			::	self
integer,	intent(in)			::	priority	higher: hovered first

procedure, public :: set_vector

private subroutine set_vector(self, vector)

The vector (frame coordinates); can change at any time.

Arguments

Type	Intent	Optional	Attributes		Name
class(VectorHandle),	intent(inout)			::	self
real(kind=wp),	intent(in)			::	vector(3)	frame coordinates

procedure, public :: set_x_label

private subroutine set_x_label(self, text)

The text of the x-axis label (default 'X').

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
character(len=*),	intent(in)			::	text	the x-axis label (default 'X')

procedure, public :: set_y_label

private subroutine set_y_label(self, text)

The text of the y-axis label (default 'Y').

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
character(len=*),	intent(in)			::	text	the y-axis label (default 'Y')

procedure, public :: set_z_label

private subroutine set_z_label(self, text)

The text of the z-axis label (default 'Z').

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
character(len=*),	intent(in)			::	text	the z-axis label (default 'Z')

procedure, public :: show_axes

private subroutine show_axes(self, axes)

Which axes vectors to show: NO_AXES, or X_AXIS, Y_AXIS, Z_AXIS combined with ior.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
integer,	intent(in)			::	axes	NO_AXES, or X_AXIS, Y_AXIS, Z_AXIS combined with ior

procedure, public :: show_axes_labels

private subroutine show_axes_labels(self, labels)

Which axes labels to show (as show_axes).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
integer,	intent(in)			::	labels	NO_AXES, or X_AXIS, Y_AXIS, Z_AXIS combined with ior

procedure, public :: show_contents

private subroutine show_contents(self, show)

Show or hide what the frame draws (its sphere, model, ...), but not its axes, labels or children.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
logical,	intent(in)			::	show	(true: shown)

procedure, public :: show_decorations

private subroutine show_decorations(self, show)

Show (true) or hide all the frame's decorations at once: its axes, their labels and its name label (show_axes, show_axes_labels, show_name_label).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
logical,	intent(in)			::	show	true: all axes, axes labels and the name label

procedure, public :: show_name_label

private subroutine show_name_label(self, show)

Show or hide the name label (at the frame's origin; default shown).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self
logical,	intent(in)			::	show	(true: shown)

procedure, public :: show_state => vector_show_state

private subroutine vector_show_state(self)

The arrow's color, brighter when hovered and more when dragged.

Arguments

Type	Intent	Optional	Attributes		Name
class(VectorHandle),	intent(inout)			::	self

procedure, public :: sync

private recursive subroutine sync(self)

Copy the positions and attitudes of this frame and its descendants to their transform nodes (only those that changed since the last sync).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self

procedure, public :: tip

private pure function tip(self) result(p)

The arrow's tip: the display scale times the vector (frame coordinates).

Arguments

Type	Intent	Optional	Attributes		Name
class(VectorHandle),	intent(in)			::	self

Return Value real(kind=wp), (3)

procedure, public :: unfollow

private subroutine unfollow(self)

Stop following trajectories (the frame keeps its last position and attitude).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout)			::	self

procedure, public :: update

private recursive subroutine update(self, t)

Update this frame and its descendants for simulation time t (followed trajectories set positions and attitudes).

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(inout),		target	::	self
real(kind=wp),	intent(in)			::	t	simulation time

procedure, public :: vector

private pure function vector(self) result(v)

The vector (frame coordinates).

Arguments

Type	Intent	Optional	Attributes		Name
class(VectorHandle),	intent(in)			::	self

Return Value real(kind=wp), (3)

procedure, public :: world_matrix

private recursive function world_matrix(self) result(m)

The transform from this frame to the root of its tree, through the first parent at each level.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self

Return Value real(kind=wp), (4,4)

procedure, public :: world_matrix_at

private recursive function world_matrix_at(self, t) result(m)

The transform from this frame to the root of its tree at simulation time t (through the first parent at each level): each frame's local_matrix_at time t. The same as world_matrix after the tree's update at time t, for any t, without changing anything.

Arguments

Type	Intent	Optional	Attributes		Name
class(ReferenceFrame),	intent(in)			::	self
real(kind=wp),	intent(in)			::	t	simulation time

Return Value real(kind=wp), (4,4)

Source Code

    type, extends(DragHandle), public :: VectorHandle
        private
        real(wp) :: vector_(3) = [1.0_wp, 0.0_wp, 0.0_wp]   !! the vector (frame coordinates)
        real(wp) :: scale_ = 1.0_wp                         !! drawn as scale * vector (scene units)
        real(wp) :: head_size_ = 0.0_wp                     !! the head's length (scene units; 0: 0.2 of the arrow)
        type(c_ptr) :: switch = c_null_ptr                  !! shows the arrow (not when the vector is 0)
        type(c_ptr) :: shaft = c_null_ptr, head = c_null_ptr  !! the transforms of the unit shaft and head
        type(c_ptr) :: shaft_mesh = c_null_ptr, head_mesh = c_null_ptr  !! the unit shaft and head (colored by their materials)
    contains
        procedure :: set_vector, vector, tip
        procedure :: set_display_scale, display_scale
        procedure :: set_head_size, head_size
        procedure :: set_color => vector_set_color
        procedure :: handle_point => vector_handle_point
        procedure :: move_handle_point => vector_move_handle_point
        procedure :: show_state => vector_show_state
        procedure :: frame_info => vector_frame_info
        procedure :: bound => vector_bound
        procedure :: pick => vector_pick
        procedure :: build_contents => vector_build_contents
    end type VectorHandle

VectorHandle Derived Type

Contents

Variables

Constructor

Type-Bound Procedures

Source Code

type, public, extends(DragHandle) :: VectorHandle

Inherits

Components

Constructor

public interface VectorHandle

private function new_vector_handle(name, vector, color, scale) result(h)

Arguments

Return Value type(VectorHandle)

Type-Bound Procedures

procedure, public :: add_child

private function add_child(self, child) result(ok)

Arguments

Return Value logical

procedure, public :: attitude

private pure function attitude(self) result(q)

Arguments

Return Value real(kind=wp), (4)

procedure, public :: axes_labels_shown

private pure function axes_labels_shown(self)

Arguments

Return Value integer

procedure, public :: axes_shown

private pure function axes_shown(self)

Arguments

Return Value integer

procedure, public :: axis_label

private function axis_label(self, axis) result(text)

Arguments

Return Value character(len=:), allocatable

procedure, public :: bound => vector_bound

private subroutine vector_bound(self, center, radius)

Arguments

procedure, public :: build_contents => vector_build_contents

private subroutine vector_build_contents(self, viewer, group)

Arguments

procedure, public :: child

private function child(self, i) result(c)

Arguments

Return Value class(ReferenceFrame), pointer

procedure, public :: child_index

private function child_index(self, frame)

Arguments

Return Value integer

procedure, public :: color

private pure function color(self) result(c)

Arguments

Return Value real(kind=wp), (4)

procedure, public :: constraint

private pure function constraint(self)

Arguments

Return Value integer

procedure, public :: constraint_axis

private pure function constraint_axis(self) result(axis)

Arguments

Return Value real(kind=wp), (3)

procedure, public :: contents_shown

private pure function contents_shown(self)

Arguments

Return Value logical

procedure, public :: detach

private subroutine detach(self)

Arguments

procedure, public :: display_scale

private pure function display_scale(self)

Arguments

Return Value real(kind=wp)

procedure, public :: drag

private function drag(self, origin, dir) result(moved)

Arguments

Return Value logical

procedure, public :: draggable

private pure function draggable(self)

Arguments

Return Value logical