BlockageViewpointOptions Object

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:

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	Attributes
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Diagram	The blockage diagram to use for the blockage view.	Type: Variable Access: Read/Write
DisplayName	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
KeepAspectRatio	Determines if the view fits the window, or keeps the correct aspect ratio.	Type: Variable Access: Read/Write
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.	Type: Variable Access: Read/Write Units: deg
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.	Type: Variable Access: Read/Write Units: deg
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
OverlayFont	The font used to display any overlay text associated with the blockage diagram.	Type: ViewFont Access: Read/Write
ShowOverlayText	Determines if the view will display any overlay text associated with the blockage diagram.	Type: Variable Access: Read/Write
Source	The ObjectId of the Source Object for the viewpoint.	Type: Variable Access: Read/Write
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.	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.

BlockageViewpointOptions Object

Description

Available In Editions:

Timing Precision Mode