Scripting: CreateOperatorWizard

CreateOperatorWizard

Introduced

v7.5

Description

Creates an instance of a custom operator wizard you can use to generate self-installing CustomOperator plug-ins. The resulting wizard is a CustomProperty nested under the SDK wizard model which itself resides under the scene root.

Scripting Syntax

oReturn = CreateOperatorWizard( [DestinationDir_Optional], [PropName_Optional] );

Return Value

Newly created custom operator wizard as a CustomProperty object.

Parameters

Parameter	Type	Description
DestinationDir_Optional	String	The destination folder for the plug-in to generate. Default Value: If no destination folder is specified, the wizard property will be created in the user path.
PropName_Optional	String	Name of the operator to create. Default Value: Custom Operator Wizard

Examples

JScript Example

/*
        This example demonstrates how to create a custom operator wizard 
        using the CreateOperatorWizard command and then generate a very 
        simple custom operator using the new wizard.
*/
var sicowiz = CreateOperatorWizard();
sicowiz.OperatorName = "XYZOp";
sicowiz.ScriptLanguage = "JScript";
// Declare output port
CreatePrim("Cone", "MeshSurface", null, null);
sicowiz.OutObj = "cone.kine.global";
// Add input port
GetPrim("Null");
AddInputPortToOperatorWizard(sicowiz, "null.kine.global");
// Declare parameters
sicowiz.ParamType = "siBool";
sicowiz.ParamName = "BoolParam";
AddParamToOperatorWizard(sicowiz);
sicowiz.ParamType = "siFloat";
sicowiz.ParamName = "FloatParam";
AddParamToOperatorWizard(sicowiz);
// Generates the XYZOp implementation and plug-in
GenerateOperatorPlugin(sicowiz);