| Procedure | Location | Procedure Type | Description |
|---|---|---|---|
| add | vkf_shapes | Subroutine | Add |
| add_artist | vkf_artists | Subroutine | Add an artist (it must stay alive while added). Artists added after the frame is shown are built and compiled at the next update. |
| add_attitude | vkf_trajectory | Subroutine | Add an attitude quaternion [x, y, z, w] for the next time that has none.
|
| add_child | vkf_frames | Function | Add |
| add_color | vkf_trajectory | Subroutine | Add a color ([r, g, b], alpha 1, or [r, g, b, a], 0 to 1) for the next
time that has none. |
| add_elevation_layer | vkf_terrain | Subroutine | Add an elevation layer: |
| add_hud_text | vkf_window | Subroutine | Show |
| add_image_layer | vkf_terrain | Subroutine | Add an image layer: |
| add_intermediates | vkf_artists | Subroutine | Compute the intermediate markers not computed yet (all of them when counted from the end), and write them. |
| add_layer | vkf_terrain | Subroutine | Keep |
| add_name | vkf_sky | Subroutine | Remember the name of the star just read (self%n_stars), if it has one. |
| add_pick_hit | vkf_frames | Subroutine | Add |
| add_point | vkf_trajectory | Subroutine | Add a point: a time with an optional position, attitude and color ([r, g, b] or [r, g, b, a]). |
| add_points | vkf_trajectory | Subroutine | Add points in bulk: times |
| add_position | vkf_trajectory | Subroutine | Add a position (the first dof elements of |
| add_time | vkf_trajectory | Subroutine | Add a time at the end of the time list. |
| add_trajectory | vkf_follower | Subroutine | Also follow |
| add_view | vkf_window | Subroutine | Add |
| after_fields | vkf_sky | Function | The text of |
| alignment | vkf_hud | Function | Which point of the text is at its position (an ALIGN_* constant). |
| append | vkf_shapes | Subroutine | Append points b to a (allocatable, (3, n)). |
| append | vkf_frames | Subroutine | Add |
| apply_attitude | vkf_sky | Subroutine | The attitude matrix (column-major 4x4) into a sky node's style. |
| apply_camera_controls | vkf_window | Subroutine | Give the zoom speed and throw to the trackball (if open). |
| apply_color | vkf_shadow | Subroutine | A region's color, through its mesh's material (the unlit shader multiplies the vertex color, white, by the diffuse color). |
| apply_highlight | vkf_artists | Subroutine | Give the highlight |
| apply_layer | vkf_terrain | Subroutine | Add |
| apply_light | vkf_frames | Subroutine | Give the light source's node its colors (if it has been made). |
| apply_material | vkf_sphere | Subroutine | The material, with the diffuse color times the body's color (without a texture), and the twilight, on every mesh built. |
| apply_material_to | vkf_sphere | Subroutine | The material, with the diffuse color times the body's color (without a
texture), and the twilight, on mesh |
| apply_mode | vkf_sky | Subroutine | Show or hide the texture, the constellations and the stars (and their names), as the draw mode says. |
| apply_name_attitude | vkf_sky | Subroutine | The sky's attitude into the star names' transform. |
| apply_settings | vkf_terrain | Subroutine | Give the lighting and the frame's color to the map (if made). |
| apply_style | vkf_line_chain | Subroutine | Give the chain's style (color, width or size, pattern, highlight, marker shape) to the node |
| apply_style | vkf_line_segments | Subroutine | Give the line width and dash pattern to the chain (if built). |
| apply_window_light | vkf_window | Subroutine | Give the renderer's window light its colors and position (if open). |
| arrow | vkf_geometry | Subroutine | An arrow (OpenFrames' Vector: a cylinder body and a cone head) from
|
| arrow_create | vkf_geometry | Function | An arrow mesh node (see arrow) of color |
| arrow_size | vkf_geometry | Subroutine | Number of vertices and triangle indices of |
| arrow_sizes | vkf_handles | Subroutine | The arrow's length, its head's length and radius (scene units). |
| art_point | vkf_artists | Function | Point i from |
| art_point_between | vkf_artists | Function | The point at time t between points k and k2 (interpolated in the data frame), in the drawable's coordinates (by the transform at time t). |
| art_points | vkf_artists | Subroutine | Points i1 .. i2 (every |
| artist | vkf_artists | Function | Artist i (1 to num_artists). |
| artist_pickable | vkf_artists | Function | Whether pick tests what this artist draws. |
| artist_release | vkf_artists | Subroutine | Forget the render nodes (after the artist's group was removed from the scene): build starts again. |
| artist_set_pickable | vkf_artists | Subroutine | Whether pick tests what this artist draws (default true; e.g. false for a spacecraft's marker beside its orbit's curve). |
| aspect_ratio | vkf_window | Function | The width / height of the window drawn: a host's (from resize), or of the window's own, as it is now. |
| attach_frames | vkf_artists | Subroutine | Give the artists the frames: this one (their points' coordinates) and the data frame (if set, and in the same tree). |
| attitude | vkf_frames | Function | Attitude relative to the parent frame, a quaternion [x, y, z, w]. |
| attitude | vkf_sky | Function | The sky's attitude in the root frame (quaternion [x, y, z, w]). |
| attitude | vkf_trajectory | Function | Attitude i (quaternion [x, y, z, w]). |
| attitudes | vkf_trajectory | Subroutine | Pointer to the attitudes (4, num_attitudes), without copying. |
| auto_attenuate | vkf_artists | Function | Whether the markers are auto-attenuated. |
| auto_lod | vkf_sphere | Function | Whether level of detail is on. |
| axes_bound | vkf_shapes | Subroutine | The bounding sphere: the origin, radius the axis length. |
| axes_build_contents | vkf_shapes | Subroutine | Draw the axes under |
| axes_frame_info | vkf_shapes | Function | What kind of frame this is: 'CoordinateAxes'. |
| axes_labels_shown | vkf_frames | Function | Which axes labels are shown (as axes_shown). |
| axes_set_color | vkf_shapes | Subroutine | The axes' color (lines and ticks). |
| axes_shown | vkf_frames | Function | Which axes vectors are shown (NO_AXES, or X_AXIS, Y_AXIS, Z_AXIS combined). |
| axis_label | vkf_frames | Function | The label text of axis X_AXIS, Y_AXIS or Z_AXIS. |
| axis_length | vkf_shapes | Function | The axes' length (scene units). |
| axis_width | vkf_shapes | Function | The axis lines' width (window units). |
| background_color | vkf_window | Function | The background color [r, g, b]. |
| begin_panel | vkf_gui | Subroutine | A panel titled |
| better | vkf_artists | Function | A candidate closer to the cursor than the best so far (or as close, and nearer). |
| body | vkf_shadow | Function | The body casting the shadow (null if not set). |
| body_radius | vkf_shadow | Function | The body's radius used (0: none known). |
| body_radius | vkf_terrain | Function | The body's equatorial radius in scene units (from its profile: the Moon's for 'moon', else the Earth's). |
| bound | vkf_frames | Subroutine | 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. |
| build_artist | vkf_artists | Subroutine | Create artist k's node (compiled now if the frame is already shown). |
| build_contents | vkf_frames | Subroutine | Add what this frame draws to |
| build_decorations | vkf_frames | Subroutine | The axes (arrows), axes labels and name label, each under a switch, in the frame's color (OpenFrames' ReferenceFrame decorations). |
| build_light | vkf_frames | Subroutine | The light source's node: a point light at the origin, under a switch. |
| build_lod_mesh | vkf_sphere | Subroutine | Build level-of-detail mesh k (lod_segments(k) segments around) and add it
to the level-of-detail node (compiled for the windows if |
| build_marker_nodes | vkf_artists | Subroutine | The start, end and intermediate marker nodes, in the artist's group (compiled now if it is already shown). |
| button | vkf_gui | Function | A button: true once after it was clicked. |
| cache_directory | vkf_cache | Function | The cache directory, created if it doesn't exist yet (e.g. a VKFRAMES_CACHE_DIR not made yet); '' if there is none or it can't be created: nothing is cached. |
| camera_between | vkf_view | Function | The camera a fraction |
| camera_orientation | vkf_view | Subroutine | A camera's orientation (columns: right, up, back, as a quaternion) and its distance from eye to center (at least a tiny one). |
| camera_throw | vkf_window | Function | Whether the camera keeps moving after a released drag (set_camera_throw). |
| capture | vkf_window | Function | Save the last frame as an image (format from the file extension, e.g. .png). Returns false on failure. |
| chain_build | vkf_artists | Subroutine | Create the chain of buffers (sized for the points now) and the trace
tail under |
| chain_init | vkf_artists | Subroutine | The chain, colored if the trajectory's colors are drawn. |
| chain_points_per_point | vkf_artists | Function | Chain points per trajectory point: 1, or 2 for a surface (a pair each). |
| chain_release | vkf_artists | Subroutine | Forget the render nodes: the chain and the tail (see artist_release). |
| chain_update | vkf_artists | Subroutine | Write the points added (all of them on a redraw), and draw them all or, in trace mode, those passed and the tail to the point at time t. |
| check_status | vkf_layer | Subroutine | Report a failed rendering-layer call (a status not 0), saying where
( |
| checkbox | vkf_gui | Function | A checkbox showing |
| child | vkf_frames | Function | Child i (1 to num_children). |
| child_index | vkf_frames | Function | Index of |
| chosen_trajectory | vkf_follower | Function | The trajectory to follow at time t: the current one if it contains t, else the first that does, else the closest. |
| chunk_bounds | vkf_line_chain | Subroutine | Chunk j's points (strips: first .. first + n - 1 of the chain) and the bounding box of them (n = 0 if none are measured yet), e.g. to skip a chunk when picking. |
| clear | vkf_trajectory | Subroutine | Remove all points (keeping the memory). |
| clear_cache | vkf_cache | Function | Delete the cache's files (converted fonts, compiled shaders; nothing else in the directory) and its fonts and shaders directories if left empty (the cache directory itself is kept): the number of files removed, or -1 if some couldn't be. They are made again when next needed. |
| clear_callback | vkf_line_segments | Subroutine | Stop computing the segments with a callback (they stay as last set). |
| clear_default_view_parameters | vkf_view | Subroutine | Forget the camera set by set_default_view_parameters (back to the default view distance). |
| clear_event_handler | vkf_window | Subroutine | Give the events to no handler (the built-in keys remain). |
| clear_segments | vkf_line_segments | Subroutine | Remove all segments. |
| clock | vkf_window | Function | The window's simulation clock (e.g. to synchronize it with another window's). |
| clock_angles | vkf_shapes | Function | The vertices' clock angles (radians). |
| close | vkf_window | Subroutine | Close the window (waiting for the GPU). The scene is kept, and can be shown again in another window. So are the window's settings (views, HUD texts, sky, handler, time): open again (e.g. on a host's new native window, after Qt destroyed the old one) shows them as before. |
| closed_segments | vkf_shapes | Function | Points along a closed curve, as separate segments: pairs (p(i), p(i+1)). |
| color | vkf_hud | Function | The color: [r, g, b, a] (0 to 1). |
| color | vkf_frames | Function | The color of the frame's decorations, [r, g, b, a] (0 to 1). |
| color | vkf_trajectory | Function | Color i ([r, g, b, a]). |
| color_at | vkf_artists | Function | The trajectory's color at time t (between points i and i + 1: blended),
|
| color_slice | vkf_line_chain | Subroutine | As slice, for the colors of a colored chain: c(rgba, point) of points lo .. hi of chunk j (null if not colored or nothing there). |
| colors | vkf_trajectory | Subroutine | Pointer to the colors (4, num_colors; single precision, as drawn), without copying. |
| combo | vkf_gui | Function | A combo box (a drop-down menu) of |
| compact | vkf_trajectory | Subroutine | Free the storage not used: each array is reallocated to the points it holds (one copy, an array at a time), and arrays holding none are deallocated. For a trajectory that is complete: growing doubles the storage, so up to about half of it can be unused. The data and what is drawn of them don't change; pointers from times, positions, ... must be fetched again. Points can still be added (storage grows again). |
| cone_angles | vkf_shapes | Function | The vertices' cone angles (radians). |
| cone_bound | vkf_shapes | Subroutine | The bound of the apex and the base. |
| cone_build_contents | vkf_shapes | Subroutine | Draw the cone under |
| cone_color | vkf_shapes | Function | The sides' color [r, g, b, a]. |
| cone_frame_info | vkf_shapes | Function | What kind of frame this is: 'PolyhedralCone'. |
| cone_is_visible | vkf_shapes | Function | Whether |
| cone_length | vkf_shapes | Function | The cone's length along the boresight (scene units). |
| cone_line_color | vkf_shapes | Function | The edges' and base outline's color [r, g, b, a]. |
| cone_set_line_color | vkf_shapes | Subroutine | The edges' and base outline's color. |
| constellation_file_read | vkf_sky | Function | The constellation file read ('' for none). |
| constellation_line | vkf_sky | Subroutine | Constellation line i (1 to num_constellation_lines): its ends' directions (unit vectors, sky frame). |
| constellation_lines | vkf_sky | Subroutine | Constellation i's lines (1 to num_constellations): first .. last (see constellation_line; none if last < first). |
| constellation_name | vkf_sky | Function | Constellation i's name (1 to num_constellations). |
| constellations | vkf_sky | Function | Whether the constellations are drawn (as set). |
| constrained | vkf_handles | Function | Where the ray (origin, unit dir; root frame) meets the constraint taken
at the grab, the frame at transform |
| constraint | vkf_handles | Function | The handle's constraint (HANDLE_*). |
| constraint_axis | vkf_handles | Function | The constraint's normal or direction (unit vector, frame coordinates). |
| contents_shown | vkf_frames | Function | Whether what the frame draws is shown (show_contents). |
| CoordinateAxes | vkf_shapes | Interface | The CoordinateAxes constructor: |
| count_frame | vkf_window | Subroutine | Count a frame for the frame rate (render_stats): its duration, and the rate over about half a second. |
| counted | vkf_artists | Function | Index of the j-th point counted in the intermediate markers' direction. |
| create_hud | vkf_window | Subroutine | The node of HUD text k, added to the window (compiled if it runs). |
| create_huds | vkf_window | Subroutine | Create the window's nodes for its HUD texts (before its first frame). |
| cross | vkf_math | Function | The cross product a x b. |
| current_view | vkf_window | Function | The view shown (the default view of the scene's root if none were added). |
| cursor_ray | vkf_window | Function | The ray from the eye through point (x, y) of the window (-1 to 1 across it, y up: as the event handler's positions), in the root frame, as at the last frame: its origin (the eye; in an orthographic view, on the eye's plane) and its direction (a unit vector). False before the first frame. E.g. where the cursor points on a plane: vkf_pick's ray_plane. |
| curve_chain_kind | vkf_artists | Function | The chain: a line strip. |
| curve_color | vkf_artists | Function | The line's color [r, g, b, a]. |
| curve_dash_mode | vkf_artists | Function | The dash pattern's layout: DASH_SCENE, DASH_SCREEN or DASH_FIXED. |
| curve_highlight | vkf_artists | Function | The curve's highlight: HIGHLIGHT_* (added; HIGHLIGHT_NONE: not highlighted). |
| curve_init_chain | vkf_artists | Subroutine | The chain (ChainArtist's), with the curve's level of detail. |
| curve_new_tail | vkf_artists | Function | The trace tail: a line of two points (white unless the points' colors are drawn). |
| curve_pattern | vkf_artists | Subroutine | The dash pattern: its |
| curve_pick | vkf_artists | Subroutine | A curve's best hit: on the segments drawn (and the trace tail). |
| curve_points | vkf_artists | Function | Number of points to draw (1 if all sources are zero: a point at the origin). |
| curve_set_color | vkf_artists | Subroutine | The line's color: [r, g, b] (alpha unchanged) or [r, g, b, a], 0 to 1 (with the trajectory's point colors drawn: for points without one). |
| curve_set_dash_mode | vkf_artists | Subroutine | How the dash pattern (and a trail's) is laid out: DASH_SCENE (the
default) anchored to the line: a dash stays put on it as the view
changes, its size in scene units (one per line and view, from 0.7 to
1.4 times the pattern's on screen, changing by doubling as it zooms);
DASH_SCREEN screen-locked, as OpenGL's line stipple (OpenFrames'):
every dash the pattern's length in pixels, at any zoom and depth,
sliding along the line as the view changes; DASH_FIXED a fixed
length of the line, as paint on it: never changing, so zooming in the
dashes grow on screen, and out they shrink (under a pixel, blending
into a fainter solid line); |
| curve_set_highlight | vkf_artists | Subroutine | Highlight the curve (see the module documentation): |
| curve_set_pattern | vkf_artists | Subroutine | A dash pattern, as OpenGL's line stipple (OpenFrames' setPattern): each
bit of the 16-bit |
| curve_set_trajectory | vkf_artists | Subroutine | Draw |
| curve_set_width | vkf_artists | Subroutine | The line's width in window units (logical pixels). |
| curve_style | vkf_artists | Subroutine | The style: the artist's color, or white if the points' colors are drawn (the shader multiplies them by it). |
| curve_update | vkf_artists | Subroutine | Write the points added (all of them on a redraw), and draw them all, or in trace mode those passed and the tail to the point at time t, or with a trail the window about time t. |
| curve_width | vkf_artists | Function | The line's width (window units). |
| CurveArtist | vkf_artists | Interface | The CurveArtist constructor: |
| CustomLineSegments | vkf_line_segments | Interface | The CustomLineSegments constructor: |
| dash_mode_of | vkf_line_chain | Function | The dashes' layout (set_dash_mode). |
| data_changed | vkf_artists | Function | Whether the trajectory changed since last drawn; |
| data_frame | vkf_artists | Function | The frame the data are in (set_data_frame; null: this frame). |
| data_revision | vkf_follower | Function | The sum of the followed trajectories' revisions and generations: it grows with any change to their data (the set of trajectories itself changes the motion_stamp). |
| data_sources | vkf_artists | Function | The x, y and z data sources. |
| data_sources | vkf_follower | Function | Where the followed position's x, y and z come from. |
| data_to_shown | vkf_artists | Function | The transform from the data frame's coordinates to the drawable's at time t. |
| data_valid | vkf_follower | Function | True if every followed trajectory has the data the position sources use. |
| DataSource | vkf_trajectory | Interface | The DataSource constructor: |
| decreasing_times | vkf_artists | Function | Whether points 1 .. n have decreasing times (a trajectory propagated backwards). |
| default_key | vkf_window | Subroutine | The built-in keys (OpenFrames'): |
| default_keys | vkf_window | Function | Whether the built-in keys are on (set_default_keys). |
| default_view_distance | vkf_view | Function | The radius framed when the view is reset (<= 0: the viewed frame's bound). |
| default_view_parameters | vkf_view | Subroutine | The camera after a reset (view-frame coordinates; all zero if none is set). |
| detach | vkf_line_chain | Subroutine | Remove the chunks from the group (also while running), and release them. |
| detach | vkf_frames | Subroutine | Remove this frame from all its parents and children (before it goes out of scope or is deallocated while in a tree). |
| device_info | vkf_window | Function | The window's Vulkan device and driver (see vkf_diagnostics); '' while it isn't open. |
| dispatch_event | vkf_window | Subroutine | One event (see vkf_viewer_events): kind, key, key base, modifiers, button, buttons held, x, y (framebuffer pixels from the top left), the render area (x, y, width, height). |
| dispatch_events | vkf_window | Subroutine | The keyboard and mouse events of the last frame, to the handler and the built-in keys (stopping if the window is closed meanwhile). |
| display_scale | vkf_handles | Function | The display scale. |
| distance | vkf_shadow | Function | The distance between the body and the light at the last update. |
| distance | vkf_line_chain | Function | A strip's distance along it at point i, as written. |
| dof | vkf_trajectory | Function | Degrees of freedom (2 or 3) of positions and optionals. |
| drag | vkf_handles | Function | 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. |
| drag_handle | vkf_window | Subroutine | The grabbed handle dragged to (x, y). |
| draggable | vkf_handles | Function | Whether the mouse may grab the handle. |
| dragged | vkf_handles | Function | The handle is grabbed (until released). |
| draw | vkf_line_chain | Subroutine | Draw points 1 .. k (no upload). |
| draw_axes | vkf_shapes | Function | Which axes are drawn: an ior of X_AXIS, Y_AXIS, Z_AXIS. |
| draw_mode | vkf_shapes | Function | What is drawn: an ior of CONE_SIDES, CONE_EDGES, CONE_BASE_OUTLINE. |
| draw_mode | vkf_sky | Function | What is drawn: SKY_NONE, or a sum of SKY_TEXTURE and SKY_STARS. |
| draw_range | vkf_line_chain | Subroutine | Draw points i1 .. i2 only (chain indices; none if i2 < i1): e.g. a trace of decreasing times, its last points. |
| draw_trail | vkf_artists | Subroutine | A trail at time t: the points within its window (and the one beyond each end: the GPU cuts the segments at the cutoffs) drawn, and the distances along the curve at t and at the window's edges given to the shader (see vkf_line_set_trail), as distances from t's in the direction of time; times beyond the trajectory's are extrapolated from its end segments. |
| draw_written | vkf_artists | Subroutine | Draw the points written: all of them (the tail hidden) or, in trace
mode, those passed by time t (times up to it) and the tail from the
latest of them to the point at t (unchanged if nothing |
| drawable_build_contents | vkf_artists | Subroutine | Build the artists' nodes under |
| drawable_frame_info | vkf_artists | Function | What kind of frame this is: 'DrawableTrajectory'. |
| drawable_pick | vkf_artists | Subroutine | Picks what the artists draw (see the module documentation), then the frame's origin (if it shows axes or its name label). |
| drawable_set_highlight | vkf_artists | Subroutine | Highlight all the frame's curve and segment artists (see set_highlight; HIGHLIGHT_NONE: none of them). |
| drawable_update | vkf_artists | Subroutine | Update the frame (and its descendants), then its artists. |
| DrawableTrajectory | vkf_artists | Interface | The DrawableTrajectory constructor: |
| drawn_color | vkf_artists | Function | The color of point i (1 to num_drawn) as drawn: read back from the line buffers. |
| drawn_distance | vkf_artists | Function | The distance along the curve at point i (1 to num_drawn), as drawn (for the dash pattern): read back from the line buffers. |
| drawn_length | vkf_shadow | Function | The length drawn at the last update. |
| drawn_marker | vkf_artists | Function | Where marker |
| drawn_pair | vkf_artists | Subroutine | The pair at trajectory point i (1 to num_drawn) as drawn, its start a and end b: read back from the buffers. |
| drawn_point | vkf_artists | Function | Point i (of the trajectory's: first_drawn to first_drawn + num_drawn - 1 drawn) as written: read back from the line buffers. |
| drawn_segment | vkf_artists | Subroutine | Segment s (at point 1 + (s-1) stride; first_drawn to first_drawn + num_drawn - 1 drawn) as written: read back from the line buffers. |
| drawn_segment | vkf_line_segments | Subroutine | Segment i as drawn (read back from the GPU buffers, for checks): its endpoints and colors. |
| drop_colors | vkf_shapes | Subroutine | No colors per vertex. |
| elevation | vkf_terrain | Function | The height of the terrain (scene units, above the body's sphere or
ellipsoid) at latitude and longitude |
| ellipsoid | vkf_geometry | Subroutine | A triaxial ellipsoid with semi-axes |
| ellipsoid_create | vkf_geometry | Function | An ellipsoid mesh node with semi-axes |
| ellipsoid_size | vkf_geometry | Subroutine | Number of vertices and triangle indices of |
| elliptic_frame_info | vkf_shapes | Function | What kind of frame this is: 'EllipticCone'. |
| elliptic_is_visible | vkf_shapes | Function | Inside the elliptic cone (exactly; OpenFrames' EllipticCone::isVisible). |
| elliptic_primary_angles | vkf_shapes | Subroutine | The half-angles along x (a) and y (b), radians. |
| elliptic_set_primary_angles | vkf_shapes | Subroutine | The half-angles along x (a) and y (b), radians (0 to 90 degrees). |
| elliptic_vertices | vkf_shapes | Subroutine | 120 vertices (every 3 degrees), cone angle a b / sqrt(b^2 cos^2 + a^2 sin^2) (OpenFrames' createEllipticCone). |
| EllipticCone | vkf_shapes | Interface | The EllipticCone constructor: |
| encoder_options | vkf_window | Function | ffmpeg's encoder options for |
| end_data_sources | vkf_artists | Function | The x, y and z data sources of the segments' end points. |
| end_panel | vkf_gui | Subroutine | End the panel started by begin_panel. |
| end_relative | vkf_artists | Function | Whether the ends are relative (see set_end_relative). |
| end_rgba | vkf_artists | Function | The color of point i for a start or end marker: the trajectory's (its own if none), with point colors. |
| event_handler | vkf_window | Function | The event handler (null if none). |
| face_color | vkf_shapes | Function | The faces' color [r, g, b, a]. |
| field_of_view | vkf_view | Function | The vertical field of view (degrees) of the perspective projection. |
| find | vkf_frames | Function | Index of |
| find_data_file | vkf_files | Function | The path of data file |
| find_font | vkf_text | Function | The path of font |
| find_in_dirs | vkf_files | Function | The path dir/name of the first directory in |
| first_drawn | vkf_artists | Function | The first point drawn (1, or in trace mode of decreasing times the earliest point passed): points first_drawn .. first_drawn + num_drawn - 1. |
| fly | vkf_window | Subroutine | The camera of an active flight to view |
| fm_frame | vkf_window | Function | The root frame (null if none). |
| fm_num_updates | vkf_window | Function | Number of scene updates so far (update). |
| fm_set_frame | vkf_window | Subroutine | Set the root frame of the scene (not owned: it must stay alive while managed). (The scene is for a window: this also starts loading the Vulkan driver for the first one, in the background, which can take a few tenths of a second.) |
| fm_update | vkf_window | Subroutine | Update the scene for time t (followed trajectories, artists) and copy
the frames' positions and attitudes to the renderer, unless another
window already did for this time since this window's last frame.
|
| follow | vkf_frames | Subroutine | Follow |
| follow_data | vkf_follower | Function | What is followed: FOLLOW_POSITION and/or FOLLOW_ATTITUDE (combined with ior). |
| follow_frame | vkf_frames | Function | The frame the followed data are in (follow's |
| follow_mode | vkf_follower | Function | How time outside the trajectories is handled: FOLLOW_LOOP or FOLLOW_LIMIT. |
| followed_pose | vkf_frames | Subroutine | The followed position and attitude at time t, in the parent's
coordinates (from the data frame's, if follow had one, by both
frames' poses at time t); |
| follower | vkf_frames | Function | The frame's trajectory follower, for finer control (data sources, time offset, ...). |
| font | vkf_hud | Function | The font file ('' for the default font). |
| forget_handles | vkf_window | Subroutine | No handle hovered or grabbed (the scene or the window changes). |
| frame | vkf_window | Function | Render one frame: advance the clock, update the frames and draw. Returns false once the window has been closed (or on failure). |
| frame_info | vkf_frames | Function | What kind of frame this is (shown by frame_string; extensions override it). |
| frame_matrix | vkf_math | Function | A frame's local-to-parent transform, as OpenFrames' FrameTransform builds it: translate(position) * rotate(attitude) * scale(scale) * translate(-pivot). |
| frame_radius | vkf_shadow | Function | A body's own radius: a Sphere's equatorial one, a TerrainBody's; else 0. |
| frame_string | vkf_frames | Function | The tree below this frame, one line per frame ("name (info)"), in OpenFrames' createFrameString format: children are prefixed "|-->". |
| frame_to_root | vkf_view | Function | The transform from |
| FrameManager | vkf_window | Interface | The FrameManager constructor: |
| generation | vkf_trajectory | Function | Number of times the data were cleared (by clear, set_dof or set_num_optionals): while it is unchanged, data were only appended. |
| get_camera | vkf_window | Subroutine | The camera of the view shown (from the last frame): eye, center and up
in the view frame's coordinates (OpenFrames' trackball
getTransformation), or in its root frame's if |
| get_font | vkf_text | Function | The font handle for |
| get_trajectory | vkf_artists | Function | The trajectory drawn (null if none). |
| grab | vkf_handles | Function | 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. |
| grab_handle | vkf_window | Subroutine | A left press grabbed the mouse (the grab armed): the hovered handle grabbed. |
| grid_bound | vkf_shapes | Subroutine | The bounding sphere: the origin, radius the largest semi-axis. |
| grid_build_contents | vkf_shapes | Subroutine | Draw the grid under |
| grid_frame_info | vkf_shapes | Function | What kind of frame this is: 'LatLonGrid'. |
| grid_parameters | vkf_shapes | Subroutine | The ellipsoid's semi-axes and the line spacings, as OpenFrames' getParameters. |
| grid_set_color | vkf_shapes | Subroutine | The lines' color. |
| grid_set_parameters | vkf_shapes | Subroutine | The ellipsoid's semi-axes (> 0; e.g. a Sphere's radii, a little larger to draw above its surface) and the line spacings (radians; 0 for no latitude or longitude lines), as OpenFrames' setParameters. |
| grow_attitudes | vkf_trajectory | Subroutine | Grow the attitudes' storage to hold at least |
| grow_colors | vkf_trajectory | Subroutine | Grow the colors' storage to hold at least |
| grow_positions | vkf_trajectory | Subroutine | Grow the positions' (and optionals') storage to hold at least |
| grow_times | vkf_trajectory | Subroutine | Grow the times' storage to hold at least |
| handler_before_draw | vkf_window | Subroutine | Called each frame just before drawing, the scene at time |
| handler_before_update | vkf_window | Subroutine | Called each frame with its time |
| handler_button_press | vkf_window | Subroutine | A mouse button (MOUSE_LEFT, MOUSE_MIDDLE, MOUSE_RIGHT) was pressed at (x, y) (see mouse_motion). |
| handler_button_release | vkf_window | Subroutine | A mouse button was released at (x, y) (see button_press). |
| handler_handle_drag | vkf_window | Subroutine | A handle (vkf_handles) was grabbed (DRAG_START), dragged (DRAG_MOVE: it has moved) or released (DRAG_END) with the mouse: e.g. compute again what depends on it (see the module documentation). |
| handler_key_press | vkf_window | Subroutine | A key was pressed: |
| handler_key_release | vkf_window | Subroutine | A key was released (see key_press). |
| handler_mouse_motion | vkf_window | Subroutine | The mouse moved to (x, y) (-1 to 1 across the window, y up), with the buttons held (left, middle, right): moving (none held, OpenFrames' mouse motion) or dragging. |
| handles_shown | vkf_handles | Function | Whether any handle has been shown in a window (so windows look for handles under the cursor). |
| has_light_source | vkf_frames | Function | Whether this frame or one of its descendants has a light source enabled. |
| has_model | vkf_model | Function | True if a model was read (or shared). |
| has_trail | vkf_artists | Function | Whether the curve has a trail (set_trail). |
| has_vertex_colors | vkf_shapes | Function | Whether the faces have a color per vertex. |
| head_size | vkf_handles | Function | The head's length set (0: 0.2 of the arrow's). |
| home | vkf_view | Subroutine | The default camera (eye, center, up in view-frame coordinates) for a
viewport of aspect ratio |
| hover_handle | vkf_window | Subroutine | The handle under (x, y), if any, hovered (the one before not), and the
grab armed for it. Of handles on the same spot: the nearest on the
screen; within |
| hovered | vkf_handles | Function | The handle is under the cursor. |
| HUDText | vkf_hud | Interface | The HUDText constructor: |
| identity_matrix | vkf_math | Function | The 4x4 identity matrix. |
| in_range | vkf_shapes | Function | Along the boresight (-z) between the distances (a point ahead of the apex). |
| in_transition | vkf_window | Function | True while the camera is flying (a transition). |
| init | vkf_line_chain | Subroutine | Draw under |
| intermediate_direction | vkf_artists | Function | Where intermediate markers are counted from (MARKER_START or MARKER_END). |
| intermediate_spacing | vkf_artists | Function | Spacing of intermediate markers. |
| intermediate_type | vkf_artists | Function | How intermediate markers are spaced (INTERMEDIATE_*). |
| intermediates_by_data | vkf_artists | Subroutine | Every int(spacing)-th point after the first, before the last. |
| intermediates_by_distance | vkf_artists | Subroutine | Every |
| intermediates_by_time | vkf_artists | Subroutine | Every |
| interpolate_attitude | vkf_follower | Subroutine | Slerp of the attitude at time t; the first/last attitude outside the time
range. |
| interpolate_position | vkf_follower | Subroutine | Linear interpolation of the position (from |
| is_built | vkf_line_chain | Function | True if the chain has a group to draw under (between init and release). |
| is_colored | vkf_line_chain | Function | For lines and markers, whether each point has its own color (init's |
| is_descendant | vkf_frames | Function | True if |
| is_empty | vkf_trajectory | Function | True if the trajectory has no times. |
| is_following | vkf_frames | Function | Whether the frame follows trajectories (at least one, since follow). |
| is_following_time | vkf_follower | Function | True if following the simulation time plus an offset, false for a fixed time. |
| is_open | vkf_window | Function | Whether the window is open (not closed, by the program or the user). |
| is_paused | vkf_clock | Function | True if the simulation time is paused. |
| is_position_xyz | vkf_artists | Function | The sources are x, y, z of the position, unscaled. |
| is_recording | vkf_window | Function | Whether the window is recording a video. |
| is_shown | vkf_hud | Function | True if the text is shown. |
| is_time_paused | vkf_window | Function | Whether the simulation time is paused. |
| is_valid | vkf_gui | Function | False if the window has no GUI (not open). |
| is_valid | vkf_view | Function | True if the view has a frame to view. |
| key | vkf_window | Subroutine | A key press (pressed true) or release, as VSG key symbols and modifiers (ASCII for printable keys; vsg/ui/KeyEvent.h). |
| label_alignment | vkf_frames | Function | The labels' alignment (ALIGN_*). |
| label_create | vkf_text | Function | A label node: |
| label_font | vkf_frames | Function | The labels' font as set ('' for the renderer's default). |
| label_set_layout | vkf_text | Function | Change label |
| label_size | vkf_frames | Function | The labels' size in pixels. |
| last_time | vkf_follower | Function | The time (after looping) at the last update. |
| last_trajectory | vkf_follower | Function | The trajectory followed at the last update (null if none). |
| late_update | vkf_frames | Subroutine | 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'. |
| LatLonGrid | vkf_shapes | Interface | The LatLonGrid constructor: |
| length | vkf_shadow | Function | The length set (0: automatic). |
| level_of_detail | vkf_artists | Function | Whether level of detail is on. |
| library_versions | vkf_diagnostics | Function | The versions of vkframes and the libraries it uses. |
| light | vkf_shadow | Function | The light (null if not set). |
| light_ambient | vkf_window | Function | The ambient color of the window's light [r, g, b]. |
| light_ambient | vkf_frames | Function | The light source's ambient color [r, g, b]. |
| light_diffuse | vkf_window | Function | The diffuse color of the window's light [r, g, b]. |
| light_diffuse | vkf_frames | Function | The light source's diffuse color [r, g, b]. |
| light_position | vkf_window | Function | The position of the window's light (see set_light_position). |
| light_radius | vkf_shadow | Function | The light's radius used (0: none known). |
| light_source_enabled | vkf_frames | Function | Whether this frame carries a light source. |
| light_specular | vkf_window | Function | The specular color of the window's light [r, g, b]. |
| light_specular | vkf_frames | Function | The light source's specular color [r, g, b]. |
| lighting | vkf_terrain | Function | True if the body is lit by the scene's lights. |
| line_buffer | vkf_line_chain | Subroutine | The point buffer of a line or marker node: (xyz and distance, high/low, point). |
| line_node | vkf_shapes | Function | A line node through points xyz(3, n): a strip, or separate segments (points 1-2, 3-4, ...). |
| line_set_pattern | vkf_layer | Function | Set a line's dash pattern, as OpenGL's line stipple: each bit of the
16-bit |
| line_set_points | vkf_layer | Function | Set the points of a line strip ( |
| line_set_segments | vkf_layer | Function | Draw a line's points as separate segments (pairs of points: 1-2, 3-4, ...) instead of a strip. Set before its points are drawn. Returns 0, or -1 on failure. |
| line_set_style | vkf_layer | Function | Set the color ( |
| line_width | vkf_line_segments | Function | Line width (window units). |
| line_widths | vkf_shapes | Subroutine | Widths of the grid lines and of the equator and prime meridian (window units). |
| lit | vkf_shapes | Function | Whether the faces are lit. |
| local_matrix | vkf_frames | Function | The transform from this frame to its parent (4x4). |
| local_matrix_at | vkf_frames | Function | The transform from this frame to its parent at simulation time |
| lod_error | vkf_artists | Function | The error bounds of chunk j of the curve's points (for checks): how far the points skipped can be from the segments drawn at stride 2^k, k = 1, 2, ... (scene units). |
| lod_error | vkf_line_chain | Function | Chunk j's error bounds: how far the points skipped can be from the segments drawn at stride 2^k (k = 1 .. lod_levels; 0 where not known). |
| lookat_frame | vkf_view | Function | The frame looked at, for a view between frames (null if none). |
| make_axes | vkf_shapes | Subroutine | Make the axes' lines and tick marks, in place of the old (nothing before build_contents). |
| make_axis | vkf_frames | Subroutine | Axis k's arrow and label, in their switches (in place of the old ones; compiled first if the window already runs). |
| make_cone | vkf_shapes | Subroutine | Make the sides, edges and base outline (those the draw mode says), in place of the old. |
| make_cone_look_at | vkf_shapes | Subroutine | Place the cone's apex at |
| make_grid | vkf_shapes | Subroutine | Make the grid's lines (circles in 1 degree steps, meridians in 0.5 degree steps), in place of the old. |
| make_line_node | vkf_sky | Subroutine | The constellations node for the lines read and the settings, in place of the old one (none unless shown). |
| make_map | vkf_terrain | Subroutine | The map (in the contents group) for |
| make_name_label | vkf_frames | Subroutine | The name label (in place of the old one; compiled first if shown). |
| make_name_node | vkf_sky | Subroutine | The star names node for the current names and settings, in place of the old one: a label per named star drawn up to the names' magnitude, under the stars' switch (shown with them), turned by the sky's attitude. |
| make_plane | vkf_shapes | Subroutine | Make the disk, its circles and its radial lines (1 degree steps), in place of the old. |
| make_polyhedron | vkf_shapes | Subroutine | The polyhedron's nodes, made again (if shown). |
| make_star_node | vkf_sky | Subroutine | The star node for the current stars, in place of the old one. |
| make_texture_node | vkf_sky | Subroutine | The texture node for the current image, in place of the old one. |
| marker_build | vkf_artists | Subroutine | Create the marker nodes under |
| marker_color | vkf_artists | Function | The color of the start, intermediate or end markers ( |
| marker_data_sources | vkf_artists | Function | The x, y and z data sources. |
| marker_drawn_color | vkf_artists | Function | The color marker k of |
| marker_image_file | vkf_artists | Function | The marker image file ('' for none). |
| marker_node | vkf_shapes | Function | A marker node at points xyz(3, n), |
| marker_pick | vkf_artists | Subroutine | A marker artist's best hit: its start, end and intermediate markers drawn. |
| marker_point | vkf_artists | Function | Point i from the data sources (the origin if |
| marker_point_colors | vkf_artists | Function | Whether the trajectory's colors are drawn (set_point_colors). |
| marker_release | vkf_artists | Subroutine | Forget the render nodes (see artist_release). |
| marker_set_point_colors | vkf_artists | Subroutine | How intermediate markers are spaced: INTERMEDIATE_TIME, _DISTANCE or _DATA.
Point colors (default off): with the trajectory's colors (Trajectory%
add_color, or add's |
| marker_set_style | vkf_layer | Function | Set the color ( |
| marker_set_trajectory | vkf_artists | Subroutine | Draw |
| marker_set_x_data | vkf_artists | Function | Where the x (y, z) of the markers come from. Returns whether the trajectory has those data. |
| marker_set_y_data | vkf_artists | Function | Where the y of the markers come from (see set_x_data). |
| marker_set_z_data | vkf_artists | Function | Where the z of the markers come from (see set_x_data). |
| marker_shape | vkf_handles | Function | The marker's shape (MARKER_*). |
| marker_shape | vkf_artists | Function | Marker shape (a MARKER_* shape constant). |
| marker_size | vkf_handles | Function | The marker's size (window units). |
| marker_size | vkf_artists | Function | Marker size (window units). |
| marker_style | vkf_artists | Subroutine | Apply the colors, size, shape and attenuation radius (0: off) to the marker nodes. |
| marker_update | vkf_artists | Subroutine | Write the start, end and new intermediate markers if the trajectory changed, and draw them all or, in trace mode, those passed at time t. |
| marker_uses_colors | vkf_artists | Function | Whether the markers are drawn in the trajectory's colors: wanted, and it has some. |
| MarkerArtist | vkf_artists | Interface | The MarkerArtist constructor: |
| markers | vkf_artists | Function | Which markers are drawn (an ior of MARKER_* flags). |
| markers_passed | vkf_artists | Subroutine | The intermediate markers (in trajectory order) whose times are at most
t: |
| material | vkf_sphere | Subroutine | The material (each optional): ambient, diffuse, specular and emission colors and shininess. |
| measure | vkf_line_chain | Subroutine | The distances along the strip of points lo .. hi of chunk j: from the
previous point (in this chunk; the first point of a chunk after the
first is the previous chunk's last, measured before), or 0 at point 1.
From |
| mesh_arrays | vkf_layer | Subroutine | Pointers to the arrays of a mesh of |
| mesh_set_material | vkf_layer | Function | Set a lit mesh's material: ambient, diffuse, specular and emissive colors (rgba) and shininess (VSG's Phong: the ambient color scales the diffuse color reflected from ambient light). Returns 0, or -1 on failure (e.g. a mesh without a material). |
| Model | vkf_model | Interface | The Model constructor: |
| model_attitude | vkf_model | Function | Attitude of the model in its frame (quaternion [x, y, z, w]). |
| model_bound | vkf_model | Subroutine | The model's bounding sphere, in the model's own coordinates (before its transform). |
| model_build_contents | vkf_model | Subroutine | The model under the model transform. |
| model_file | vkf_model | Function | The model file ('' if none). |
| model_frame_bound | vkf_model | Subroutine | The model's bounding sphere in the frame (through the model transform). |
| model_frame_info | vkf_model | Function | The kind of frame: 'Model'. |
| model_pick | vkf_model | Subroutine | Picked on the model's bounding sphere (not its triangles); else at the frame's origin. |
| model_pivot | vkf_model | Function | The model's pivot, in its own coordinates (see set_model_pivot). |
| model_position | vkf_model | Function | Where the model's pivot is placed in its frame (frame coordinates). |
| model_scale | vkf_model | Function | Scale along the model's x, y and z axes. |
| motion_changed | vkf_artists | Subroutine | With data in another frame (transformed): |
| motion_key | vkf_frames | Subroutine | What the frame's motion depends on, for drawings that depend on it to
know when to redraw: |
| motion_stamp | vkf_follower | Function | The stamp of the last change of the follower's settings (the trajectories followed, what and how, the time); 0 if never changed. |
| mouse | vkf_window | Subroutine | A mouse event: kind MOUSE_MOVE, MOUSE_PRESS or MOUSE_RELEASE. |
| move_axis | vkf_frames | Subroutine | Place axis k (as move_x_axis), made again if the frame is shown. |
| move_chunks | vkf_line_chain | Subroutine | Chunks moved to a new array (their level-of-detail bounds moved, not copied). |
| move_x_axis | vkf_frames | Subroutine | Place the x axis vector: from |
| move_y_axis | vkf_frames | Subroutine | Place the y axis vector (as move_x_axis; OpenFrames' moveYAxis). |
| move_z_axis | vkf_frames | Subroutine | Place the z axis vector (as move_x_axis; OpenFrames' moveZAxis). |
| moves | vkf_artists | Function | Whether a frame moves in time: it or an ancestor (first parents) follows trajectories. |
| name | vkf_frames | Function | The frame's name ('' if none). |
| name_label_on_top | vkf_frames | Function | Whether the name label is drawn on top of the scene (set_name_label_on_top). |
| name_label_shown | vkf_frames | Function | Whether the name label is shown. |
| new_capacity | vkf_trajectory | Function | The capacity to grow to for |
| new_coordinate_axes | vkf_shapes | Function | Coordinate axes named |
| new_curve_artist | vkf_artists | Function | A curve artist for |
| new_custom_line_segments | vkf_line_segments | Function | Line segments named |
| new_data_source | vkf_trajectory | Function | A data source (see DataSource); |
| new_drawable_trajectory | vkf_artists | Function | A drawable trajectory frame named |
| new_elliptic_cone | vkf_shapes | Function | An elliptic cone named |
| new_frame_manager | vkf_window | Function | A frame manager for the scene with root |
| new_hud_text | vkf_hud | Function | HUD text |
| new_lat_lon_grid | vkf_shapes | Function | A latitude/longitude grid named |
| new_marker_artist | vkf_artists | Function | A marker artist for |
| new_model | vkf_model | Function | A model frame named |
| new_polyhedral_cone | vkf_shapes | Function | A polyhedral cone named |
| new_polyhedron | vkf_shapes | Function | A polyhedron named |
| new_radial_plane | vkf_shapes | Function | A radial plane named |
| new_rectangular_cone | vkf_shapes | Function | A rectangular cone named |
| new_reference_frame | vkf_frames | Function | A frame named |
| new_ribbon_artist | vkf_artists | Function | A ribbon artist for |
| new_segment_artist | vkf_artists | Function | A segment artist for |
| new_shadow_cones | vkf_shadow | Function | The shadow named |
| new_sphere | vkf_sphere | Function | A sphere named |
| new_terrain_body | vkf_terrain | Function | A body named |
| new_time_handle | vkf_handles | Function | A time handle (see the module documentation) on |
| new_trajectory | vkf_trajectory | Function | A trajectory with |
| new_trajectory_path | vkf_handles | Function | A path along |
| new_vector_handle | vkf_handles | Function | A vector handle (see the module documentation): |
| new_view | vkf_view | Function | A view of |
| next_motion_stamp | vkf_follower | Function | A new motion stamp: larger than all before (a change of some frame's motion: its pose, its parents, what it follows and how). |
| next_view | vkf_window | Subroutine | Show the next view (wrapping around); |
| night_texture_map | vkf_sphere | Function | The night texture file ('' for none). |
| node | vkf_frames | Function | The frame's transform node (null until realized). |
| node | vkf_sky | Function | The sky's node, made on first use, for a window (set_sky).
For a window's |
| now | vkf_clock | Function | The wall time (s): |
| num_artists | vkf_artists | Function | Number of artists. |
| num_attitudes | vkf_trajectory | Function | Number of attitudes (at most num_times). |
| num_children | vkf_frames | Function | Number of children. |
| num_chunks | vkf_artists | Function | Number of buffers the artist is drawn with (0 until built). |
| num_chunks | vkf_line_chain | Function | Number of chunks. |
| num_colors | vkf_trajectory | Function | Number of colors (at most num_times). |
| num_constellation_lines | vkf_sky | Function | Number of constellation lines read (of all of them). |
| num_constellations | vkf_sky | Function | Number of constellations read. |
| num_drawn | vkf_artists | Function | Number of trajectory points drawn now (all of them, or in trace mode those passed). |
| num_drawn | vkf_line_segments | Function | Segments drawn now (0 until shown and updated). |
| num_edges | vkf_shapes | Function | The number of edges. |
| num_intermediate | vkf_artists | Function | Number of intermediate markers drawn now. |
| num_layers | vkf_terrain | Function | Number of layers (image and elevation). |
| num_lod_meshes | vkf_sphere | Function | Number of level-of-detail meshes built so far (0 without level of detail). |
| num_optionals | vkf_trajectory | Function | Number of optional vectors per position. |
| num_parents | vkf_frames | Function | Number of parents. |
| num_points | vkf_trajectory | Function | Number of points available with these sources: the number of times, limited by the positions or attitudes they use; huge() if all are zero. |
| num_positions | vkf_trajectory | Function | Number of positions (at most num_times). |
| num_segments | vkf_line_segments | Function | Number of segments set. |
| num_star_names | vkf_sky | Function | Number of named stars read (of the stars read). |
| num_star_names_drawn | vkf_sky | Function | Number of star names drawn now (0 until the sky is shown, or if the names aren't). |
| num_stars | vkf_sky | Function | Number of stars read. |
| num_times | vkf_trajectory | Function | Number of times. |
| num_trajectories | vkf_follower | Function | Number of trajectories followed. |
| num_triangles | vkf_shapes | Function | The number of triangles drawn (polygons: as fans). |
| num_vertices | vkf_shapes | Function | The number of vertices. |
| num_views | vkf_window | Function | Number of views added. |
| opacity | vkf_sphere | Function | The body's opacity (set_opacity). |
| open | vkf_window | Function | Open the window: |
| open_segments | vkf_shapes | Function | Points along an open curve, as separate segments. |
| optional | vkf_trajectory | Function | Optional vector k (1 to num_optionals) of position i. |
| optional_sources | vkf_trajectory | Function | The sources of optional |
| orthographic_bounds | vkf_view | Function | The bounds [left, right, bottom, top] of the orthographic projection. |
| parent | vkf_frames | Function | Parent i (1 to num_parents). |
| parent_index | vkf_frames | Function | Index of |
| pattern | vkf_line_segments | Subroutine | The dash pattern (see set_pattern). |
| pause | vkf_clock | Subroutine | Pause (true) or resume (false) the simulation time. |
| pause_time | vkf_window | Subroutine | Pause (true) or resume (false) the simulation time. |
| pick | vkf_frames | Subroutine | Pick what the frame draws (see the module documentation): |
| pick_camera | vkf_pick | Function | The camera of a pick: eye, center and up (root frame), a perspective
projection ( |
| pick_ellipsoid | vkf_frames | Function | Pick a body of frame |
| pickable | vkf_frames | Function | Whether pick tests what this frame draws (set_pickable). |
| pixel_ratio | vkf_window | Function | Framebuffer pixels per window unit of a host's window (as given to open or resize; 1 for a window of its own). |
| place | vkf_shadow | Subroutine | Move the shadow to the body's center (in the parent's coordinates) with its +z axis away from the light, and reshape the cones if the radii, the distance or the length set changed. |
| place_axes | vkf_shapes | Subroutine | The frame's own axes (arrows) at |
| place_camera | vkf_window | Subroutine | Set the renderer's camera for the current view: keep the previous view's trackball state and restore (or reset) the current one's when the view changes, then set its world-to-view transform and projection. |
| place_grid_axes | vkf_shapes | Subroutine | The frame's own axes (arrows) at the ellipsoid's semi-axes, half as long. |
| plane_bound | vkf_shapes | Subroutine | The bounding sphere: the origin, radius the plane's radius. |
| plane_build_contents | vkf_shapes | Subroutine | Draw the plane under |
| plane_color | vkf_shapes | Function | The plane's color [r, g, b, a]. |
| plane_frame_info | vkf_shapes | Function | What kind of frame this is: 'RadialPlane'. |
| plane_line_color | vkf_shapes | Function | The lines' color [r, g, b, a]. |
| plane_parameters | vkf_shapes | Subroutine | The plane's radius, circle spacing and radial line spacing, as OpenFrames' getParameters. |
| plane_set_line_color | vkf_shapes | Subroutine | The lines' color (default white, 0.2 opaque). |
| plane_set_parameters | vkf_shapes | Subroutine | The plane's radius (> 0), circle spacing and radial line spacing (radians; 0 for none), as OpenFrames' setParameters. |
| point | vkf_line_chain | Function | Point i as written: read back from the buffers (zero if not held). |
| point | vkf_trajectory | Function | Point i with components from |
| point_at | vkf_trajectory | Function | The point at time t (components from |
| point_between | vkf_trajectory | Function | The point at time t between points k and k2 (components from
|
| point_color | vkf_line_chain | Function | The color of point i of a colored chain, as stored (rgba; white if not colored). |
| point_color | vkf_shapes | Function | The vertices' color [r, g, b, a]. |
| point_colors | vkf_artists | Function | Whether a trajectory's colors are drawn. |
| point_pick | vkf_pick | Function | Point p (root frame) is within the tolerance (plus |
| point_rgba | vkf_artists | Function | Color of point i as drawn by a colored chain: the trajectory's, or the artist's if it has none yet. |
| point_rgba_or | vkf_artists | Function | Color of point i: the trajectory's, or |
| point_size | vkf_shapes | Function | The vertices' size (window units). |
| points | vkf_trajectory | Subroutine | Points i1, i1 + stride, ... (up to i2) with components from |
| poly_bound | vkf_shapes | Subroutine | The bounding sphere: about the vertices' box's center. |
| poly_build_contents | vkf_shapes | Subroutine | |
| poly_draw_mode | vkf_shapes | Function | What is drawn: an ior of POLY_FACES, POLY_EDGES, POLY_VERTICES. |
| poly_frame_info | vkf_shapes | Function | What kind of frame this is: 'Polyhedron'. |
| poly_line_color | vkf_shapes | Function | The edges' color [r, g, b, a]. |
| poly_line_width | vkf_shapes | Function | The edges' width (window units). |
| poly_opacity | vkf_shapes | Function | The faces' opacity. |
| poly_set_draw_mode | vkf_shapes | Subroutine | What to draw: an ior of POLY_FACES, POLY_EDGES, POLY_VERTICES (default faces and edges). |
| poly_set_line_color | vkf_shapes | Subroutine | The edges' color. |
| poly_set_line_width | vkf_shapes | Subroutine | The edges' width (window units; default 1). |
| poly_set_opacity | vkf_shapes | Subroutine | The faces' opacity (0 to 1; default 1, opaque): below 1 translucent. |
| PolyhedralCone | vkf_shapes | Interface | The PolyhedralCone constructor: |
| Polyhedron | vkf_shapes | Interface | The Polyhedron constructor: |
| position | vkf_hud | Function | Where the text is: [x, y] (0 to 1 across the window, y up). |
| position | vkf_frames | Function | Position relative to the parent frame. |
| position | vkf_trajectory | Function | Position i (z = 0 for a 2-DOF trajectory). |
| position_of | vkf_frames | Function | The origin of |
| position_sources | vkf_trajectory | Function | The sources of a trajectory's positions: x, y, (z) of the position, and
zero for components beyond |
| positions | vkf_trajectory | Subroutine | Pointer to the positions (3, num_positions), without copying. |
| previous_view | vkf_window | Subroutine | Show the previous view (wrapping around); |
| priority | vkf_handles | Function | The handle's priority over others on the same spot. |
| profile | vkf_terrain | Function | Rocky's tiling profile ('': Rocky's default, the Earth). |
| project | vkf_pick | Function | The screen offset (framebuffer pixels) of point p (root frame) from the cursor, and its depth; false if it is behind the eye. |
| projection_type | vkf_view | Function | The projection: ORTHOGRAPHIC or PERSPECTIVE. |
| push_intermediate | vkf_artists | Subroutine | Append an intermediate marker at |
| put_camera | vkf_window | Subroutine | The renderer's camera (columns: eye, center, up; the shown view's frame). |
| quat_conjugate | vkf_math | Function | The conjugate of q: the inverse rotation, for a unit quaternion. |
| quat_from_axis_angle | vkf_math | Function | The rotation by |
| quat_from_matrix | vkf_math | Function | The unit quaternion of a 3x3 rotation matrix (columns: the rotated axes; the inverse of quat_to_matrix), by Shepperd's method (from the largest of w and the vector components, for accuracy). |
| quat_from_vectors | vkf_math | Function | The shortest rotation taking the direction of |
| quat_multiply | vkf_math | Function | The product a*b: rotating by b, then by a. |
| quat_normalize | vkf_math | Function | q / |q| (the identity for a zero quaternion). |
| quat_rotate | vkf_math | Function | The vector v rotated by the unit quaternion q. |
| quat_slerp | vkf_math | Function | Spherical linear interpolation from |
| quat_to_matrix | vkf_math | Function | The 3x3 rotation matrix of the unit quaternion q (columns: the rotated axes). |
| RadialPlane | vkf_shapes | Interface | The RadialPlane constructor: |
| radii | vkf_sphere | Function | The semi-axes: radius * sphere_scale. |
| radius | vkf_sphere | Function | The sphere's radius (scene units). |
| raw_size | vkf_sky | Function | A star's pixel diameter from its apparent magnitude, from its brightness and luminance (OpenFrames' getStarPixelSizeFromMagnitude). |
| ray | vkf_pick | Subroutine | The ray from the eye through the cursor (root frame; |
| ray_ellipsoid | vkf_pick | Function | Where the ray (origin, unit dir) first meets the ellipsoid centered at
|
| ray_line | vkf_pick | Function | The point of the line through |
| ray_plane | vkf_pick | Function | Where the ray (origin, unit dir) meets the plane through |
| ray_sphere | vkf_pick | Function | Where the ray (origin, unit dir) meets the sphere of |
| read_constellations | vkf_sky | Function | Read the constellations of |
| read_stars | vkf_sky | Function | Read the stars of the catalog into self%stars. |
| read_texture | vkf_sphere | Function | An image handle for texture file |
| realize | vkf_frames | Subroutine | Create the render nodes of this frame and its descendants (once; for
|
| rebuild_markers | vkf_artists | Subroutine | New marker nodes (for a new image), in place of the old ones. |
| recorded_frames | vkf_window | Function | Frames recorded since recording started (the video's length: frames / fps). |
| rect_frame_info | vkf_shapes | Function | What kind of frame this is: 'RectangularCone'. |
| rect_primary_angles | vkf_shapes | Subroutine | The half-angles along x and y, radians. |
| rect_set_primary_angles | vkf_shapes | Subroutine | The half-angles along x and y, radians (0 to 90 degrees). |
| rect_vertices | vkf_shapes | Subroutine | The 4 corners (OpenFrames' createRectangularCone). |
| RectangularCone | vkf_shapes | Interface | The RectangularCone constructor: |
| redraw_markers | vkf_artists | Subroutine | Compute and write everything again at the next update. |
| ReferenceFrame | vkf_frames | Interface | The ReferenceFrame constructor: |
| region_color | vkf_shadow | Function | A region's color [r, g, b, a] (0 for an unknown region). |
| region_extent | vkf_shadow | Subroutine | A region's surface at the last update, along the frame's +z axis (away from the light; the body's center at the origin): drawn, from z0 (radius r0) to z1 (radius r1). |
| region_index | vkf_shadow | Function | The index in self%region of SHADOW_UMBRA, SHADOW_PENUMBRA or SHADOW_ANTUMBRA (0 for anything else). |
| regions | vkf_shadow | Function | The regions drawn: an ior of SHADOW_UMBRA, SHADOW_PENUMBRA and SHADOW_ANTUMBRA. |
| relayout_labels | vkf_frames | Subroutine | The labels' size and alignment changed: the name label's in place, the axes' labels made again. |
| release | vkf_handles | Subroutine | Let the handle go. |
| release | vkf_line_chain | Subroutine | Forget the chunks (after their group was removed from the scene): init starts again. |
| release_handle | vkf_window | Subroutine | The grabbed handle released at (x, y); then the handle under the cursor hovered. |
| remake_axes | vkf_frames | Subroutine | The axes and their labels made again (another color, size or font). |
| remove | vkf_frames | Function | Remove |
| remove_all | vkf_follower | Subroutine | Stop following all trajectories. |
| remove_all_artists | vkf_artists | Subroutine | Remove all the artists. |
| remove_all_views | vkf_window | Subroutine | Remove all the window's views (the default view is then used). |
| remove_artist | vkf_artists | Subroutine | Remove an artist (it stops being drawn; it can be added again, also to another frame). |
| remove_child | vkf_frames | Function | Remove |
| remove_hud_text | vkf_window | Subroutine | Stop showing |
| remove_trail | vkf_artists | Subroutine | No trail: the whole curve (or trace mode, if set) again. |
| remove_trajectory | vkf_follower | Subroutine | Stop following |
| remove_vertex_colors | vkf_shapes | Subroutine | The face color again, for every vertex. |
| remove_view | vkf_window | Subroutine | Remove all instances of |
| render_stats | vkf_window | Function | The window's frame rate and frame times (see vkf_diagnostics); zeros while it isn't open. |
| replace | vkf_shapes | Subroutine | Show |
| replace_child | vkf_frames | Subroutine | Put |
| reposition_axes | vkf_frames | Subroutine | 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. |
| reserve | vkf_line_chain | Subroutine | Chunks for at least n points (at least one chunk). Separate segments and ribbons: chunks hold whole pairs (n should be even). |
| reserve | vkf_trajectory | Subroutine | Reserve memory for |
| reset_markers | vkf_artists | Subroutine | Start the intermediate markers and the bounds again. |
| reset_view | vkf_view | Subroutine | Put the camera back at the default position (applied at the next frame in which the view is shown). |
| resize | vkf_window | Subroutine | The host window was resized (framebuffer pixels), and |
| revision | vkf_hud | Function | Number of changes so far (for the windows drawing the text to update it). |
| revision | vkf_trajectory | Function | Number of changes so far (any added, set or cleared data). |
| rgba | vkf_line_segments | Subroutine | Colors c (3 or 4 rows) into rgba(4, n) (alpha 1 if not given). |
| ribbon_chain_kind | vkf_artists | Function | The chain: a surface (a pair of points per trajectory point). |
| ribbon_color | vkf_artists | Function | The surface's color [r, g, b, a]. |
| ribbon_drawn_color | vkf_artists | Function | The color of the pair at trajectory point i as drawn (rgba: the trajectory's color times the artist's alpha, or the artist's color). |
| ribbon_end_data_sources | vkf_artists | Function | The x, y and z data sources of the surface's end points. |
| ribbon_new_tail | vkf_artists | Function | The trace tail: a quad (white unless the points' colors are drawn). |
| ribbon_point_rgba | vkf_artists | Function | Color of point i in a colored chain: the trajectory's, or the artist's (opaque: the style has the alpha) if it has none yet. |
| ribbon_points | vkf_artists | Function | Number of trajectory points to draw the surface through (none if all sources are zero). |
| ribbon_set_color | vkf_artists | Subroutine | The surface's color: [r, g, b] (alpha unchanged) or [r, g, b, a]; its alpha is the surface's opacity (also with the trajectory's colors). |
| ribbon_set_end_x_data | vkf_artists | Function | Where the x of the surface's end points come from (see set_start_x_data). |
| ribbon_set_end_y_data | vkf_artists | Function | Where the y of the surface's end points come from (see set_start_x_data). |
| ribbon_set_end_z_data | vkf_artists | Function | Where the z of the surface's end points come from (see set_start_x_data). |
| ribbon_set_start_x_data | vkf_artists | Function | Where the x (y, z) of the surface's start (end) points come from. Returns whether the trajectory has the data of all sources. |
| ribbon_set_start_y_data | vkf_artists | Function | Where the y of the surface's start points come from (see set_start_x_data). |
| ribbon_set_start_z_data | vkf_artists | Function | Where the z of the surface's start points come from (see set_start_x_data). |
| ribbon_set_trajectory | vkf_artists | Subroutine | Draw |
| ribbon_start_data_sources | vkf_artists | Function | The x, y and z data sources of the surface's start points. |
| ribbon_style | vkf_artists | Subroutine | The style: the artist's color, or white with its alpha if the points' colors are drawn (the shader multiplies them by it). |
| ribbon_trace_end | vkf_artists | Function | In trace mode, the pair at the current time (the tail's end) as drawn; false if no tail is drawn. |
| RibbonArtist | vkf_artists | Interface | The RibbonArtist constructor: |
| rigid_inverse | vkf_math | Function | The inverse of a rigid transform (rotation and translation): [R' -R't]. |
| rocky_available | vkf_terrain | Function | Whether vkframes was built with Rocky (the |
| root_of | vkf_artists | Function | The root of a frame's tree (through first parents). |
| rotated | vkf_view | Function | rotate(r) * m, for a rotation r (3x3). |
| run | vkf_window | Subroutine | Render frames until the window is closed (or for |
| same_clock | vkf_clock | Function | True if |
| same_frame | vkf_frames | Function | True if |
| same_line | vkf_gui | Subroutine | The next widget on the same line as the last. |
| same_pointer | vkf_artists | Function | Whether two frame pointers are both null or point to the same frame. |
| save_state | vkf_view | Subroutine | Keep the trackball state while another view is shown. |
| saved_state | vkf_view | Function | The kept trackball state; false if there is none. |
| scene_counts | vkf_window | Function | The size of the window's scene graph (see vkf_diagnostics): traverses it all, for an occasional update, not every frame. Zeros while it isn't open. |
| screen_position | vkf_window | Function | Where point |
| scroll | vkf_window | Subroutine | The scroll wheel: dy > 0 away from the user. |
| segment | vkf_line_segments | Subroutine | Segment i: its endpoints, and their colors (rgba). |
| segment_artist_pick | vkf_artists | Subroutine | A segment artist's best hit: on the segments drawn (as drawn: relative ends included; a segment of no length isn't drawn). |
| segment_build | vkf_artists | Subroutine | Create the chain of line buffers (sized for the segments now) under |
| segment_color | vkf_artists | Function | The segments' color [r, g, b, a]. |
| segment_color | vkf_line_segments | Function | Color i of |
| segment_count | vkf_artists | Function | Number of segments to draw (none if all sources are zero). |
| segment_dash_mode | vkf_artists | Function | The dash pattern's layout: DASH_SCENE or DASH_SCREEN. |
| segment_distance | vkf_line_chain | Function | Distance from point v to the segment from a to b. |
| segment_first_drawn | vkf_artists | Function | The first segment drawn (1, or in trace mode of decreasing times the earliest passed): segments first_drawn .. first_drawn + num_drawn - 1. |
| segment_highlight | vkf_artists | Function | The segments' highlight: HIGHLIGHT_* (added; HIGHLIGHT_NONE: not highlighted). |
| segment_num_chunks | vkf_artists | Function | Number of line buffers the segments are drawn with (0 until built). |
| segment_num_drawn | vkf_artists | Function | Number of segments drawn now (all of them, or in trace mode those at the points passed). |
| segment_pattern | vkf_artists | Subroutine | The dash pattern: its |
| segment_pick | vkf_pick | Function | Segment a-b (root frame) passes within the tolerance (plus |
| segment_release | vkf_artists | Subroutine | Forget the render nodes (see artist_release). |
| segment_set_color | vkf_artists | Subroutine | The segments' color: [r, g, b] (alpha unchanged) or [r, g, b, a], 0 to 1. |
| segment_set_dash_mode | vkf_artists | Subroutine | The dash pattern's layout (see set_dash_mode): screen-locked dashes start again at each segment's start, as GL_LINES; DASH_FIXED (strips only) is taken as DASH_SCENE. |
| segment_set_highlight | vkf_artists | Subroutine | Highlight the segments (see set_highlight): the arrows run along each segment from its start to its end. |
| segment_set_pattern | vkf_artists | Subroutine | A dash pattern (see set_pattern), starting again at the start of each segment. |
| segment_set_trajectory | vkf_artists | Subroutine | Draw |
| segment_set_width | vkf_artists | Subroutine | The segments' width in window units (logical pixels). |
| segment_update | vkf_artists | Subroutine | Write the segments added (all of them on a redraw), and draw them all or, in trace mode, those at the points passed at time t. |
| segment_width | vkf_artists | Function | The segments' width (window units). |
| SegmentArtist | vkf_artists | Interface | The SegmentArtist constructor: |
| segments_bound | vkf_line_segments | Subroutine | The segments' bounding sphere (frame coordinates). |
| segments_build_contents | vkf_line_segments | Subroutine | The chain of separate segments with a color per point, under |
| segments_frame_info | vkf_line_segments | Function | The kind of frame: 'CustomLineSegments'. |
| segments_late_update | vkf_line_segments | Subroutine | After the tree's update for time t: the callback's segments (all frames at their positions for t), written and uploaded if they changed. |
| segments_set_color | vkf_line_segments | Subroutine | The frame's color: also that of segments set without colors. |
| select_view | vkf_window | Subroutine | Show view i (1 to num_views), flying there over |
| send_lod | vkf_line_chain | Subroutine | Give chunk j's level of detail to the renderer (none if switched off). |
| separator | vkf_gui | Subroutine | A horizontal separator line. |
| set_alignment | vkf_hud | Subroutine | Set which point of the text is at its position. |
| set_attitude | vkf_frames | Subroutine | Attitude relative to the parent frame, a quaternion [x, y, z, w] (normalized here; overridden by a followed trajectory). |
| set_attitude | vkf_sky | Subroutine | The sky's attitude in the root frame (quaternion [x, y, z, w]): e.g. to turn an equatorial catalog into an ecliptic root frame. |
| set_auto_attenuate | vkf_artists | Subroutine | Shrink markers farther from the camera than the trajectory's size (OpenFrames' auto-attenuation; see shaders/marker.vert). On by default (OpenFrames': off). |
| set_auto_lod | vkf_sphere | Subroutine | Level of detail (default on; see the module documentation): meshes of several resolutions, the one drawn chosen per view. Off: one mesh of set_resolution's segments. Set it before a window shows the sphere. |
| set_axis_length | vkf_shapes | Subroutine | The axes' length (scene units, >= 0; default 1); the frame's own axes are moved to the lines' ends. |
| set_axis_width | vkf_shapes | Subroutine | The axis lines' width (window units; default 1). |
| set_background_color | vkf_window | Subroutine | The background color [r, g, b] (0 to 1; default black). |
| set_body | vkf_shadow | Subroutine | The body casting the shadow (it must stay alive while set), and its radius (optional: see set_body_radius). |
| set_body_radius | vkf_shadow | Subroutine | The body's radius (scene units; 0: the body's own, a Sphere's equatorial radius or a TerrainBody's). |
| set_callback | vkf_line_segments | Subroutine | Compute the segments each frame with |
| set_camera | vkf_window | Subroutine | Set the camera of the current view: eye, center and up in the view
frame's coordinates (OpenFrames' trackball setTransformation), or in its
root frame's if |
| set_camera_throw | vkf_window | Subroutine | Whether the camera keeps moving (turning, zooming, panning) after a drag is released while the mouse moves (default true, VSG's and OSG's throw); false: it stops where it is released. |
| set_color | vkf_hud | Subroutine | [r, g, b] (alpha unchanged) or [r, g, b, a], 0 to 1. |
| set_color | vkf_frames | Subroutine | The color of the frame's decorations: [r, g, b] (alpha unchanged) or [r, g, b, a]. |
| set_compile | vkf_line_chain | Subroutine | Compile chunks made from now on (for the windows running): once the group is shown (not while building, when they are compiled with it). |
| set_cone_color | vkf_shapes | Subroutine | The sides' color ([r, g, b] or [r, g, b, a]; their alpha makes them transparent). |
| set_cone_length | vkf_shapes | Subroutine | The cone's length along the boresight (> 0; default 1). |
| set_constellations | vkf_sky | Function | Draw the constellations: faint lines between their stars, from
constellation file |
| set_constraint | vkf_handles | Subroutine | Where the handle can be dragged (HANDLE_*; see the module documentation),
with |
| set_curve_source | vkf_artists | Function | Set data source k (1: x, 2: y, 3: z); returns whether the trajectory has the data. |
| set_dash_mode | vkf_line_chain | Subroutine | For lines, how the dashes are laid out: 0 anchored to the line (the
default), 1 screen-locked (a constant length in pixels, following the
line on screen), 2 a fixed length of the line (strips): |
| set_data_frame | vkf_artists | Subroutine | The frame of the scene its trajectories' data are in (see the module
documentation): each point drawn where it is in this frame at the
point's own time. Absent: this frame's own coordinates (the default).
|
| set_default_data | vkf_follower | Subroutine | Use the trajectories' positions (per the first trajectory's DOF). |
| set_default_keys | vkf_window | Subroutine | The built-in keys (default on): |
| set_default_view_distance | vkf_view | Subroutine | The radius to frame when the view is reset (<= 0: the viewed frame's bound, the default), as OpenFrames' default view distance. |
| set_default_view_parameters | vkf_view | Subroutine | The camera after a reset, in view-frame coordinates (overrides the default view distance). |
| set_display_scale | vkf_handles | Subroutine | Scene units per unit of the vector (> 0; default 1): the arrow is
|
| set_dof | vkf_trajectory | Subroutine | Set the degrees of freedom (2 or 3) of positions and optionals; clears the trajectory. |
| set_draggable | vkf_handles | Subroutine | Whether the mouse may grab the handle (default true). |
| set_draw_axes | vkf_shapes | Subroutine | Which axes to draw: an ior of X_AXIS, Y_AXIS, Z_AXIS. |
| set_draw_mode | vkf_shapes | Subroutine | What to draw: an ior of CONE_SIDES, CONE_EDGES, CONE_BASE_OUTLINE. |
| set_draw_mode | vkf_sky | Subroutine | What to draw: SKY_NONE, or SKY_TEXTURE + SKY_STARS (default; each only if given). |
| set_edges | vkf_shapes | Subroutine | The edges drawn (2, k) (vertex numbers), in place of the faces' (after set_faces, set_triangles or set_grid). |
| set_end_data | vkf_artists | Function | All three end sources at once (see set_start_data). |
| set_end_relative | vkf_artists | Subroutine | Relative ends (default false): each segment ends at its start plus the end sources' values (a vector drawn from each point), not at them. |
| set_end_scale | vkf_artists | Subroutine | Set the scale of all three end sources (with relative ends: the length drawn per unit of the stored vector, e.g. km per newton). Only this artist's segments are written again. |
| set_end_x_data | vkf_artists | Function | Where the x of the segments' end points come from (see set_start_x_data). |
| set_end_y_data | vkf_artists | Function | Where the y of the segments' end points come from (see set_start_x_data). |
| set_end_z_data | vkf_artists | Function | Where the z of the segments' end points come from (see set_start_x_data). |
| set_event_handler | vkf_window | Subroutine | Give the window's keyboard and mouse events to |
| set_face_color | vkf_shapes | Subroutine | The faces' color (the alpha times the opacity). |
| set_faces | vkf_shapes | Subroutine | Faces given as polygons: |
| set_follow_type | vkf_follower | Subroutine | What to follow (FOLLOW_POSITION and/or FOLLOW_ATTITUDE, combined with ior) and how (FOLLOW_LOOP or FOLLOW_LIMIT). |
| set_font | vkf_hud | Subroutine | Set the font (the text is made again when next drawn). |
| set_grid | vkf_shapes | Subroutine | Faces given as a grid of points (3, nu, nv): quadrilaterals between
neighbours (two triangles each), joined around if |
| set_head_size | vkf_handles | Subroutine | The head's length (scene units; at most half the arrow); 0 (the default): 0.2 of the arrow's length. |
| set_highlight | vkf_line_chain | Subroutine | For lines, the highlight (see shaders/line.vert): |
| set_hovered | vkf_handles | Subroutine | The handle is under the cursor (set by the window), or not. |
| set_intermediate_direction | vkf_artists | Subroutine | Count intermediate markers from the start (MARKER_START, default) or from the end (MARKER_END; recomputed whenever points are added). |
| set_intermediate_spacing | vkf_artists | Subroutine | Spacing of intermediate markers (> 0): time units, arc length, or a number of data points (rounded down, at least 1). |
| set_intermediate_type | vkf_artists | Subroutine | |
| set_label_alignment | vkf_frames | Subroutine | The alignment of the labels relative to their positions (ALIGN_*; default ALIGN_LEFT_BASE_LINE). |
| set_label_font | vkf_frames | Subroutine | 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. |
| set_label_size | vkf_frames | Subroutine | 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). |
| set_length | vkf_shadow | Subroutine | How far behind the body's center the shadow is drawn (scene units; 0: automatic, twice the umbra's length). |
| set_level_of_detail | vkf_artists | Subroutine | Level of detail (default on): seen from far away, the curve is drawn from every 2nd, 4th, ... point (and its last), as many as can be skipped while staying within half a pixel of all of them, chosen per view and per chunk of points. Off: every point is drawn. |
| set_light | vkf_shadow | Subroutine | The light (e.g. the Sun; it must stay alive while set), and its radius (optional: see set_light_radius). |
| set_light_ambient | vkf_window | Subroutine | The ambient, diffuse and specular colors ([r, g, b], 0 to 1) of the window's light (OpenFrames' defaults: 0.2 gray, white, none). The window's light is used while no frame of the scene has a light source (set_light_source_enabled). |
| set_light_ambient | vkf_frames | Subroutine | The light source's ambient, diffuse and specular colors ([r, g, b], 0 to 1; defaults 0.05, 0.8 and 0.05 gray). |
| set_light_diffuse | vkf_window | Subroutine | The diffuse color of the window's light (see set_light_ambient). |
| set_light_diffuse | vkf_frames | Subroutine | The light source's diffuse color (see set_light_ambient). |
| set_light_position | vkf_window | Subroutine | The light's position in eye coordinates (x right, y up, z toward the viewer): [x, y, z, 0] for a directional light from direction (x, y, z), [x, y, z, 1] for a point light (OpenFrames' setLightPosition; default [0, 0, 1, 0], a headlight). |
| set_light_radius | vkf_shadow | Subroutine | The light's radius (scene units; 0: the light's own, if a Sphere). |
| set_light_source_enabled | vkf_frames | Subroutine | 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. |
| set_light_specular | vkf_window | Subroutine | The specular color of the window's light (see set_light_ambient). |
| set_light_specular | vkf_frames | Subroutine | The light source's specular color (see set_light_ambient). |
| set_lighting | vkf_terrain | Subroutine | Light the body with the scene's lights (default), or show its imagery as it is. |
| set_line_width | vkf_line_segments | Subroutine | Line width (window units: logical pixels). |
| set_line_widths | vkf_shapes | Subroutine | Widths of the grid lines and of the equator and prime meridian (window units; defaults 1 and 3). |
| set_lit | vkf_shapes | Subroutine | Faces lit by the scene's lights (the default), or unlit (their color as is, transparent as a cone's sides: writing no depth). |
| set_lod | vkf_line_chain | Subroutine | Level of detail on (the default: seen from far away, a strip is drawn from fewer points, within half a pixel of all of them) or off (every point drawn). |
| set_marker_color | vkf_artists | Subroutine | The color of the markers in |
| set_marker_image | vkf_artists | Function | Draw the markers as an image file (tinted by the marker color; its transparent parts left out), or as a disk again with ''. Returns false if the image cannot be read (the markers are then unchanged). |
| set_marker_shape | vkf_handles | Subroutine | The marker's shape (a MARKER_* shape of vkf_artists but MARKER_IMAGE; default MARKER_DISK). |
| set_marker_shape | vkf_artists | Subroutine | Marker shape: a MARKER_ shape constant (MARKER_DISK to MARKER_SPIRAL; MARKER_IMAGE after set_marker_image). These are OpenFrames' disk and its marker shaders (Demos/Shaders/Marker_.frag), built in. |
| set_marker_size | vkf_handles | Subroutine | The marker's size (window units, > 0; default 14). |
| set_marker_size | vkf_artists | Subroutine | Marker size in window units (logical pixels; > 0). |
| set_marker_source | vkf_artists | Function | Set data source k (1: x, 2: y, 3: z), redrawing the markers; returns whether the trajectory has the data. |
| set_marker_style | vkf_line_chain | Subroutine | For markers, the color (rgba), size (window units), shape (shaders/marker.frag) and attenuation radius (scene units, 0 for none). |
| set_markers | vkf_artists | Subroutine | Which markers to draw: an ior of MARKER_START, MARKER_INTERMEDIATE and MARKER_END (0 for none). |
| set_material | vkf_sphere | Subroutine | The material (OpenFrames' setMaterial; each optional): ambient, diffuse, specular and emission colors ([r, g, b] or [r, g, b, a], 0 to 1) and shininess (0 to 128: the specular highlight's sharpness; 0 for none). The ambient and diffuse colors scale the body's color or texture (VSG's Phong); the specular color is reflected from the lights' specular parts. Defaults: ambient and diffuse white, no specular reflection or emission. |
| set_model | vkf_model | Function | Read the model file (now, so its bound is known). Returns false if it could not be read. Set it before a window first shows the model. |
| set_model_attitude | vkf_model | Subroutine | Attitude of the model in its frame (quaternion [x, y, z, w]). |
| set_model_pivot | vkf_model | Subroutine | The point of the model (in its own coordinates) placed at model_position, about which it is rotated and scaled. |
| set_model_position | vkf_model | Subroutine | Where the model's pivot is placed in its frame (frame coordinates). |
| set_model_scale | vkf_model | Subroutine | Scale along the model's x, y and z axes. |
| set_name | vkf_frames | Subroutine | The frame's name, shown by its name label (also once shown: e.g. a readout that follows the frame). |
| set_name_label_on_top | vkf_frames | Subroutine | 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'). |
| set_night_texture_map | vkf_sphere | Subroutine | The texture for the side away from the light (e.g. city lights; an equirectangular image file as the texture, '' for none), shown where the diffuse light is weak. |
| set_num_optionals | vkf_trajectory | Subroutine | Set the number of optional vectors per position; clears the trajectory. |
| set_offset_time | vkf_follower | Subroutine | Follow at the simulation time plus |
| set_opacity | vkf_sphere | Subroutine | The body's opacity, 0 (invisible) to 1 (opaque, the default): below 1 it is drawn translucent (see the module documentation). Set below 1 before a window first shows it to make it translucent; then the opacity can change at any time (a translucent body stays translucent, an opaque one opaque). |
| set_optional | vkf_trajectory | Subroutine | Set optional vector |
| set_orthographic | vkf_view | Subroutine | An orthographic projection with the given bounds (in view units). |
| set_path | vkf_handles | Subroutine | The path the handle moves along (which must stay alive while used); its time kept (the frame placed on the new path). |
| set_pattern | vkf_line_chain | Subroutine | For lines, a dash pattern (see line_set_pattern; z'FFFF' solid). |
| set_pattern | vkf_line_segments | Subroutine | Dash pattern: OpenGL's line stipple (16 bits, bit 0 first, each |
| set_perspective | vkf_view | Subroutine | A perspective projection with vertical field of view |
| set_pickable | vkf_frames | Subroutine | 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. |
| set_plane_color | vkf_shapes | Subroutine | The plane's color ([r, g, b] or [r, g, b, a]; default 0.8 gray, 0.2 opaque). |
| set_point_color | vkf_shapes | Subroutine | The vertices' color (POLY_VERTICES). |
| set_point_colors | vkf_artists | Subroutine | Whether a trajectory with colors is drawn in them (default true); points without a color yet (colors arriving after positions) in the artist's color. A curve: each segment blended from its first point's color to its second's (with level of detail, a color lasting fewer points than are skipped may not show from far away); a surface: each point's pair in its color, times the artist's alpha. False: all in the artist's color. |
| set_point_size | vkf_shapes | Subroutine | The vertices' size (window units; default 6). |
| set_position | vkf_hud | Subroutine | Set where the text is. |
| set_position | vkf_frames | Subroutine | Position relative to the parent frame (overridden by a followed trajectory). |
| set_priority | vkf_handles | Subroutine | 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). |
| set_radius | vkf_sphere | Subroutine | The sphere's radius (scene units, > 0; default 1); can change at any time. |
| set_region_color | vkf_shadow | Subroutine | A region's color (region: one of SHADOW_UMBRA, SHADOW_PENUMBRA, SHADOW_ANTUMBRA; [r, g, b], alpha unchanged, or [r, g, b, a]). |
| set_regions | vkf_shadow | Subroutine | The regions to draw: an ior of SHADOW_UMBRA, SHADOW_PENUMBRA and SHADOW_ANTUMBRA (default SHADOW_ALL). |
| set_resolution | vkf_sphere | Subroutine | The mesh resolution without level of detail: segments in longitude and latitude (default 128 x 64). |
| set_rgba | vkf_math | Subroutine | Set |
| set_ribbon_source | vkf_artists | Function | Set component k of the start (side 1) or end (side 2) sources. |
| set_scene | vkf_window | Subroutine | Show the scene of |
| set_segment_source | vkf_artists | Function | Set component k of the start (side 1) or end (side 2) sources. |
| set_segments | vkf_line_segments | Subroutine | The segments: from a(:, i) to b(:, i) (frame coordinates), colored color_a(:, i) at a and color_b(:, i) at b ([r, g, b] or [r, g, b, a] columns; one of them for both ends; neither: the frame's color). Setting the same segments again changes nothing (no upload). |
| set_size | vkf_hud | Subroutine | Set the size of the text. |
| set_sky | vkf_window | Subroutine | Draw |
| set_smooth | vkf_shapes | Subroutine | Shading smooth across the vertices (normals averaged over the faces around each: a curved surface, e.g. a grid's), or flat faces (the default: a polyhedron's). |
| set_sphere_attitude | vkf_sphere | Subroutine | Attitude of the body in its frame (quaternion [x, y, z, w]), e.g. to orient its texture. |
| set_sphere_position | vkf_sphere | Subroutine | Position of the body's center in its frame. |
| set_sphere_scale | vkf_sphere | Subroutine | Scale the sphere along its x, y and z axes (all > 0), making an ellipsoid with semi-axes radius * scale. |
| set_star_data | vkf_sky | Function | Draw the stars of |
| set_star_names | vkf_sky | Function | Draw the names of the named stars drawn (those of the catalog's last
field), beside them: |
| set_start_data | vkf_artists | Function | All three start (end) sources at once, e.g. position_sources(3) or optional_sources(1). Returns whether the trajectory has their data. |
| set_start_x_data | vkf_artists | Function | Where the x (y, z) of the segments' start (end) points come from. Returns whether the trajectory has the data of all sources. |
| set_start_y_data | vkf_artists | Function | Where the y of the segments' start points come from (see set_start_x_data). |
| set_start_z_data | vkf_artists | Function | Where the z of the segments' start points come from (see set_start_x_data). |
| set_stride | vkf_artists | Subroutine | Draw a segment at points 1, 1 + stride, 1 + 2 stride, ... (stride >= 1). |
| set_style | vkf_line_chain | Subroutine | Color (rgba) and width (window units) of the whole chain. |
| set_text | vkf_hud | Subroutine | Set the text (up to 256 characters, or twice the first text's length; see the module documentation). |
| set_texture_map | vkf_sphere | Subroutine | The texture: an equirectangular image file ('' for none). |
| set_texture_map | vkf_sky | Function | Draw an image file as the sky (found with find_data_file); '' for none. Returns false if it cannot be read (the sky is then unchanged). |
| set_tick_image | vkf_shapes | Function | Draw the ticks as an image (OpenFrames' setTickImage; found with find_data_file; '' for disks again). False if it cannot be read. |
| set_tick_shape | vkf_shapes | Subroutine | Tick shape: a MARKER_* shape (default MARKER_DISK; OpenFrames' setTickShader with its marker shaders). |
| set_tick_size | vkf_shapes | Subroutine | Major and minor tick sizes (window units; default 8 and 4). |
| set_tick_spacing | vkf_shapes | Subroutine | Major and minor tick spacings (>= 0; 0 for none). |
| set_time | vkf_window | Subroutine | Set the simulation time (limited to the time range). |
| set_time | vkf_handles | Subroutine | The handle's time (kept within its time range): the frame placed at the path's point for it. |
| set_time | vkf_follower | Subroutine | Follow at a fixed time (independent of the simulation time). |
| set_time | vkf_clock | Subroutine | Set the simulation time (limited to the time range) and restart counting from it. |
| set_time_range | vkf_window | Subroutine | Limit the simulation time to [t_min, t_max] (ignored if t_max < t_min). |
| set_time_range | vkf_handles | Subroutine | The times a drag may reach (t_min <= t_max; else swapped); the handle's time brought within them. Taken at the next grab. |
| set_time_range | vkf_clock | Subroutine | Limit the simulation time to [t_min, t_max] (ignored if t_max < t_min). |
| set_time_scale | vkf_window | Subroutine | Simulation seconds per wall-clock second (may be 0 or negative). |
| set_time_scale | vkf_clock | Subroutine | Simulation seconds per wall-clock second (may be 0 or negative). |
| set_trace_mode | vkf_artists | Subroutine | Draw only the part up to the current time (see the module documentation). |
| set_trail | vkf_artists | Subroutine | A trail (see the module documentation): only the part within |
| set_trail | vkf_line_chain | Subroutine | For strips, the trail (see vkf_line_set_trail: 20 values; the third 0: none), given to every chunk (changed every frame the time does: a few floats per chunk uploaded). |
| set_trail_style | vkf_artists | Subroutine | The style of a trail's part, |
| set_trajectory | vkf_artists | Subroutine | Draw |
| set_trajectory | vkf_follower | Subroutine | Follow only |
| set_triangles | vkf_shapes | Subroutine | Faces given as triangles (3, m) of vertex numbers (1-based); the edges are their sides (each once). |
| set_twilight | vkf_sphere | Subroutine | The twilight: the diffuse light extended past the terminator to where
the light is |
| set_two_sided | vkf_shapes | Subroutine | Both sides of the faces drawn and lit (the default: open surfaces), or only their fronts (a closed surface, its faces counterclockwise seen from outside: translucent, its far side isn't drawn through it). |
| set_vector | vkf_handles | Subroutine | The vector (frame coordinates); can change at any time. |
| set_vertex_angles | vkf_shapes | Subroutine | The vertices: clock angles (from +x toward +y) and cone angles (from the boresight, -z; below 90 degrees), radians, the same number of each (>= 3). |
| set_vertex_colors | vkf_shapes | Subroutine | A color per vertex (4, n) or (3, n) ([r, g, b(, a)], 0 to 1), for the faces, blended across them (in place of the face color; the opacity still applies). Dropped when the faces are set again. |
| set_vertices | vkf_shapes | Subroutine | Move the vertices (3, n), keeping the faces and edges (as many as before; e.g. a surface changing in time). |
| set_view_between_frames | vkf_view | Subroutine | Look from |
| set_view_frame | vkf_view | Subroutine | View |
| set_view_transition | vkf_window | Subroutine | The time (s) a change of view or a reset flies from one camera to the other (default 0: a cut, as OpenFrames). |
| set_x_data | vkf_artists | Function | Where the x (y, z) of the points come from. Returns whether the trajectory has those data. |
| set_x_data | vkf_follower | Function | Where the x, y and z of the followed position come from (default: the trajectories' positions). Returns whether all followed trajectories have those data. |
| set_x_label | vkf_frames | Subroutine | The text of the x-axis label (default 'X'). |
| set_y_data | vkf_artists | Function | Where the y of the points come from (see set_x_data). |
| set_y_data | vkf_follower | Function | Where the y of the followed position comes from (see set_x_data). |
| set_y_label | vkf_frames | Subroutine | The text of the y-axis label (default 'Y'). |
| set_z_data | vkf_artists | Function | Where the z of the points come from (see set_x_data). |
| set_z_data | vkf_follower | Function | Where the z of the followed position comes from (see set_x_data). |
| set_z_label | vkf_frames | Subroutine | The text of the z-axis label (default 'Z'). |
| set_zoom_speed | vkf_window | Subroutine | How fast the mouse zooms (default 1, VSG's: 10% per wheel step, and a right drag's rate): e.g. 0.3 for a gentler zoom. Scales scroll steps however they come (a mouse wheel, a trackpad, a host's scroll). |
| shadow_bound | vkf_shadow | Subroutine | The drawn regions' bounding sphere (frame coordinates). |
| shadow_build_contents | vkf_shadow | Subroutine | A switch with a mesh for each region (vertices written at each change
of shape), under |
| shadow_frame_info | vkf_shadow | Function | What kind of frame this is: 'ShadowCones'. |
| shadow_late_update | vkf_shadow | Subroutine | After the tree's update for time t: the shadow moved to the body, turned away from the light, and reshaped if the distance or a setting changed. |
| ShadowCones | vkf_shadow | Interface | The ShadowCones constructor: |
| shape_regions | vkf_shadow | Subroutine | The regions' frustums for body radius r, light radius rs and distance d (see the module documentation), written to their meshes. |
| share_model | vkf_model | Function | Use the model already read by |
| show | vkf_hud | Subroutine | Show (true) or hide the text (OpenFrames' enable HUD text). |
| show_axes | vkf_frames | Subroutine | Which axes vectors to show: NO_AXES, or X_AXIS, Y_AXIS, Z_AXIS combined with ior. |
| show_axes_labels | vkf_frames | Subroutine | Which axes labels to show (as show_axes). |
| show_contents | vkf_frames | Subroutine | Show or hide what the frame draws (its sphere, model, ...), but not its axes, labels or children. |
| show_decorations | vkf_frames | Subroutine | 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). |
| show_name_label | vkf_frames | Subroutine | Show or hide the name label (at the frame's origin; default shown). |
| side | vkf_shapes | Function | Which side of the line from a to b q is on: > 0 left, < 0 right, 0 on it (twice the signed area of the triangle a, b, q). |
| size | vkf_hud | Function | The size of the text: character height (window units). |
| size_of | vkf_sky | Function | The number of columns of a (the stars' capacity). |
| sky | vkf_window | Function | The sky drawn behind the scene (null if none). |
| sky_direction | vkf_sky | Function | The unit vector of a direction on the sky from its right ascension (hours) and declination (degrees), as the stars' (star_to_point). |
| slice | vkf_line_chain | Subroutine | The part lo .. hi of points i1 .. i2 that chunk j holds, and its buffer p(xyz and distance, high/low, lo:hi) (null if none). |
| slider | vkf_gui | Function | A slider showing |
| smooth | vkf_shapes | Function | Whether the shading is smooth. |
| sort_keys | vkf_shapes | Subroutine | Sort keys, increasing (a bottom-up merge sort). |
| source_points | vkf_artists | Function | Number of points the data sources give: 0 for invalid sources or no trajectory, huge() if all are zero. |
| Sphere | vkf_sphere | Interface | The Sphere constructor: |
| sphere_attitude | vkf_sphere | Function | Attitude of the body in its frame (quaternion [x, y, z, w]). |
| sphere_bound | vkf_sphere | Subroutine | The body's bounding sphere: its center, and its largest semi-axis. |
| sphere_build_contents | vkf_sphere | Subroutine | The body: an ellipsoid mesh under the sphere's transform. |
| sphere_create | vkf_geometry | Function | A sphere mesh node: ellipsoid_create with equal semi-axes. |
| sphere_frame_info | vkf_sphere | Function | What kind of frame this is: 'Sphere'. |
| sphere_near | vkf_pick | Function | A sphere (root frame: center c, radius r) might be within the tolerance
(plus |
| sphere_pick | vkf_sphere | Subroutine | Picked on the ellipsoid (exact), with the geodetic latitude and longitude of the point hit (in the body's axes: sphere_attitude); else the frame's origin. |
| sphere_position | vkf_sphere | Function | Position of the body's center in its frame (scene units). |
| sphere_scale | vkf_sphere | Function | The scale along the sphere's x, y and z axes. |
| sphere_set_color | vkf_sphere | Subroutine | The body's color (used without a texture); [r, g, b] or [r, g, b, a]. |
| sphere_update | vkf_sphere | Subroutine | Update the frame (followed trajectories, children) and, with level of detail, build the mesh the views have wanted if it isn't built yet (the coarsest with as many segments as wanted, or the finest). |
| split_distances | vkf_line_chain | Subroutine | Distances s(n) into d(high/low, n). |
| split_points | vkf_line_chain | Subroutine | Points x(3, n) into p(xyz and distance, high/low, n): the floats nearest, and the rest (the distances are left as they are). |
| star | vkf_sky | Subroutine | Star i (1 to num_stars): its direction (unit vector, sky frame), color (rgb, dimmed) and size (window units). |
| star_catalog | vkf_sky | Function | The star catalog file ('' for none). |
| star_magnitude_range | vkf_sky | Function | The range of magnitudes of the stars read. |
| star_magnitudes | vkf_sky | Function | The magnitude range drawn (as set). |
| star_name | vkf_sky | Subroutine | Named star i (1 to num_star_names): its name, apparent magnitude and star (1 to num_stars: see star). |
| star_names | vkf_sky | Function | Whether the star names are drawn (as set). |
| star_sizes | vkf_sky | Function | The size range of the stars (window units). |
| star_to_point | vkf_sky | Subroutine | A star's direction, color (from its B-V color index: Ballesteros' temperature, then Tanner Helland's temperature to RGB) and raw size (OpenFrames' SkySphere::StarToPoint). |
| start_data_sources | vkf_artists | Function | The x, y and z data sources of the segments' start points. |
| start_flight | vkf_window | Subroutine | Fly from camera |
| start_recording | vkf_window | Function | Start recording the frames drawn to the video |
| state_at | vkf_follower | Subroutine | The position and attitude followed at simulation time |
| stop_recording | vkf_window | Function | Stop recording: ffmpeg finishes the file. The window's time goes on
from where the video was, on the wall clock again. |
| stop_transition | vkf_window | Subroutine | End a flight where the camera is now. |
| storage_bytes | vkf_trajectory | Function | The memory the trajectory's data take (bytes), used or not: its storage's capacity (see reserve, compact). |
| stride | vkf_artists | Function | The stride: a segment at every stride-th point. |
| style_node | vkf_line_chain | Subroutine | Give the chain's style to |
| surface_node | vkf_shapes | Function | A surface of triangles idx(3, m) (1-based) through points xyz(3, n), of
color rgba: unlit and transparent (seen from both sides, writing no
depth: planes, cones' sides), or, given |
| surface_point | vkf_shapes | Function | The point at geodetic latitude lat and longitude lon on the ellipsoid (OpenFrames' LatLonGrid formula: the surface point whose normal has those angles). |
| sync | vkf_frames | Subroutine | Copy the positions and attitudes of this frame and its descendants to their transform nodes (only those that changed since the last sync). |
| synchronize | vkf_clock | Function | Follow |
| synchronized_to | vkf_clock | Function | The clock this one is synchronized to (null if none). |
| tail_colors | vkf_artists | Subroutine | The tail's colors: from point k's to the color at frac along to point k2's (white, showing the style's color, if the chain has none). |
| tail_ends | vkf_artists | Subroutine | Trace mode's tail, for the points passed i1 .. i2 of the n written: from the latest passed (k) toward the next in time (k2: i2 + 1, or i1 - 1 for decreasing times); none (0, 0) without a trajectory. |
| take_camera | vkf_view | Function | True (once) if a camera was set (set_camera), and that camera. |
| take_reset | vkf_view | Function | True (once) if a reset is pending. |
| terrain_bound | vkf_terrain | Subroutine | The body's bounding sphere (frame coordinates): its equatorial radius, at the origin. |
| terrain_build_contents | vkf_terrain | Subroutine | The map, made for the viewer showing the body (none headless or without Rocky). |
| terrain_frame_info | vkf_terrain | Function | The kind of frame: 'TerrainBody'. |
| terrain_pick | vkf_terrain | Subroutine | Picked on a sphere of the body's radius (not the terrain's heights), with the latitude and longitude of the point hit; else the frame's origin. |
| terrain_update | vkf_terrain | Subroutine | Each frame: if the map's window has closed (the map was released with it), the map again for a window still open (compiled for the windows running), then the frame's update. |
| TerrainBody | vkf_terrain | Interface | The TerrainBody constructor: |
| text | vkf_gui | Subroutine | A line of text. |
| text | vkf_hud | Function | The text (as shown: '' while hidden). |
| texture_map | vkf_sphere | Function | The texture file ('' for none). |
| texture_map | vkf_sky | Function | The texture file ('' for none). |
| tick_image | vkf_shapes | Function | The tick image file ('' for none). |
| tick_shape | vkf_shapes | Function | Tick shape: a MARKER_* shape. |
| tick_size | vkf_shapes | Subroutine | Major and minor tick sizes (window units). |
| tick_spacing | vkf_shapes | Subroutine | Major and minor tick spacings. |
| time | vkf_window | Function | The simulation time (at the last frame). |
| time | vkf_handles | Function | The handle's time. |
| time | vkf_trajectory | Function | Time i. |
| time | vkf_clock | Function | The simulation time at the last update (or as last set). |
| time_bound | vkf_handles | Subroutine | The marker's bounding sphere: the frame's origin. |
| time_build_contents | vkf_handles | Subroutine | The marker: one point at the frame's origin. |
| time_distance | vkf_trajectory | Function | The "distance" from time t to the time range [t0, tf]: > 0 outside it (to the nearer end), 0 at its ends, < 0 inside; huge() without times. (OpenFrames' getTimeDistance.) |
| time_drag | vkf_handles | Function | Drag the grabbed handle to the cursor's ray (origin, unit dir; root frame): its time where the path is nearest the ray (see the module documentation). False (not moved) if it isn't grabbed or the path is all behind the eye. |
| time_fraction | vkf_trajectory | Function | The fraction of the way in time from point k to point k2 (any two points: e.g. k + 1, or k - 1 with times running backward) at time t, kept within 0 to 1 (0 if their times are the same). No checks: k and k2 must be times. |
| time_frame_info | vkf_handles | Function | What kind of frame this is: 'TimeHandle'. |
| time_grab | vkf_handles | Function | Grab the handle with the cursor's ray (origin, unit dir; root frame): the path sampled over the time range. False if it isn't draggable or has no path. |
| time_handle_point | vkf_handles | Function | The point the mouse grabs: the marker, at the frame's origin. |
| time_index | vkf_trajectory | Function | Find the interval of the time list containing t, by bisection (times
increasing or decreasing). Returns a TIME_ code, or the number of
iterations (> 0) when found, with times(index) <= t < times(index+1) for
increasing times (>= and > for decreasing). See the TIME_ constants for
|
| time_move_handle_point | vkf_handles | Subroutine | The handle moved to the sampled point of the path nearest |
| time_pick | vkf_handles | Subroutine | Picked at its marker (within the tolerance plus half its size), as PICK_HANDLE; else the frame's origin. |
| time_range | vkf_window | Subroutine | The simulation time range (set_time_range). |
| time_range | vkf_handles | Subroutine | The times a drag may reach. |
| time_range | vkf_trajectory | Function | The first and last times, ordered (t0 <= tf); false if there are no times. |
| time_range | vkf_clock | Subroutine | The time range the simulation time is limited to (s; +-huge() if unlimited). |
| time_scale | vkf_window | Function | Simulation seconds per wall-clock second. |
| time_scale | vkf_clock | Function | Simulation seconds per wall-clock second. |
| time_set_color | vkf_handles | Subroutine | The marker's color; [r, g, b] or [r, g, b, a]. |
| time_show_state | vkf_handles | Subroutine | The marker's color and size: brighter and larger when hovered, more when dragged. |
| TimeHandle | vkf_handles | Interface | The TimeHandle constructor: |
| times | vkf_trajectory | Subroutine | Pointer to the times (num_times), without copying. |
| tip | vkf_handles | Function | The arrow's tip: the display scale times the vector (frame coordinates). |
| to_float_rgba | vkf_trajectory | Subroutine | rgba from [r, g, b] (alpha 1) or [r, g, b, a]. |
| to_shown | vkf_artists | Subroutine | Points v (data frame) at times |
| to_shown_at | vkf_artists | Subroutine | Points i1, i1 + stride, ... (data frame; their times the trajectory's) into the drawable's coordinates, if transformed. |
| trace_end | vkf_artists | Function | In trace mode, the end of the line (the point at the current time) as drawn; false if no tail is drawn. |
| trace_mode | vkf_artists | Function | Whether only the part up to the current time is drawn. |
| trace_range | vkf_artists | Subroutine | The points of 1 .. n whose times are at most t (trace mode): i1 .. i2 (none: i2 < i1), the first points for increasing times, the last for decreasing ones (by bisection). |
| track_view | vkf_window | Subroutine | The view's frame (the frame it follows) where it is now: the renderer's world-to-view transform (the camera stays where it is in that frame). |
| Trajectory | vkf_trajectory | Interface | The Trajectory constructor: |
| trajectory_path_position | vkf_handles | Function | The trajectory's position at time |
| TrajectoryPath | vkf_handles | Interface | The TrajectoryPath constructor: |
| transform_camera | vkf_view | Function | A camera (columns: eye, center, up) in the coordinates a rigid
transform |
| transformed | vkf_artists | Function | Whether the artist's data are in another frame than the drawable's (DrawableTrajectory's set_data_frame), so its points are transformed. |
| translation_matrix | vkf_math | Function | The 4x4 transform translating by |
| twilight | vkf_sphere | Function | The twilight angle (radians below the horizon; 0: none). |
| two_sided | vkf_shapes | Function | Whether both sides are drawn. |
| umbra_length | vkf_shadow | Function | The distance from the body's center to the umbra's apex at the last update (huge() for a body no smaller than its light; 0 before). |
| unfollow | vkf_frames | Subroutine | Stop following trajectories (the frame keeps its last position and attitude). |
| unique_edges | vkf_shapes | Function | Edges (2, k) of vertex numbers (1 to n), each once whichever its direction (sorted by their smaller vertex, then the larger). |
| unit_normal | vkf_shapes | Function | A triangle's unit normal (counterclockwise: its front), or +z if it has no area. |
| unit_part | vkf_handles | Function | A unit part of an arrow along z from the origin (vkf_geometry's arrow: body and head lengths and radii), white (colored by its material), lit as frames' axes. Null on failure. |
| units_per_meter | vkf_terrain | Function | Scene units per meter the body is drawn at. |
| update | vkf_frames | Subroutine | Update this frame and its descendants for simulation time |
| update | vkf_follower | Subroutine | The position and attitude at simulation time |
| update | vkf_clock | Function | Advance the clock to the current wall time (call once per frame) and return the simulation time. |
| update_arrow | vkf_handles | Subroutine | The shaft and head placed for the vector (hidden if it is 0). |
| update_bounds | vkf_artists | Subroutine | The bounds of the points (for the attenuation radius: OpenFrames uses the artist's bounding sphere). |
| update_highlight | vkf_artists | Subroutine | Change the settings given (see set_highlight). |
| update_huds | vkf_window | Subroutine | Show the HUD texts' changes: text, color, position, size and alignment in place; a new font makes the text's node again. |
| update_lod | vkf_line_chain | Subroutine | Points lo .. hi of chunk j (a strip's) were written, the last being hi:
update the bounding box and the error bounds of the segments they change
at each stride, and give them to the renderer. |
| update_model_transform | vkf_model | Subroutine | Give the model transform to its node (once built). |
| update_ribbon_tail | vkf_artists | Subroutine | The tail: the quad from the pair at point k to the pair interpolated at time t toward point k2 (as the curve's tail: none if either isn't a point written). |
| update_sphere_transform | vkf_sphere | Subroutine | The body's transform: its position, attitude and scale (radii / the built radii); nothing before it is built. |
| update_switches | vkf_frames | Subroutine | Show or hide the decorations' switches as set. |
| update_tail | vkf_artists | Subroutine | The tail: from point k (the latest passed) to the point interpolated at time t toward point k2 (the next in time: k + 1, or k - 1 for decreasing times); none if either isn't a point written (before the start, or everything passed). |
| update_window_light | vkf_window | Subroutine | The window's light on while no frame of the scene has a light source. |
| uses_colors | vkf_artists | Function | Whether the trajectory's colors are drawn: wanted, and it has some. |
| using_default_data | vkf_follower | Function | True if the followed position is the trajectories' positions (set_default_data). |
| vector | vkf_handles | Function | The vector (frame coordinates). |
| vector_bound | vkf_handles | Subroutine | The arrow's bounding sphere (frame coordinates). |
| vector_build_contents | vkf_handles | Subroutine | The arrow: a unit shaft and head under their transforms, in a switch. |
| vector_frame_info | vkf_handles | Function | What kind of frame this is: 'VectorHandle'. |
| vector_handle_point | vkf_handles | Function | The point the mouse grabs: the tip. |
| vector_move_handle_point | vkf_handles | Subroutine | The tip dragged to |
| vector_pick | vkf_handles | Subroutine | Picked at its tip and along its head (within the tolerance, plus a few pixels), as PICK_HANDLE; else the frame's origin. |
| vector_set_color | vkf_handles | Subroutine | The arrow's color; [r, g, b] or [r, g, b, a]. |
| vector_show_state | vkf_handles | Subroutine | The arrow's color, brighter when hovered and more when dragged. |
| VectorHandle | vkf_handles | Interface | The VectorHandle constructor: |
| verify_data | vkf_trajectory | Function | True if the trajectory has the data the sources refer to (elements and optionals in range). |
| version_string | vkf_diagnostics | Function | The rendering layer's version string |
| vertex_normals | vkf_shapes | Function | Normals per vertex: the faces' around it, weighted by their areas. |
| vertices_sphere | vkf_shapes | Subroutine | A sphere around points v (3, n): their box's center, out to the farthest (zero for none). |
| View | vkf_view | Interface | The View constructor: |
| view_camera | vkf_window | Function | The pick camera of the view shown, with the cursor at (x, y) (-1 to 1, y up) and no tolerance. False before the first frame (or closed). |
| view_frame | vkf_view | Function | The viewed frame (null if none). |
| view_frame_type | vkf_view | Function | The base of the trackball: ABSOLUTE_FRAME or RELATIVE_FRAME. |
| view_root | vkf_view | Function | The root of the viewed frames' tree (null if none). |
| view_rotation_type | vkf_view | Function | How a view between frames turns: VIEW_DIRECT or VIEW_AZEL. |
| view_set_camera | vkf_view | Subroutine | The camera (view-frame coordinates) to show the next time the view is drawn (at once if it is shown: the window's set_camera can also fly there). It replaces a pending reset. |
| view_transition | vkf_window | Function | The time (s) a change of view or a reset flies (set_view_transition). |
| vkf_cache_clear | vkf_layer | Interface | |
| vkf_cache_directory | vkf_layer | Interface | |
| vkf_compile_node | vkf_layer | Interface | |
| vkf_driver_preload | vkf_layer | Interface | |
| vkf_font_delete | vkf_layer | Interface | |
| vkf_font_read | vkf_layer | Interface | |
| vkf_gui_begin | vkf_layer | Interface | |
| vkf_gui_button | vkf_layer | Interface | |
| vkf_gui_checkbox | vkf_layer | Interface | |
| vkf_gui_combo | vkf_layer | Interface | |
| vkf_gui_end | vkf_layer | Interface | |
| vkf_gui_same_line | vkf_layer | Interface | |
| vkf_gui_separator | vkf_layer | Interface | |
| vkf_gui_slider | vkf_layer | Interface | |
| vkf_gui_text | vkf_layer | Interface | |
| vkf_image_delete | vkf_layer | Interface | |
| vkf_image_read | vkf_layer | Interface | |
| vkf_label_create | vkf_layer | Interface | |
| vkf_label_set_at_infinity | vkf_layer | Interface | |
| vkf_label_set_color | vkf_layer | Interface | |
| vkf_label_set_layout | vkf_layer | Interface | |
| vkf_label_set_on_top | vkf_layer | Interface | |
| vkf_label_set_text | vkf_layer | Interface | |
| vkf_light_create | vkf_layer | Interface | |
| vkf_light_set | vkf_layer | Interface | |
| vkf_line_colors | vkf_layer | Interface | |
| vkf_line_create | vkf_layer | Interface | |
| vkf_line_create_colored | vkf_layer | Interface | |
| vkf_line_points | vkf_layer | Interface | |
| vkf_line_points_changed | vkf_layer | Interface | |
| vkf_line_set_dash_mode | vkf_layer | Interface | |
| vkf_line_set_highlight | vkf_layer | Interface | |
| vkf_line_set_lod | vkf_layer | Interface | |
| vkf_line_set_range | vkf_layer | Interface | |
| vkf_line_set_trail | vkf_layer | Interface | |
| vkf_line_style | vkf_layer | Interface | |
| vkf_line_style_changed | vkf_layer | Interface | |
| vkf_marker_create | vkf_layer | Interface | |
| vkf_mesh_array | vkf_layer | Interface | |
| vkf_mesh_create | vkf_layer | Interface | |
| vkf_mesh_material | vkf_layer | Interface | |
| vkf_mesh_material_changed | vkf_layer | Interface | |
| vkf_mesh_set_bound | vkf_layer | Interface | |
| vkf_mesh_set_twilight | vkf_layer | Interface | |
| vkf_mesh_vertices_changed | vkf_layer | Interface | |
| vkf_model_read | vkf_layer | Interface | |
| vkf_node_add_child | vkf_layer | Interface | |
| vkf_node_bound | vkf_layer | Interface | |
| vkf_node_delete | vkf_layer | Interface | |
| vkf_node_remove_child | vkf_layer | Interface | |
| vkf_ribbon_create | vkf_layer | Interface | |
| vkf_rocky_add_elevation | vkf_layer | Interface | |
| vkf_rocky_add_image | vkf_layer | Interface | |
| vkf_rocky_available | vkf_layer | Interface | |
| vkf_rocky_elevation | vkf_layer | Interface | |
| vkf_rocky_map_alive | vkf_layer | Interface | |
| vkf_rocky_map_create | vkf_layer | Interface | |
| vkf_rocky_map_radius | vkf_layer | Interface | |
| vkf_rocky_map_settings | vkf_layer | Interface | |
| vkf_sky_lines_create | vkf_layer | Interface | |
| vkf_sky_stars | vkf_layer | Interface | |
| vkf_sky_stars_changed | vkf_layer | Interface | |
| vkf_sky_style | vkf_layer | Interface | |
| vkf_sky_style_changed | vkf_layer | Interface | |
| vkf_sky_texture_create | vkf_layer | Interface | |
| vkf_sphere_lod_add | vkf_layer | Interface | |
| vkf_sphere_lod_create | vkf_layer | Interface | |
| vkf_sphere_lod_requested | vkf_layer | Interface | |
| vkf_stars_create | vkf_layer | Interface | |
| vkf_switch_create | vkf_layer | Interface | |
| vkf_switch_set | vkf_layer | Interface | |
| vkf_transform_create | vkf_layer | Interface | |
| vkf_transform_set_matrix | vkf_layer | Interface | |
| vkf_version | vkf_layer | Interface | |
| vkf_viewer_add_node | vkf_layer | Interface | |
| vkf_viewer_any | vkf_layer | Interface | |
| vkf_viewer_capture | vkf_layer | Interface | |
| vkf_viewer_close | vkf_layer | Interface | |
| vkf_viewer_create | vkf_layer | Interface | |
| vkf_viewer_delete | vkf_layer | Interface | |
| vkf_viewer_device_info | vkf_layer | Interface | |
| vkf_viewer_events | vkf_layer | Interface | |
| vkf_viewer_frame | vkf_layer | Interface | |
| vkf_viewer_frame_begin | vkf_layer | Interface | |
| vkf_viewer_frame_draw | vkf_layer | Interface | |
| vkf_viewer_get_look_at | vkf_layer | Interface | |
| vkf_viewer_gui | vkf_layer | Interface | |
| vkf_viewer_hud_add | vkf_layer | Interface | |
| vkf_viewer_hud_remove | vkf_layer | Interface | |
| vkf_viewer_key | vkf_layer | Interface | |
| vkf_viewer_light | vkf_layer | Interface | |
| vkf_viewer_light_enable | vkf_layer | Interface | |
| vkf_viewer_look_at | vkf_layer | Interface | |
| vkf_viewer_mouse | vkf_layer | Interface | |
| vkf_viewer_orthographic | vkf_layer | Interface | |
| vkf_viewer_perspective | vkf_layer | Interface | |
| vkf_viewer_pixel_ratio | vkf_layer | Interface | |
| vkf_viewer_record_frames | vkf_layer | Interface | |
| vkf_viewer_record_start | vkf_layer | Interface | |
| vkf_viewer_record_stop | vkf_layer | Interface | |
| vkf_viewer_remove_node | vkf_layer | Interface | |
| vkf_viewer_resize | vkf_layer | Interface | |
| vkf_viewer_scene_counts | vkf_layer | Interface | |
| vkf_viewer_scroll | vkf_layer | Interface | |
| vkf_viewer_set_background | vkf_layer | Interface | |
| vkf_viewer_set_camera_controls | vkf_layer | Interface | |
| vkf_viewer_set_grab | vkf_layer | Interface | |
| vkf_viewer_set_pixel_ratio | vkf_layer | Interface | |
| vkf_viewer_set_view_transform | vkf_layer | Interface | |
| vkf_viewer_size | vkf_layer | Interface | |
| vkf_viewer_stats | vkf_layer | Interface | |
| vkf_vulkan_device_name | vkf_layer | Interface | |
| vsg_alignment | vkf_text | Subroutine | The horizontal and vertical alignments of vsg::StandardLayout for an ALIGN_* constant (vkf_frames: 0 left-top ... 8 right-bottom, 9 to 11 base line). |
| vulkan_device_name | vkf_layer | Function | Name of the first Vulkan physical device, or an empty string if there is none. |
| wall_time | vkf_clock | Function | Wall-clock time in seconds (system_clock), for the clock's default. |
| wants | vkf_pick | Function | Hits of |
| window_gui | vkf_window | Function | The window's GUI panels (vkf_gui), made on first use: with |
| window_pick | vkf_window | Subroutine | What is under point (x, y) of the window (-1 to 1 across it, y up: as
the event handler's positions), nearest first (see the module
documentation): none before the first frame. |
| window_view | vkf_window | Function | View i (1 to num_views). |
| window_viewer | vkf_window | Function | The window's viewer handle in the rendering layer (null until open), for adding low-level nodes (src/vsg/vkf_layer.f90). |
| window_wall | vkf_window | Function | The window's wall time (s): the wall clock's, or while recording the video's (its start, plus a frame's time per frame drawn). |
| world_matrix | vkf_frames | Function | The transform from this frame to the root of its tree, through the first parent at each level. |
| world_matrix_at | vkf_frames | Function | The transform from this frame to the root of its tree at simulation
time |
| world_to_view | vkf_view | Function | The transform from the root frame to the view frame (4x4), from the frames' current positions and attitudes. |
| wrapped_time | vkf_follower | Function | For FOLLOW_LOOP, t wrapped into the combined time range of the trajectories. |
| write_changed | vkf_artists | Function | The points written as the trajectory changed: the chain made again if its colors are drawn now or no longer (its first colors, or the setting), then the points new since the last written (and the last one again: set_optional; and those whose colors came since), or all of them on a redraw (cleared, a new trajectory or data sources). False if the chain isn't built. |
| write_colors | vkf_artists | Subroutine | The colors of points i1 .. i2 into the chain: the trajectory's, and the artist's color for points without one yet. |
| write_curve | vkf_artists | Subroutine | Write points i1 .. i2 into the chain (and upload the chunks written to). |
| write_intermediates | vkf_artists | Subroutine | Write intermediate markers i1 .. i2 into their chain, with their colors (with point colors), and upload the chunks written to. |
| write_marker | vkf_artists | Subroutine | A single marker's point (in a chain of one marker), and its color (a colored chain), uploaded. |
| write_region | vkf_shadow | Subroutine | A region's frustum into its mesh (uploaded), and shown or hidden. |
| write_ribbon | vkf_artists | Subroutine | Write the pairs of trajectory points i1 .. i2 into the chain, with their colors (and upload the chunks written to). |
| write_segments | vkf_artists | Subroutine | Write segments s1 .. s2 into the chain (and upload the chunks written to). |
| write_segments | vkf_line_segments | Subroutine | The segments into the chain: segment i as points 2i-1 (a) and 2i (b), with their colors; uploaded, and drawn. |
| written | vkf_line_chain | Subroutine | Points i1 .. i2 were written: measure a strip's distances along it (from
the distance at point i1-1), update its level of detail, and upload the
chunks holding them. |
| zoom_speed | vkf_window | Function | The zoom speed (set_zoom_speed). |