Eyeon:Script/Reference/Applications/Fusion/Classes/Composition

From VFXPedia

Parent Class: Object

Composition.

Contents 1 Methods: 2 Members: 3 Other: 4 Tips for Composition (edit)

Methods:

AbortRender	Stops any current rendering
AbortRenderUI	Asks the user before aborting the render
AddTool	Adds a tool type at a specified position
AskRenderSettings	Show the Render Settings dialog
AskUser	Present a custom dialog to the user, and return selected values
ClearUndo	Clears the Undo/Redo history
Close	Close the composition
Copy	Copy a list of tools to the Clipboard
CopySettings	Copy a list of tools to a settings table
EndUndo	End an undo event
Execute	Executes a script string for this comp (useful remotely)
FindTool	Find a tool by name
FindToolByID	Find a tool by ID type
GetCompPathMap	Returns a table of all available path maps
GetConsoleHistory	Returns the console history as a table of strings
GetFrameList	Retrieves a table of the comp's ChildFrames
GetPrefs	Retrieves a table of comp-specific preferences, or a single value
GetPreviewList	Retrieves a table of Previews
GetToolList	Returns a table of all tools or selected tools
IsLocked	Returns true if popups and updates are disabled
IsPlaying	Returns true if the comp is being played
IsRendering	Returns true if the comp is busy rendering
Lock	Lock the composition from updating
Loop	Enables looping interactive playback
MapPath	Expands any Fusion path maps in a filename
Paste	Pastes a tool from the Clipboard or a settings table
Play	Starts interactive playback
Redo	Redo one or more changes to the composition
Render	Start a render
ReverseMapPath	Maps an ordinary file path back to any Fusion pathmaps
RunScript	Run a script within the composition's script context
Save	Save the composition
SaveAs	Save the composition to a filename
SetActiveTool	Set the currently active tool
SetPrefs	Set a specific preference, or a table of them
StartUndo	Start an undo event
Stop	Stops interactive playback
Undo	Undo one or more changes to the composition
Unlock	Unlock the composition

Members:

ActiveTool	[R]	Represents the currently active tool on this comp
CurrentFrame	[R]	Represents the currently active frame for this composition
UpdateMode	[RW]	Represents the Some/All/None mode
XPos	[RW]	The X coordinate on the flow of the next added tool
YPos	[RW]	The Y coordinate on the flow of the next added tool
AutoPos	[RW]	Enable autoupdating of XPos/YPos when adding tools

Other:

• Attributes

Tips for Composition (edit)

• The member variable CurrentTime is also available and corresponds to the COMPN_CurrentTime attribute. Don't confuse it with CurrentFrame though since that deals with the GUI where "frames" are the sections of the interface (flow, viewers, tool panel).

• The Composition object's methods and members are directly available in the console and in comp scripts written in LUA. This means that you can simply type ==CurrentTime or call AddTool("Blur") without the need to prefix the command with comp. Python scripts have to use the full name.

• Two yet undocumented methods have been added to the Composition class in recent releases. To quote eyeon tech support:
  GetNextKeyTime([number Time [, object Tool]]) and GetPrevKeyTime([number Time [, object Tool]]). Return the next/previous keyframe time from 'Time', on the tool specified by 'Tool'. If no Tool is specified, then the keyframe time on ANY tool will be returned. If time is unspecified, or TIME_UNDEFINED is used, then the first or last keyframe time will be returned.