Implement the copy paste interface, to/from templates, which is available to the scripting environment. More...

#include <copypasteinterface.h>

Inheritance diagram for copyPaste:

Collaboration diagram for copyPaste:

Public Slots
String	createTemplateFromSelection (String name, String &path)

void	useCreateTemplateSpecial (bool flag, bool addModellingDir=true, bool addScanFiles=true, bool includeDefaultCameraName=true)

bool	pasteTemplateIntoScene (String &srcPath, String insertColumnName, int insertFrame)

bool	pasteActionTemplateIntoNode (String &srcPath, String &nodeName, int insertFrame)

void	usePasteSpecial (bool flag)

void	setExtendScene (bool flag)

Module Section
void	setPasteSpecialCreateNewColumn (bool flag)

void	setPasteSpecialElementTimingColumnMode (String mode)

Pegs and Functions Section
void	setPasteSpecialAddRemoveMotionKeyFrame (bool flag)

void	setPasteSpecialAddRemoveVelocityKeyFrame (bool flag)

void	setPasteSpecialAddRemoveAngleKeyFrame (bool flag)

void	setPasteSpecialAddRemoveSkewKeyFrame (bool flag)

void	setPasteSpecialAddRemoveScalingKeyFrame (bool flag)

void	setPasteSpecialForcesKeyFrameAtBegAndEnd (bool flag)

void	setPasteSpecialOffsetKeyFrames (bool flag)

void	setPasteSpecialReplaceExpressionColumns (bool flag)

Drawings Section
void	setPasteSpecialDrawingAction (String mode)

void	setPasteSpecialDrawingFileMode (String mode)

void	setPasteSpecialDrawingAutomaticExtendExposure (bool extendExposure, bool keyFrameMode)

void	setPasteSpecialColorPaletteOption (String mode)

Public Member Functions
	copyPaste (QObject parent, char name)

Static Public Member Functions
static void	registerObjects (QScriptEngine &engine)

Misc section
void	setPasteSpecialCopyScanFiles (bool copy)

void	setPasteSpecialCopyModelDir (bool copy)

void	setPasteSpecialTVPreserveName (bool preserve)

void	setPasteSpecialDefaultCameraName (bool flag)

void	setPasteSpecialMatchNodeName (bool flag)

void	setPasteSpecialFullTransfer (bool flag)

void	setStartFrameSrc (int startFrame)

void	setNumFramesSrc (int nFrames)

SCR_CopyOptions *	getCurrentCreateOptions ()

SCR_PasteOptions *	getCurrentPasteOptions ()

SCR_DragObject *	copy (StringList &selectionOfNodes, int startFrame, int numFrames, SCR_CopyOptions *createOption)

bool	paste (SCR_DragObject dragObject, StringList &selectionOfNodes, int startFrame, int numFrames, SCR_PasteOptions pasteOptions)

SCR_DragObject *	copyFromTemplate (String &filename, int startFrame, int numFrames, SCR_CopyOptions *createOption)

void	changeNodeSelection (MO_Node *node)

DD_DragObject	createDragObjectFromSelection ()

void	computeSelection (StringList &selectedNodes, int startFrame, int numFrames, SL_Selection &selection)

Detailed Description

Implement the copy paste interface, to/from templates, which is available to the scripting environment.

Constructor & Destructor Documentation

copyPaste::copyPaste	(	QObject *	parent,
		char *	name
	)

Member Function Documentation

void copyPaste::changeNodeSelection ( MO_Node * node )

private

Just change the current selection to a new node It will clear the current selection *

void copyPaste::computeSelection	(	StringList &	selectedNodes,
		int	startFrame,
		int	numFrames,
		SL_Selection &	selection
	)

private

SCR_DragObject* copyPaste::copy	(	StringList &	selectionOfNodes,
		int	startFrame,
		int	numFrames,
		SCR_CopyOptions *	createOption
	)

slot

SCR_DragObject* copyPaste::copyFromTemplate	(	String &	filename,
		int	startFrame,
		int	numFrames,
		SCR_CopyOptions *	createOption
	)

slot

DD_DragObject copyPaste::createDragObjectFromSelection ( )

private

Creates a drag object from the current selection in the scene, using only the current drawing versions

String copyPaste::createTemplateFromSelection	(	String	name,
		String &	path
	)

slot

Creates template from the current selection in the scene, using only the current drawing versions

Parameters

name	= name of new template
path	= location of new template

SCR_CopyOptions* copyPaste::getCurrentCreateOptions ( )

slot

SCR_PasteOptions* copyPaste::getCurrentPasteOptions ( )

slot

bool copyPaste::paste	(	SCR_DragObject *	dragObject,
		StringList &	selectionOfNodes,
		int	startFrame,
		int	numFrames,
		SCR_PasteOptions *	pasteOptions
	)

slot

