Navigation: Scripting Reference Manual > Functions & Subroutines > AddCatalogScatter

 

AddCatalogScatter

 

Contact Us: fredsupport@photonengr.com

 

Description

This function adds a scatter model from a scatter catalog and returns the node number of the model that was added to the document.  If the name of the scatter catalog being supplied does not exist or the name of the scatter model does not exist in the designated catalog, the script will halt with an error.

 

 

Syntax

sNode = AddCatalogScatter( sName, sCatalog )

 

 

Parameters

sNode (Long)

Returned node number of the scatter model that was added to the document.

 

sName As String

String name of the scatter model to be added.  This name must be present in the catalog designated by sCatalog.

 

sCatalog As String

String name of the catalog from which a scatter model is being added.

 

 

Example

The example below adds a scatter model from the Custom scatter catalog and reports the node number at which the model was added.

 

Sub Main

 

    Dim sNode As Long

    Dim sName As String, sCatalog As String

 

    sName    = "Acktar_Metal_Velvet_10.6"

    sCatalog = "Custom"

    sNode    = AddCatalogScatter( sName, sCatalog )

 

    Print "Scatter model added at node " & sNode

 

    Update

 

End Sub

 

 

See Also

Scatter Model Script Commands

 

 

 

 

 

Copyright © Photon Engineering, LLC