DragHandle Derived Type

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

Return Value logical

private pure function attitude(self) result(q)

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

Arguments

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

private pure function axes_labels_shown(self)

Which axes labels are shown (as axes_shown).

Arguments

Return Value integer

private pure function axes_shown(self)

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

Arguments

Return Value integer

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

The label text of axis X_AXIS, Y_AXIS or Z_AXIS.

Arguments

Return Value character(len=:), allocatable

private subroutine bound(self, center, radius)

The bounding sphere of what the frame draws, in its own coordinates (radius 0 if it draws nothing; extensions override it). Views use it for their default distance.

Arguments

private subroutine build_contents(self, viewer, group)

Add what this frame draws to group (a node handle). ReferenceFrame draws nothing itself (its axes and labels come later); extensions such as Sphere and Model override this.

Arguments

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

Child i (1 to num_children).

Arguments

Return Value class(ReferenceFrame), pointer

private function child_index(self, frame)

Index of frame among the children, or 0.

Arguments

Return Value integer

private pure function color(self) result(c)

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

Arguments

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

private pure function constraint(self)

The handle's constraint (HANDLE_*).

Arguments

Return Value integer

private pure function constraint_axis(self) result(axis)

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

Arguments

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

private pure function contents_shown(self)

Whether what the frame draws is shown (show_contents).

Arguments

Return Value logical

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

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

Return Value logical

private pure function draggable(self)

Whether the mouse may grab the handle.

Arguments

Return Value logical

private pure function dragged(self)

The handle is grabbed (until released).

Arguments

Return Value logical

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

private function follow_frame(self) result(f)

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

Arguments

Return Value class(ReferenceFrame), pointer

private function follower(self) result(f)

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

Arguments

Return Value type(TrajectoryFollower), pointer

private function frame_info(self) result(info)

What kind of frame this is (shown by frame_string; extensions override it).

Arguments

Return Value character(len=:), allocatable

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

Return Value character(len=:), allocatable

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

Return Value logical

pure function handle_point_interface(self) result(p) Prototype

The point the mouse grabs (frame coordinates).

Arguments

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

private recursive function has_light_source(self) result(has)

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

Arguments

Return Value logical

private pure function hovered(self)

The handle is under the cursor.

Arguments

Return Value logical

private pure function is_following(self)

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

Arguments

Return Value logical

private pure function label_alignment(self)

The labels' alignment (ALIGN_*).

Arguments

Return Value integer

private function label_font(self) result(font)

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

Arguments

Return Value character(len=:), allocatable

private pure function label_size(self)

The labels' size in pixels.

Arguments

Return Value integer

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

private pure function light_ambient(self) result(rgb)

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

Arguments

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

private pure function light_diffuse(self) result(rgb)

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

Arguments

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

private pure function light_source_enabled(self)

Whether this frame carries a light source.

Arguments

Return Value logical

private pure function light_specular(self) result(rgb)

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

Arguments

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

private pure function local_matrix(self) result(m)

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

Arguments

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

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

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

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

subroutine move_handle_point_interface(self, p) Prototype

Move the point to p (frame coordinates), and the drawing with it.

Arguments

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

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

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

private function name(self) result(n)

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

Arguments

Return Value character(len=:), allocatable

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

Return Value logical

private pure function name_label_shown(self)

Whether the name label is shown.

Arguments

Return Value logical

private function node(self) result(n)

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

Arguments

Return Value type(c_ptr)

private pure function num_children(self)

Number of children.

Arguments

Return Value integer

private pure function num_parents(self)

Number of parents.

Arguments

Return Value integer

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

Parent i (1 to num_parents).

Arguments

Return Value class(ReferenceFrame), pointer

private function parent_index(self, frame)

Index of frame among the parents, or 0.

Arguments

Return Value integer

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

Pick what the frame draws (see the module documentation): to_root is its transform to the root frame; hits are added to hits(1:n). A plain frame: its origin, if it shows axes or its name label.

Arguments

private pure function pickable(self)

Whether pick tests what this frame draws (set_pickable).

Arguments

Return Value logical

private pure function position(self) result(p)

Position relative to the parent frame.

Arguments

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

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

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

private pure function priority(self)

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

Arguments

Return Value integer

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

private subroutine release(self)

Let the handle go.

Arguments

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

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

Arguments

Return Value logical

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

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

private subroutine set_color(self, color)

The color of the frame's decorations: [r, g, b] (alpha unchanged) or [r, g, b, a].

Arguments

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

private subroutine set_draggable(self, draggable)

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

Arguments

private subroutine set_hovered(self, hovered)

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

Arguments

private subroutine set_label_alignment(self, alignment)

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

Arguments

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

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

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

private subroutine set_light_diffuse(self, rgb)

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

Arguments

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

private subroutine set_light_specular(self, rgb)

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

Arguments

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

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

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

private subroutine set_position(self, position)

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

Arguments

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

private subroutine set_x_label(self, text)

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

Arguments

private subroutine set_y_label(self, text)

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

Arguments

private subroutine set_z_label(self, text)

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

Arguments

private subroutine show_axes(self, axes)

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

Arguments

private subroutine show_axes_labels(self, labels)

Which axes labels to show (as show_axes).

Arguments

private subroutine show_contents(self, show)

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

Arguments

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

private subroutine show_name_label(self, show)

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

Arguments

subroutine show_state_interface(self) Prototype

Draw the handle as hovered, dragged or neither (hovered, dragged).

Arguments

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

private subroutine unfollow(self)

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

Arguments

private recursive subroutine update(self, t)

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

Arguments

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

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

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

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