bool copyPaste::pasteActionTemplateIntoNode	(	String &	srcPath,
		String &	nodeName,
		int	insertFrame
	)

slot

Pastes the action template into the scene and excludes modules that are in the list

Parameters

srcPath	- path of the template
nodeName	- name of existing node in which we will insert template
insertFrame	- frame at which insert commences

bool copyPaste::pasteTemplateIntoScene	(	String &	srcPath,
		String	insertColumnName,
		int	insertFrame
	)

slot

Pastes the template into the scene

Parameters

templateSrcPath	- path of the template
insertColumnName	- name of existing column in which we will insert template
insertFrame	- frame at which insert commences

static void copyPaste::registerObjects ( QScriptEngine & engine )

static

void copyPaste::setExtendScene ( bool flag )

slot

void copyPaste::setNumFramesSrc ( int nFrames )

slot

void copyPaste::setPasteSpecialAddRemoveAngleKeyFrame ( bool flag )

slot

void copyPaste::setPasteSpecialAddRemoveMotionKeyFrame ( bool flag )

slot

void copyPaste::setPasteSpecialAddRemoveScalingKeyFrame ( bool flag )

slot

void copyPaste::setPasteSpecialAddRemoveSkewKeyFrame ( bool flag )

slot

void copyPaste::setPasteSpecialAddRemoveVelocityKeyFrame ( bool flag )

slot

void copyPaste::setPasteSpecialColorPaletteOption ( String mode )

slot

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

void copyPaste::setPasteSpecialCopyModelDir ( bool copy )

slot

void copyPaste::setPasteSpecialCopyScanFiles ( bool copy )

slot

void copyPaste::setPasteSpecialCreateNewColumn ( bool flag )

slot

void copyPaste::setPasteSpecialDefaultCameraName ( bool flag )

slot

Use this when you want the camera in a template to be set as default camera in the target scene. Note that this is not necessary if there is NO camera assigned in the target scene, as the incoming camera will automatically be set as default camera.

void copyPaste::setPasteSpecialDrawingAction ( String mode )

slot

Drawings action Acceptable Strings are: DO_NOTHING ADD_OR_REMOVE_EXPOSURE UPDATE_PIVOT

void copyPaste::setPasteSpecialDrawingAutomaticExtendExposure	(	bool	extendExposure,
		bool	keyFrameMode
	)

slot

void copyPaste::setPasteSpecialDrawingFileMode ( String mode )

slot

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

void copyPaste::setPasteSpecialElementTimingColumnMode ( String mode )

slot

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

void copyPaste::setPasteSpecialForcesKeyFrameAtBegAndEnd ( bool flag )

slot

void copyPaste::setPasteSpecialFullTransfer ( bool flag )

slot

use this when you want to control the paste of all non animated attribute and all local values of a module. The default is 'true'

void copyPaste::setPasteSpecialMatchNodeName ( bool flag )

slot

Use this when you want to paste a template and use the actual node names for matching nodes instead of basic algorithme 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.

void copyPaste::setPasteSpecialOffsetKeyFrames ( bool flag )

slot

void copyPaste::setPasteSpecialReplaceExpressionColumns ( bool flag )

slot

void copyPaste::setPasteSpecialTVPreserveName ( bool preserve )

slot

void copyPaste::setStartFrameSrc ( int startFrame )

slot

When pasting an external template or local content, these two functions controls the # of frames and 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.

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.

void copyPaste::useCreateTemplateSpecial	(	bool	flag,
		bool	addModellingDir = `true`,
		bool	addScanFiles = `true`,
		bool	includeDefaultCameraName = `true`
	)

slot

Allows 2 extra options in the template creation

Parameters

addModellingDir	- copies the modelling 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.

void copyPaste::usePasteSpecial ( bool flag )

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:

extendScene = false

MODULE createNewColumn = false elementTimingColumnMode = ELEMENT_AS_ELEMENT_AND_TIMING_AS_TIMING

PEG add/remove motion KF = true add/remove velocity KF = true add/remove angle KF = true add/remove skew KF = true add/remove scaling KF = true force keyframes at functions beginning and end = true offset keyframes = false; replace expression columns = true

DRAWING drawing action = add or remove exposure

PALETTE palette mode = REUSE_PALETTES

SRC FRAMES start frame source = 1 - start frame frame of the copied sequenced). num frame source = 0 - 0 indicate to use the original length of the source

If Drawing add/remove exposure is set, the following modes are available drawing file mode = ALWAYS_CREATE if the preference LIBRARY_PASTE_CREATE_NEW_DRAWING is set, otherwise it is ONLY_CREATE_IF_DOES_NOT_EXIST automatically extend exposure = false drawing as key frame = true ( note, only used if automatic extend exposure = true )

The documentation for this class was generated from the following file:

dox_files/variableScript/copypasteinterface.h

Public Slots

Public Member Functions

Static Public Member Functions

Misc section

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation