openframes_module – openframes-fortran

Type	Visibility	Attributes		Name		Initial
integer(kind=c_int),	public,	parameter	::	of_zero	=	0
integer(kind=c_int),	public,	parameter	::	of_time	=	1
integer(kind=c_int),	public,	parameter	::	of_posopt	=	2
integer(kind=c_int),	public,	parameter	::	of_attitude	=	3
integer(kind=c_int),	public,	parameter	::	of_x	=	0	x position or quaternion 1 element
integer(kind=c_int),	public,	parameter	::	of_y	=	1	y position or quaternion 2 element
integer(kind=c_int),	public,	parameter	::	of_z	=	2	z position or quaternion 3 element
integer(kind=c_int),	public,	parameter	::	of_w	=	3	quaternion 4 element (angle)
integer(kind=c_int),	public,	parameter	::	ofma_start	=	1	draw start marker
integer(kind=c_int),	public,	parameter	::	ofma_intermediate	=	2	draw intermediate markers
integer(kind=c_int),	public,	parameter	::	ofma_end	=	4	draw end marker
integer(kind=c_int),	public,	parameter	::	ofma_time	=	1
integer(kind=c_int),	public,	parameter	::	ofma_distance	=	2	distance increments
integer(kind=c_int),	public,	parameter	::	ofma_data	=	3	data point increments
integer(kind=c_int),	public,	parameter	::	offollow_loop	=	0
integer(kind=c_int),	public,	parameter	::	offollow_limit	=	1
integer(kind=c_int),	public,	parameter	::	offollow_position	=	1
integer(kind=c_int),	public,	parameter	::	offollow_attitude	=	2
integer(kind=c_int),	public,	parameter	::	of_noaxes	=	0	don't use any axes
integer(kind=c_int),	public,	parameter	::	of_xaxis	=	1	use x axis
integer(kind=c_int),	public,	parameter	::	of_yaxis	=	2	use y axis
integer(kind=c_int),	public,	parameter	::	of_zaxis	=	4	use z axis
integer(kind=c_int),	public,	parameter	::	ofview_absolute	=	0	global reference frame
integer(kind=c_int),	public,	parameter	::	ofview_relative	=	1	body-fixed frame
integer(kind=c_int),	public,	parameter	::	ofview_direct	=	0	direct rotation
integer(kind=c_int),	public,	parameter	::	ofview_azel	=	1	azimuth-elevation rotation

public subroutine of_initialize()

sets up all internal openframes fortran/c interface variables must be called before other openframes calls

Arguments

None

public subroutine of_cleanup()

cleans up all internal openframes fortran/c interface variables must be called when done using openframes afterwards, the only way to continue using openframes is to first make another call to of_initialize

Arguments

None

public subroutine of_getreturnedvalue(val)

Get the return value returned by the most recent API function call.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(out)			::	val	variable to store the return value from the previous API function call.

public subroutine of_adddatafilepath(newpath)

Add a search path when OSG tries to load data files.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	newpath	full path to be searched when loading a file.

public subroutine ofwin_activate(id)

Set the active WindowProxy

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(in)			::	id	ID of the window to activate.

public subroutine ofwin_getid(id)

Get ID of the active WindowProxy

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(out)			::	id	ID of the active window.

public subroutine ofwin_createproxy(x, y, width, height, nrow, ncol, embedded, id, usevr)

Create a new WindowProxy that will manage drawing onto a window. This new WindowProxy will also become the current active one.

Arguments

Type	Intent		Name
integer(kind=int32),	intent(in)	::	x	X-coordinate (in pixels) of the screen of the upper-right corner of the window.
integer(kind=int32),	intent(in)	::	y	Y-coordinate (in pixels) of the screen of the upper-right corner of the window.
integer(kind=int32),	intent(in)	::	width	Width of the window (in pixels).
integer(kind=int32),	intent(in)	::	height	Height of the window (in pixels).
integer(kind=int32),	intent(in)	::	nrow	Number of rows in the window grid.
integer(kind=int32),	intent(in)	::	ncol	Number of columns in the window grid.
logical,	intent(in)	::	embedded	True if the user wants to provide their own OpenGL window.
integer(kind=int32),	intent(in)	::	id	ID of this window.
logical,	intent(in)	::	usevr	Whether to enable rendering in VR (if OpenFrames is built with OpenVR support)

