Function Summary

These tables show all of the supported functions, their arguments and descriptions, each description provided in the function tables includes a link to the page in this document where you can find more detail.

About Function
Action Function
Column Function
CopyPaste Function
DrawingTools Function
Element Function
Exporter Function
FileMapper Function
Frame Function
Function Curve Function
MessageLog Function
MovieImport Function
Node Function
PaletteManager Function
PenStyleManager Function
Preferences Function
Render Function
Scene Function
Selection Function
Sound Function
SpecialFolders Function
Timeline Function
ToolProperties Function
View Function

 

About Function

Description

about.animate

This is a read-only property that is true whenever this script is being executed by Animate.

For details, see animate

about.animatePro

This is a read-only property that is true whenever this script is being executed by Animate Pro.

For details, see animatePro

about.applicationPath;

Contains application path.

For details, see applicationPath

about.controlCenterApp;

Contains true when ControlCenter.

For details, see controlCenterApp

about.demoVersion;

Contains true when a Demo Version.

For details, see demoVersion

about.digital;

This function returns false whenever this script is being executed by Digital.

Deprecated always FALSE. For details, see digital

about.digitalPro

This function returns false whenever this script is being executed by DigitalPro.

Deprecated always FALSE. For details, see digitalPro

about.educVersion;

Contains true when in Educational Version.

For details, see educVersion

about.fullVersion;

Contains true when in Commercial Version.

For details, see fullVersion

about.getApplicationPath();

Returns the application path.

For details, see getApplicationPath

about.getBinaryPath();

Returns the folder were the binaries can be found.

For details, see getBinaryPath

about.getFlavorString();

Returns the flavour string.

For details, see getFlavorString

about.getResourcesPath();

Returns the folder were the resources can be found.

For details, see getResourcesPath

about.getVersionInfoStr();

Returns the version string.

For details, see getVersionInfoStr

about.harmony;

Returns true when in Harmony.

For details, see harmony

about.interactiveApp

Contains true when interactive application.

For details, seeinteractiveApp

about.isAnimate()

Returns true when in Animate.

For details, see isAnimate

about.isAnimatePro()

Returns true when in Animate Pro.

For details, see isAnimatePro

about.isControlCenterApp();

Returns true when ControlCenter.

For details, see isControlCenterApp

about.isDemoVersion();

Returns true when a demo version.

For details, see isDemoVersion

about.isDigital();

Returns false when in Digital.

Deprecated. Always FALSE.

For details, see isDigital

about.isDigitalPro();

Returns false when in Digital Pro.

Deprecated. Always FALSE.

For details, see isDigitalPro

about.isEducVersion();

Returns true when in Educational Version.

For details, see isEducVersion

about.isFullVersion();

Returns true when in Commercial Version.

For details, see isFullVersion

about.isHarmony();

This is a read-only property that is true whenever this script is being executed by Harmony.

For details, see isHarmony

about.isInteractiveApp();

Returns true when in Interactive.

For details, see isInteractiveApp

about.isLinuxArch();

Returns true when on Linux OS.

For details, see isLinuxArch

about.isMacArch();

Returns true when on OS X.

For details, see isMacArch

about.isMacIntelArch();

Returns true when on OS X, Intel.

For details, see isMacIntelArch

about.isMacPpcArch();

Returns true when on OS X, PowerPC.

For details, see isMacPpcArch

about.isMainApp();

Returns true when in Stage/DigitalPro.

For details, see isMainApp

about.isOpus();

Returns false when in Opus.

Deprecated. Always returns FALSE.

For details, seeisOpus

about.isPaintMode();

Returns true when in Paint Mode.

For details, see isPaintMode

about.isScanApp();

Returns true when in TbScan.

For details, see isScanApp

about.isStage();

Returns true when in Stage.

For details, see isStage()

about.isWindowsArch();

Returns true when on Windows.

For details, see isWindowsArch

about.isXsheetMode();

Returns true when in XSheet Mode.

For details, see isXsheetMode

about.linuxArch;

Contains true when on Linux.

For details, see linuxArch

about.macArch;

Contains true when on OS X.

For details, see macArch

about.macIntelArch;

Contains true when on OS X, Intel.

For details, see macIntelArch

about.macPpcArch;

Contains true when on OS X, PowerPC.

For details, see macPpcArch

about.mainApp;

Contains true when in Stage, DigitalPro.

For details, see mainApp

about.paintMode;

Contains true when in PaintMode.

For details, see paintMode

about.productName;

Returns the product name.

For details, see productName

about.scanApp;

Contains true when in TbScan.

For details, see scanApp

about.stage;

Returns true when in Stage.

For details, see stage

about.windowsArch;

Contains true when on Windows.

For details, see windowsArch

about.xsheetMode;

Contains true when in XSheet Mode.

For details, see xsheetMode

 

Action Function

Description

action.perform(name);

This function calls the menu function directly.

For details, see perform

action.perform (const QString&,const QString&);

This function calls the menu function directly, but the second argument is the id of the responder.

For details, see perform

 

 

Column Function

Description

column.add(“columnName”, “columnType”);

Adds a column with the specified name and type.

For details, see add.

column.clearKeyFrame(“columnName”, atFrame );

Removes a keyframe from a cell in a column.

For details, see clearKeyFrame.

column.getColorForXSheet();

Returns the colour of a specified XSheet column.

For details, see getColorForXSheet

column.getColumnListOfType(“DRAWING”);

Returns the name of all drawing columns

For details, see getColumnListOfType

column.getCurrentVersionForDrawing();

Returns the current drawing version for the given column and drawing name.

For details, see getCurrentVersionFor Drawing

column.getDisplayName();

Returns the display name of the column. Note that the column functions now return a unique identifier for the columns. In order to translate this unique identifier into the same string that is viewable in the xsheet, this function must be used.

For details, see getDisplayName

column.getDrawingName();

Returns the name at given frame of a drawing column.

For details, see getDrawingName

column.getDrawingTimings(“columnName”, true);

Lists list of all drawing names used in the drawing column.

For details, see getDrawingTimings

column.getDrawingType(QString col, double f);

Will return the drawing type of drawing at frame f from column col. Types can be "K" for key drawings, "I" for in between or "B" for break down or any other custom type the user might have defined.

For details, see getDrawingType

column.getElementIdOfDrawing(“columnName”);

Returns the id of the element linked to the specified drawing column.

For details, see getElementIdOfDrawing.

column.getEntry(“columnName”, subColumn, atFrame);

Returns the value of a cell in a column.

For details, see getEntry.

column.getName(columnNumber);

Returns the unique identifier that names the column. This is not the display name shown in the xsheet view.

For details, see getName.

column.getNextKeyDrawing();

Returns the frame number of the next key drawing in the given drawing column from the specified start frame.

For details, see getNextKeyDrawing

column.getNextKeyDrawing(QString col,int f);

