Navigation: Scripting Reference Manual > Functions & Subroutines > GetChangeSurfRayColor

 

GetChangeSurfRayColor

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the integer RGB values for the color assigned to a specific Ray Color option.

 

Syntax

GetChangeSurfRayColor  n, rtype, red, green, blue

 

Parameters

n As Long

Entity node number.

 

rtype As String

String indicating the type of ray intersection for which ray color is to being queried.  Valid options are:

"transmit"

"reflect"

"diffract"

"scatter"

"all"

 

red As Integer

Holds integer value for red RGB component.

 

green As Integer

Holds integer value for green RGB component.

 

blue As Integer

Holds integer value for blue RGB component.

 

Remarks

Retrieves the integer RGB values for the color assigned to a specific Ray Color option. If the specified Ray Color option is not active, returns the default color white (255,255,255).

 

See Also

IsChangeSurfRayColor

ChangeSurfRayColorOff

ChangeSurfRayColor

 

 

 

 

 

Copyright © Photon Engineering, LLC