public subroutine ofwin_setwindowname(winname)

Set the window name (title). Only applies to non-embedded windows.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	winname	The new window name.

public subroutine ofwin_setgridsize(nrow, ncol)

Set the number rows and columns in the grid.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(in)			::	nrow	Number of rows in the window grid.
integer(kind=int32),	intent(in)			::	ncol	Number of columns in the window grid.

public subroutine ofwin_setkeypresscallback(fcn)

Set a callback function to be called on keypress.

Arguments

Type	Intent	Optional	Attributes		Name
procedure(keypresscallback)				::	fcn	Callback function to be called on keypress.

public subroutine ofwin_setmousemotioncallback(fcn)

Set a callback function to be called on mouse motion.

Arguments

Type	Intent	Optional	Attributes		Name
procedure(mousemotioncallback)				::	fcn	Callback function to be called on mouse motion.

public subroutine ofwin_setbuttonpresscallback(fcn)

Set a callback function to be called on button press.

Arguments

Type	Intent	Optional	Attributes		Name
procedure(buttonpresscallback)				::	fcn	Callback function to be called on button press.

public subroutine ofwin_setbuttonreleasecallback(fcn)

Set a callback function to be called on button release.

Arguments

Type	Intent	Optional	Attributes		Name
procedure(buttonreleasecallback)				::	fcn	Callback function to be called on button release.

public subroutine ofwin_start()

Start animation.

Arguments

None

public subroutine ofwin_stop()

Force animation to stop and wait for the thread to stop.

Arguments

None

public subroutine ofwin_signalstop()

Signal animation to stop and return immediately.

Arguments

None

public subroutine ofwin_waitforstop()

Wait for user to exit animation.

Arguments

None

public subroutine ofwin_pauseanimation(pause)

Pause/unpause the animation.

Arguments

Type	Intent	Optional	Attributes		Name
logical,	intent(in)			::	pause	True to pause the animation, False to unpause the animation.

public subroutine ofwin_isrunning(state)

Check if the animation is running.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(out)			::	state	This variable is set to 1 if the animation is running, 0 otherwise.

public subroutine ofwin_setscene(row, col)

Set the scene at the specified grid position.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(in)			::	row	Row in the grid to set.
integer(kind=int32),	intent(in)			::	col	Column in the grid to set.

public subroutine ofwin_settime(time)

Set the simulation time.

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=real64),	intent(in)			::	time	New simulation time.

public subroutine ofwin_gettime(time)

Get the simulation time.

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=real64),	intent(out)			::	time	Current simulation time.

public subroutine ofwin_pausetime(pause)

Set whether to pause time.

Arguments

Type	Intent	Optional	Attributes		Name
logical,	intent(in)			::	pause	Set to 1 to pause the simulation time, 0 to unpause.

public subroutine ofwin_istimepaused(ispaused)

Check if time is paused.

Arguments

Type	Intent	Optional	Attributes		Name
logical,	intent(out)			::	ispaused	Set to 1 if simulation time is paused, 0 if unpaused.

public subroutine ofwin_settimescale(tscale)

Set the simulation time scale.

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=real64),	intent(in)			::	tscale	New simulation time scale.

public subroutine ofwin_gettimescale(tscale)

Get the simulation time scale.

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=real64),	intent(out)			::	tscale	Current simulation time scale.

public subroutine ofwin_setlightambient(row, col, r, g, b)

Set the lighting parameters for the specified grid position.

Arguments

Type	Intent		Name
integer(kind=int32),	intent(in)	::	row	Row in the grid to set.
integer(kind=int32),	intent(in)	::	col	Column in the grid to set.
real(kind=real32),	intent(in)	::	r	Red component of specified light.
real(kind=real32),	intent(in)	::	g	Green component of specified light.
real(kind=real32),	intent(in)	::	b	Blue component of specified light.

public subroutine ofwin_setlightdiffuse(row, col, r, g, b)

Set the lighting parameters for the specified grid position.

Arguments

Type	Intent		Name
integer(kind=int32),	intent(in)	::	row	Row in the grid to set.
integer(kind=int32),	intent(in)	::	col	Column in the grid to set.
real(kind=real32),	intent(in)	::	r	Red component of specified light.
real(kind=real32),	intent(in)	::	g	Green component of specified light.
real(kind=real32),	intent(in)	::	b	Blue component of specified light.