Returns the next drawing of type "K" after frame f in column col.

For details, see getNextKeyDrawing

column.getPos(QString col);

Returns the position of column col in the xsheet.

For details, see getPos

column.getTextOfExpr(“columnName”);

Returns the expression text in the identified column.

For details, see getTextOfExpr.

column.importSound();

Import a external sound file into a sound column.

For details, see importSound

column.isKeyFrame(“columnName”, subColumn, atFrame);

Returns true or false indicating if a cell in a column is a keyframe.

For details, see isKeyFrame.

column.isKeyFramelineTestFill(QString col, int fromFrame, int toFrame, QString prefix, bool keyOnly);

Fills the drawings from frame fromFrame to frame toFrame with drawing duplicates named with prefix prefix in column col. It will perform this operation only on drawings marked as "K" if keyOnly is true.

For details, see lineTestFill

column.move(int i, int j);

Moves the column at position i to position j.

For details, see move

column.numberOf();

Returns the number of columns in the scene.

For details, see numberOf.

column.rename(“oldName”, “newName”);

Renames the specified column.

For details, see rename.

column.removeSoundColumn(QString name);

Removes the sound column named name from the scene.

For details, see removeSoundColumn

column.setColorForXSheet();

Change the colour of an XSheet column.

For details, see setColorForXSheet

column.setDrawingType(QString col, double f, QString newType);

Sets the drawing type of drawing at frame f from column col to be newType. Types can be "K" for key drawings, "I" for in between or "B" for break down or any other custom type the user might have defined.

For details, see setDrawingType

column.setElementIdOfDrawing(“columnName”, “elementId”);

Links an empty Drawing column to an element.

For details, see setElementIdOfDrawing.

column.setEntry(“columnName”, subColumn, atFrame, “value” );

Set the value of a cell in a column.

For details, see setEntry.

column.setKeyFrame(“columnName”, atFrame );

Makes a cell in a column a keyframe.

For details, see setKeyFrame.

column.setTextOfExpr(“columnName”, “text”);

Sets the value in the Expression column to the specified text.

For details, see setTextOfExpr .

column.type(“columnName”);

This function returns the column type. There are nine column types: Drawing (DRAWING), Sound (SOUND), 3D Path (3DPATH), Bezier Curve (BEZIER), Ease Curve (EASE), Expression (EXPR), Timing (TIMING) for timing columns, Quaternion path (QUATERNIONPATH) for 3D rotation and Annotation (ANNOTATION) for annotation columns.

For details, see type.

column.update();

Forces an update in the xsheet user interface.

For details, see update

 

CopyPaste Function

Description

copyPaste.createTemplateFromSelection( “name”, const “path” );

This function creates template from the current selection in the scene, using only the current drawing versions.

For details, see createTemplateFromSelection

copyPaste.useCreateTemplateSpecial(bool inUse, bool allModellingDir, bool addScanFiles, bool /* not used */);

This function instructs the copy/paste operations to use special operations for createTemplateFromSelection.

If inUse is TRUE, will use the two other flags in the createTemplateFromSelection..

For details, see

copyPaste.pasteTemplateIntoScene( const “templateSrcPath”, “insertColumnName”, int insertFrame );

This function pastes the template into the scene.

For details, see pasteTemplateIntoScene

copyPaste.usePasteSpecial( flag );

This function enables the paste special options.

For details, see pasteTemplateIntoScene

copyPaste.setExtendScene( flag );

This function sets the option to extend the scene to accommodate the incoming template.

For details, see pasteTemplateIntoScene

copyPaste.setExtendScene(bool);

This function sets a property in the copy/paste to extend the scene if the pasted template is longer than the scene.

For details, see setExtendScene

copyPaste.setPasteSpecialCopyModelDir(bool);

This function sets the flag to copy the model directory in pasted templates.

For details, see setPasteSpecialCopyModelDir

copyPaste.setPasteSpecialCopyScanFiles(bool);

This function sets the flag to copy the scan files along with the TVG in copy/paste operation.

For details, see setPasteSpecialCopyScanFiles

copyPaste.setPasteSpecialCreateNewColumn( flag );

This function sets the option to create new columns to paste.

For details, see setPasteSpecialCreateNewColumn

copyPaste.setPasteSpecialElementTimingColumnMode ( “mode” );

This function sets the paste special element timing mode for calls to pasteTemplateIntoScene.

For details, see setPasteSpecialElementTimingColumnMode

copyPaste.setPasteSpecialAddRemoveMotionKeyFrame( flag );

PEGS: This function is a paste special option for pegs and functions.

For details, see setPasteSpecialAddRemoveMotionKeyFrame

copyPaste.setPasteSpecialAddRemoveVelocityKeyFrame( flag );

PEGS: This function is a paste special option for pegs and functions.

For details, see setPasteSpecialAddRemoveVelocityKeyFrame

copyPaste.setPasteSpecialAddRemoveAngleKeyFrame( flag );

PEGS: This function is a paste special option for pegs and functions.

For details, see setPasteSpecialAddRemoveAngleKeyFrame

copyPaste.setPasteSpecialAddRemoveSkewKeyFrame( flag );

PEGS: This function is a paste special option for pegs and functions.

For details, see setPasteSpecialAddRemoveScalingKeyFrame

copyPaste.setPasteSpecialAddRemoveScalingKeyFrame( flag );

PEGS: This function is a paste special option for pegs and functions.

For details, see setPasteSpecialAddRemoveScalingKeyFrame

copyPaste.setPasteSpecialForcesKeyFrameAtBegAndEnd( flag );

PEGS: This function is a paste special option for pegs and functions.

For details, see setPasteSpecialForcesKeyFrameAtBegAndEnd

copyPaste.setPasteSpecialOffsetKeyFrames( flag );

PEGS: This function is a paste special option for pegs and functions.

For details, see setPasteSpecialOffsetKeyFrames

copyPaste.setPasteSpecialReplaceExpressionColumns( flag );

PEGS: This function is a paste special option for pegs and functions.

For details, see setPasteSpecialReplaceExpressionColumns

copyPaste.setPasteSpecialDefaultCameraName(bool flag);

This function attempts to transfer the default camera name from the pasted template to the current scene if flag is TRUE.

For details, see setPasteSpecialDefaultCameraName

copyPaste.setPasteSpecialDrawingAction( “mode” );

DRAWING: This function sets the drawing file mode - only used if the DrawingAction is set to ADD_OR_REMOVE_EXPOSURE

For details, see setPasteSpecialDrawingAction

copyPaste.setPasteSpecialDrawingAutomaticExtendExposure( extendExposure, keyFrameMode );

DRAWING: This function sets the drawing file mode.

For details, see setPasteSpecialDrawingFileMode

copyPaste.setPasteSpecialColorPaletteOption( “mode” );

