The JavaScript class for getting or setting the model directory, the scan files and the default camera name flags when pasting. Obtain from the copyPaste global object. Warning: Some of these properties will only be applied if the Paste Special option is active. More...

Properties
bool	extendScene
	Property setting if the paste should extend the scene range. Default value is false. More...

bool	defaultCameraName
	Property setting if the paste should use the default camera name. Default value is false. More...

bool	createNewColumn
	Property setting if the paste should create new columns. Default value is false. More...

String	elementMode
	Property setting the element mode, read copyPaste::setPasteSpecialElementTimingColumnMode() for more details on how to activate this property. More...

bool	addRemoveMotionKeyFrame
	Property setting if the paste should apply the peg positions. Default value is true. More...

bool	addRemoveVelocityKeyFrame
	Property setting if the paste should apply the peg velocites. Default value is true. More...

bool	addRemoveAngleKeyFrame
	Property setting if the paste should apply the peg rotation angles. Default value is true. More...

bool	addRemoveSkewKeyFrame
	Property setting if the paste should apply the peg skews. Default value is true. More...

bool	addRemoveScalingKeyFrame
	Property setting if the paste should apply the peg scales. Default value is true. More...

bool	forceKeyframeAtBeginningAndEnd
	Property setting if the paste should force the creation of keyframes at the beggining and at the ending of the pasted exposure. Default value is false. More...

bool	offsetKeyFrame
	Property setting if the paste should offset keyframes. Default value is false. More...

bool	replaceExpressionColumns
	Property setting if the paste should replace expression columns. Default value is true. More...

String	drawingPasteAction
	Property setting the drawing paste mode, read copyPaste::setPasteSpecialDrawingAction() for more details on how to activate this property. More...

String	drawingFileMode
	Property setting the drawing file mode, read copyPaste::setPasteSpecialDrawingFileMode() for more details on how to activate this property. More...

bool	autoExtendExposure

bool	drawingSubstitution

String	colourPalette
	Property setting the colour palette paste mode, read copyPaste::setPasteSpecialColorPaletteOption() for more details on how to activate this property. More...

bool	copyScanFiles

bool	copyModelsDir

bool	preserveColumnName

bool	actionTemplateMode

bool	fullTransfer

int	startFrameSource
	The number of frames from the source of the copy-paste. Default value is 0, indicative that the selection is empty. More...

int	numberOfFramesSource
	The number of frames from the source of the copy-paste. Default value is 1. More...

int	startDeleteFrame
	The frame from which to start the deletion range from. Default value is 0, indicative that the selection is empty. More...

bool	matchNodeName
	Match node by name. Default value is false. More...

String	writeMode
	Sets the paste write mode, default value is "OVERWRITE". More...

String	deleteMode
	Sets the paste delete mode, default value is "DELETE_NOTHING". More...

Detailed Description

The JavaScript class for getting or setting the model directory, the scan files and the default camera name flags when pasting. Obtain from the copyPaste global object. Warning: Some of these properties will only be applied if the Paste Special option is active.

See also: copyPaste::usePasteSpecial().

var myPasteOptions = copyPaste.getCurrentPasteOptions();
myPasteOptions.extendScene = false;
myPasteOptions.defaultCameraName = true;
copyPaste.paste(dragObject, selectionOfNodes, startFrame, numFrames, myPasteOptions);

Property Documentation

◆ actionTemplateMode

bool PasteOptions::actionTemplateMode

readwrite

◆ addRemoveAngleKeyFrame

bool PasteOptions::addRemoveAngleKeyFrame

readwrite

Property setting if the paste should apply the peg rotation angles. Default value is true.

◆ addRemoveMotionKeyFrame

bool PasteOptions::addRemoveMotionKeyFrame

readwrite

Property setting if the paste should apply the peg positions. Default value is true.

◆ addRemoveScalingKeyFrame

bool PasteOptions::addRemoveScalingKeyFrame

readwrite

Property setting if the paste should apply the peg scales. Default value is true.

◆ addRemoveSkewKeyFrame

bool PasteOptions::addRemoveSkewKeyFrame

readwrite

Property setting if the paste should apply the peg skews. Default value is true.

◆ addRemoveVelocityKeyFrame

bool PasteOptions::addRemoveVelocityKeyFrame

readwrite

Property setting if the paste should apply the peg velocites. Default value is true.

◆ autoExtendExposure

bool PasteOptions::autoExtendExposure

readwrite

◆ colourPalette

String PasteOptions::colourPalette

readwrite