public subroutine ofwin_setlightspecular(row, col, r, g, b)

Set the lighting parameters for the specified grid position.

Arguments

Type	Intent		Name
integer(kind=int32),	intent(in)	::	row	Row in the grid to set.
integer(kind=int32),	intent(in)	::	col	Column in the grid to set.
real(kind=real32),	intent(in)	::	r	Red component of specified light.
real(kind=real32),	intent(in)	::	g	Green component of specified light.
real(kind=real32),	intent(in)	::	b	Blue component of specified light.

public subroutine ofwin_setlightposition(row, col, x, y, z, w)

Set the light position for the specified grid position.

Arguments

Type	Intent		Name
integer(kind=int32),	intent(in)	::	row	Row in the grid to set.
integer(kind=int32),	intent(in)	::	col	Column in the grid to set.
real(kind=real32),	intent(in)	::	x	X position in eye space.
real(kind=real32),	intent(in)	::	y	Y position in eye space.
real(kind=real32),	intent(in)	::	z	Z position in eye space.
real(kind=real32),	intent(in)	::	w	If 0 then directional (antiparallel to x,y,z direction). If 1 then positional (radiates from x,y,z direction).

public subroutine ofwin_setstereo(row, col, enable, eyeseparation, width, height, distance)

Set the 3D stereo mode for the specified grid position.

Arguments

Type	Intent		Name
integer(kind=int32),	intent(in)	::	row	Row in the grid to set.
integer(kind=int32),	intent(in)	::	col	Column in the grid to set.
logical,	intent(in)	::	enable	True to enable 3D stereo mode.
real(kind=real32),	intent(in)	::	eyeseparation	Set eye separation for 3D stereo.
real(kind=real32),	intent(in)	::	width	Width of the screen.
real(kind=real32),	intent(in)	::	height	Height of the screen.
real(kind=real32),	intent(in)	::	distance	Distance of the screen.

public subroutine ofwin_setbackgroundcolor(row, col, r, g, b)

Set the background color of the specified grid position.

Arguments

Type	Intent		Name
integer(kind=int32),	intent(in)	::	row	Row in the grid to set.
integer(kind=int32),	intent(in)	::	col	Column in the grid to set.
real(kind=real32),	intent(in)	::	r	Red color component [0-1].
real(kind=real32),	intent(in)	::	g	Green color component [0-1].
real(kind=real32),	intent(in)	::	b	Blue color component [0-1].

public subroutine ofwin_setbackgroundtexture(row, col, fname)

Set the background texture of the specified grid position.

Arguments

Type	Intent		Name
integer(kind=int32),	intent(in)	::	row	Row in the grid to set.
integer(kind=int32),	intent(in)	::	col	Column in the grid to set.
character(len=*),	intent(in)	::	fname	File containing the background texture.

public subroutine ofwin_setbackgroundstardata(row, col, minmag, maxmag, fname)

Set the background star field of the specified grid position.

Arguments

Type	Intent		Name
integer(kind=int32),	intent(in)	::	row	Row in the grid to set.
integer(kind=int32),	intent(in)	::	col	Column in the grid to set.
real(kind=real32),	intent(in)	::	minmag	Minimum star magnitude to show.
real(kind=real32),	intent(in)	::	maxmag	Maximum star magnitude to show.
character(len=*),	intent(in)	::	fname	File containing the background star field catalog data.

public subroutine ofwin_enablehudtext(row, col, enable)

Enable/disable the HUD text for the specified grid position. Create placeholder HUD text if it does not yet exist.

Arguments

Type	Intent		Name
integer(kind=int32),	intent(in)	::	row	Row in the grid to set.
integer(kind=int32),	intent(in)	::	col	Column in the grid to set.
logical,	intent(in)	::	enable	Whether to enable or disable the HUD text.

public subroutine ofwin_sethudtextfont(row, col, fname)

Set HUD font. Create placeholder HUD text if it does not yet exist.

Arguments

Type	Intent		Name
integer(kind=int32),	intent(in)	::	row	Row in the grid to set.
integer(kind=int32),	intent(in)	::	col	Column in the grid to set.
character(len=*),	intent(in)	::	fname	Name of font to use, e.g. "arial.ttf".

public subroutine ofwin_sethudtextparameters(row, col, r, g, b, charsize)

Set HUD color and size. Create placeholder HUD text if it does not yet exist.

