Navigation: Scripting Reference Manual > Functions & Subroutines > SurfRoughFindName

 

SurfRoughFindName

 

Contact Us: fredsupport@photonengr.com

 

Description

This command finds a surface roughness model by its name and returns its node number.

 

 

Syntax

roughNode = SurfRoughFindName( roughName )

 

 

Parameters

roughNode (Long)

Returned node number of the surface roughness model with name given by roughName

 

roughName As String

String name of the surface roughness model whose node number is being returned.

 

 

Example

The following script makes a copy of an existing surface roughness node, checking for return values not equal to -1 (indicating failure) and printing information to the output window.

 

Sub Main

 

    Dim gaussRoughNode As Long

    gaussRoughNode = SurfRoughFindName( "Gaussian Roughness" )

    If gaussRoughNode <> -1 Then

        Print "Gaussian roughness node found at: " & gaussRoughNode

    End If

 

 

    Dim gaussCopyNode As Long

    gaussCopyNode = SurfRoughCopy( gaussRoughNode )

    If gaussCopyNode <> -1 Then

        Print "Copy of gaussian roughness made at: " & gaussCopyNode

    End If

 

    Update

 

End Sub

 

 

See Also

SurfRoughCopy

SurfRoughDelete

SurfRoughDeleteAllNodes

SurfRoughGetDescription

SurfRoughGetMaxNodeNum

SurfRoughGetName

SurfRoughGetNodeCount

SurfRoughGetType

SurfRoughIsActive

SurfRoughIsValidNode

SurfRoughSetActive

SurfRoughSetDescription

SurfRoughSetName

SurfRoughSRSNCreate

SurfRoughSRSNGetEntries

SurfRoughSRSNGetEntryCount

SurfRoughSRSNGetIthAngle

SurfRoughSRSNGetIthProbability

SurfRoughSRSNGetOverallRoughnessProbability

SurfRoughSRSNSetEntries

SurfRoughSRSNSetOverallRoughnessProbability

 

 

 

 

 

Copyright © Photon Engineering, LLC