Description Returns the C axis parameters for an existing Analysis Results Node (ARN). Only applies to 3D datasets.
Syntax ARNGetCAxisParams nNodeNum, cLabel, cUnits, cType
Parameters nNodeNum As Long Node number of existing ARN.
cLabel As String Text label for C axis of ARN.
cUnits As String Units for C axis of ARN. See Units for allowed string representations.
cType As String Axis parameter type. Allowed options are "Spatial", "AngularInRadians", "AngularInDegrees", "DirectionCosine", "Frequency". All other entries result in a type "Unknown".
Example The following example performs a raytrace and then retrieves and prints information about the C-axis of an analysis results node (ARN).
Sub Main
'Delete existing rays and ARNs, trace new rayset DeleteRays() ARNDeleteAllNodes() TraceCreate
'Retrieve the ARN created by 3D Box detector entity Dim Box3dDe As Long, arnNode As Long Box3dDe = FindFullName( "Analysis Surface(s).Detector Entity - 1x1" ) arnNode = DEGetMostRecentARNNum( Box3dDe )
'Range Dim cMinRange As Double, cMaxRange As Double ARNGetCAxisRange arnNode, cMinRange, cMaxRange
'Direction Dim cDirX As Double, cDirY As Double, cDirZ As Double ARNGetCAxisDir arnNode, cDirX, cDirY, cDirZ
'Dimensions Dim cDim As Long cDim = ARNGetCAxisDim( arnNode )
'Params Dim cLabel As String, cUnits As String, cType As String ARNGetCAxisParams arnNode, cLabel, cUnits, cType
'Print results to output window Print "C Axis Dim: " & Chr(9) & cDim Print "C Axis Dir: " & Chr(9) & "X" & Chr(9) & "Y" & Chr(9) & "Z" Print Chr(9) & cDirX & Chr(9) & cDirY & Chr(9) & cDirZ Print "C Range: " & Chr(9) & cMinRange & Chr(9) & "to" & Chr(9) & cMaxRange Print "C Label: " & Chr(9) & cLabel Print "C Units: " & Chr(9) & cUnits Print "C Type: " & Chr(9) & cType
End Sub
See Also
|