Script
Class Hierarchy

Go to the graphical class hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
 CBAPP_SpecialFolders
 CspecialFoldersBy 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
 CLabeled
 CComboBoxSimplified ComboBox widget
 CDateEditSimplified DateEdit widget
 CLineEditSimplified LineEdit widget. Note that this widget is derived from Label, so also has a label property
 CNumberEditSimplified NumberEdit widget
 CSliderSimplified slider widget
 CSpinBoxSimplified SpinBox widget
 CTimeEditSimplified TimeEdit widget
 CQObject
 CaboutReturns information about the current application running the script and its environment. You can use it in both Script Editor and scriptModule
 CColorOverrideDefines an interface for the colour override node
 CColorRGBA
 CCompositionItemA class that represent a single entry in the composition order. The composition order is an array of this composition item
 CDateEditEnumEnum class for simplified DateEdit class - specifies display order of day, month, year
 CDirInterface to operating system Dir operations, ie, mkdir, rmdir, rename, etc
 CDirSpecEnum for directory operations
 CDrawingToolParamsDrawingTool params class - used as parameters in drawingTools calls
 CFileInterface to operating system File operations, ie open, close, read, write..
 CFileAccessEnum to define file operation
 CMatrix4x4Defines a four by four matrix container. Matrix4x4 objects can be instantiated in the scripting environment
 CPaletteDefines a palette of colours
 CPaletteListDefines a collection of palettes
 CPoint2d
 CPoint3d
 CProcessUsed to launch an external process. Processes can be instantiated in the scripting environment
 CRemoteCmd
 CSCR_DragObject
 CSCR_FileIOTypeWrapper
 CSCR_FileWrapperUsed to represent an actual image file on disk. Files can be instantiated in the scripting environment or retrieved in an SM_InputPortWrapper object
 CSRC_TemporaryFileContext
 CVector2d
 CVector3d
 CQScriptable
 CDirInterface to operating system Dir operations, ie, mkdir, rmdir, rename, etc
 CFileInterface to operating system File operations, ie open, close, read, write..
 CSCR_BaseInterface
 CaboutReturns information about the current application running the script and its environment. You can use it in both Script Editor and scriptModule
 CActionAction interface is used to perform menu or tool bar functions
 CcolumnWith the Column function, you can retrieve values from columns in your scene and you can add and remove them
 CcompositionOrderScriptable interface for extracting the timeline composition order. var composition = composition.buildDefaultCompositionOrder() or var composition = composition.buildCompositionOrderForDisplay( displayNode );
 CcopyPasteImplement the copy paste interface, to/from templates, which is available to the scripting environment
 CDrawing
 CDrawingTools
 CelementWith 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 )
 CexporterThis set of functions provides access to the project's export directory
 CFileDialogSimplified FileDialog interface
 CfileMapperMap paths from one format to another
 CframeWith the Frame functions, you can retrieve values from frames and you can add and remove frames in your scene
 CfuncWith the Function Curve functions, you can retrieve and modify values in the function curves
 CInputAccess to Simplified Input Dialogs
 CKeyModifiers
 ClibraryInterface to select templates, and generate thumbnails and movies for them
 CMessageBoxSimplified MessageBox widget
 CMessageLogAllows the user to print messages to the message log window
 CMovieImport
 CnodeNodes are synonymous with Filter, IO, Move and Group Modules in the Network View
 CPaletteManagerQuery information from the Colour view
 CPaletteObjectManagerProvide access to palette list (PaletteList) and palette (Palette) objects
 CPenstyleManagerThis 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
 CpreferencesWith 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
 CrenderThe 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
 CsceneWith the Scene functions, you can retrieve and set global scene attributes, like the aspect ratio of the cells in the scene grid
 CselectionWith 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
 CsoundThe 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
 CSystem
 CTimelineWith the Timeline functions, you can return values for layers and frames in the Timeline window
 CToolPropertiesThis 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
 CUiloaderThe 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
 CviewThe View functions provide information about the contents of selected View windows
 CSCRIPT_QSWidget
 CCheckBoxSimplified CheckBox widget
 CDialogSimplified Dialog widget. This class and the associated widget classes are used to build simple dialogs
 CGroupBoxSimplified GroupBox widget
 CLabelSimplified Label widget
 CRadioButtonSimplified RadioButton widget
 CTextEditSimplified TextEdit widget
 CUI_DialogController
 CExportVideoDlg