Navigation: Scripting Reference Manual > Functions & Subroutines > ARNGetPolarAxis

 

ARNGetPolarAxis

 

Contact Us: fredsupport@photonengr.com

 

Description

Returns the value of the polar axis of the ARN as a Long data type.  A value of 0 indicates the polar axis is in the A-direction and a value of 1 indicates that the polar axis is in the B-direction.

 

 

Syntax

axis = ARNGetPolarAxis( arnNode )

 

 

Parameters

axis (Long)

Value of the polar axis with 0 indicating the polar axis in the A-direction and 1 indicating the polar axis in the B-direction.

 

arnNode as Long

Node number of the ARN being queried.

 

 

Remarks

The following example calculates and writes the intensity from a DAE to file, loads the file into an ARN and then retrieves the value of the polar axis.

 

numRays = IntensityToFileDAE( 18, GetDocDir() & "\intensity_file.fgd" )

arnNode = ARNCreateFromFile( GetDocDir() & "\intensity_file.fgd", "newARN" )

axis = ARNGetPolarAxis( arnNode )

Print "Polar Axis: " & axis

 

 

See Also

IntensityToFileDAE

All ARN Scripting Commands

 

 

 

 

 

Copyright © Photon Engineering, LLC