Viewpoint Object

 Top  Previous  Next

Description

A viewpoint specifies the camera position and orientation in 3D space, the field of view angle, and view mode. You can assign Viewpoint objects using the = operator.

 

Inheritance Hierarchy: Object->Viewpoint

 

Available In Editions:

Engineer

Mission

 

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

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

 

Properties

 

Name

Description

Attributes

BlockageView

Options for the blockage view mode.

Type:   BlockageViewpointOptions

Access: Read-Only

CelestialSphereView

Options for the celestial sphere view mode.

Type:   CelestialSphereViewpointOptions

Access: Read-Only

DeclaredName

The name of the object as declared.

Type:   String

Access: Read-Only

DisplayName

The name displayed for this object in output windows such as views, plots, and reports.

Type:   String

Access: Read/Write

MapView

Options for the map view mode.

Type:   MapViewpointOptions

Access: Read-Only

ObjectId

The unique identifier for the object.

Type:   Variable

Access: Read-Only

ObjectType

The type of the object.

Type:   String

Access: Read-Only

RotatingPulsatingView

Options for the Rotating Pulsating view mode.

Type:   RotatingPulsatingViewpointOptions

Access: Read-Only

SensorView

Options for the sensor view mode.

Type:   SensorViewpointOptions

Access: Read-Only

StarMapView

Options for the star map view mode.

Type:   StarMapViewpointOptions

Access: Read-Only

ThreeDView

Options for the 3D view mode.

Type:   ThreeDViewpointOptions

Access: Read-Only

ViewpointName

The title of the viewpoint.

Type:   String

Access: Read/Write

ViewpointType

The Mission View view mode of the viewpoint.

Type:   String

Access: Read/Write

 
 

 

Methods

 

Name

Description

ClearSavedStates

Clears previous saved states for this object.

GetFromFile

Load the object state from the specified FreeFlyer object file.

GetFromString

Load the object state from the specified string.

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.

ReferenceEquals

Returns 1 if the argument refers to the calling object and 0 otherwise.

Restore

Restore an object's state from a previously saved state.

Save

Save the object's state so that it can be restored later.

 
 

 

 

See also

Viewpoints Guide