Navigation: Scripting Reference Manual > Functions & Subroutines > GetSourcePosCharacters

 

GetSourcePosCharacters

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the data from a source with a Random String ray position type.  Depending on the number of rays traced, it may be necessary to dimension ray index and ray counter variables as data type Huge_ instead of Long.  Please see Multi-threaded Raytracing for more information.

 

Syntax

success = GetSourcePosCharacters ( n, text, height, numRays )

 

Parameters

success = (Boolean)

Shows if the function succeeded (True) or failed (False).

 

n As Long

Node number of the source.

 

text As String

Returns the text string the character text string of the source.

 

height As Double

Returns the character height (system units).

 

numRays As Long (or Huge_)

Returns the number of rays per character.

 

Remarks

This function retrieves the data from a source with a Random String ray position type. If there is a problem the function does not set an error and returns False.

 

See Also

IsSourcePosCharacters

SetSourcePosCharacters

Examples

Sources

 

 

 

 

 

 

Copyright © Photon Engineering, LLC