DzScriptedStepsPane Class Reference
[Interface Components, Script Objects]

Pane for ... More...

Inheritance diagram for DzScriptedStepsPane:

DzPane List of all members.

Enumerations

enum  SourceType { File, Code, Action }

Methods

void addStep (String label, String source, SourceType type=File, Boolean seperatorBefore=false, Number index=-1)
void clearAllSteps ()
void clearSignalScripts ()
String getActivityChangeScript (String source)
DzStepButton getButton (Number index)
DzElement getDataHolder ()
String getLabel (Number index)
String getNodeAddScript (String source)
Number getNumSteps ()
String getScript (Number index)
String getSelectionChangeScript (String source)
String getSkeletonAddScript (String source)
Number getStep (String label)
void removeStep (Number index)
void removeStepByLabel (String label)
void setActivityChangeScript (String source)
void setNodeAddScript (String source)
void setSelectionChangeScript (String source)
void setSkeletonAddScript (String source)
void setStep (Number index, String label, String source, SourceType type=File)

Detailed Description

Pane for ...

Todo:
Brief & Descriptions

Member Enumeration Documentation

enum DzScriptedStepsPane::SourceType

Enumerated values for the type of source for a step.

Enumerator:
File  A DAZ Script file
Code  DAZ Script 2 code
Action  The name of a DzAction

Member Function Documentation

void DzScriptedStepsPane::addStep ( String  label,
String  source,
SourceType  type = File,
Boolean  seperatorBefore = false,
Number  index = -1 
)

Add a step to the pane.

Parameters:
label The label for the step
source The source to execute when the step button is pressed
type The type of step
seperatorBefore Whether or not to add a visual separator before the button being added
index The position in the list to add the step
Attention:
source can be a relative [to the ./scripts folder] path to a script, an absolute path to a script, DAZ Script 2 code or the name of a DzAction.
        var oMgr = MainWindow.getPaneMgr();
        var oPane = oMgr.findPane( "DzScriptedStepsPane" );
        if( oPane )
        {
            oPane.addStep( "Content Directory Manager",
                "support/DAZ/dzContentDirectoryManager.dse",
                DzScriptedStepsPane.File );
        }

void DzScriptedStepsPane::clearAllSteps (  ) 

Clear all steps from the pane.

void DzScriptedStepsPane::clearSignalScripts (  ) 

Clear all scripts triggered by signals.

See also:
getActivityChangeScript, getNodeAddScript, getSkeletonAddScript, getSelectionChangeScript

DzStepButton DzScriptedStepsPane::getButton ( Number  index  ) 

Returns:
The button of the step at index.

String DzScriptedStepsPane::getLabel ( Number  index  ) 

Returns:
The label of the step at index.

Number DzScriptedStepsPane::getNumSteps (  ) 

Returns:
The number of steps currently in the pane.

String DzScriptedStepsPane::getScript ( Number  index  ) 

Returns:
The relative path of the script for the step at index.

Number DzScriptedStepsPane::getStep ( String  label  ) 

Returns:
The index of the step labeled label.

void DzScriptedStepsPane::removeStep ( Number  index  ) 

Remove the step at index.

void DzScriptedStepsPane::removeStepByLabel ( String  label  ) 

Remove the step labeled label.

void DzScriptedStepsPane::setStep ( Number  index,
String  label,
String  source,
SourceType  type = File 
)

Set the step at index.

Parameters:
index The index of the step to set
label The label for the step
source The source to execute when the step button is pressed
type The type of step
Attention:
source can be a relative [to the ./scripts folder] path to a script, an absolute path to a script, DAZ Script 2 code or the name of a DzAction.

Generated on Thu Sep 24 12:21:15 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.