agi.foundation.graphics.advanced

(agi.foundation.graphics-2024r3.jar)

Class CameraSnapshot

java.lang.Object

agi.foundation.graphics.advanced.CameraSnapshot

All Implemented Interfaces:

IDisposable, AutoCloseable

public final class CameraSnapshot
extends Object
implements IDisposable

Takes snapshots of the 3D window.

Method Summary

Modifier and Type	Method and Description
void	dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
protected void	dispose(boolean disposing)
protected void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
void	saveToClipboard() Saves a single frame of the 3D window to the clipboard.
void	saveToFile(String filename, CameraSnapshotFileFormat cameraSnapshotFormat) Saves a snapshot of the 3D window to the filename with the specified format.
void	saveToFile(String filename, CameraSnapshotFileFormat cameraSnapshotFormat, double widthInInches, double dotsPerInch) Saves a snapshot of the 3D window to the filename with the specified format at high resolution.
Raster	saveToRaster() Saves a snapshot of the 3D window to a Raster.
Texture2D	saveToTexture() Saves a snapshot of the 3D window to a Texture2D.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface agi.foundation.compatibility.IDisposable

close

Method Detail

finalize

protected void finalize()
                 throws Throwable

Description copied from class: java.lang.Object

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java™ virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Overrides:

finalize in class Object

Throws:

Throwable - the Exception raised by this method

See Also:

WeakReference, PhantomReference

dispose

public final void dispose()

Description copied from interface: IDisposable

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Specified by:

dispose in interface IDisposable

dispose

protected void dispose(boolean disposing)

saveToFile

public final void saveToFile(String filename,
                             CameraSnapshotFileFormat cameraSnapshotFormat)

Saves a snapshot of the 3D window to the filename with the specified format.

Parameters:

filename - The filename of the snapshot.

cameraSnapshotFormat - The file format of the snapshot

saveToFile

public final void saveToFile(String filename,
                             CameraSnapshotFileFormat cameraSnapshotFormat,
                             double widthInInches,
                             double dotsPerInch)

Saves a snapshot of the 3D window to the filename with the specified format at high resolution. Generally, this is used to take snapshots for print media, such as posters, which is why the input parameters are in terms of inches and dots per inch typically required by printers.

Parameters:

filename - The filename of the snapshot.

cameraSnapshotFormat - The file format of the snapshot

widthInInches - The desired width of the snapshot in inches.

dotsPerInch - The number of pixels per inch.

saveToClipboard

public final void saveToClipboard()

Saves a single frame of the 3D window to the clipboard.

saveToRaster

public final Raster saveToRaster()

Saves a snapshot of the 3D window to a Raster.

Returns:

The snapshot in a Raster.

saveToTexture

public final Texture2D saveToTexture()

Saves a snapshot of the 3D window to a Texture2D.

Returns:

The snapshot in a Texture2D.