Description
The BlockageViewpointOptions object allows the user to configure a blockage diagram 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:
Viewpoint1.BlockageView.LookAngle1Center = 0;
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.
Inheritance Hierarchy: ObjectàBlockageViewpointOptions
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in millisecond timing precision mode.
Name
|
Description
|
DeclaredName
|
The name of the object as declared.
|
Diagram
|
The blockage diagram to use for the blockage view.
|
KeepAspectRatio
|
Determines if the view fits the window, or keeps the correct aspect ratio.
|
LookAngle1Center
|
The angle at the center of the look angle 1 axis of the blockage diagram. If BlockageUseCenterDefaults is 1, this property will default to the middle angle of look angle 1 in the blockage diagram's LookAngleFrame specification. Setting this property from script will cause the BlockageUseCenterDefaults property to be set to 0. For blockage diagrams without a look angle 1 range of 360 degrees, this property will be ignored.
|
LookAngle2Center
|
The angle at the center of the look angle 2 axis of the blockage diagram. If BlockageUseCenterDefaults is 1, this property will default to the middle angle of look angle 2 in the blockage diagram's LookAngleFrame specification. Setting this property from script will cause the BlockageUseCenterDefaults property to be set to 0. For blockage diagrams without a look angle 2 range of 360 degrees, this property will be ignored.
|
Name
|
The name displayed for this object in output windows such as views, plots, and reports.
|
ObjectId
|
The unique identifier for the object.
|
ObjectType
|
The type of the object.
|
OverlayFont
|
The font used to display any overlay text associated with the blockage diagram.
|
ShowOverlayText
|
Determines if the view will display any overlay text associated with the blockage diagram.
|
Source
|
The ObjectId of the Source Object for the viewpoint.
|
UseCenterDefaults
|
Determines if the blockage diagram is displayed with axes centered around the middle angles of the LookAngleFrame specification or around custom values set in the BlockageLookAngle1Center and BlockageLookAngle2Center properties.
|
|
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
Blockage Diagram Viewpoints Guide
|