Property setting the colour palette paste mode, read copyPaste::setPasteSpecialColorPaletteOption() for more details on how to activate this property.

◆ copyModelsDir

bool PasteOptions::copyModelsDir

readwrite

◆ copyScanFiles

bool PasteOptions::copyScanFiles

readwrite

◆ createNewColumn

bool PasteOptions::createNewColumn

readwrite

Property setting if the paste should create new columns. Default value is false.

◆ defaultCameraName

bool PasteOptions::defaultCameraName

readwrite

Property setting if the paste should use the default camera name. Default value is false.

◆ deleteMode

String PasteOptions::deleteMode

readwrite

Sets the paste delete mode, default value is "DELETE_NOTHING".

Parameters

mode

: The Delete mode, acceptable strings are:

"REMOVE" - Paste will remove the destination frames (pulling posterig frames backwards in the process), before adding the new frames.
"EMPTY" - Paste will empty the exposure, before adding the new frames.
"DELETE_NOTHING" - Paste will not delete or empty anything.

◆ drawingFileMode

String PasteOptions::drawingFileMode

readwrite

Property setting the drawing file mode, read copyPaste::setPasteSpecialDrawingFileMode() for more details on how to activate this property.

◆ drawingPasteAction

String PasteOptions::drawingPasteAction

readwrite

Property setting the drawing paste mode, read copyPaste::setPasteSpecialDrawingAction() for more details on how to activate this property.

◆ drawingSubstitution

bool PasteOptions::drawingSubstitution

readwrite

◆ elementMode

String PasteOptions::elementMode

readwrite

Property setting the element mode, read copyPaste::setPasteSpecialElementTimingColumnMode() for more details on how to activate this property.

◆ extendScene

bool PasteOptions::extendScene

readwrite

Property setting if the paste should extend the scene range. Default value is false.

◆ forceKeyframeAtBeginningAndEnd

bool PasteOptions::forceKeyframeAtBeginningAndEnd

readwrite

Property setting if the paste should force the creation of keyframes at the beggining and at the ending of the pasted exposure. Default value is false.

◆ fullTransfer

bool PasteOptions::fullTransfer

readwrite

◆ matchNodeName

bool PasteOptions::matchNodeName

readwrite

Match node by name. Default value is false.

◆ numberOfFramesSource

int PasteOptions::numberOfFramesSource

readwrite

The number of frames from the source of the copy-paste. Default value is 1.

◆ offsetKeyFrame

bool PasteOptions::offsetKeyFrame

readwrite

Property setting if the paste should offset keyframes. Default value is false.

◆ preserveColumnName

bool PasteOptions::preserveColumnName

readwrite

◆ replaceExpressionColumns

bool PasteOptions::replaceExpressionColumns

readwrite

Property setting if the paste should replace expression columns. Default value is true.

◆ startDeleteFrame

int PasteOptions::startDeleteFrame

readwrite

The frame from which to start the deletion range from. Default value is 0, indicative that the selection is empty.

◆ startFrameSource

int PasteOptions::startFrameSource

readwrite

The number of frames from the source of the copy-paste. Default value is 0, indicative that the selection is empty.

◆ writeMode

String PasteOptions::writeMode

readwrite

Sets the paste write mode, default value is "OVERWRITE".

Parameters

mode

: The Write mode, acceptable strings are:

"INSERT" - Paste will insert new frames at the destination, pushing forward subsquent exposures.
"OVERWRITE" - Paste will add the new frames at the destination, overwriting any pre-existing exposures.
"DO_NOTHING" - Paste will add new drawings to the destination element, but will not add frame exposures.

Properties

Detailed Description

Property Documentation

◆ actionTemplateMode

◆ addRemoveAngleKeyFrame

◆ addRemoveMotionKeyFrame

◆ addRemoveScalingKeyFrame

◆ addRemoveSkewKeyFrame

◆ addRemoveVelocityKeyFrame

◆ autoExtendExposure

◆ colourPalette

◆ copyModelsDir

◆ copyScanFiles

◆ createNewColumn

◆ defaultCameraName

◆ deleteMode

◆ drawingFileMode

◆ drawingPasteAction

◆ drawingSubstitution

◆ elementMode

◆ extendScene

◆ forceKeyframeAtBeginningAndEnd

◆ fullTransfer

◆ matchNodeName

◆ numberOfFramesSource

◆ offsetKeyFrame

◆ preserveColumnName

◆ replaceExpressionColumns

◆ startDeleteFrame

◆ startFrameSource

◆ writeMode