Arguments

Type	Intent		Name
integer(kind=int32),	intent(in)	::	row	Row in the grid to set.
integer(kind=int32),	intent(in)	::	col	Column in the grid to set.
real(kind=real32),	intent(in)	::	r	Red color component.
real(kind=real32),	intent(in)	::	g	Green color component.
real(kind=real32),	intent(in)	::	b	Blue color component.
real(kind=real32),	intent(in)	::	charsize	Character size in pixels.

public subroutine ofwin_sethudtextposition(row, col, x, y, alignment)

Set HUD text position and alignment. Create placeholder HUD text if it does not yet exist.

Arguments

Type	Intent		Name
integer(kind=int32),	intent(in)	::	row	Row in the grid to set.
integer(kind=int32),	intent(in)	::	col	Column in the grid to set.
real(kind=real32),	intent(in)	::	x	Text origin x position, in range [0,1] from left to right.
real(kind=real32),	intent(in)	::	y	Text origin y position, in range [0,1] from bottom to top.
integer(kind=int32),	intent(in)	::	alignment	Alignment location of text origin, see osgText::AlignmentType enum.

public subroutine ofwin_sethudtext(row, col, text)

Set HUD text. Create placeholder HUD text if it does not yet exist.

Arguments

Type	Intent		Name
integer(kind=int32),	intent(in)	::	row	Row in the grid to set.
integer(kind=int32),	intent(in)	::	col	Column in the grid to set.
character(len=*),	intent(in)	::	text	The new HUD text.

public subroutine ofwin_setdesiredframerate(fps)

Set the desired framerate of the window (frames/second).

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=real64),	intent(in)			::	fps	Desired framerate value in frames per second.

public subroutine ofwin_addview(row, col)

Add a view to the window.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(in)			::	row	Row to add the view to.
integer(kind=int32),	intent(in)			::	col	Column to add the view to.

public subroutine ofwin_removeview(row, col)

Remove a view from the window.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(in)			::	row	Row to remove the view from.
integer(kind=int32),	intent(in)			::	col	Column to remove the view from.

public subroutine ofwin_removeallviews(row, col)

Remove all the view(s) from the window.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(in)			::	row	Row to remove the view(s) from.
integer(kind=int32),	intent(in)			::	col	Column to remove the view(s) from.

public subroutine ofwin_selectview(row, col)

Set the view currently displayed in the window.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(in)			::	row	Row to set the active view in.
integer(kind=int32),	intent(in)			::	col	Column to set the active view in.

public subroutine ofwin_setswapbuffersfunction(fcn)

Set a callback function for swapping the front/back buffers.

Arguments

Type	Intent	Optional	Attributes		Name
procedure(swapbuffersfunction)				::	fcn	Callback function to be called.

public subroutine ofwin_setmakecurrentfunction(fcn)

Set a callback function for making the OpenGL context current (so it can be drawn on).

Arguments

Type	Intent	Optional	Attributes		Name
procedure(makecurrentfunction)				::	fcn	Callback function to be called.

public subroutine ofwin_setupdatecontextfunction(fcn)

Set a callback function for updating the OpenGL context after qualifying events.

Arguments

Type	Intent	Optional	Attributes		Name
procedure(updatecontextfunction)				::	fcn	Callback function to be called.

public subroutine ofwin_resizewindow(x, y, width, height)

Resize the window to a new position and size.

Arguments

Type	Intent		Name
integer(kind=int32),	intent(in)	::	x	X-coordinate (in pixels) of the screen of the upper-right corner of the window.
integer(kind=int32),	intent(in)	::	y	Y-coordinate (in pixels) of the screen of the upper-right corner of the window.
integer(kind=int32),	intent(in)	::	width	Width of the window (in pixels).
integer(kind=int32),	intent(in)	::	height	Height of the window (in pixels).

public subroutine ofwin_keypress(key)

Create a key-pressed event.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(in)			::	key	Key pressed (see osg::GUIEventAdapter::KeySymbol enum).

public subroutine ofwin_keyrelease(key)

Create a key released event.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(in)			::	key	Key released (see osg::GUIEventAdapter::KeySymbol enum).

public subroutine ofwin_buttonpress(x, y, button)

Create a mouse button pressed event.

Arguments

