This subroutine has been deprecated. Please use LoadAnalysis instead.
Description Retrieves an analysis sample plane structure with data from a specified FRED entity.
Syntax GetAnalysis n, analysis
Parameters n As Long Node number of the entity to retrieve the analysis structure from.
analysis As T_ANALYSIS Holds the analysis data from the FRED entity (in global coordinates).
Remarks This subroutine retrieves a T_ANALYSIS structure with data derived from the specified FRED entity. If there is a problem, the subroutine posts an error and returns without modifying analysis.
If the entity specified by n is an analysis surface, then the parameters of the analysis structure will match those in the analysis surface. Note that the analysis structure does not have the ability to autosize even if the associated analysis surface is set to autosize. The analysis structure will be filled with the analysis surface's current information regardless of whether or not the analysis surface is set to autosize. Note also that the T_ANALYSIS parameter, analysis, does not contain any ray filter specification; it is simply a specification for determining sample points. Therefore, the ray filter specification of the FRED analysis surface is not transferred to the analysis parameter.
If the entity specified by n is not an analysis surface, then the parameters of the analysis structure will be set to match the position, orientation, and size of the entity. The remaining structure information will acquire default values.
The information in the analysis structure is relative to the global coordinate system. This means that the coordinate system parameter in the Irradiance, intensity, etc. script commands should be set to -1. See the help for these commands for more information.
Special care should be used when using the analysis structure obtained from this command as an argument to the Intensity command. See the help on the Intensity command for more information.
See Also Examples
|