API documentation for visualization library

Michael Galloy

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

objectgraphics/

visgrimagefile__define.pro

object graphics

includes main-level program

Create an image file destination for an object graphics scene.

Examples

Try the main-level program at the end of this file:

IDL> .run visgrimagefile__define
This should produce:

Class description for visgrimagefile

Properties

_extra set init type=keywords

keywords to IDLgrBuffer and IDLgrClipboard

filename get set init type=string

filename to send output to

vector get set init type=boolean

set to produce vector output that is then converted to raster output

_ref_extra get

Routines

visgrimagefile::getProperty, filename=string, /vector, _ref_extra=_ref_extra

Get properties of the image file destination.

visgrimagefile::setProperty, filename=string, /vector, _extra=keywords

Set properties of the image file destination.

visgrimagefile::draw [, picture]

Draw the given scene to an image file.

visgrimagefile::cleanup

Free resources.

result = visgrimagefile::init(filename=string, /vector, _extra=keywords)

Create an image file destination.

visgrimagefile__define

Define instance variables.

Routine details

top visgrimagefile::getProperty

visgrimagefile::getProperty, filename=string, /vector, _ref_extra=_ref_extra

Get properties of the image file destination.

Keywords

filename type=string

filename to send output to

vector type=boolean

set to produce vector output that is then converted to raster output

_ref_extra

top visgrimagefile::setProperty

visgrimagefile::setProperty, filename=string, /vector, _extra=keywords

Set properties of the image file destination.

Keywords

filename type=string

filename to send output to

vector type=boolean

set to produce vector output that is then converted to raster output

_extra type=keywords

keywords to IDLgrBuffer and IDLgrClipboard

top visgrimagefile::draw

visgrimagefile::draw [, picture]

Draw the given scene to an image file.

Parameters

picture in optional type=objref

scene, viewgroup, or view to draw

top visgrimagefile::cleanup

visgrimagefile::cleanup

Free resources.

top visgrimagefile::init

result = visgrimagefile::init(filename=string, /vector, _extra=keywords)

Create an image file destination.

Return value

1 for success, 0 for failure

Keywords

filename type=string

filename to send output to

vector type=boolean

set to produce vector output that is then converted to raster output

_extra type=keywords

keywords to IDLgrBuffer and IDLgrClipboard

top visgrimagefile__define

visgrimagefile__define

Define instance variables.

File attributes

Modification date: Mon Nov 29 18:32:37 2010
Lines: 198
Docformat: rst rst