This function sets the colour palette option.
For details, see setPasteSpecialDrawingAutomaticExtendExposure

copyPaste.setPasteSpecialTVPreserveName(bool);

This function sets the flag to preserve the name of the pasted timed values if possible.

For details, see setPasteSpecialTVPreserveName

 

DrawingTools Function

Description

drawingTools.computeBreakingTriangles(const DT_ScriptParams *params);

This function computes the breaking triangles of the current layer using params.

For details, see computeBreakingTriangles

drawingTools.convertPencilToBrush(int layer,const DT_ScriptParams *params);

This function converts the selected pencil lines in layer of the current drawing using params.

For details, see convertPencilToBrush

drawingTools.extractCenterline(int srcLayer, int dstLayer,const DT_ScriptParams* params);

This function extracts the centreline from srcLayer and puts the extracted line in dstLayer using params.

For details, see extractCenterline

drawingTools.setCurrentArt(int layer);

This function sets the current art to be one of the following; DrawingTools.underlayArt, DrawingTools.colourArt,
DrawingTools.lineArt
DrawingTools.overlayArt.

For details, see setCurrentArt

drawingTools.setCurrentDrawingFromColumnName(QString columnName,int frame);

This function sets the current drawing to be from column columnName at frame frame.

For details, see setCurrentDrawingFromColumnName

drawingTools.setCurrentDrawingFromNodeName(QString nodeName, int frame);

This function sets the current drawing to be from node nodeName at frame frame.

For details, see setCurrentDrawingFromNodeName

 

Element Function

Description

element.add(“name”, “scanType”, “fieldChart”, “fileFormat”, “Vectorize”);

Adds an element to the scene and returns the element id of the newly added element if successful, otherwise it returns - l -.

For details, see add.

element.completeFolder(int elem);

Returns the complete path to the folder of element elem.

For details, see completeFolder

element.fieldChart();

Returns the field chart size of the provided element.

For details, see fieldChart

element.folder( id );

Returns the name of the folder on disk of the element.

For details, see Folder

element.getNameById(id);

Returns the name of the element.

For details, see getNameById.

element.id(index);

Returns the id (key) of the element.

For details, see id.

element.modify(int elem, QString scanType, double fieldChart, QString fileFormat, int vectorType);

Changes the attributes of the element elem.

For details, see modify

element.numberOf();

Returns the number of elements in the scene.

For details, see numberOf.

element.physicalName(int elem);

Returns the folder name (just the folder, not the full path) where the element is stored.

For details, see physicalName

element.pixmapFormat();

Returns the pixmap format for the provided element.

For details, see pixmapFormat

element.remove();

Remove an element. Optionally delete all files associated with that element.

For details, see remove

element.renameById();

Rename an element.

For details, see renameById

element.scanType();

Returns the scan type of an element.

For details, see scanType

element.vectorType();

Returns the vector type of an element. Will return 0 if image, or 2 if TVG.

For details, see vectorType

 

 

Exporter Function

Description

exporter.cleanExportDir();

This function removes all files from the export directory.

For details, see cleanExportDir

exporter.getExportDir();

This function returns the path of the projects default export directory.

For details, see getExportDir

 

 

FileMapper Function

Description

filemapper.oNativePath(const QString&);

This function returns the complete path of the passed path, resolving shortcuts in windows.

For details, see toNativePath

 

Frame Function

Description

frame.current();

Returns the number of the current frame.

For details, see current.

frame.insert(atFrame, nbFrame);

Inserts frames at the specified frame number.

For details, see insert.

frame.numberOf();

Returns the number of frames in the scene.

For details, see numberOf.

frame.remove(startFrame, nbFrame);

Removes frames from the specified frame.

For details, see remove.

frame.setCurrent( frame );

Set the current frame in a scene.

For details, see setCurrent

 

Function Curve Function

Description

func.holdStartFrame(“columnName”);

Returns the Start value from the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors.

For details, see holdStartFrame.

func.holdStep(“columnName”);

Returns the Step value from the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors.

For details, see holdStep.

func.holdStopFrame(“columnName”);

Returns the Stop value from the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors.

For details, see holdStopFrame.

Functions common to Bezier, Ease and Velocity-Based Function Curves

func.numberOfPoints(“columnName”);

Returns the number of keyframes and control points on a curve.

For details, see numberOfPoints.

func.pointConstSeg(“columnName”, point);

Returns a 1 to indicate that the point is on a constant segment, or a 0 to indicate that the point is not on a constant segment.

For details, see pointConstSeg.

func.pointContinuity(“columnName”, point);

Returns the continuity of the curve that follows the point. One of the following values will be returned, in upper-case: SMOOTH, CORNER or STRAIGHT.

For details, see pointContinuity.

func.pointX(“columnName”, point);

Returns the X value (frame number) of a point on a function curve.

For details, see pointX.

func.pointY(“columnName”, point);

Returns the Y value of a point on a function curve.

For details, see pointY.

Bezier Functions

func.pointHandleLeftX(“columnName”, point);

Returns the X value of the left handle of a point on a curve.

For details, see pointHandleLeftX.

func.pointHandleLeftY(“columnName”, point);

Returns the Y value of the left handle of a point on a curve.

For details, see pointHandleLeftY.

func.pointHandleRightX(“columnName”, point);

Returns the X value of the right handle of a point on a curve.

For details, see pointHandleRightX.

func.pointHandleRightY(“columnName”, point);

Returns the Y value of the right handle of a point on a curve.

For details, see pointHandleRightY.

Ease Functions

func.angleEaseIn(“columnName”, point);

Returns the angle of the ease-in handle.

For details, see angleEaseIn.

func.angleEaseOut(“columnName”, point);

Returns the angle of the ease-out handle.

For details, see angleEaseOut.

func.pointEaseIn(“columnName”, point);

Returns the number of frames in the ease-in.

For details, see pointEaseIn.

func.pointEaseOut(“columnName”, point);

Returns the number of frames in the ease-out.

For details, see pointEaseOut.

3D Path Functions

func.numberOfPointsPath3d(“columnName”);

Returns the number of keyframes and control points on the 3D Path.

For details, see numberOfPointsPath3d.

func.pointBiasPath3d(“columnName”, point);

Returns the bias value for the specified point on the 3D Path.

For details, see pointBiasPath3d.

func.pointContinuityPath3d(“columnName”, point);

Returns the continuity value (STRAIGHT, SMOOTH or CORNER) for the specified point on the 3D Path.

For details, see pointContinuityPath3d.

func.pointLockedAtFrame(“columnName”, point);

Returns the frame the point is locked at, or 0 if the point is not locked.

For details, see pointLockedAtFrame.

func.pointTensionPath3d(“columnName”, point);

Returns the tension value for the specified point on the 3D Path.

For details, see pointTensionPath3d.

func.pointXPath3d(“columnName”, point);

