ViewWindow Object

Description

A ViewWindow displays the specified objects in either a 3D View, 2D Map, Celestial Sphere, or Sensor View.

Inheritance Hierarchy: Object->OutputWindow->ViewWindow

Available In Editions:

Engineer

Mission

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Name	Description	Attributes
AmbientColor	Color of the light that is added to all objects in the Mission View regardless of their position with respect to the sun. Setting the Ambient Light Color to white effectively turns off all effects of lighting. Setting the Ambient Light Color to black means the surfaces of objects facing away from the sun appear very dark.	Type: Variable Access: Read/Write
BackgroundColor	Color of the background of the Mission View.	Type: Variable Access: Read/Write
CurrentViewpoint	Allows the user to access properties and methods of the Viewpoint currently active in the ViewWindow.	Type: Viewpoint Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
DefaultObjectLabelFont	The default font used for object labels unless specified using SetFont.	Type: ViewFont Access: Read/Write
ID	The unique ID number used to reference the visualization output window.	Type: Variable Access: Read-Only
LogoTextureFilename	Filename of the image to display in lower right corner of the Mission View. It can be in jpg, png, tiff, bmp, or gif format. If ViewWindow.ShowLogo is true, but ViewWindow.LogoTextureFilename is empty, the default logo will be used.	Type: String Access: Read/Write
MouseInteractionEnabled	Determines whether users will be able to manipulate Viewpoints contained in this ViewWindow.	Type: Variable Access: Read/Write
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
Objects	String array enumerating the object names for which properties will be defined by the ShowBody, ShowAxes, ShowName, ShowGrid, BodyColor, TailLength, and ProjectionHeight properties.	Type: StringArray Access: Read-Only
ObjectShadowing	Determines how object diffuse lighting will be calculated.	Type: Variable Access: Read/Write
ObjectType	The type of the object.	Type: String Access: Read-Only
OutputProperties	Control options for how the Mission View Output Properties behaves.	Type: ViewWindowOutputProperties Access: Read-Only
ProjectionHeights	Array indicating the projection height of the GroundStation or Region object whose name is defined by the Object's property of the same index. If the object at that index is not a GroundStation or Region, the value is ignored.	Type: Array Access: Read/Write Units: km
ShowLogo	Determines whether or not to display specified logo image at bottom right of the MissionView.	Type: Variable Access: Read/Write
ShowStatusText	Determines whether to show the status text in the top left corner of the Mission View window.	Type: Variable Access: Read/Write
ShowTextBackdrops	Determines whether a dark background is drawn behind text. This option can improve text readability. This property takes negative precedence to the GraphicsOverlay.ShowTextBackDrop property.	Type: Variable Access: Read/Write
StatusTextColor	Color of the text displayed in the top left corner of the Mission View. This text displays the UTC Calendar Epoch and viewpoint location information.	Type: Variable Access: Read/Write
StatusTextFont	Font of the text displayed in the top left corner of the Mission View. This text displays the UTC Calendar Epoch and viewpoint location information. FreeFlyer will autoscale the status text font size based on the size of the window if the ViewWindow.StatusTextFont.Size is set to zero.	Type: ViewFont Access: Read/Write
TargetDisplayMode	If the window is updated automatically, this property determines how the window updates will be controlled when a targeting loop is entered.	Type: String Access: Read/Write
UseLighting	Determines whether or not to show realistic lighting effects in the Mission View.	Type: Variable Access: Read/Write
UseTextures	Determines whether or not to enable textures in the Mission View. On some old video cards disabling textures can improve performance of the Mission View.	Type: Variable Access: Read/Write
Viewpoints	The ViewWindow's Viewpoints.	Type: Array of Viewpoint Access: Read/Write
WindowTitle	Sets the title for the output window.	Type: String Access: Read/Write

