Navigation: Scripting Reference Manual > Functions & Subroutines > RetrieveSurfRoughFromSurface

 

RetrieveSurfRoughFromSurface

 

Contact Us: fredsupport@photonengr.com

 

Description

This command retrieves the node number of the roughness model currently assigned to a surface.

 

 

Syntax

SRnode = RetrieveSurfRoughFromSurface( surfNode )

 

 

Parameters

SRnode (Long)

Node number of the surface roughness model currently applied to the surface.  A return value of -1 specifies "None".

 

surfNode As Long

Node number of the surface being queried.

 

 

Example

The following example retrieves the node number of a surface's roughness model and if the return value is greater than or equal to 0, the surface roughness model is removed by using the -1 specifier.

 

 Sub Main

 

Dim surfNode As Long

surfNode = FindFullName( "Geometry.Detector.Surface" )

 

If RetrieveSurfRoughFromSurface( surfNode ) >= 0 Then

    ApplySurfRoughToSurface surfNode, -1

End If

 

 End Sub

 

See Also

ApplySurfRoughToSurface

 

 

 

 

 

Copyright © Photon Engineering, LLC