Returns the value of the specified point on the X path.

For details, see pointXPath3d.

func.pointYPath3d(“columnName”, point);

Returns the value of the specified point on the Y path.

For details, see pointYPath3d.

func.pointZPath3d(“columnName”, point);

Returns the value of the specified point on the Z path.

For details, see pointZPath3d.

Editing Functions

func.addCtrlPointAfterPath3d(“columnName”, point, X, Y, Z, tension, continuity, bias);

Adds a keyframe after a point on a 3D Path and sets the X, Y and Z values, as well as the tension, continuity and bias.

For details, see addCtrlPointAfterPath3d.

func.addKeyFramePath3d(“columnName”, frame, X, Y, Z, tension, continuity, bias);

Adds a keyframe to a 3D Path and sets the X, Y and Z value, as well as the tension, continuity and bias.

For details, see addKeyFramePath3d.

func.removePointPath3d(“columnName”, point);

Removes either a control point or a keyframe from the 3D Path.

For details, see removePointPath3d.

func.setPath3dPointConstantSegment(QString p,int i,bool b);

Sets the constant segment flag of point i of path p to b.

For details, see setPath3dPointConstantSegment

func.setPath3dPointConstantSegmentForFrame(QString p,double f,bool b);

Sets the constant segment flag of point found at frame f of path p to b.

For details, see setPath3dPointConstantSegmentForFrame

func.setPointPath3d(“columnName”, point, X, Y, Z, tension, continuity, bias);

Sets the properties of a point on a 3D Path, including X, Y, and Z values, and tension, continuity and bias values.

For details, see setPointPath3d.

func.setBezierPoint(“columnName”, frame, Y, handleLeftX, handleLeftY, handleRightX, handleRightY, constSeg, “continuity”);

Sets the values of a point on a Bezier function curve.

For details, see setBezierPoint.

func.setEasePoint(“columnName”, frame, Y, easeIn, angleEaseIn, easeOut, angleEaseOut, constSeg, “continuity”);

Sets the values of a point on an Ease function curve.

For details, see setEasePoint.

func.setHoldStartFrame(“columnName”, startFrame);

Sets the Start value in the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors.

For details, see setHoldStartFrame.

func.setHoldStep(“columnName”, stepNumber);

Sets the Hold value in the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors.

For details, see setHoldStep.

func.setHoldStopFrame(“columnName”, stopFrame);

Sets the Stop value in the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors.

For details, see setHoldStopFrame.

func.setVeloBasedPoint(“columnName”, frame, Y);

Sets the values of a point on a Velocity-Based function curve.

For details, see setVeloBasedPoint.

 

 

KeyModifiers Function

Description

keyModifiers.IsAlternatePressed();

Returns TRUE if Alt key is pressed.

For details, see IsAlternatePressed

keyModifiers.IsControlPressed();

Returns TRUE if Ctrl key is pressed.

For details, see IsControlPressed

keyModifiers.IsShiftPressed();

Returns TRUE if Shift key is pressed.

For details, see IsShiftPressed

keyModifiers.IsSpacePressed();

Returns TRUE if Spacebar is pressed.

For details, see IsSpacePressed

 

MessageLog Function

Description

MessageLog.debug( message );

Writes the message to the message log if debug mode is on.

For details, see debug

MessageLog.isDebug();

Returns whether debug mode is enabled in the messageLog.

For details, see isDebug .

MessageLog.setDebug( b );

Sets the debug mode in message log. This will set debug mode for the entire application.

For details, see setDebug .

MessageLog.trace( message );

Writes the message to the message log.

For details, see trace

 

 

MovieImport Function

Description

movieImport.doImport();

This function performs the imports.

For details, see doImport

movieImport.image(int n);

Returns the filename of image n.

For details, see image

movieImport.isAudioFileCreated();

Returns TRUE if an audio file was created.

For details, see isAudioFileCreated

movieImport.numberOfImages();

Returns the number of images imported.

For details, see numberOfImages

movieImport.setAudioFile(QString);

Defines where to store the audio file.

For details, see setAudioFile

movieImport.setImageFolder(QString);

Defines where to store the extracted images.

For details, see setImageFolder

movieImport.setImagePrefix(QString);

Defines which prefix to use to save the images.

For details, see setImagePrefix

movieImport.setMovieFilename(QString);

Defines the input movie name.

For details, see setMovieFilename

 

 

Node Function

Description

node.add(“parent_group_path”, “name”, “type”, X, Y, Z);

Adds a module to the network.

For details, see add.

node.addCompositeToGroup();

Add a composite to the given group.

For details, see addCompositeToGroup

node.coordX(“node_path”);

Returns an integer indicating the X position of a module in the network.

For details, see coordX.

node.coordY(“node_path”);

Returns an integer indicating the Y position of a module in the network.

For details, see coordY.

node.createGroup();

Create a group with the selected nodes.

For details, see createGroup

node.deleteNode();

Delete a single node. Optionally, delete the columns and elements used by that node.

For details, see deleteNode

node.dstNode(“node_path”, iPort, iLink);

Returns the path of the destination module linked to by the output port on the source module.

For details, see dstNode.

node.equals(“node_path”, “node_path”);

Returns true or false to indicate if a node path is equal to another.

For details, see equals.

node.explodeElementSymbolsInGroups(QString elem, bool disableElement, bool clearExposure, const QString& prefix);

Creates a group for each exposure of element elem where there is a symbol and will put the content of the symbol in that group. If disable element is TRUE, will disable the element afterwards. If clearExposure is TRUE, will clear the exposures where there were symbols afterwards. Will use prefix as the prefix for the generated group names.

For details, see explodeElementSymbolsInGroups

node.explodeGroup();

Explode a provided group.

For details, see explodeGroup

node.flatDstNode(“node_path”, iPort, iLink);

If the dstNode is a Group Module, this returns the path of the module inside the Group Module that is the destination.

For details, see flatDstNode

node.flatSrcNode(“node_path”, iPort);

If the srcNode is a Group Module, this returns the path of the module inside the Group Module that is the source.

For details, see flatSrcNode

node.getCameras();

Returns list of all cameras.

For details, see getCameras

node.getDefaultCamera();

Returns name of default camera.

For details, see getDefaultCamera

node.getEnable();

Returns whether a module is enabled or not.

For details, see getEnable

node.getLocked(QString n);

Returns the lock flag of node n.

For details, see getLocked

node.getMatrix();

Returns the model matrix for the node.

For details, see getMatrix

node.getName(“node_path”);

Returns the name of a module.

For details, see getName.

node.getTextAttr(“node_path”, atFrame, “attrName”);

Returns the value(s) of the module’s selected attribute.

For details, see getTextAttr.

node.groupAtNetworkBuilding(QString peg);

Returns TRUE if the peg's groupAtNetworkBuilding attribute is true.

For details, see groupAtNetworkBuilding