Type	Intent		Name
real(kind=real32),	intent(in)	::	x	X-coordinate of the mouse in the window.
real(kind=real32),	intent(in)	::	y	Y-coordinate of the mouse in the window.
integer(kind=int32),	intent(in)	::	button	Mouse button pressed. Button numbering is 1 for left mouse button, 2 for middle, 3 for right.

public subroutine ofwin_buttonrelease(x, y, button)

Create a mouse button released event.

Arguments

Type	Intent		Name
real(kind=real32),	intent(in)	::	x	X-coordinate of the mouse in the window.
real(kind=real32),	intent(in)	::	y	Y-coordinate of the mouse in the window.
integer(kind=int32),	intent(in)	::	button	Mouse button released. Button numbering is 1 for left mouse button, 2 for middle, 3 for right.

public subroutine ofwin_mousemotion(x, y)

Create a mouse-moved event.

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=real32),	intent(in)			::	x	X-coordinate of the mouse in the window.
real(kind=real32),	intent(in)			::	y	Y-coordinate of the mouse in the window.

public subroutine ofwin_capturewindow()

Capture the next rendered frame.

Arguments

None

public subroutine ofwin_setwindowcapturefile(fname, fext)

Set the file name and type that will be used for window captures.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	fname	File name (without extension).
character(len=*),	intent(in)			::	fext	File extension (determines image type).

public subroutine ofwin_setwindowcapturekey(key)

Set the key that activates a window capture.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(in)			::	key	Integer representation of key char. Set to 0 (zero) to disable key-based window capture.

public subroutine offm_activate(id)

Set the currently active FrameManager.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(in)			::	id	ID of the frame manager to activate.

public subroutine offm_create(id)

Create a new FrameManager with the given ID.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(in)			::	id	ID of the frame manager to create.

public subroutine offm_setframe()

Assign a ReferenceFrame to the FrameManager.

Arguments

None

public subroutine offm_lock()

Lock the current FrameManager.

Arguments

None

public subroutine offm_unlock()

Unlock the current FrameManager.

Arguments

None

public subroutine offrame_activate(name)

Set the currently active reference frame.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	name	Name of the frame to activate.

public subroutine offrame_create(name)

Create a new ReferenceFrame with the given name.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	name	Name of the frame to create.

public subroutine offrame_setcolor(r, g, b, a)

Set the color of the current frame.

Arguments

Type	Intent		Name
real(kind=real32),	intent(in)	::	r	Red color component [0-1].
real(kind=real32),	intent(in)	::	g	Green color component [0-1].
real(kind=real32),	intent(in)	::	b	Blue color component [0-1].
real(kind=real32),	intent(in)	::	a	Alpha (transparancy) component [0-1].

public subroutine offrame_addchild(name)

* Add a child frame to the current frame.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	name	Name of the frame to add as a child to the active frame.

public subroutine offrame_removechild(name)

Remove a child frame from the current frame.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	name	Name of the child frame to remove from the active frame.

public subroutine offrame_removeallchildren()

Remove all child frames from the current frame.

Arguments

None

public subroutine offrame_getnumchildren(numchildren)

Get the number of child frames in the current frame.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(out)			::	numchildren	variable to store the number of child frames to.

public subroutine offrame_setposition(x, y, z)

Set the position of the current frame.

Arguments

Type	Intent		Name
real(kind=real64),	intent(in)	::	x	X position.
real(kind=real64),	intent(in)	::	y	Y position.
real(kind=real64),	intent(in)	::	z	Z position.

public subroutine offrame_getposition(x, y, z)

Get the position of the current frame.

Arguments

Type	Intent		Name
real(kind=real64),	intent(out)	::	x	Returned X position.
real(kind=real64),	intent(out)	::	y	Returned Y position.
real(kind=real64),	intent(out)	::	z	Returned Z position.

public subroutine offrame_setattitude(x, y, z, angle)

Set the attitude of the current frame.

Arguments

Type	Intent		Name
real(kind=real64),	intent(in)	::	x	X component of the rotation quaternion.
real(kind=real64),	intent(in)	::	y	Y component of the rotation quaternion.
real(kind=real64),	intent(in)	::	z	Z component of the rotation quaternion.
real(kind=real64),	intent(in)	::	angle	Angle component of the rotation quaternion.

public subroutine offrame_getattitude(x, y, z, angle)

Get the attitude of the current frame.

Arguments

