API documentation for visualization library

Michael Galloy

single page | use frames     summary     class     fields     routine details     file attributes

animation/

visgrimagedestination__define.pro


Image destination for object graphics.

Class description for visgrimagedestination

Inheritance

All ancestor classes: IDLGRBUFFER IDLGRSRCDEST IDLITCOMPONENT

Properties

show_frame get set init

set to put frame number in output filenames

basename get set init

basename of image filename

_extra set init

properties of IDLgrBuffer

format get set init

image format: bmp, gif, jpeg, png, ppm, srf, tiff

_ref_extra get
frame_format get set init

format code used for including frame number in output filenames

Routines

visgrimagedestination::draw [, picture]

Draw the scene.

visgrimagedestination::getProperty, basename=basename, format=format, show_frame=show_frame, frame_format=frame_format, _ref_extra=_ref_extra

Get properties.

visgrimagedestination::setProperty, basename=basename, format=format, show_frame=show_frame, frame_format=frame_format, _extra=_extra

Set properties.

visgrimagedestination::cleanup

Free resources.

result = visgrimagedestination::init(basename=basename, format=format, show_frame=show_frame, frame_format=frame_format, _extra=_extra)

Create image destination.

visgrimagedestination__define

Define instance variables.

Routine details

top visgrimagedestination::draw

visgrimagedestination::draw [, picture]

Draw the scene.

Parameters

picture in optional type=object

scene, view group, or view to draw

top visgrimagedestination::getProperty

visgrimagedestination::getProperty, basename=basename, format=format, show_frame=show_frame, frame_format=frame_format, _ref_extra=_ref_extra

Get properties.

Keywords

basename

basename of image filename

format

image format: bmp, gif, jpeg, png, ppm, srf, tiff

show_frame

set to put frame number in output filenames

frame_format

format code used for including frame number in output filenames

_ref_extra

top visgrimagedestination::setProperty

visgrimagedestination::setProperty, basename=basename, format=format, show_frame=show_frame, frame_format=frame_format, _extra=_extra

Set properties.

Keywords

basename

basename of image filename

format

image format: bmp, gif, jpeg, png, ppm, srf, tiff

show_frame

set to put frame number in output filenames

frame_format

format code used for including frame number in output filenames

_extra

properties of IDLgrBuffer

top visgrimagedestination::cleanup

visgrimagedestination::cleanup

Free resources.

top visgrimagedestination::init

result = visgrimagedestination::init(basename=basename, format=format, show_frame=show_frame, frame_format=frame_format, _extra=_extra)

Create image destination.

Return value

1 for success, 0 for failure

Keywords

basename

basename of image filename

format

image format: bmp, gif, jpeg, png, ppm, srf, tiff

show_frame

set to put frame number in output filenames

frame_format

format code used for including frame number in output filenames

_extra

properties of IDLgrBuffer

top visgrimagedestination__define

visgrimagedestination__define

Define instance variables.

File attributes

Modification date: Mon Nov 29 18:32:10 2010
Lines: 138
Docformat: rst rst