node.isGroup(“node_path”);

Returns a true or false value indicating if the module is a Group Module.

For details, see isGroup.

node.isLinked(“node_path”, iPort);

Returns true or false to indicate if a port is connected to another module.

For details, see isLinked.

node.link(“srcNode_path”, srcPort, “dstNode_path”, dstPort);

Links a port on a module to a port on another module.

For details, see link.

node.linkAttr(“node_path”, “attrName”, “columnName”);

Links an attribute to a function column in the Xsheet View.

For details, see linkAttr.

node.linkedColumn(“node_path”, “attrName”);

Returns the name of the column that an attribute is linked to. If the attribute is not linked to a column, the function returns the null string.

For details, see linkedColumn.

node.noNode();

Returns the null string that is returned by other functions when there is an error.

For details, see noNode.

node.numberOfInputPorts(“node_path”);

Returns an integer indicating the number of input ports on the module.

For details, see numberOfInputPorts.

node.numberOfOutputLinks(“node_path”, iPort);

Returns an integer indicating the number of modules actually linked from the output ports.

For details, see numberOfOutputLinks.

node.numberOfOutputPorts(“node_path”);

Returns an integer indicating the number of output ports on a module.

For details, see numberOfOutputPorts.

node.numberOfSubNodes(“node_path”);

Returns an integer that indicates the number of modules contained in a group.

For details, see numberOfSubNodes.

node.parentNode(“node_path”);

Returns the path of the parent level of a module contained in a group.

For details, see parentNode.

node.rename(“node_path”, “newName”);

Changes the name of a module.

For details, see rename.

node.root();

Returns the name of the Top level in the network, which is “Top”.

For details, see root.

node.setAsDefaultCamera(“cam1”);

Sets the default camera.

For details, see setAsDefaultCamera

node.setAsGlobalDisplay ();

Select the provided display as the current global display.

For details, see setAsGlobalDisplay

node.setCoord(“node_path”, X, Y);

Sets the position of a module in the network.

For details, see setCoord.

node.setEnable(true);

enables or disables a module.

For details, see setEnable

node.setGlobalToDisplayAll();

Select the "Display All" display as the current global display.

For details, see setGlobalToDisplayAll

node.setLocked(QString n,bool b);

Sets the lock flag of node n to b; .

For details, see setLocked

node.setTextAttr(“node_path”, “attrName”, atFrame, “attrValue”);

Changes the value of an attribute in a module.

For details, see setTextAttr.

node.srcNode(“node_path”, iPort);

Returns the path for the module that the port is linked to.

For details, see srcNode.

node.subNode(“node_path_parent”, iSubNode);

Returns the path of a module in a group.

For details, see subNode.

node.subNodeByName ();

Returns the path of a module in a group.

For details, see subNodeByName

node.type(“node_path”);

Returns the module type.

For details, see type.

node.unlink(“dstNode_path”, inPort);

Unlinks a port on one module from the port on another module.

For details, see unlink.

node.unlinkAttr(“node_path”, “attrName”);

Unlinks an attribute from a function column.

For details, see unlinkAttr.

node.height();

Returns the node height.

For details, see width/height

node.width();

Returns the node width.

For details, see width/height

 

PaletteManager Function

Description

PaletteManager.getCurrentColorId();

This function retrieves the id of the currently selected colour..

For details, see getCurrentColorId

PaletteManager.getCurrentColorName();

This function returns the current colour name from the ColourView.

For details, see getCurrentColorName

PaletteManager.getCurrentPaletteId();

This function returns the id of the current palette from the ColourView.

For details, see coordX

PaletteManager.getCurrentPaletteName();

This function returns the current palette name from the ColourView.

For details, see getCurrentPaletteName

PaletteManager.setCurrentPaletteById( “palette”);

This function sets the current palette in the ColourView.

For details, see setCurrentPaletteById

PaletteManager.setCurrentColorById( “color”);

This function sets the current colour in the ColourView.

For details, see setCurrentColorById

PaletteManager.setCurrentPaletteAndColorById(“palette”, “color”);

 

This function sets the current palette and colour in the ColourView.

For details, see setCurrentPaletteAndColorById

PaletteManager.getCurrentPaletteSize();

This function returns the size of the currently selected palette in the ColourView.

For details, see getCurrentPaletteSize

PaletteManager.getColorName(int index);

This function returns the name of the colour in the currently selected palette.

For details, see getColorName

PaletteManager.getColorId(int index);

This function returns the id of the colour in the currently selected palette.

For details, see getColorId

PaletteManager.getNumPalettes();

This function returns the number of palettes in the current selected palette list in ColourView list.

For details, see getNumPalettes

PaletteManager.getNumPalettes( scenePaletteList );

This function returns the number of palettes in palette list in ColourView.

For details, see getNumPalettes

PaletteManager.getPaletteName(int index);

This function returns the name of the palette in the current palette list in the ColourView.

For details, see getPaletteName

PaletteManager.getPaletteName(int index, scenePaletteList)

This function returns the name of the palette in the current palette list in the ColourView.

For details, see getPaletteName

PaletteManager.getPaletteId(int index);

This function returns the id of the palette in the current palette list in the ColourView.

For details, see getPaletteId

PaletteManager.getPaletteId(int index, scenePaletteList );

This function returns the id of the palette in the current palette list in the ColourView.

For details, see getPaletteId

 

PenStyleManager Function

Description

PenstyleManager.getNumberOfPenstyles();

This function returns the number of penstyles.

For details, see getNumberOfPenstyles

PenstyleManager.getPenstyleName(int index);

This function returns the name of the penstyle.

For details, see getPenstyleName

PenstyleManager.getCurrentPenstyleName();

This function returns the name of the current pen style.

For details, see getCurrentPenstyleName

PenstyleManager.setCurrentPenstyleByName(“name”);

This function sets the current penstyle by name.

For details, see setCurrentPenstyleByName

PenstyleManager.setCurrentPenstyleByIndex(int index);

This function sets the current penstyle by index.

For details, see setCurrentPenstyleByIndex

PenstyleManager.changeCurrentPenstyleMinimumSize

This function sets the current penstyle minimum size.

For details, see changeCurrentPenstyleMinimumSize

PenstyleManager.changeCurrentPenstyleMaximumSize(double maximum);

 

This function sets the current penstyle maximum size.

For details, see changeCurrentPenstyleMaximumSize

PenstyleManager.getCurrentPenstyleIndex();

This function sets the index of the current penstyle.

For details, see getCurrentPenstyleIndex

PenstyleManager.changeCurrentPenstyleOutlineSmoothness(int smooth);

This function sets the current penstyle outline smoothness.

For details, see changeCurrentPenstyleOutlineSmoothness

PenstyleManager.changeCurrentPenstyleCenterlineSmoothness(int smooth);

This function sets the current penstyle centreline smoothness.