Type	Intent		Name
real(kind=real64),	intent(out)	::	x	Returned X component of the rotation quaternion.
real(kind=real64),	intent(out)	::	y	Returned Y component of the rotation quaternion.
real(kind=real64),	intent(out)	::	z	Returned Z component of the rotation quaternion.
real(kind=real64),	intent(out)	::	angle	Returned angle component of the rotation quaternion.

public subroutine offrame_showaxes(axes)

Toggle which axis components are displayed.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(in)			::	axes	Axis components to show specified by `OpenFrames::ReferenceFrame::AxesType`, others will be hidden.

public subroutine offrame_shownamelabel(namelabel)

Toggle display of the name label of the frame.

Arguments

Type	Intent	Optional	Attributes		Name
logical,	intent(in)			::	namelabel	True to display the label, false to hide it.

public subroutine offrame_showaxeslabels(labels)

Toggle which axis labels are displayed.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(in)			::	labels	Axis labels to show specified by `OpenFrames::ReferenceFrame::AxesType`, others will be hidden.

public subroutine offrame_setnamelabel(name)

Change the name label for the current ReferenceFrame.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	name	Name of the label.

public subroutine offrame_setaxeslabels(xlabel, ylabel, zlabel)

Change the axes labels for the current ReferenceFrame.

Arguments

Type	Intent		Name
character(len=*),	intent(in)	::	xlabel	Name of the x-axis label.
character(len=*),	intent(in)	::	ylabel	Name of the y-axis label.
character(len=*),	intent(in)	::	zlabel	Name of the z-axis label.

public subroutine offrame_setlabelfont(font)

Set the label font for the current ReferenceFrame.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	font	Font name, either with absolute path or standalone. Must include extension.

public subroutine offrame_setlabelsize(size)

Set the label size for the current ReferenceFrame.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(in)			::	size	Label size, used as maximum size for axes labels

public subroutine offrame_movexaxis(pos, length, headratio, bodyradius, headradius)

Reposition and resize the x component of the coordinate axis.

Arguments

Type	Intent	Attributes		Name
real(kind=real64),	intent(in),	dimension(3)	::	pos	Position array of the origin of the x-axis component.
real(kind=real64),	intent(in)		::	length	Length of the x-axis arrow.
real(kind=real64),	intent(in)		::	headratio	Ratio of the arrow head to body. Set to 0.0 to use default.
real(kind=real64),	intent(in)		::	bodyradius	Radius of the body of the arrow. Set to 0.0 to use default.
real(kind=real64),	intent(in)		::	headradius	Radius of the head of the arrow. Set to 0.0 to use default.

public subroutine offrame_moveyaxis(pos, length, headratio, bodyradius, headradius)

Reposition and resize the y component of the coordinate axis.

Arguments

Type	Intent	Attributes		Name
real(kind=real64),	intent(in),	dimension(3)	::	pos	Position array of the origin of the y-axis component.
real(kind=real64),	intent(in)		::	length	Length of the y-axis arrow.
real(kind=real64),	intent(in)		::	headratio	Ratio of the arrow head to body. Set to 0.0 to use default.
real(kind=real64),	intent(in)		::	bodyradius	Radius of the body of the arrow. Set to 0.0 to use default.
real(kind=real64),	intent(in)		::	headradius	Radius of the head of the arrow. Set to 0.0 to use default.

public subroutine offrame_movezaxis(pos, length, headratio, bodyradius, headradius)

Reposition and resize the z component of the coordinate axis.

Arguments

Type	Intent	Attributes		Name
real(kind=real64),	intent(in),	dimension(3)	::	pos	Position array of the origin of the z-axis component.
real(kind=real64),	intent(in)		::	length	Length of the z-axis arrow.
real(kind=real64),	intent(in)		::	headratio	Ratio of the arrow head to body. Set to 0.0 to use default.
real(kind=real64),	intent(in)		::	bodyradius	Radius of the body of the arrow. Set to 0.0 to use default.
real(kind=real64),	intent(in)		::	headradius	Radius of the head of the arrow. Set to 0.0 to use default.

public subroutine offrame_setlightsourceenabled(enabled)

Enable and manage per-frame lighting.

Arguments

Type	Intent	Optional	Attributes		Name
logical,	intent(in)			::	enabled	Whether to enable or disable lighting.

public subroutine offrame_getlightsourceenabled(enabled)

Enable and manage per-frame lighting.

Arguments

