AGI STK Objects 11 Send comments on this topic.
IAgSpEnvMagFieldGfx Interface

Description

Graphics settings for showing the magnetic field.

Note: late-bound clients (e.g., VB, JScript) must use the ComputeBFieldAsArray method instead of ComputeBField to get the results as an array.

Public Methods

Public Method ComputeBBeq Compute B/Beq (i.e., the ratio of the magnetic field at the specified Earth location to the minimum field intensity along the field line thru the location). Uses Date, Angle, Longitude, and Distance Dimensions.
Public Method ComputeBField Compute geomagnetic field in Earth Fixed components at the specified Earth location. Uses Date, Angle, Longitude, Distance, and MagneticField Dimensions.
Public Method ComputeBFieldAsArray Compute geomagnetic field in Earth Fixed components, returned as the array (Bx, By, Bz), at the specified Earth location. Uses Date, Angle, Longitude, Distance, and MagneticField Dimensions.
Public Method ComputeDipoleL Compute dipole L-shell parameter at the specified Earth location. Uses Date, Angle, Longitude, and Distance Dimensions.
Public Method ComputeMcIlwainL Compute McIlwain L-shell parameter at the specified Earth location. Uses Date, Angle, Longitude, and Distance Dimensions.

Public Properties

Public Property ColorMode Mode by which color is assigned
Public Property ColorRampStart Magnetic field start color
Public Property ColorRampStop Magnetic field stop color
Public Property ColorScale Scaling of magnetic field to use when assigning color/translucency
Public Property ExternalField External magnetic field
Public Property FieldLineRefresh Time between refresh of magnetic field lines. Uses Time Dimension.
Public Property IGRF_UpdateRate Duration between updates of IGRF magnetic field model coefficients. Uses Time Dimension.
Public Property IsMagFieldVisible Flag to show magnetic field
Public Property LineStyle Magnetic field line style
Public Property LineWidth Magnetic field line width
Public Property MainField Main magnetic field
Public Property MaxTranslucency Maximum translucency expressed as a percentage.
Public Property NumFieldLines Number of field lines to show per longitude
Public Property NumLongitudes Number of longitudes to show
Public Property RefLongitude Sets initial longitude sample. Longitude is measured about the Z-axis of the Solar Magnetic axes from the -X-axis. Uses Longtitude Dimension.
Public Property StartLatitude Starting magnetic latitude field line to show. Uses Latitude Dimension.
Public Property StopLatitude Ending magnetic latitude field line to show. Uses Latitude Dimension.
© 2016 Analytical Graphics, Inc. All Rights Reserved.

STK Programming Interface 11.0.1