For details, see changeCurrentPenstyleCenterlineSmoothness

PenstyleManager.changeCurrentPenstyleEraserFlag(flag);

This function sets the current penstyle eraser flag.

For details, see changeCurrentPenstyleEraserFlag

PenstyleManager.getCurrentPenstyleMinimumSize();

This function gets the current penstyle minimum size.

For details, see getCurrentPenstyleMinimumSize

PenstyleManager.getCurrentPenstyleMaximumSize();

This function gets the current penstyle maximum size.

For details, see getCurrentPenstyleMaximumSize

PenstyleManager.getCurrentPenstyleOutlineSmoothness();

This function gets the current penstyle outline smoothness.

For details, see getCurrentPenstyleOutlineSmoothness

PenstyleManager.getCurrentPenstyleEraserFlag();

This function gets the current penstyle eraser flag.

For details, see getCurrentPenstyleEraserFlag

PenstyleManager.exportPenstyleToString(int index)

This function creates a string representing the penstyle which can be used to store the penstyle and import it later.

For details, see exportPenstyleToString

PenstyleManager.exportPenstyleListToString();

This function formats the penstyle list into a string, which can be used to store the penstyle list and import it later.

For details, see exportPenstyleListToString

PenstyleManager.importPenstyleListFromString(“str”);

This function imports a penstyle list from a previously formatted penstyle string.

For details, see importPenstyleListFromString

PenstyleManager.savePenstyles();

This function saves the pen styles.

For details, see getNumberOfPenstyles

PenstyleManager.savePenstyles();

This function saves the pen styles.

For details, see getNumberOfPenstyles

 

Preferences Function

Description

preferences.get();

Retrieve the value of a boolean preference.

For details, see getBool

preferences.getColor();

Retrieve the value of a colour preference.

For details, see getColor

preferences.getDouble();

Retrieve the value of a double preference.

For details, see getDouble

preferences.getEnumValue(QString p,int v);

Returns the value of an enumerated type preference. v will be returned if enumerated preference p is not found.

For details, see getEnumValue

preferences.getInt();

Retrieve the value of a integer preference.

For details, see getInt

preferences.getString();

Gets the value of a string preference.

For details, see getString

preferences.setBool();

Set the value of a boolean preference.

For details, see setBool

preferences.setColor();

Sets the value of a colour preference.

For details, seesetColor

preferences.setDouble();

Sets the value of a double preference.

For details, see setDouble

preferences.setEnumValue(QString p,int v);

Sets the value of the enumerated preference p to v.

For details, see setEnumValue

preferences.setInt();

Set the value of a integer preference.

For details, see setInt

preferences.setString();

Sets the value of a string preference.

For details, see setString

 

Render Function

Description

render.setCombine(autoCombine, secondFieldFirst);

Set if rendered frames sets should be combined and in which order.

Specify these options if you are rendering in PAL or NTSC format.

For details, see setCombine

render.setFieldType(int type);

Sets the frame output format.

For details, see setFieldType

render.setBgColor(QColor bgColor);

Set the background colour to use when rendering in scene machine mode.

For details, see setBgColor

render.setResolution(int x, int y);

Set the scene resolution to use for rendering.

For details, see setResolution

render.setRenderDisplay(“name”);

Set which display module to use for rendering."Display All" uses the global unconnected display module.

For details, see setRenderDisplay

render.setWriteEnabled(enabled);

Enable or disable write modules during the render.

For details, see setWriteEnabled

render.renderScene(int fromFrame, int toFrame);

Render a part of the scene.

For details, see renderScene

render.renderSceneAll();

Render the complete scene.

For details, see renderSceneAll

render.cancelRender();

Interrupt an active render.

For details, see cancelRender

 

Scene Function

Description

scene.beginUndoRedoAccum(“commandname”);

Starts the accumulation of all of the functions between it and the endUndoRedoAccum function as one command that will appear in the undo/redo list. If you do not use this function with endUndoRedoAccum, each function in the script generates a separate undo/redo entry.

For details, see beginUndoRedoAccum.

scene.cancelUndoRedoAccum();

Cancel the accumulation of undo commands. Rollback all executed commands.

For details, see cancelUndoRedoAccum

scene.clearHistory ();

This function clears the command history. After this call, it is not possible to undo the command.

For details, see clearHistory

scene.closeScene();

Closes the current scene.

For details, see closeScene

scene.closeSceneAndExit();

Closes the current scene and exits.

For details, see closeSceneAndExit

scene.closeSceneAndOpen(const QString &env, const QString &job,const QString &scene, const QString &version);

Closes the current scene and opens the scene specified by env, job, scene and version.

For details, see closeSceneAndOpen

scene.coordAtCenterX();

Returns the X value of the centre coordinate of the scene grid.

For details, see coordAtCenterX.

scene.coordAtCenterY();

Returns the Y value of centre coordinate of the scene grid.

For details, see coordAtCenterY.

scene.currentEnvironment();

Returns the current environment name.

For details, seecurrentEnvironment

scene.currentJob();

Returns the current job name.

For details, see currentJob

scene.currentProjectPath();

Returns the current project path.

For details, seecurrentProjectPath

scene.currentProjectPathRemapped();

Returns the current project path with shortcut translated and symlink resolved.

For details, see currentProjectPathRemapped

scene.currentResolutionX();

Returns the preview resolution in X.

For details, see currentResolutionX

scene.currentResolutionY();

Returns the previous resolution in Y.

For details, see currentResolutionY

scene.currentScene();

Returns the name of the current scene.

For details, see currentScene.

scene.currentVersion();

Returns the current version of project/scene.

For details, see currentVersion

scene.defaultResolutionFOV();

Returns the field of view.

For details, seedefaultResolutionFOV

scene.defaultResolutionName();

Returns the name of the scene resolution preset.

For details, see defaultResolutionName

scene.defaultResolutionX();

Returns the scene resolution in X.

For details, see defaultResolutionX

scene.defaultResolutionY();

Returns the scene resolution in Y.

For details, see defaultResolutionY

scene.endUndoRedoAccum();

Ends the accumulation all of the functions between it and the beginUndoRedoAccum function as one command that will appear in the undo/redo list. If you do not use this function with beginUndoRedoAccum, each function in the script generates a separate undo/redo entry.

For details, see endUndoRedoAccum.

scene.fromOGL();

Convert an OGL coordinate to a field coordinate.

For details, see fromOGL

scene.getCameraMatrix();

Returns the model matrix for the default camera. Note that this is the inverse of the view matrix.

For details, see getCameraMatrix

scene.getFrameRate();

Returns the frame rate.

For details, see getFrameRate

scene.getMissingPalettes(bool unrecovered, bool recoveredNotYetSaved);

Returns all palettes that were either unrecovered or recovered but not yet saved, depending on the arguments of the function.

For details, see

