Navigation: Scripting Reference Manual > Functions & Subroutines > AddSurfScatter

 

AddSurfScatter

 

Contact Us: fredsupport@photonengr.com

 

Description

Assigns a scatter model to a specific surface.

 

Syntax

i = AddSurfScatter ( n, scatter )

 

Parameters

i (Long)

The index (counter) of the scatter model assigned to the surface.

 

n As Long

Node number for the surface.

 

scatter As Long

Identifier for the scatter model assigned to the surface.

 

Remarks

This function assigns a scatter model to a specified surface and returns the model's index into the list of the surface's scatter models.  If it fails, it returns a value of -1.

 

The index into the surface's list of scatter models is zero-based.  That is, the first scatter model assigned to the surface will be indexed as 0, the second will be indexed as 1, etc.

 

The index into the surface's list of scatter models is not the same thing as the scatter model's identifier.  Each scatter model in the FRED document has its own unique identifier, but the same scatter model can be simultaneously assigned to many different surfaces.

 

Obviously, the scatter model must be defined and added to the FRED document before it can be assigned to a surface.  See the AddXXXXXScatter family of commands for more information.

 

See Also

GetSurfScatterCount

GetSurfIthScatter

SetSurfIthScatter

DeleteSurfIthScatter

Examples

Scatter

 

 

 

 

 

 

Copyright © Photon Engineering, LLC