STK ObjectsSend 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 ComputeBBeqCompute 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 ComputeBFieldCompute geomagnetic field in Earth Fixed components at the specified Earth location. Uses Date, Angle, Longitude, Distance, and MagneticField Dimensions.
Public Method ComputeBFieldAsArrayCompute 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 ComputeDipoleLCompute dipole L-shell parameter at the specified Earth location. Uses Date, Angle, Longitude, and Distance Dimensions.
Public Method ComputeMcIlwainLCompute McIlwain L-shell parameter at the specified Earth location. Uses Date, Angle, Longitude, and Distance Dimensions.

Public Properties

Public Property ColorModeMode by which color is assigned.
Public Property ColorRampStartThis property is deprecated. Magnetic field start color.
Public Property ColorRampStartColorMagnetic field start color.
Public Property ColorRampStopThis property is deprecated. Magnetic field stop color.
Public Property ColorRampStopColorMagnetic field stop color.
Public Property ColorScaleScaling of magnetic field to use when assigning color/translucency.
Public Property ExternalFieldExternal magnetic field.
Public Property FieldLineRefreshTime between refresh of magnetic field lines. Uses Time Dimension.
Public Property IGRF_UpdateRateDuration between updates of IGRF magnetic field model coefficients. Uses Time Dimension.
Public Property IsMagFieldVisibleFlag to show magnetic field.
Public Property LineStyleMagnetic field line style.
Public Property LineWidthMagnetic field line width.
Public Property MainFieldGets or sets the main magnetic field.
Public Property MaxTranslucencyMaximum translucency expressed as a percentage.
Public Property NumFieldLinesGets or sets the number of field lines to show per longitude.
Public Property NumLongitudesGets or sets the number of longitudes to show.
Public Property RefLongitudeSets initial longitude sample. Longitude is measured about the Z-axis of the Solar Magnetic axes from the -X-axis. Uses Longtitude Dimension.
Public Property StartLatitudeGets or sets the starting magnetic latitude field line to show. Uses Latitude Dimension.
Public Property StopLatitudeGets or sets the ending magnetic latitude field line to show. Uses Latitude Dimension.
© 2024 Analytical Graphics, Inc. All Rights Reserved.