scene.numberOfUnitsX();

Returns the number of units in the X-axis of the scene grid.

For details, see numberOfUnitsX.

scene.numberOfUnitsY();

Returns the number of units in the Y-axis of the scene grid.

For details, see numberOfUnitsY.

scene.numberOfUnitsZ();

Returns the number of units in the Z-axis of the scene grid.

For details, see numberOfUnitsZ.

scene.redo(int n);

Redo the last n operations. If n is not specified, it will be 1.

For details, see redo

scene.saveAll();

Save project, all drawings, palettes and palette list.

For details, see saveAll

scene.saveAsNewVersion(“name.true”);

Save all, while creating a new version of project.

For details, see saveAsNewVersion

scene.setUnitsAspectRatio(x, y);

Sets the aspect ratio of the scene.

For details, see setUnitsAspectRatio.

scene.setNumberOfUnits(x, y, z);

Sets the number of X, Y, and Z units in the scene grid.

For details, see setNumberofUnits.

scene.setCoordAtCenter(x, y);

Sets the value of the centre (X, Y) coordinates.

For details, see setCoordAtCenter.

scene.setDefaultResolution();

Set the default resolution X,Y and field of view.

For details, see setDefaultResolution

scene.setFrameRate();

Set the global frame rate.

For details, see setFrameRate

scene.tempProjectPath();

Returns the folder where the elements are created before any save operation occurs.

For details, see tempProjectPath

scene.tempProjectPathRemapped();

Returns the folder where the elements are created before any save operation occurs. The folder name might contain windows shortcuts, these shortcuts will be resolved and the result will be the resolved name.

For details, see tempProjectPathRemapped

scene.toOGL();

Converts a field coordinate to an OGL coordinate.

For details, see toOGL

scene.undo(int n);

Undoes the last n operations. If n is not specified, it will be 1.

For details, see

scene.unitsAspectRatioX();

Returns the X value of the aspect ratio of the cells in the scene grid.

For details, see unitsAspectRatioX.

scene.unitsAspectRatioY();

Returns the Y value of the aspect ratio of the cells in the scene grid.

For details, see unitsAspectRatioY.

 

Selection Function

Description

selection.clearSelection();

This function clears the selection.

For details, see clearSelection

selection.addDrawingColumnToSelection(columnName);

This function adds the drawing column and it's associated read node to the selection.

For details, see addDrawingColumnToSelection

selection.addColumnToSelection(column);

This function adds a column to the selection.

For details, see addColumnToSelection

selection.addNodeToSelection(node);

This function adds a node to the selection.

For details, see addNodeToSelection

selection.extendSelectionWithColumn(columnName);

This function adds the drawing column to the selection. If the column is a drawing column, also adds the associated read node to the selection.

For details, see extendSelectionWithColumn

selection.numberOfCellColumnsSelected();

Returns the number of columns selected in the xsheet.

For details, see numberOfCellColumnsSelected

selection.numberOfFramesSelected();

This function returns the number of frames -selected (to be used in the xhseetview only).

For details, see numberOfFramesSelected

selection.numberOfNodesSelected();

This function returns the number of modules that are selected.

For details, see numberOfNodesSelected

selection.selectAll();

This function selects all nodes and all columns in the scene.

For details, see pointEaseIn

selection.selectedCellColumn(int i);

This function returns the name of the selected column.

For details, see selectedCellColumn

selection.selectedCellFrame(int i);

Returns the ith frame selected in the xsheet.

For details, see selectedCellFrame

selection.selectedColumn(int i);

Returns the ith column selected in the xsheet.

For details, see selectedColumn

selection.selectedNode(int i);

This function returns the path of the selected node.

For details, see selectedNode

selection.setSelectionFrameRange(int start, int end );

This function sets the frame range for the selection.

For details, see setSelectionFrameRange

 

Sound Function

Description

sound.getSoundtrack(int fromFrame, int toFrame);

Returns a part of the scene's soundtrack in a temporary file in WAV format.

For details, see getSoundtrack

sound.getSoundtrackAll();

Returns the scene's soundtrack in a temporary file in WAV format.

For details, see getSoundtrackAll

sound.setChannelCount(int count);

Sets the number of audio channels (i.e 1 for mono and 2 for stereo).

For details, see setChannelCount

sound.setChannelSize(int size);

Sets the audio channel size (i.e. 8 or 16 bit).

For details, see setChannelSize

sound.setFrameRate(int);

Sets the desired frame rate to use when calling getSoundtrack or getSoundtrackAll.

For details, see setFrameRate

sound.setSampleRate(double rate);

This function sets the audio sample rate.

For details, see setSampleRate

SpecialFolders Function

Description

specialFolders.app;

Returns the global application folder.

For details, see app

specialFolders.bin;

Returns the global binary folder.

For details, see bin

specialFolders.config;

Returns the global configuration file folder.

For details, see config

specialFolders.etc;

Returns the global./etc folder.

For details, see etc

specialFolders.htmlHelp;

Returns the path to html folder.

For details, see htmlHelp

specialFolders.lang;

Returns the language folder.

For details, see lang

specialFolders.legacyPlugins;

Location where the plugins that were designed for the previous SDK are stored. Replaces the plugins property.

For details, see legacyPlugins

specialFolders.library;

Returns the platform library folder.

For details, see library

specialFolders.pdf

Returns the path to pdf folder.

For details, see platform

specialFolders.platform;

Returns the platform folder.

For details, see platform

specialFolders.plugins;

Location where the plugins that comply with the current SDK are stored.

For details, see plugins

specialFolders.resource;

Returns the resource folder.

For details, see resource

specialFolders.root;

Returns the installation root folder.

For details, see root

specialFolders.temp;

Returns the platform temporary folder.

For details, see temp

specialFolders.userConfig;

Returns the user configuration file folder.

For details, see userConfig

 

 

Timeline Function

Description

Timeline.firstFrameSel

Returns the number of the first frame in the Timeline selection or the current frame, if only one frame is selected.

For details, see firstFrameSel.

Timeline.isAncestorOf(parentLayerIdx, layerIdx);

Returns true or false to identify if a layer is the parent of another layer.

For details, see isAncestorOf.

Timeline.layerIsColumn(layerIdx);

Returns true or false to identify if the Timeline layer is linked to a column in the Xsheet.

For details, see layerIsColumn.

Timeline.layerIsNode(layerIdx);

Returns true or false to identify if the Timeline layer is linked to a module (node) in the Network.

For details, see layerIsNode.

Timeline.layerToColumn(layerIdx);

Returns the column name for the Timeline layer. It returns an empty string if the layer is not a column.

For details, see layerToColumn.

Timeline.layerToNode(layerIdx);

Returns the node (module) index from the Network for the Timeline layer. It returns an empty string if the layer is not a node.

For details, see layerToNode.

Timeline.numFrameSel

