Navigation: Scripting Reference Manual > Functions & Subroutines > GetMatrixCoatingExtra

 

GetMatrixCoatingExtra

 

Contact Us: fredsupport@photonengr.com

 

Description

This command retrieves the additional coating specifier for a Jones matrix coating type.

 

 

Syntax

coatID = GetMatrixCoatingExtra(matrixID)

 

 

Parameters

coatID (Long)

Returned node number of the extra coating applied to the Jones matrix coating.  A value of -1 indicates "None".

 

matrixID As Long

Node number of the matrix coating being queried.

 

 

Example

The following example loops over all coatings on the tree, checks to see if the current coating is a Jones matrix coating type, checks to see if there is an extra coating datum applied and resets the value to "None" using the -1 specifier.

 

Sub Main

 

Dim curCoat As Long

For curCoat = 0 To GetCoatingCount()-1

    If InStr( GetCoatingType( curCoat ), "MatrixCoating" ) <> 0 Then

        If GetMatrixCoatingExtra( curCoat ) >= 0 Then

            SetMatrixCoatingExtra( curCoat, -1 )

        End If

    End If

Next curCoat

 

 End Sub

 

 

See Also

SetMatrixCoatingExtra

 

 

 

 

 

Copyright © Photon Engineering, LLC