mglib

Personal IDL library for M. Galloy

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

vis/objectgraphics/

mggrimagefile__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 mggrimagefile__define
This should produce:

Class description for mggrimagefile

Properties

Properties in mggrimagefile

_extra set init type=keywords

keywords to IDLgrBuffer and IDLgrClipboard

_ref_extra get
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

Routines

Routines from mggrimagefile__define.pro

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

Get properties of the image file destination.

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

Set properties of the image file destination.

mggrimagefile::draw [, picture]

Draw the given scene to an image file.

mggrimagefile::cleanup

Free resources.

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

Create an image file destination.

mggrimagefile__define

Define instance variables.

Routine details

top mggrimagefile::getProperty

mggrimagefile::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 mggrimagefile::setProperty

mggrimagefile::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 mggrimagefile::draw

mggrimagefile::draw [, picture]

Draw the given scene to an image file.

Parameters

picture in optional type=objref

scene, viewgroup, or view to draw

top mggrimagefile::cleanup

mggrimagefile::cleanup

Free resources.

top mggrimagefile::init

result = mggrimagefile::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 mggrimagefile__define

mggrimagefile__define

Define instance variables.

File attributes

Modification date: Wed May 14 15:07:15 2014
Lines: 104
Docformat: rst rst
Personal library of Michael Galloy
Contact me if you have enhancement requests or bug fixes.