Script
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
oCaboutReturns information about the current application running the script and its environment. You can use it in both Script Editor and scriptModule
oCActionAction interface is used to perform menu or tool bar functions
oCCheckBox
oCColorRGBA
oCcolumnWith the Column function, you can retrieve values from columns in your scene and you can add and remove them
oCComboBox
oCCompositionItemA class that represent a single entry in the composition order. The composition order is an array of this composition item
oCcompositionOrderScriptable interface for extracting the timeline composition order. var composition = composition.buildDefaultCompositionOrder() or var composition = composition.buildCompositionOrderForDisplay( displayNode );
oCcopyPasteImplement the copy paste interface, which is available to the scripting environment
oCDateEditSimplified DateEdit widget
oCDateEditEnum
oCDialogSimplified Dialog widget. This class and the associated widget classes are used to build simple dialogs
oCDialogPrivate
oCDirInterface to operating system Dir operations, ie, mkdir, rmdir, rename, etc
oCDirSpecEnum for directory operations
oCDrawing
oCDrawingToolParamsDrawingTool params class - used as parameters in drawingTools calls
oCDrawingTools
oCelementWith the Element functions, you can retrieve information about the elements in your scene and you can add and remove them. Each element has an index (0..nbElements), an integer id (key of the element in the database), which is unique and a name ( which is not guaranteed to be unique )
oCexporterThis set of functions provides access to the project's export directory
oCExportVideoDlg
oCFileInterface to operating system File operations, ie open, close, read, write..
oCFileAccessEnum to define file operation
oCFileDialog
oCfileMapperThe FileMapper function, toNativePath( String&) will return the complete path of the passed path resolving shortcuts in windows. Will also convert the path separator to
oCframeWith the Frame functions, you can retrieve values from frames and you can add and remove frames in your scene
oCfuncWith the Function Curve functions, you can retrieve and modify values in the function curves
oCGroupBox
oCImportDrawingDlg
|oCCreateSymbolInfo
|oCLayerGroupInfo
|oCTUDrawingImportElement
|oCTUDrawingImportItem
|oCTUDrawingImportSimpleVectoOptions
|\CTUModuleSelectionPredicate
oCInput
oCKeyModifiers
oCLabel
oClibraryInterface to select templates, and generate thumbnails and movies for them
oCLineEdit
oCMatrix4x4Defines a four by four matrix container. Matrix4x4 objects can be instantiated in the scripting environment
oCMessageBoxSimplified MessageBox widget
oCMessageLogAllows the user to print messages to the message log window
oCMovieImport
oCnodeNodes are synonymous with Filter, IO, Move and Group Modules in the Network View
oCNumberEdit
oCPaletteManagerQuery information from the Colour view
oCPenstyleManagerThis set of functions is used to query/modify the current penstyle and list of penstyles. The list of penstyles includes the brush, pencil and texture styles
oCPermanentFileUsed to represent an actual image file on disk which will not be deleted after script execution. Permanent files can be instantiated in the scripting environment or retrieved in an SM_InputPortWrapper object
oCPoint2d
oCPoint3d
oCpreferencesWith the Preferences functions, you can retrieve information about the whole preference system. The user can set and retrieve the value of any preferences in the software
oCProcessUsed to launch an external process. Processes can be instantiated in the scripting environment
oCRadioButton
oCRemoteCmd
oCrenderThe Render class is used to render the scene or a part of the scene. The scripting environment can receive notifications when scene frame is ready. See the TB_ExportFLV script for an example
oCsceneWith the Scene functions, you can retrieve and set global scene attributes, like the aspect ratio of the cells in the scene grid
oCSCR_DragObject
oCSCR_FileIOTypeWrapper
oCSCR_FileWrapperBase class to TemporaryFile and PermanentFile
oCSCR_SoundController
oCSCUI_SimpleScanButtons
oCselectionWith the Selection functions, you can retrieve information about the modules or columns you have selected within a view. These functions work best if run from an icon in the Views Toolbar
oCSlider
oCsoundThe Sound class is used to access the scene's soundtrack in part or in whole. The scripting environment can receive notifications when scene frame is ready. See the TB_ExportFLV script for an example
oCspecialFoldersBy using the SpecialFolders functions, you can retrieve information about the different folders (directories) used by the application. All of the functions are read-only. They return strings that represent folders in use by the various applications. Depending on the application (e.g. Toon Boom Harmony versus Toon Boom AnimatePro), the same content is stored in a different location
oCSpinBox
oCSystem
oCTemporaryFileUsed to represent an actual image file on disk which will be deleted after script execution. Temporary files can be instantiated in the scripting environment or retrieved in an SM_InputPortWrapper object
oCTextEdit
oCTimeEdit
oCTimelineWith the Timeline functions, you can return values for layers and frames in the Timeline window
oCToolPropertiesThis object controls most of the tool properties that can be found on the Tool Properties Panel. The Tool Presets view must have been loaded for these function to be available
oCUiloaderThe UILoader interface allows the user to load pre-defined Qt forms that define Qt widgets (generally built within Qt Designer). This allows users to build complex dialogs, using all of the pre-defined widgets that Qt4.8 supports. See Qt documentation for further details: http://qt-project.org/doc/qt-4.8
oCVector2d
oCVector3d
\CviewThe View functions provide information about the contents of selected View windows