The copyPaste JavaScript global object. Copy paste to/from templates. More...
Public Slots | |
String | createTemplateFromSelection (String name, String &path) |
Creates template from the current selection in the scene, using only the current drawing versions. More... | |
void | useCreateTemplateSpecial (bool flag, bool addModellingDir=true, bool addScanFiles=true, bool includeDefaultCameraName=true) |
Allows 2 extra options in the template creation. More... | |
bool | pasteTemplateIntoScene (String &templateSrcPath, String &insertColumnName, int insertFrame) |
Pastes the template into the scene. More... | |
bool | pasteTemplateIntoGroup (String &srcPath, String &groupName, int insertFrame) |
Pastes the template into a group of the scene. More... | |
bool | pasteActionTemplateIntoNode (String &srcPath, String &nodeName, int insertFrame, QScriptValue &compositionOptions=QScriptValue()) |
Pastes the action template into the scene and excludes nodes that are in the list. More... | |
void | usePasteSpecial (bool flag) |
Enables PasteSpecial. More... | |
void | setExtendScene (bool flag) |
PasteSpecial Structure value. Default value is false. More... | |
Node Section | |
void | setPasteSpecialCreateNewColumn (bool flag) |
PasteSpecial Structure value. Default value is false. More... | |
void | setPasteSpecialElementTimingColumnMode (String mode) |
PasteSpecial Structure value. Default value is ELEMENT_AS_ELEMENT_AND_TIMING_AS_TIMING. More... | |
Pegs and Functions Section | |
void | setPasteSpecialAddRemoveMotionKeyFrame (bool flag) |
PasteSpecial Structure value. Default value is true. More... | |
void | setPasteSpecialAddRemoveVelocityKeyFrame (bool flag) |
PasteSpecial Structure value. Default value is true. More... | |
void | setPasteSpecialAddRemoveAngleKeyFrame (bool flag) |
PasteSpecial Structure value. Default value is true. More... | |
void | setPasteSpecialAddRemoveSkewKeyFrame (bool flag) |
PasteSpecial Structure value. Default value is true. More... | |
void | setPasteSpecialAddRemoveScalingKeyFrame (bool flag) |
PasteSpecial Structure value. Default value is true. More... | |
void | setPasteSpecialForcesKeyFrameAtBegAndEnd (bool flag) |
PasteSpecial Structure value. Default value is true. More... | |
void | setPasteSpecialOffsetKeyFrames (bool flag) |
PasteSpecial Structure value. Default value is false. More... | |
void | setPasteSpecialReplaceExpressionColumns (bool flag) |
PasteSpecial Structure value. Default value is true. More... | |
Drawings Section | |
void | setPasteSpecialDrawingAction (String &mode) |
PasteSpecial Structure value. Default value is ADD_OR_REMOVE_EXPOSURE. More... | |
void | setPasteSpecialDrawingFileMode (String &mode) |
PasteSpecial Structure value. Default value is ALWAYS_CREATE if LIBRARY_PASTE_CREATE_NEW_DRAWING is set, otherwise it is ONLY_CREATE_IF_DOES_NOT_EXIST. More... | |
void | setPasteSpecialDrawingAutomaticExtendExposure (bool extendExposure, bool keyFrameMode) |
PasteSpecial Structure value. Default values are extendExposure : false, keyFrameMode: true. More... | |
void | setPasteSpecialColorPaletteOption (String &mode) |
PasteSpecial Structure value. Default value is REUSE_PALETTES. More... | |
Static Public Member Functions | |
static void | registerObjects (QScriptEngine &engine) |
Misc section | |
void | setPasteSpecialCopyScanFiles (bool copy) |
Set to true to copy the scan files associated to the selected drawings. More... | |
void | setPasteSpecialCopyModelDir (bool copy) |
Set to true to copy the model directory. More... | |
void | setPasteSpecialTVPreserveName (bool preserve) |
Set to true to keep timed values names intact, even if cloned i.e. Drawing(3). More... | |
void | setPasteSpecialDefaultCameraName (bool flag) |
Use this when you want the camera in a template to be set as default camera in the target scene. More... | |
void | setPasteSpecialMatchNodeName (bool flag) |
Use this when you want to paste a template and use the actual node names for matching nodes instead of basic algorithm of composition order. More... | |
void | setPasteSpecialFullTransfer (bool flag) |
Use this when you want to control the paste of all non animate attributes and all local values of a node. More... | |
void | setStartFrameSrc (int startFrame) |
When pasting an external template or local content, this functions controls the start frame of the content that will be pasted. More... | |
void | setNumFramesSrc (int nFrames) |
When pasting an external template or local content, this functions controls the number of frames of the content that will be pasted. More... | |
CopyOptions * | getCurrentCreateOptions () |
Returns a copy of the current copy options. More... | |
PasteOptions * | getCurrentPasteOptions () |
Returns a copy of the current paste options. More... | |
DragObject * | copy (StringList &selectionOfNodes, int startFrame, int numFrames, CopyOptions *createOption) |
Create an object that represent a 'copy' of a selection of nodes and a range of frames. More... | |
bool | paste (DragObject *dragObject, StringList &selectionOfNodes, int startFrame, int numFrames, PasteOptions *pasteOptions) |
Pastes the drag object as an action template. Must paste over a selection of nodes. No new nodes are created by this action. More... | |
bool | pasteNewNodes (DragObject *dragObject, String &groupWhereToDrop, PasteOptions *pasteOptions) |
DragObject * | copyFromTemplate (String &filename, int startFrame, int numFrames, CopyOptions *createOption) |
Load a template from the file system onto a drag object, which can then be pasted onto the scene. More... | |
The copyPaste JavaScript global object. Copy paste to/from templates.
|
slot |
Create an object that represent a 'copy' of a selection of nodes and a range of frames.
Create an object that represent a 'copy' of a selection of nodes and a range of frames. This object can be pasted or saved in the template library. It is practically identical to what the user would copy from a selection of layers and frames in the timeline.
selectionOfNodes | : The list of nodes to be copied. |
startFrame | : The start frame for the selection. First frame is 1. |
numFrames | : The number of frames to copy. |
createOption | : Options that should be used when doing the creating the copy. See CopyOptions for more information about these options. |
|
slot |
Load a template from the file system onto a drag object, which can then be pasted onto the scene.
filename | - the exact filename of the .tpl folder. Need to be the folder, not the .xstage file. |
startFrame | start frames for the data pasted. Starting at 1. However, if 0 is provided, the whole template is copied. |
numFrames | - number of frames to paste, up to the maximum number of frames. If 'startFrame' is 0, this parameter is disregarded. |
createOption | - options that should be used when doing the code. See CopyOptions for more information about these options. |
|
slot |
Creates template from the current selection in the scene, using only the current drawing versions.
No template is created when there is nothing selected, when the path is not valid or when there is an IO error.
name | : The name of the new template. |
path | : The location of the new template. |
|
slot |
Returns a copy of the current copy options.
To be used with copy(). There used to be an API to set these parameters globally, for the next drag&drop
|
slot |
Returns a copy of the current paste options.
To be used with paste()
|
slot |
Pastes the drag object as an action template. Must paste over a selection of nodes. No new nodes are created by this action.
dragObject | : The dragObject to be pasted. |
selectionOfNodes | : The list of nodes to be pasted over. |
startFrame | : The start frame for the selection. First frame is 1. |
numFrames | : The number of frames to paste across. |
pasteOptions | : Options that should be used when pasting. See PasteOptions for more information about these options. |
|
slot |
Pastes the action template into the scene and excludes nodes that are in the list.
srcPath | : The path of the template. |
nodeName | : The name of the existing node in which we will insert template. |
insertFrame | : The frame at which insert commences. |
compositionOptions | : Defines how to handle the selection of nodes onto which to paste. Separately controls to paste of groups, effects and composite nodes when building the selection. Default value: { "groups": true, "effects": true, "composites": false } |
|
slot |
Paste an external drag object as new nodes. This is similar to pasting on the node view where new nodes are created (from an external selection).
dragObject | - the actual drag object - see copy() or copyFromTemplate() to create this drag object. |
groupWhereToDrop | - root group where the new nodes will be created. If empty string is provided, it will paste at the root. |
pasteOptions | - paste special options (ie. create keyframes, drawings, new columns, or relink columns,.... - see paste special dialog and PasteOptions). |
|
slot |
Pastes the template into a group of the scene.
srcPath | : The path of the template. |
groupName | : The name of the existing column in which we will insert template. |
insertFrame | : The frame at which insert commences. |
|
slot |
Pastes the template into the scene.
templateSrcPath | : The path of the template. |
insertColumnName | : The name of the existing column in which we will insert template. |
insertFrame | : The frame at which insert commences. |
|
static |
|
slot |
PasteSpecial Structure value. Default value is false.
flag | : The new value. |
|
slot |
When pasting an external template or local content, this functions controls the number of frames of the content that will be pasted.
The default number of frames is 0, which effectively turn off this override feature and make it paste the entire copied content length. Set this length to anything >0 to override the number of frames pasted.
Must be using the paste special mode.
nFrames | : The number of frames that the content will be pasted. |
|
slot |
PasteSpecial Structure value. Default value is true.
flag | : The new value. |
|
slot |
PasteSpecial Structure value. Default value is true.
flag | : The new value. |
|
slot |
PasteSpecial Structure value. Default value is true.
flag | : The new value. |
|
slot |
PasteSpecial Structure value. Default value is true.
flag | : The new value. |
|
slot |
PasteSpecial Structure value. Default value is true.
flag | : The new value. |
|
slot |
PasteSpecial Structure value. Default value is REUSE_PALETTES.
Acceptable Strings are: DO_NOTHING REUSE_PALETTES COPY_AND_OVERWRITE_EXISTING_PALETTES COPY_AND_CREATE_NEW_PALETTES COPY_AND_CREATE_NEW_PALETTES_IN_ELEMENT_FOLDER COPY_PALETTE_AND_MERGE_COLOURS COPY_PALETTE_AND_UPDATE_COLOURS LINK_TO_ORIGINAL COPY_SCENE_PALETTE_AND_MERGE_COLOURS COPY_SCENE_PALETTE_AND_UPDATE_COLOURS
|
slot |
Set to true to copy the model directory.
copy | : Whether or not to copy the model directory. |
|
slot |
Set to true to copy the scan files associated to the selected drawings.
copy | : Whether or not to copy the scan files associated to the selected drawings. |
|
slot |
PasteSpecial Structure value. Default value is false.
flag | : The new value. |
|
slot |
Use this when you want the camera in a template to be set as default camera in the target scene.
flag | : Whether or not to set the camera in the template to be set as the default camera in the target scene. |
|
slot |
|
slot |
PasteSpecial Structure value. Default values are extendExposure : false, keyFrameMode: true.
extendExposure | : Whether or not to automatically extend the exposure. |
keyFrameMode | : Whether or not to enable key frame mode. |
|
slot |
PasteSpecial Structure value. Default value is ALWAYS_CREATE if LIBRARY_PASTE_CREATE_NEW_DRAWING is set, otherwise it is ONLY_CREATE_IF_DOES_NOT_EXIST.
Sets the drawing file mode - only used if the DrawingAction is set to ADD_OR_REMOVE_EXPOSURE Acceptable Strings are: NEVER_CREATE ONLY_CREATE_IF_DOES_NOT_EXIST ALWAYS_CREATE ALWAYS_CREATE_AND_VERSION_IF_NECESSARY REPLACE_EXISTING
|
slot |
PasteSpecial Structure value. Default value is ELEMENT_AS_ELEMENT_AND_TIMING_AS_TIMING.
Sets the paste special elementtiming mode for calls to pasteTemplateIntoScene Acceptable strings are:
ELEMENT_AS_ELEMENT_AND_TIMING_AS_TIMING ALL_DRWGS_AS_ELEMENTS ALL_DRWGS_LINKED_THRU_TIMING_COLS
|
slot |
PasteSpecial Structure value. Default value is true.
flag | : The new value. |
|
slot |
Use this when you want to control the paste of all non animate attributes and all local values of a node.
The default is true.
flag | : Whether or not to control the paste of all non animate attributes and all local values of a node. |
|
slot |
Use this when you want to paste a template and use the actual node names for matching nodes instead of basic algorithm of composition order.
In this mode, it is important to make sure that all nodes of the template are found in the destination's group.
flag | : Whether or not to use the actual node names for matching nodes when pasting a template. |
|
slot |
PasteSpecial Structure value. Default value is false.
flag | : The new value. |
|
slot |
PasteSpecial Structure value. Default value is true.
flag | : The new value. |
|
slot |
Set to true to keep timed values names intact, even if cloned i.e. Drawing(3).
preserve | : Whether or not to keep timed values names intact. |
|
slot |
When pasting an external template or local content, this functions controls the start frame of the content that will be pasted.
The default start frame is 1, which means that it will be pasting starting from the first frame of the copied content. Set this to a value >= 1 to specific the frame to use as a starting frame. Must be using the paste special mode.
startFrame | : The frame to start at when pasting an external template or local content. |
|
slot |
Allows 2 extra options in the template creation.
flag | : Set that the copy paste manager is in use. |
addModellingDir | : Copies the modeling directory into the template. |
addScanFiles | : Copies the *.scans that match the drawings. |
includeDefaultCameraName | : Deprecated in 7.8. As long as the camera node is in the selection, it will be copied into the template automatically. |
|
slot |
Enables PasteSpecial.
This is a STATIC structure - once initialized it may be re-used for the duration of the session. By default, it is NOT used until usePasteSpecial(true) is called.
The structure defaults are:
NODE
PEG
DRAWING
PALETTE
SRC FRAMES
If Drawing add/remove exposure is set, the following modes are available:
flag | : True to enable PasteSpecial. |