AddPass (PassContainer)

Description

Creates and adds a new Pass to the scene.

Scripting Syntax

    PassContainer.AddPass( [Preset], [Name] )

C# Syntax

    Pass PassContainer.AddPass( Object in_Preset, String in_name );

Parameters

Parameter | Type | Description
Preset | Variant containing preset or string representing a preset object (e.g. "Caustic_Pass") | Any of the Pass Presets Default Value: "Pass" (default pass)
Name | String | Name of the new Pass object Default Value: ""

Return Value

The new Pass object

Examples

Python Example

    #
    # This example demonstrates how to add a new reflection pass
    #
    app = Application
    oPassContainer = app.ActiveProject.ActiveScene.PassContainer
    oPass = oPassContainer.AddPass( "Reflection_Pass", "My_Reflection_Pass" )

    Application.LogMessage( "Pass's name: " + oPass.Name )

See Also

Scene.ActivePass | Scene.PassContainer | Pass | PassCollection
PassContainer | PassContainer.AddPass | GetCurrentPass | CreatePass
DeleteCurrentPass |  |  |

Autodesk Softimage v7.5