Description | Example | Return message | Group

VO_R GetReferenceFrame

Return the reference frame for the selected 3D window.

Syntax

VO_R <ScenarioPath> GetReferenceFrame [<WinNumber>]

Description

The VO_R GetReferenceFrame command will return the reference frame for the selected window. If the <WinNumber> option is not included the reference frame for the first 3D window will be returned.

The returned string will be an axes specification or, if in untethered mode, a system specification. The format of the returned string is as follows:

<TruncObjectPath> <Name> <Type>

Where <TruncObjectPath> is a truncated object path or central body path that indicates the parent of the component, <Name> is the component name, and <Type> is the component type, Axes or System.

The returned string can be passed into Connect commands that take a reference frame. For example: VO View AddReferenceFrame and SetReferenceFrame.

Examples

Get the reference frame of the first 3D window:

VO_R * GetReferenceFrame

Return message

ACK CentralBody/Earth Inertial Axes

Group membership

This command belongs to the following group(s):

VO

VO Window

Version

9.2.1