Type	Intent	Optional	Attributes		Name
logical,	intent(out)			::	enabled	Whether to enable or disable lighting.

public subroutine offrame_setlightambient(r, g, b)

Enable and manage per-frame lighting.

Arguments

Type	Intent		Name
real(kind=real32),	intent(in)	::	r	Red component of specified light type.
real(kind=real32),	intent(in)	::	g	Green component of specified light type.
real(kind=real32),	intent(in)	::	b	Blue component of specified light type.

public subroutine offrame_setlightdiffuse(r, g, b)

Enable and manage per-frame lighting.

Arguments

Type	Intent		Name
real(kind=real32),	intent(in)	::	r	Red component of specified light type.
real(kind=real32),	intent(in)	::	g	Green component of specified light type.
real(kind=real32),	intent(in)	::	b	Blue component of specified light type.

public subroutine offrame_setlightspecular(r, g, b)

Enable and manage per-frame lighting.

Arguments

Type	Intent		Name
real(kind=real32),	intent(in)	::	r	Red component of specified light type.
real(kind=real32),	intent(in)	::	g	Green component of specified light type.
real(kind=real32),	intent(in)	::	b	Blue component of specified light type.

public subroutine offrame_followtrajectory(name)

Have this frame follow the specified trajectory.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	name	Name of the trajectory to follow.

public subroutine offrame_followtype(data, mode)

Follow the trajectory's position, attitude, or both, and set the follow mode.

Arguments

Type	Intent	Optional	Attributes		Name
integer(kind=int32),	intent(in)			::	data	Set whether to follow position and/or velocity (see `OpenFrames::TrajectoryFollower::FollowData`).
integer(kind=int32),	intent(in)			::	mode	Set the follow mode to loop repeatedly or to limit to the times added to the trajectory (see `OpenFrames::TrajectoryFollower::FollowMode`).

public subroutine offrame_followposition(src, element, opt, scale)

Set the elements to follow position.

Arguments

Type	Intent	Attributes		Name
integer(kind=int32),	intent(in),	dimension(3)	::	src	Set data source for each axis (see `OpenFrames::Trajectory::SourceType`).
integer(kind=int32),	intent(in),	dimension(3)	::	element	Set which element to follow.
integer(kind=int32),	intent(in),	dimension(3)	::	opt	Set which optional to follow.
real(kind=real64),	intent(in),	dimension(3)	::	scale	Set the scale for each axis.

public subroutine offrame_printframestring()

Print (to std::out) a formatted string of the current ReferenceFrame's descendant hierarchy.

Arguments

None

public subroutine ofsphere_create(name)

Create a new Sphere with the given name.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	name	Name of the sphere to create.

public subroutine ofsphere_setradius(radius)

Set the radius of the sphere.

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=real64),	intent(in)			::	radius	Radius of the sphere.

public subroutine ofsphere_settexturemap(fname)

Set the image file used as the texture map for the sphere.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	fname

public subroutine ofsphere_setnighttexturemap(fname)

Set the image file used as the night texture map for the sphere.

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	fname	File containing the night texture map.

public subroutine ofsphere_setautolod(lod)

Enable/disable auto level of detailing for the sphere.

Arguments

Type	Intent	Optional	Attributes		Name
logical,	intent(in)			::	lod	True to enable auto level of detailing, false to disable.

public subroutine ofsphere_setsphereposition(x, y, z)

Set position of the sphere (within its own reference frame).

Arguments

Type	Intent		Name
real(kind=real64),	intent(in)	::	x	X position.
real(kind=real64),	intent(in)	::	y	Y position.
real(kind=real64),	intent(in)	::	z	Z position.

public subroutine ofsphere_setsphereattitude(rx, ry, rz, angle)

Set attitude of the sphere (within its own reference frame).

Arguments

Type	Intent		Name
real(kind=real64),	intent(in)	::	rx	X component of the rotation quaternion.
real(kind=real64),	intent(in)	::	ry	Y component of the rotation quaternion.
real(kind=real64),	intent(in)	::	rz	Z component of the rotation quaternion.
real(kind=real64),	intent(in)	::	angle	Angle component of the rotation quaternion.

public subroutine ofsphere_setspherescale(sx, sy, sz)

Set the scale of the sphere (to turn sphere into ellipsoid). This applies to the current active Sphere, and can be used to turn a Sphere into an ellipsoid.