CelestialSphereViewpointOptions Object

The CelestialSphereViewpointOptions object allows the user to configure a celestial sphere type Viewpoint object. This object is not creatable in script, but is always created as a child object of the Viewpoint object as seen in the example below:

Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.

Available In Editions:

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.

Name	Description	Attributes
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Declination	The declination offset of the viewpoint with respect to the Source Object.	Type: Variable Access: Read/Write Units: deg
FieldOfView	The field of view angle of the viewpoint.	Type: Variable Access: Read/Write Units: deg
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
ObjectType	The type of the object.	Type: String Access: Read-Only
Radius	The magnitude of the offset vector of the viewpoint with respect to the Source Object.	Type: Variable Access: Read/Write Units: km
ReferenceFrame	The coordinate frame in which offsets to the camera are applied.	Type: String Access: Read/Write
RightAscension	The right ascension offset of the viewpoint with respect to the Source Object.	Type: Variable Access: Read/Write Units: deg
ShowAxes	Determines whether the celestial sphere axes will be drawn.	Type: Variable Access: Read/Write
ShowRightAscensionDeclinationLabels	Determines whether Right-Ascension/Declination grid labels will be draw.	Type: Variable Access: Read/Write
Target	The ObjectId of the Target Object for the viewpoint.	Type: Variable Access: Read/Write

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.

CelestialSphereViewpointOptions Object

Description

Available In Editions:

Timing Precision Mode