Returns the number of the selected frame in the Timeline, if only one frame is selected.

For details, see numFrameSel.

Timeline.numLayers

Returns the number of layers in the Timeline.

For details, see numLayers.

Timeline.numLayersSel

Returns the number of layers that are selected in the Timeline.

For details, see numLayerSel.

Timeline.parentNodeIndex(layerIdx)

Returns a layer identifier (layerIdx) for the parent of the layer (layerIdx).

For details, see parentNodeIndex.

Timeline.selIsColumn(selIdx)

Returns true or false to indicate if the Timeline selection has a column in the Xsheet.

For details, see selIsColumn.

Timeline.selIsNode(selIdx)

Returns true or false to identify if the Timeline selection is linked to a module (node) in the Network.

For details, see linuxArch.

Timeline.selToColumn(selIdx)

Returns the column name for the Timeline selection.

For details, see selToColumn.

Timeline.selToLayer(selIdx)

Returns the layer identifier (layerIdx) for the selection (selIdx) in the Timeline.

For details, see selToLayer.

Timeline.selToNode(selIdx)

Returns the node name from the module in the Network for the Timeline selection.

For details, see selToNode.

Timeline.setDisplayToUnconnected();

Make the "Display All" display the current display. This method is obsolete.

For details, see setDisplayToUnconnected

 

ToolProperties Function

Description

toolProperties.setApplyAllArts(bool);

This function will set to b the Apply to Line Art and Colour Art checkbox state to b; in the Select Tool Options.

For details, see setApplyAllArts

toolProperties.setApplyAllDrawings(bool);

This function will turn set the apply all drawing mode to b.

For details, see setApplyAllDrawings

toolProperties.setApplyAllVisibleDrawings(bool);

This function will turn set the apply all visible drawing mode to b.

For details, see setApplyAllVisibleDrawings

toolProperties.setAutoCreateColourArt(bool);

This function will set the auto create colour art mode of the current tool to b if applicable.

For details, see setAutoCreateColourArt

toolProperties.setAutogapClosingMode(int);

This function will set the auto gap closing mode to m. Mode can be 0, 1, 2 or 3. Which correspond to No Gap, Small, Medium and Large.

For details, see setAutogapClosingMode

toolProperties.setAutoFlattenMode(bool);

This function will set the auto flatten mode to b if applicable.

For details, see setAutoFlattenMode

toolProperties.setAutoFillInside(bool);

This function will set the auto fill mode of Rectangle and Ellipse tool to b.

For details, see setAutoFillInside

toolProperties.setBringInkedLinesOnTop(bool);

This function will instruct the ink tool to bring inked lines on top after inking if b is true.

For details, see setBringInkedLinesOnTop

toolProperties.setDrawBehindMode(bool);

 

This function will toggle the Draw Behind mode of the Brush tool.

For details, see setDrawBehindMode

toolProperties.setDrawingMagnifierMode(bool);

This function will set the magnifier mode to b.

For details, see setDrawingMagnifierMode

toolProperties.setGestureCutter(bool);

This function will set the cutter's gesture mode to b.

For details, see setGestureCutter

toolProperties.setInkLineSelectionMode(bool);

This function will instruct the ink tool to select inked lines after inking if b is true.

For details, see setInkLineSelectionMode

toolProperties.setInkJoinMode(QString);

This function will set the join mode of the inked lines to be joinType. Join type can be one of:

"ROUND_JOIN", "MITER_JOIN" or "BEVEL_JOIN".

For details, see setInkJoinMode

toolProperties.setInkTipMode(QString);

This function will set the tip mode of the inked lines to be tipType. Join type can be one of:

"ROUND_TIP", "FLAT_TIP" or "BEVEL_TIP".

For details, see

toolProperties.setLineBuildingMode(bool);

This function will set the line building mode of the Pencil tool to b.

For details, see setLineBuildingMode

toolProperties.setLinePushingMode(bool);

This function will set the line pushing mode of the Pencil tool to b.

For details, see setLinePushingMode

toolProperties.setMarkeeMode(bool);

This function will set the select tool mode selection to Lasso or Marquee. If b is true, the mode will be set to Marquee.

For details, see setMarkeeMode

toolProperties.setMouseGestureBreakeMode(bool);

This function will set the cutter's gesture break mode to b.

For details, see setMouseGestureBreakeMode

toolProperties.setPaintAndRemoveTextureMode(bool);

This function will instruct the paint tool to remove the opacity texture if b is true.

For details, see setPaintAndRemoveTextureMode

toolProperties.setPaintToolShouldSelectPaintedZonesAfterPainting(bool);

This function will do the following: If b is true, the paint tool will select the newly painted zone after painting. This can be useful if you want to edit a gradient on multiple zones after painting.

For details, see setPaintToolShouldSelectPaintedZonesAfterPainting

toolProperties.setPegSelectionMode(bool);

This function will set the selection mode of the transform tool to peg mode if b is true.

For details, see setPegSelectionMode

toolProperties.setPermanentSelectionMode(bool);

This function will turn the permanent selection mode on/off depending on the parameter b.

For details, see setPermanentSelectionMode

toolProperties.setRespectProtectedColourMode(bool);

This function will set the Respect Protected Colour mode to b if applicable.

For details, see setRespectProtectedColourMode

toolProperties.setSelectByColourMode(bool);

This function will turn set the select by colour mode of the Select tool to b.

For details, see setSelectByColourMode

toolProperties.setShowHideManipulatorControls(bool);

This function will hide on the transform tool manipulator if b is true.

For details, see setShowHideManipulatorControls

toolProperties.setShowInkableLines(bool);

In the ink tool, this function will show the inkable lines if b is true.

For details, see setShowInkableLines

toolProperties.setSmartInkLineConnectionMode(bool);

This function will set the smart ink line connection mode to b.

For details, see setSmartInkLineConnectionMode

toolProperties.setSnapping(bool contour, bool align, bool grid);

This function will set the snapping mode for the contour, align and grid mode all to the modes specified in argument.

For details, see setSnapping

toolProperties.setTransformToolSnapping(bool align, bool grid);

This function will set the align and grid snapping modes of the transform tool.

For details, see setTransformToolSnapping

toolProperties.setUsedStoredColourGradientMode(bool);

This function will instruct the paint tool to use the gradient/texture matrix stored in the tool if b is true

For details, see setUsedStoredColourGradientMode

 

View Function

Description

view.column(currentView);

Returns the name of the column for the currently displayed function in the Function View.

For details, see column.

view.currentView();

Returns a unique identifier for the current, active View.

For details, see currentView.

view.group(currentView);

Returns the name of the current Group Module in the active Network View.

For details, see group.

view.refreshViews();

Forces a redisplay of drawing and scene planning views.

For details, see refreshViews

view.type(currentView);

Returns a string that indicates what type of View the currentView is.

For details, see type.