MovieMaker (Artisynth API documentation)

java.lang.Object
- artisynth.core.moviemaker.MovieMaker

public class MovieMaker
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MovieMaker.Method` Describes the method used to make movies
`static class`	`MovieMaker.MethodInfo` Information about a particular movie making method.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ANIMATED_GIF_METHOD`
`static java.lang.String`	`AVCONV_METHOD`
`static java.lang.String`	`FFMPEG_METHOD`
`static java.lang.String`	`INTERNAL_METHOD`
`static java.lang.String`	`MENCODER_METHOD`
`static java.lang.String`	`MENCODER_OSX_METHOD`
`static int`	`OFFSCREEN_MODE`
`static int`	`ONSCREEN_MODE`

Constructor Summary

Constructors
Constructor and Description

MovieMaker(GLViewer viewer)

Constructors
Constructor and Description
`MovieMaker(GLViewer viewer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMethod(MovieMaker.Method method, java.lang.String methodCmd, java.lang.String imgFmt)`
`void`	`clean()` Remove the image files created in the specified folder after a movie has been made.
`int`	`close()` Writes movie information file.
`void`	`closeDialog()` Hides MovieMakerDialog.
`void`	`forceGrab()` Grabs rectangle and writes to disk right now, forcing a rerender (as opposed to waiting for next render cycle).
`java.lang.String`	`getAudioFileName()` Returns the path name of the current audio file.
`double`	`getAudioSampleRate()` Returns the audio sampling rate in Hz.
`java.awt.Rectangle`	`getCaptureArea()` Returns the area defining the movie region.
`static MovieMaker.MethodInfo`	`getDefaultMethodInfo(MovieMaker.Method method)`
`java.lang.String`	`getDefaultMovieFolderPath()` Returns the path name of the default working folder
`java.lang.String`	`getFormat()` /** Returns the output format.
`java.io.File`	`getFrameFile(int n)` Returns the file of the frame specified by int n.
`java.lang.String`	`getFrameFileName(int n)` Returns the absolute file path of the frame specified by int n.
`double`	`getFrameRate()` Returns the current frame rate in Hz.
`int`	`getGrabMode()`
`MovieMaker.Method`	`getMethod()` Returns current movie making method.
`MovieMaker.Method`	`getMethod(java.lang.String methodName)` Returns the method corresponding to a specific name, or `null` if there is no such method.
`MovieMaker.MethodInfo`	`getMethodInfo(MovieMaker.Method method)` Returns information for a specific method
`java.io.File`	`getMovieFolder()` Returns the working folder in which movies are made.
`java.lang.String`	`getMovieFolderPath()` Returns the path name of the working folder
`double`	`getRequestedStopTime()`
`double`	`getSpeed()` Returns the video speed.
`void`	`grab()` Grabs rectangle and writes to disk.
`void`	`grab(java.lang.String filename)` Grabs rectangle and writes to disk.
`void`	`grabScreenShot(java.lang.String filename)`
`boolean`	`isAlwaysOnTop()`
`boolean`	`isAudioNormalized()` Returns true if audio must be normalized.
`boolean`	`isGrabbing()` Returns true if currently grabbing frames.
`boolean`	`isRenderingAudioToFile()` Returns true if currently rendering audio to a file.
`boolean`	`isRenderingAudioToText()` Returns true if currently rendering audio to text.
`boolean`	`isStopRequestPending()` Returns true if a stop has been requested.
`void`	`print(java.lang.String msg)` Print to the messages text area
`void`	`println(java.lang.String msg)` Print to the messages text area, followed by a newline
`boolean`	`render(java.lang.String fn)` Renders captured data to a movie with the specified file name.
`void`	`requestStop()`
`void`	`resetFrameCounter()`
`void`	`saveFirstFrame(java.lang.String fn)` Saves the first image file in the same folder as the movie.
`void`	`setAlwaysOnTop(boolean set)`
`void`	`setAntiAliasingSamples(int s)`
`void`	`setAudioFileName(java.lang.String fileName)` Sets the path name for the audio save file.
`void`	`setAudioNormalized(boolean normalize)` Sets whether audio must be normalized.
`void`	`setAudioSampleRate(double rate)` Sets the audio sampling rate in Hz.
`void`	`setCaptureArea(java.awt.Rectangle rect, java.awt.Dimension grabResize)` Sets the rectangle defining the movie region and what dimensions to capture the movie to; resizeDim should only be set if rendering from a GL canvas, otherwise null.
`void`	`setFormat(java.lang.String fmt)` Sets the output format.
`void`	`setFrameRate(double rate)` Sets the current frame rate in Hz.
`void`	`setGrabbing(boolean grabbing)` Sets whether the MovieMaker is currently grabbing frames.
`void`	`setMethod(MovieMaker.Method method)` Sets the current movie making method.
`void`	`setMethod(MovieMaker.Method method, java.lang.String methodCmd, java.lang.String imgFmt)` Sets movie making method.
`void`	`setMethodInfo(MovieMaker.Method method, MovieMaker.MethodInfo info)` Returns information for a specific method
`void`	`setMovieFolder(java.io.File dir)` Sets the working folder in which movies are made.
`void`	`setRenderingAudioToFile(boolean rendering)` Sets whether the MovieMaker is currently rendering audio to a file.
`void`	`setRenderingAudioToText(boolean rendering)` Sets whether the MovieMaker is currently rendering audio to text.
`void`	`setSpeed(double s)` Sets the video speed.
`void`	`setViewer(GLViewer viewer)`
`void`	`showDialog(java.awt.Window win)` Displays MovieMakerDialog to the right of the specified window.
`void`	`updateDialogWidgets()` Updates widgets in the dialog to reflect changes in underlying properties.
`void`	`updateForNewRootModel(java.lang.String modelName, RootModel root)` Update MovieMakerDialog for new model name and audio capabilities.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INTERNAL_METHOD
```
public static final java.lang.String INTERNAL_METHOD
```
    See Also:
    
    Constant Field Values
  - MENCODER_METHOD
```
public static final java.lang.String MENCODER_METHOD
```
    See Also:
    
    Constant Field Values
  - MENCODER_OSX_METHOD
```
public static final java.lang.String MENCODER_OSX_METHOD
```
    See Also:
    
    Constant Field Values
  - FFMPEG_METHOD
```
public static final java.lang.String FFMPEG_METHOD
```
    See Also:
    
    Constant Field Values
  - ANIMATED_GIF_METHOD
```
public static final java.lang.String ANIMATED_GIF_METHOD
```
    See Also:
    
    Constant Field Values
  - AVCONV_METHOD
```
public static final java.lang.String AVCONV_METHOD
```
    See Also:
    
    Constant Field Values
  - OFFSCREEN_MODE
```
public static final int OFFSCREEN_MODE
```
    See Also:
    
    Constant Field Values
  - ONSCREEN_MODE
```
public static final int ONSCREEN_MODE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MovieMaker
```
public MovieMaker(GLViewer viewer)
           throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
- Method Detail
  - getDefaultMethodInfo
```
public static MovieMaker.MethodInfo getDefaultMethodInfo(MovieMaker.Method method)
```
  - setViewer
```
public void setViewer(GLViewer viewer)
```
  - getMethodInfo
```
public MovieMaker.MethodInfo getMethodInfo(MovieMaker.Method method)
```
    Returns information for a specific method
  - setMethodInfo
```
public void setMethodInfo(MovieMaker.Method method,
                          MovieMaker.MethodInfo info)
```
    Returns information for a specific method
  - setMethod
```
public void setMethod(MovieMaker.Method method,
                      java.lang.String methodCmd,
                      java.lang.String imgFmt)
```
    Sets movie making method. Must be one of: "internal", "mencoder", "mencoder_osx", "ffmpeg", "animated_gif" or "avconv".
  - addMethod
```
public void addMethod(MovieMaker.Method method,
                      java.lang.String methodCmd,
                      java.lang.String imgFmt)
```
  - getMethod
```
public MovieMaker.Method getMethod()
```
    Returns current movie making method.
  - getMethod
```
public MovieMaker.Method getMethod(java.lang.String methodName)
```
    Returns the method corresponding to a specific name, or null if there is no such method.
  - setMethod
```
public void setMethod(MovieMaker.Method method)
```
    Sets the current movie making method.
  - getFormat
```
public java.lang.String getFormat()
```
    /** Returns the output format.
  - setFormat
```
public void setFormat(java.lang.String fmt)
```
    Sets the output format. Useful ones include "jpg" and "bmp". ImageIO.getWriterFormatNames() gives a complete list.
  - getFrameFileName
```
public java.lang.String getFrameFileName(int n)
```
    Returns the absolute file path of the frame specified by int n.
  - getFrameFile
```
public java.io.File getFrameFile(int n)
```
    Returns the file of the frame specified by int n.
  - resetFrameCounter
```
public void resetFrameCounter()
```
  - grab
```
public void grab()
          throws java.lang.Exception
```
    Grabs rectangle and writes to disk.
    
    Throws:
    
    java.lang.Exception
  - forceGrab
```
public void forceGrab()
               throws java.lang.Exception
```
    Grabs rectangle and writes to disk right now, forcing a rerender (as opposed to waiting for next render cycle).
    
    Throws:
    
    java.lang.Exception
  - grabScreenShot
```
public void grabScreenShot(java.lang.String filename)
```
  - grab
```
public void grab(java.lang.String filename)
          throws java.lang.Exception
```
    Grabs rectangle and writes to disk.
    
    Throws:
    
    java.lang.Exception
  - close
```
public int close()
          throws java.lang.Exception
```
    Writes movie information file.
    
    Throws:
    
    java.lang.Exception
  - render
```
public boolean render(java.lang.String fn)
               throws java.lang.Exception
```
    Renders captured data to a movie with the specified file name.
    
    Throws:
    
    java.lang.Exception
  - saveFirstFrame
```
public void saveFirstFrame(java.lang.String fn)
```
    Saves the first image file in the same folder as the movie.
  - clean
```
public void clean()
```
    Remove the image files created in the specified folder after a movie has been made.
  - getAudioSampleRate
```
public double getAudioSampleRate()
```
    Returns the audio sampling rate in Hz.
  - setAudioSampleRate
```
public void setAudioSampleRate(double rate)
```
    Sets the audio sampling rate in Hz. Default rate is 44100Hz.
  - isAudioNormalized
```
public boolean isAudioNormalized()
```
    Returns true if audio must be normalized.
  - setAudioNormalized
```
public void setAudioNormalized(boolean normalize)
```
    Sets whether audio must be normalized.
  - getSpeed
```
public double getSpeed()
```
    Returns the video speed.
  - setSpeed
```
public void setSpeed(double s)
```
    Sets the video speed. A speed of 2 will create a movie that runs twice as fast as real time. The default speed is 1.
  - isGrabbing
```
public boolean isGrabbing()
```
    Returns true if currently grabbing frames.
  - setGrabbing
```
public void setGrabbing(boolean grabbing)
```
    Sets whether the MovieMaker is currently grabbing frames.
  - isStopRequestPending
```
public boolean isStopRequestPending()
```
    Returns true if a stop has been requested.
  - isRenderingAudioToFile
```
public boolean isRenderingAudioToFile()
```
    Returns true if currently rendering audio to a file.
  - setRenderingAudioToFile
```
public void setRenderingAudioToFile(boolean rendering)
```
    Sets whether the MovieMaker is currently rendering audio to a file.
  - isRenderingAudioToText
```
public boolean isRenderingAudioToText()
```
    Returns true if currently rendering audio to text.
  - setRenderingAudioToText
```
public void setRenderingAudioToText(boolean rendering)
```
    Sets whether the MovieMaker is currently rendering audio to text.
  - getCaptureArea
```
public java.awt.Rectangle getCaptureArea()
```
    Returns the area defining the movie region.
  - setCaptureArea
```
public void setCaptureArea(java.awt.Rectangle rect,
                           java.awt.Dimension grabResize)
```
    Sets the rectangle defining the movie region and what dimensions to capture the movie to; resizeDim should only be set if rendering from a GL canvas, otherwise null.
  - setAntiAliasingSamples
```
public void setAntiAliasingSamples(int s)
```
  - getGrabMode
```
public int getGrabMode()
```
  - getAudioFileName
```
public java.lang.String getAudioFileName()
```
    Returns the path name of the current audio file.
  - setAudioFileName
```
public void setAudioFileName(java.lang.String fileName)
```
    Sets the path name for the audio save file.
  - getFrameRate
```
public double getFrameRate()
```
    Returns the current frame rate in Hz.
  - setFrameRate
```
public void setFrameRate(double rate)
```
    Sets the current frame rate in Hz.
  - showDialog
```
public void showDialog(java.awt.Window win)
```
    Displays MovieMakerDialog to the right of the specified window.
  - closeDialog
```
public void closeDialog()
```
    Hides MovieMakerDialog.
  - updateForNewRootModel
```
public void updateForNewRootModel(java.lang.String modelName,
                                  RootModel root)
```
    Update MovieMakerDialog for new model name and audio capabilities.
  - isAlwaysOnTop
```
public boolean isAlwaysOnTop()
```
  - setAlwaysOnTop
```
public void setAlwaysOnTop(boolean set)
```
  - println
```
public void println(java.lang.String msg)
```
    Print to the messages text area, followed by a newline
  - print
```
public void print(java.lang.String msg)
```
    Print to the messages text area
  - getMovieFolder
```
public java.io.File getMovieFolder()
```
    Returns the working folder in which movies are made.
  - getMovieFolderPath
```
public java.lang.String getMovieFolderPath()
```
    Returns the path name of the working folder
  - getDefaultMovieFolderPath
```
public java.lang.String getDefaultMovieFolderPath()
```
    Returns the path name of the default working folder
  - setMovieFolder
```
public void setMovieFolder(java.io.File dir)
```
    Sets the working folder in which movies are made. The specified file is assumed to be a valid folder.
  - updateDialogWidgets
```
public void updateDialogWidgets()
```
    Updates widgets in the dialog to reflect changes in underlying properties.
  - getRequestedStopTime
```
public double getRequestedStopTime()
```
  - requestStop
```
public void requestStop()
```

Class MovieMaker

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INTERNAL_METHOD

MENCODER_METHOD

MENCODER_OSX_METHOD

FFMPEG_METHOD

ANIMATED_GIF_METHOD

AVCONV_METHOD

OFFSCREEN_MODE

ONSCREEN_MODE

Constructor Detail

MovieMaker

Method Detail

getDefaultMethodInfo

setViewer

getMethodInfo

setMethodInfo

setMethod

addMethod

getMethod

getMethod

setMethod

getFormat

setFormat

getFrameFileName

getFrameFile

resetFrameCounter

grab

forceGrab

grabScreenShot

grab

close

render

saveFirstFrame

clean

getAudioSampleRate

setAudioSampleRate

isAudioNormalized

setAudioNormalized

getSpeed

setSpeed

isGrabbing

setGrabbing

isStopRequestPending

isRenderingAudioToFile

setRenderingAudioToFile

isRenderingAudioToText

setRenderingAudioToText

getCaptureArea

setCaptureArea

setAntiAliasingSamples

getGrabMode

getAudioFileName

setAudioFileName

getFrameRate

setFrameRate

showDialog

closeDialog

updateForNewRootModel

isAlwaysOnTop

setAlwaysOnTop

println

print

getMovieFolder

getMovieFolderPath

getDefaultMovieFolderPath

setMovieFolder

updateDialogWidgets

getRequestedStopTime

requestStop