RotatingPulsatingViewpointOptions Object

The RotatingPulsatingViewpointOptions object allows the user to configure a rotating-pulsating Viewpoint. 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

Name	Description
CenterMode	Controls the centering behavior of this view.
CenterObject	The ObjectId of the object which is used as the center of the viewpoint when the CenterMode is set to use an object. Any viewable object is valid. Note that this is not necessarily the PrimaryObject, because the frame can be independent visually of the CenterObject.
CenterOffset	The fraction of the distance between the two objects along the axis between them at which the view will be centered. This is used when the CenterMode is CenterOffset. A value of 0 centers the view of the PrimaryObject, while a value of 1 centers the view on the SecondaryObject.
DeclaredName	The name of the object as declared.
Declination	The declination offset of the viewpoint with respect to the Source Object.
DisplayName	The name displayed for this object in output windows such as views, plots, and reports.
FieldOfView	The field of view angle of the viewpoint.
ObjectId	The unique identifier for the object.
ObjectType	The type of the object.
PrimaryObject	The ObjectId of the Primary Object for the viewpoint.
Pulsating	Controls the pulsating behavior of this view. Setting the bool to true enables the pulsating behavior, while setting the bool to false disables the pulsating behavior.
Radius	The magnitude of the offset vector of the viewpoint with respect to the Source Object.
ReferenceDistance	The distance which will be used to establish the scale factor of the frame. The ratio between this number and the instantaneous distance between the Primary and SecondaryObjects is used as the scale factor in drawing the frame. The value must be greater than 0.0 for proper functionality.
ReferenceVector	The second vector used in establishing the frame. For a closed, bounded orbit (such as Earth-Moon), this should be the velocity vector of the SecondaryObject. For alternately retro- and prograde motion (such as Earth-Mars), this should be a nearly constant vector, such as MJ2K Earth Ecliptic North.
RightAscension	The right ascension offset of the viewpoint with respect to the Source Object.
SecondaryObject	The ObjectId of the Secondary Object for the viewpoint.

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.
InitializeFromRotatingPulsatingSystem	Populates a viewpoint from an existing RotatingPulsatingSystem object using the specified objects and pulsating behavior.
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.

RotatingPulsatingViewpointOptions Object

Description

Available In Editions:

Timing Precision Mode