Navigation: Scripting Reference Manual > Functions & Subroutines > SurfRoughGetName

 

SurfRoughGetName

 

Contact Us: fredsupport@photonengr.com

 

Description

This command returns the string name of a surface roughness node.

 

 

Syntax

roughName = SurfRoughGetName( roughNode )

 

 

Parameters

roughName (String)

Name of the surface roughness model.

 

roughNode As Long

Node number of the surface roughness model being queried.

 

 

Example

The following example loops over all surface roughness models and prints their node number, active state, roughness probability, name and description to the output window.

 

Sub Main

 

    Print "Node" & Chr(9) & "Active" & Chr(9) & "Prob." & Chr(9) & "Name" & Chr(9) & "Desc."

 

    Dim roughCount As Long, curRough As Long

    Dim roughDesc As String, roughName As String

    For curRough = SurfRoughGetMaxNodeNum To 0 Step -1

        If SurfRoughIsValidNode( curRough ) Then

            roughDesc = SurfRoughGetDescription( curRough )

           roughName = SurfRoughGetName( curRough )

            Print curRough;

           Print SurfRoughIsActive( curRough );

           If SurfRoughGetType( curRough ) = "SampRanNorm" Then

                     Print SurfRoughSRSNGetOverallRoughnessProbability( curRough )

           Else

                    Print "N/A"

           End If

           Print roughName;

            Print roughDesc

        End If

    Next curRough

 

End Sub

 

 

See Also

SurfRoughCopy

SurfRoughDelete

SurfRoughDeleteAllNodes

SurfRoughFindName

SurfRoughGetDescription

SurfRoughGetMaxNodeNum

SurfRoughGetNodeCount

SurfRoughGetType

SurfRoughIsActive

SurfRoughIsValidNode

SurfRoughSetActive

SurfRoughSetDescription

SurfRoughSetName

SurfRoughSRSNCreate

SurfRoughSRSNGetEntries

SurfRoughSRSNGetEntryCount

SurfRoughSRSNGetIthAngle

SurfRoughSRSNGetIthProbability

SurfRoughSRSNGetOverallRoughnessProbability

SurfRoughSRSNSetEntries

SurfRoughSRSNSetOverallRoughnessProbability

 

 

 

 

 

Copyright © Photon Engineering, LLC