ShadowCones – vkframes

type, public, extends(ReferenceFrame) :: ShadowCones

A body's shadow cones (see the module documentation).

Inherits

Help

Components

Type	Visibility	Attributes		Name		Initial
class(ReferenceFrame),	private,	pointer	::	body_	=>	null()	the body casting the shadow (not owned)
real(kind=wp),	private		::	body_radius_	=	0.0_wp	(0: the frames' own)
real(kind=wp),	private		::	distance_	=	0.0_wp	body to light at the last update (scene units)
real(kind=wp),	private		::	drawn_length_	=	0.0_wp	the length drawn at the last update (scene units)
real(kind=wp),	private		::	length_	=	0.0_wp	(0: automatic)
class(ReferenceFrame),	private,	pointer	::	light_	=>	null()	the light (not owned)
real(kind=wp),	private		::	light_radius_	=	0.0_wp	(0: the frames' own)
type(ShadowRegion),	private		::	region(n_regions)			umbra, penumbra and antumbra
integer,	private		::	regions_	=	SHADOW_ALL	an ior of SHADOW_UMBRA, SHADOW_PENUMBRA, SHADOW_ANTUMBRA
real(kind=wp),	private		::	shaped(4)	=	-1.0_wp	R, Rs, d and length the cones have now

Constructor

public interface ShadowCones

The ShadowCones constructor: ShadowCones(...) makes one (see new_shadow_cones for its arguments).

private function new_shadow_cones(name, body, light, body_radius, light_radius) result(s)

The shadow named name of body in the light of light (frames of the same tree; optional here, set later with set_body and set_light), with their radii if given (else the frames': see the module documentation). Its axes and name label are hidden.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	name	the frame's name
class(ReferenceFrame),	intent(in),	optional,	target	::	body	the body casting the shadow, the light (not owned)
class(ReferenceFrame),	intent(in),	optional,	target	::	light	the body casting the shadow, the light (not owned)
real(kind=wp),	intent(in),	optional		::	body_radius	scene units (default: the frames' own)
real(kind=wp),	intent(in),	optional		::	light_radius	scene units (default: the frames' own)

Return Value type(ShadowCones)

Type-Bound Procedures

procedure, public :: add_child

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

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

Arguments

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

Return Value logical

procedure, public :: attitude

private pure function attitude(self) result(q)

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

Arguments

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

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

procedure, public :: axes_labels_shown

private pure function axes_labels_shown(self)

Which axes labels are shown (as axes_shown).

Arguments

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

Return Value integer

procedure, public :: axes_shown

private pure function axes_shown(self)

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

Arguments

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

Return Value integer

procedure, public :: axis_label

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

The label text of axis X_AXIS, Y_AXIS or Z_AXIS.

Arguments

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

Return Value character(len=:), allocatable

procedure, public :: body

private function body(self) result(p)

The body casting the shadow (null if not set).

Arguments

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

Return Value class(ReferenceFrame), pointer

procedure, public :: body_radius

private function body_radius(self)

The body's radius used (0: none known).

Arguments

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

Return Value real(kind=wp)

procedure, public :: bound => shadow_bound

private subroutine shadow_bound(self, center, radius)

The drawn regions' bounding sphere (frame coordinates).

Arguments

Type	Intent		Name
class(ShadowCones),	intent(in)	::	self
real(kind=wp),	intent(out)	::	center(3)	the bounding sphere, frame coordinates (scene units)
real(kind=wp),	intent(out)	::	radius	the bounding sphere, frame coordinates (scene units)

procedure, public :: build_contents => shadow_build_contents

private subroutine shadow_build_contents(self, viewer, group)

A switch with a mesh for each region (vertices written at each change of shape), under group.

Arguments

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

procedure, public :: child

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

Child i (1 to num_children).

Arguments

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

Return Value class(ReferenceFrame), pointer

procedure, public :: child_index

private function child_index(self, frame)

Index of frame among the children, or 0.

Arguments

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

Return Value integer

procedure, public :: color

private pure function color(self) result(c)

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

Arguments

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

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

procedure, public :: contents_shown

private pure function contents_shown(self)

Whether what the frame draws is shown (show_contents).

Arguments

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

Return Value logical

procedure, public :: detach

private subroutine detach(self)

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

Arguments

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

procedure, public :: distance

private pure function distance(self)

The distance between the body and the light at the last update.

Arguments

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

Return Value real(kind=wp)

procedure, public :: drawn_length

private pure function drawn_length(self)

The length drawn at the last update.

Arguments

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

Return Value real(kind=wp)

procedure, public :: follow

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

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

Arguments

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

procedure, public :: follow_frame

private function follow_frame(self) result(f)

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

Arguments

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

Return Value class(ReferenceFrame), pointer

procedure, public :: follower

private function follower(self) result(f)

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

Arguments

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

Return Value type(TrajectoryFollower), pointer

procedure, public :: frame_info => shadow_frame_info

private function shadow_frame_info(self) result(info)

What kind of frame this is: 'ShadowCones'.

Arguments

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

Return Value character(len=:), allocatable

procedure, public :: frame_string

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

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

Arguments

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

Return Value character(len=:), allocatable

procedure, public :: has_light_source

private recursive function has_light_source(self) result(has)

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

Arguments

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

Return Value logical

procedure, public :: is_following

private pure function is_following(self)

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

Arguments

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

Return Value logical

procedure, public :: label_alignment

private pure function label_alignment(self)

The labels' alignment (ALIGN_*).

Arguments

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

Return Value integer

procedure, public :: label_font

private function label_font(self) result(font)

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

Arguments

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

Return Value character(len=:), allocatable

procedure, public :: label_size

private pure function label_size(self)

The labels' size in pixels.

Arguments

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

Return Value integer

procedure, public :: late_update => shadow_late_update

private recursive subroutine shadow_late_update(self, t)

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.

Arguments

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

procedure, public :: length

private pure function length(self)

The length set (0: automatic).

Arguments

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

Return Value real(kind=wp)

procedure, public :: light

private function light(self) result(p)

The light (null if not set).

Arguments

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

Return Value class(ReferenceFrame), pointer

procedure, public :: light_ambient

private pure function light_ambient(self) result(rgb)

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

Arguments

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

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

procedure, public :: light_diffuse

private pure function light_diffuse(self) result(rgb)

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

Arguments

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

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

procedure, public :: light_radius

private function light_radius(self)

The light's radius used (0: none known).

Arguments

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

Return Value real(kind=wp)

procedure, public :: light_source_enabled

private pure function light_source_enabled(self)

Whether this frame carries a light source.

Arguments

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

Return Value logical

procedure, public :: light_specular

private pure function light_specular(self) result(rgb)

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

Arguments

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

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

procedure, public :: local_matrix

private pure function local_matrix(self) result(m)

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

Arguments

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

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

procedure, public :: local_matrix_at

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

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

Arguments

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

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

procedure, public :: motion_key

private recursive subroutine motion_key(self, stamp, data)

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

Arguments

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

procedure, public :: move_x_axis

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

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

Arguments

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

procedure, public :: move_y_axis

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

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

Arguments

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

procedure, public :: move_z_axis

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

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

Arguments

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

procedure, public :: name

private function name(self) result(n)

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

Arguments

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

Return Value character(len=:), allocatable

procedure, public :: name_label_on_top

private pure function name_label_on_top(self)

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

Arguments

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

Return Value logical

procedure, public :: name_label_shown

private pure function name_label_shown(self)

Whether the name label is shown.

Arguments

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

Return Value logical

procedure, public :: node

private function node(self) result(n)

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

Arguments

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

Return Value type(c_ptr)

procedure, public :: num_children

private pure function num_children(self)

Number of children.

Arguments

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

Return Value integer

procedure, public :: num_parents

private pure function num_parents(self)

Number of parents.

Arguments

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

Return Value integer

procedure, public :: parent

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

Parent i (1 to num_parents).

Arguments

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

Return Value class(ReferenceFrame), pointer

procedure, public :: parent_index

private function parent_index(self, frame)

Index of frame among the parents, or 0.

Arguments

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

Return Value integer

procedure, public :: pick

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

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

Arguments

Type	Intent	Attributes		Name
class(ReferenceFrame),	intent(in),	target	::	self
type(PickCamera),	intent(in)		::	cam	the cursor's ray and the pick's settings
real(kind=wp),	intent(in)		::	to_root(4,4)	the frame's transform to the root frame
type(PickHit),	intent(inout),	allocatable	::	hits(:)	hits so far (grown as needed)
integer,	intent(inout)		::	n	number of hits in hits

procedure, public :: pickable

private pure function pickable(self)

Whether pick tests what this frame draws (set_pickable).

Arguments

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

Return Value logical

procedure, public :: position

private pure function position(self) result(p)

Position relative to the parent frame.

Arguments

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

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

procedure, public :: position_of

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

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

Arguments

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

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

procedure, public :: realize

private recursive subroutine realize(self, viewer)

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

Arguments

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

procedure, public :: region_color

private function region_color(self, region) result(c)

A region's color [r, g, b, a] (0 for an unknown region).

Arguments

Type	Intent	Optional	Attributes		Name
class(ShadowCones),	intent(in)			::	self
integer,	intent(in)			::	region	SHADOW_UMBRA, SHADOW_PENUMBRA or SHADOW_ANTUMBRA

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

procedure, public :: region_extent

private subroutine region_extent(self, region, drawn, z0, r0, z1, r1)

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).

Arguments

Type	Intent	Optional		Name
class(ShadowCones),	intent(in)		::	self
integer,	intent(in)		::	region	SHADOW_UMBRA, SHADOW_PENUMBRA or SHADOW_ANTUMBRA
logical,	intent(out)		::	drawn	it has a surface and is drawn
real(kind=wp),	intent(out),	optional	::	z0	scene units
real(kind=wp),	intent(out),	optional	::	r0	scene units
real(kind=wp),	intent(out),	optional	::	z1	scene units
real(kind=wp),	intent(out),	optional	::	r1	scene units

procedure, public :: regions

private pure function regions(self)

The regions drawn: an ior of SHADOW_UMBRA, SHADOW_PENUMBRA and SHADOW_ANTUMBRA.

Arguments

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

Return Value integer

procedure, public :: remove_child

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

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

Arguments

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

Return Value logical

procedure, public :: reposition_axes

private subroutine reposition_axes(self)

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

Arguments

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

procedure, public :: set_attitude

private subroutine set_attitude(self, q)

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

Arguments

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

procedure, public :: set_body

private subroutine set_body(self, body, radius)

The body casting the shadow (it must stay alive while set), and its radius (optional: see set_body_radius).

Arguments

Type	Intent	Optional	Attributes		Name
class(ShadowCones),	intent(inout)			::	self
class(ReferenceFrame),	intent(in),		target	::	body	the body casting the shadow (not owned)
real(kind=wp),	intent(in),	optional		::	radius	scene units (see set_body_radius)

procedure, public :: set_body_radius

private subroutine set_body_radius(self, radius)

The body's radius (scene units; 0: the body's own, a Sphere's equatorial radius or a TerrainBody's).

Arguments

Type	Intent	Optional	Attributes		Name
class(ShadowCones),	intent(inout)			::	self
real(kind=wp),	intent(in)			::	radius	scene units (0: the body's own)

procedure, public :: set_color

private subroutine set_color(self, color)

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

Arguments

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

procedure, public :: set_label_alignment

private subroutine set_label_alignment(self, alignment)

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

Arguments

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

procedure, public :: set_label_font

private subroutine set_label_font(self, font)

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

Arguments

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

procedure, public :: set_label_size

private subroutine set_label_size(self, size)

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

Arguments

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

procedure, public :: set_length

private subroutine set_length(self, length)

How far behind the body's center the shadow is drawn (scene units; 0: automatic, twice the umbra's length).

Arguments

Type	Intent	Optional	Attributes		Name
class(ShadowCones),	intent(inout)			::	self
real(kind=wp),	intent(in)			::	length	scene units (0: automatic)

procedure, public :: set_light

private subroutine set_light(self, light, radius)

The light (e.g. the Sun; it must stay alive while set), and its radius (optional: see set_light_radius).

Arguments

Type	Intent	Optional	Attributes		Name
class(ShadowCones),	intent(inout)			::	self
class(ReferenceFrame),	intent(in),		target	::	light	the light, e.g. the Sun (not owned)
real(kind=wp),	intent(in),	optional		::	radius	scene units (see set_light_radius)

procedure, public :: set_light_ambient

private subroutine set_light_ambient(self, rgb)

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

Arguments

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

procedure, public :: set_light_diffuse

private subroutine set_light_diffuse(self, rgb)

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

Arguments

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

procedure, public :: set_light_radius

private subroutine set_light_radius(self, radius)

The light's radius (scene units; 0: the light's own, if a Sphere).

Arguments

Type	Intent	Optional	Attributes		Name
class(ShadowCones),	intent(inout)			::	self
real(kind=wp),	intent(in)			::	radius	scene units (0: the light's own)

procedure, public :: set_light_source_enabled

private subroutine set_light_source_enabled(self, enable)

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

Arguments

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

procedure, public :: set_light_specular

private subroutine set_light_specular(self, rgb)

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

Arguments

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

procedure, public :: set_name

private subroutine set_name(self, name)

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

Arguments

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

procedure, public :: set_name_label_on_top

private subroutine set_name_label_on_top(self, on_top)

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

Arguments

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

procedure, public :: set_pickable

private subroutine set_pickable(self, pickable)

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

Arguments

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

procedure, public :: set_position

private subroutine set_position(self, position)

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

Arguments

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

procedure, public :: set_region_color

private subroutine set_region_color(self, region, color)

A region's color (region: one of SHADOW_UMBRA, SHADOW_PENUMBRA, SHADOW_ANTUMBRA; [r, g, b], alpha unchanged, or [r, g, b, a]).

Arguments

Type	Intent		Name
class(ShadowCones),	intent(inout)	::	self
integer,	intent(in)	::	region	SHADOW_UMBRA, SHADOW_PENUMBRA or SHADOW_ANTUMBRA
real(kind=wp),	intent(in)	::	color(:)	[r, g, b] (alpha unchanged) or [r, g, b, a], 0 to 1

procedure, public :: set_regions

private subroutine set_regions(self, regions)

The regions to draw: an ior of SHADOW_UMBRA, SHADOW_PENUMBRA and SHADOW_ANTUMBRA (default SHADOW_ALL).

Arguments

Type	Intent	Optional	Attributes		Name
class(ShadowCones),	intent(inout)			::	self
integer,	intent(in)			::	regions	an ior of SHADOW_UMBRA, SHADOW_PENUMBRA, SHADOW_ANTUMBRA

procedure, public :: set_x_label

private subroutine set_x_label(self, text)

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

Arguments

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

procedure, public :: set_y_label

private subroutine set_y_label(self, text)

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

Arguments

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

procedure, public :: set_z_label

private subroutine set_z_label(self, text)

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

Arguments

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

procedure, public :: show_axes

private subroutine show_axes(self, axes)

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

Arguments

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

procedure, public :: show_axes_labels

private subroutine show_axes_labels(self, labels)

Which axes labels to show (as show_axes).

Arguments

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

procedure, public :: show_contents

private subroutine show_contents(self, show)

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

Arguments

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

procedure, public :: show_decorations

private subroutine show_decorations(self, show)

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

Arguments

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

procedure, public :: show_name_label

private subroutine show_name_label(self, show)

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

Arguments

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

procedure, public :: sync

private recursive subroutine sync(self)

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

Arguments

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

procedure, public :: umbra_length

private pure function umbra_length(self)

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).

Arguments

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

Return Value real(kind=wp)

procedure, public :: unfollow

private subroutine unfollow(self)

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

Arguments

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

procedure, public :: update

private recursive subroutine update(self, t)

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

Arguments

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

procedure, public :: world_matrix

private recursive function world_matrix(self) result(m)

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

Arguments

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

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

procedure, public :: world_matrix_at

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

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

Arguments

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

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

Source Code

    type, extends(ReferenceFrame), public :: ShadowCones
        private
        class(ReferenceFrame), pointer :: body_ => null()   !! the body casting the shadow (not owned)
        class(ReferenceFrame), pointer :: light_ => null()  !! the light (not owned)
        real(wp) :: body_radius_ = 0.0_wp, light_radius_ = 0.0_wp   !! (0: the frames' own)
        real(wp) :: length_ = 0.0_wp                                !! (0: automatic)
        integer :: regions_ = SHADOW_ALL                    !! an ior of SHADOW_UMBRA, SHADOW_PENUMBRA, SHADOW_ANTUMBRA
        type(ShadowRegion) :: region(n_regions)             !! umbra, penumbra and antumbra
        real(wp) :: shaped(4) = -1.0_wp                     !! R, Rs, d and length the cones have now
        real(wp) :: distance_ = 0.0_wp                      !! body to light at the last update (scene units)
        real(wp) :: drawn_length_ = 0.0_wp                  !! the length drawn at the last update (scene units)
    contains
        procedure :: set_body, body, set_light, light
        procedure :: set_body_radius, set_light_radius, body_radius, light_radius
        procedure :: set_length, length, drawn_length, distance
        procedure :: set_regions, regions
        procedure :: set_region_color, region_color
        procedure :: region_extent, umbra_length
        procedure :: frame_info => shadow_frame_info
        procedure :: bound => shadow_bound
        procedure :: build_contents => shadow_build_contents
        procedure :: late_update => shadow_late_update
    end type ShadowCones

ShadowCones Derived Type

Contents

Variables

Constructor

Type-Bound Procedures

Source Code

type, public, extends(ReferenceFrame) :: ShadowCones

Inherits

Components

Constructor

public interface ShadowCones

private function new_shadow_cones(name, body, light, body_radius, light_radius) result(s)

Arguments

Return Value type(ShadowCones)

Type-Bound Procedures

procedure, public :: add_child

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

Arguments

Return Value logical

procedure, public :: attitude

private pure function attitude(self) result(q)

Arguments

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

procedure, public :: axes_labels_shown

private pure function axes_labels_shown(self)

Arguments

Return Value integer

procedure, public :: axes_shown

private pure function axes_shown(self)

Arguments

Return Value integer

procedure, public :: axis_label

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

Arguments

Return Value character(len=:), allocatable

procedure, public :: body

private function body(self) result(p)

Arguments

Return Value class(ReferenceFrame), pointer

procedure, public :: body_radius

private function body_radius(self)

Arguments

Return Value real(kind=wp)

procedure, public :: bound => shadow_bound

private subroutine shadow_bound(self, center, radius)

Arguments

procedure, public :: build_contents => shadow_build_contents

private subroutine shadow_build_contents(self, viewer, group)

Arguments

procedure, public :: child

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

Arguments

Return Value class(ReferenceFrame), pointer

procedure, public :: child_index

private function child_index(self, frame)

Arguments

Return Value integer

procedure, public :: color

private pure function color(self) result(c)

Arguments

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

procedure, public :: contents_shown

private pure function contents_shown(self)

Arguments

Return Value logical

procedure, public :: detach

private subroutine detach(self)

Arguments

procedure, public :: distance

private pure function distance(self)

Arguments

Return Value real(kind=wp)

procedure, public :: drawn_length

private pure function drawn_length(self)

Arguments

Return Value real(kind=wp)

procedure, public :: follow

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

Arguments

procedure, public :: follow_frame