Navigation: Scripting Reference Manual > Functions & Subroutines > InitTargetedRay

 

InitTargetedRay

 

Contact Us: fredsupport@photonengr.com

 

Description

Initializes a targeted (iterated, Hamiltonian) ray with default values.

 

Syntax

InitTargetedRay targ

 

Parameters

targ As T_TARGETEDRAY

A T_TARGETEDRAY structure to be initialized.

 

Remarks

This subroutine initializes a targeted ray. If there is a problem the subroutine returns without setting an error or initializing targ. The initialized parameter values will be the same as the initial values you will see in the targeted ray dialog.

 

Data Type

Default

startX

0

startY

0

startZ

0

endX

0

endY

0

endZ

0

hintX

0

hintY

0

hintZ

1

hintWidthX

1

hintWidthY

1

wavelength

system default wavelength

aimTolerance

0.0001

derivativeIncrement

0.0001

startCoordSys

Global Coordinate System

endCoordSys

Global Coordinate System

hintCoordSys

coordinate system of hint data

targetSurface

last surface entered in Tree

material

Air

hintNumRays

1

hintTowards

first surface entered in Tree

rayPath

non-sequential

hintType

Direction

useX

True

useY

True

useZ

False

sameTargetAndEndCoordSys

True

 

 

See Also

T_TARGETEDRAY

TargetedRay

Trace Targeted Ray Dialog

Examples

Advanced Raytrace Functions

 

 

 

 

 

Copyright © Photon Engineering, LLC