Name	Description
ActivateViewpoint	Updates the viewing properties to those of the specified Viewpoint.
AddGroup	Add a custom group for organizing objects in the View Output Properties interface.
AddObject	Adds the specified object to the ViewWindow.
AddObjectToGroup	Add the specified object(s) to the specified group. Groups are used for organizing objects in the View Output Properties interface.
AddViewpoint	Adds a new viewpoint to the ViewWindow's Viewpoint list.
BeginBatchUpdate	This method marks the beginning of a period where any update to the window will be queued and only processed when the ViewWindow.EndBatchUpdate method is called.
ClearSavedStates	Clears previous saved states for this object.
ClearViewpoints	Clears all the viewpoints from the ViewWindow.
CloseWindow	Closes the window.
EndBatchUpdate	Processes all updates to the window that have occurred since the ViewWindow.BeginBatchUpdate method was called.
GetAxisSize	Get the axis size and mode of the specifed object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetCelestialObjectGlobeOptions	Populates the specified GlobeOptions object with the display settings for the specified CelestialObject. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetConfiguration	Populates the specified ViewWindowConfiguration object with the display settings for every object and viewpoint in the ViewWindow. If you want the configuration to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetFormationPointSize	Get the current FormationPointSize setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
GetGroundStationDrawMethod	Get the current GroundStationDrawMethod setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetGroupNames	Get the names of the currently defined groups. Groups are used for organizing objects in the View Output Properties interface.
GetHistoryMode	Get the current HistoryMode setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetLineWidth	Get the line width and units of the specifed object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetObjectColor	Get the current ObjectColor setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetObjectIcon	Get the current icon file name for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetObjectIconColor	Get the current icon color for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetObjectIconDrawingMode	Get the current icon drawing mode for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetObjectIconSize	Get the current icon size in pixels for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetObjectKey	Get the object key used to match objects on import. The ViewWindow.SetConfiguration method is used to import a configuration into a ViewWindow from a ViewWindowConfiguration object.
GetObjectLabelFont	Get the current font configuration for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetObjectOpacity	Get the current ObjectOpacity setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetObjectsInGroup	Get all the objects in the specified group. Groups are used for organizing objects in the View Output Properties interface.
GetProjectionHeight	Get the current ProjectionHeight setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetShowAxis	Get the current ShowAxis setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetShowBody	Get the current ShowBody setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetShowGrid	Get the current ShowGrid setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetShowHistory	Get the current ShowHistory setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetShowIcon	Get the current ShowIcon setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetShowName	Get the current ShowName setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetShowObject	Get the current ShowObject setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetStoreVelocity	Get the current StoreVelocity setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetTailLength	Get the current TailLength setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetTailState	Get the current TailState setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
GetTrajectoryPhaseControlVectorMaximumLength	Get the current TrajectoryPhaseControlVectorMaximumLength setting for the specified object. If you want the value to reflect modifications made by the user in the output screen, first call the Synchronize method.
InsertLineBreak	Inserts a line break.
NewWindow	Resets the OutputWindow so that a new window will be created next time Update is called.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReconnectAutomation	Reconnect view automation.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
RemoveAllGroups	Remove all defined object groups. Groups are used for organizing objects in the View Output Properties interface.
RemoveGroup	Remove a group. Groups are used for organizing objects in the View Output Properties interface.
RemoveObject	Removes the specified object from the ViewWindow.
RemoveObjectFromGroup	Remove the specified object(s) from the specified group. Groups are used for organizing objects in the View Output Properties interface.
ResetAllLineWidths	Resets all objects in the ViewWindow to use the default line width
ResetAllObjectLabelFonts	Resets all objects in the ViewWindow to use the default label font.
ResetLineWidth	Resets the specified object to use the default line width.
ResetObjectIcon	Remove the configured icon.
ResetObjectLabelFont	Resets the specified object to use the default label font.
ResetTails	Resets the object histories in the Mission View back to zero length.
Restore	Restore an object's state from a previously saved state.
Resume	Causes the window to resume updating.
Save	Save the object's state so that it can be restored later.
SaveImage	Saves an image of the OutputWindow to a file. Note that this only works with FF.exe if the --windowed-output-mode switch is used.
SetAxisSize	Sets the size of the specified object axes.
SetCelestialObjectGlobeOptions	Uses the specified GlobeOptions object to set the display settings for the specified CelestialObject.
SetConfiguration	Uses the specified ViewWindowConfiguration object to set the display settings for every object and viewpoint in the ViewWindow.
SetFormationPointSize	Sets the point size of the specified Formation objects. The Formation.GroupPointSize property will be used to control the display until this method is called, which overrides the display settings for this ViewWindow only.
SetGroundStationDrawMethod	Sets the method with which the GroundStation is drawn in the ViewWindow. The GroundStation.DrawMethod property will be used to control the display until this method is called, which overrides the display settings for this ViewWindow only.
SetHistoryMode	Determines if the visualized vehicle tail is unlimited in length, or whether new points replace the oldest points once the tail exceeds the vehicle tail length. The Vehicle.HistoryMode property will be used to control the display until this method is called, which overrides the display settings for this ViewWindow only.
SetLineWidth	Sets the width in used to draw lines for the specified object. If the object has its own Line width property, this method has no effect. For GraphicsOverlays, use GraphicsOverlayShape.LineWidth instead.
SetObjectColor	Sets the color of the specified objects. If the object has a Color property, that property will be used to control the display until this method is called, which overrides the display settings for this ViewWindow only.
SetObjectIcon	Set an icon for an object. You must call SetShowIcon to make the icon visible, while SetShowBody can be used to turn off the default rendering. The object types which may use an icon include Spacecraft, GroundVehicle, Vehicle, CelestialObject, and GroundStation.
SetObjectIconColor	Sets the color of the object icon. This color is only used when the icon drawing mode is 'Luminance'. The object types which may use an icon include Spacecraft, GroundVehicle, Vehicle, CelestialObject, and GroundStation.
SetObjectIconDrawingMode	Set the drawing mode for the object icon. 'Full Color' draws the icon using the image colors. 'Luminance' multiplies the specified icon color with the luminance of each pixel in the image. The object types which may use an icon include Spacecraft, GroundVehicle, Vehicle, CelestialObject, and GroundStation.
SetObjectIconSize	Sets the size of the object icon. The default size is 30 pixels. The object types which may use an icon include Spacecraft, GroundVehicle, Vehicle, CelestialObject, and GroundStation.
SetObjectKey	Set the object key used to match objects on import. The ViewWindow.SetConfiguration method is used to import a configuration into a ViewWindow from a ViewWindowConfiguration object.
SetObjectLabelFont	Sets the font configuration to use for the specified object's label.
SetObjectOpacity	Sets the opacity of the specified objects.If the object has an Opacity property, that property will be used to control the display until this method is called, which overrides the display settings for this ViewWindow only.
SetObjectStoreVelocity	Sets the a flag determining whether velocity will be stored for the specified object(s). Velocity data is required for some visualization features associated with the Rotating-Pulsating Viewpoint. This method has no effect after the first update.
SetProjectionHeight	Sets the height at which a Region or GroundStation is projected for the ViewWindow. If the object has an ProjectionHeight property, that property will be used to control the display until this method is called, which overrides the display settings for this ViewWindow only.
SetSceneEpoch	Overrides the automatic algorithm which determines the ViewWindow epoch for the next Update. Reset to the automatic algorithm by specifying TimeSpan.Undefined.
SetShowAxis	Changes the visibility of the specified object's axis.
SetShowBody	Changes the visibility of the specified object's body.
SetShowGrid	Changes the visibility of the specified object's grid.
SetShowHistory	Changes the visibility of the specified object's history.
SetShowIcon	Changes the visibility of the specified object's icon. The object types which may use an icon include Spacecraft, GroundVehicle, Vehicle, CelestialObject, and GroundStation.
SetShowName	Changes the visibility of the specified object's name.
SetShowObject	Changes the visibility of all the object elements.
SetTailLength	Sets the tail length of the specified object. Use caution in setting tail lengths longer than 10,000 - 30,000 points. Tail lengths exceeding this range can cause memory problems due to the large amount of relative position data that must be maintained. The maximum tail length that can be used safely depends on the amount of memory in the system and the number of objects managed by the Mission View. If the object has an TailLength property, that property will be used to control the display until this method is called, which overrides the display settings for this ViewWindow only.
SetTailState	Specifies whether subsequent points in the history will be drawn.
SetTrajectoryPhaseControlVectorMaximumLength	Sets the maximum length of the specified TrajectoryPhase control vectors in this ViewWindow. The TrajectoryPhase.ControlVectorMaximumLength property will be used to control the maximum length until this method is called, which overrides the display settings for this ViewWindow only.
Suspend	Causes the window to ignore updates until Resume is called.
Synchronize	Synchronize the ViewWindow properties with the current configuration of the view in the output workspace. You must call this method if you want the values returned by the ViewWindow 'get methods' (such as GetShowBody and GetConfiguration) to reflect modifications made by the user in the output screen. Note that calling this method can interrupt the user's manual modification of a Viewpoint in the output workspace, and therefore should only be called when it is necessary to retrieve the view configuration.
Update	Updates the window contents using current object values.

Name

Description

Attributes

DisableLabelBackdrops

Determines whether a translucent black rectangle is drawn behind annotations in the 2d map mode of the Mission View. This option can improve text readability. This property takes negative precedence to the GraphicsOverlay.ShowTextBackDrop property.

This property has been Deprecated. Please use ViewWindow.ShowLabelBackdrops instead.