.\

cgpixmapwindow__define.pro

Graphics

This is the "object" behind cgPixmap. It is a subclassed cgCmdWindow object and behaves almost identically, except that normally the draw widget at the heart of the window is invisible. That is, it is a pixmap.

Default properties of the object can be controled with cgWindow_SetDefs and cgControl, as with cgWindow. Be sure to delete the pixmap object when you are done with it, by using (for example) cgDelete.

Class description for cgPixmapWindow

Inheritance

cgCmdWindow

Properties

Properties in cgCmdWindow

Method init
Motion_Events init
MULTI get set
WYPos init
IM_RASTER get set
NOEXECUTECOMMANDS get set
_Extra get set init
XOMARGIN get set
Drop_Events init
PS_DECOMPOSED get set
PS_TT_FONT get set
CmdDelay init
PS_CHARSIZE get set
ADJUSTSIZE get set
IM_WIDTH set
IM_DENSITY get set
WMulti init
WXSize init
PS_SCALE_FACTOR get set
WYSize init
Wheel_Events init
COMMANDS get
WID get set
IM_TRANSPARENT get set
IM_OPTIONS get set
AltPS_Keywords init
P1 init
Tracking_Events init
WDestroyObjects init
P2 init
P3 init
P4 init
DIMENSIONS get set
PALETTE get set
OXMargin init
DELAY get set
PS_FONT get set
WXPos init
Background get set init
PDF_PATH get set
OYMargin init
EraseIt get set init
AltPS_Params init
PS_METRIC get set
PS_ENCAPSULATED get set
PDF_UNIX_CONVERT_CMD get set
IM_RESIZE get set
Event_Handler init
Button_Events init
TLB get
Storage get set init
WAspect init
PS_QUIET get set
Keyboard_Events init
YOMARGIN get set
Group_Leader init
UPDATE set
Command init
ReplaceCmd init
WTitle init
PS_DELETE get set

Properties in cgPixmapWindow

Method init
Multi init
_Extra set init
WXSize init
WYSize init
AltPS_Keywords init
P1 init
WDestroyObjects init
P2 init
P3 init
P4 init
OXMargin init
Visible set init
OYMargin init
EraseIt init
AltPS_Params init
WBackground init
Storage init
WAspect init
Group_Leader init
Command init
ReplaceCmd init

Fields

Fields in cgCmdWindow

MSYSVAR ptr_new()
G ptr_new()
CREATEPARENT 0B
DESTROYOBJECTS 0B
R ptr_new()
IM_RASTER 0L
NOEXECUTECOMMANDS 0B
XOMARGIN [0.000000, 0.000000]
CMDS obj_new()
LASTWRITEFILE ''
PS_DECOMPOSED 0L
PS_TT_FONT ''
PS_CHARSIZE 0.000000
ADJUSTSIZE 0B
IM_WIDTH ptr_new()
ZSYSVAR { !AXIS, TITLE: '', TYPE: 0L, STYLE: 0L, TICKS: 0L, TICKLEN: 0.000000, THICK: 0.000000, RANGE: [0.00000000D, 0.00000000D], CRANGE: [0.00000000D, 0.00000000D], S: [0.00000000D, 0.00000000D], MARGIN: [0.000000, 0.000000], OMARGIN: [0.000000, 0.000000], WINDOW: [0.000000, 0.000000], REGION: [0.000000, 0.000000], CHARSIZE: 0.000000, MINOR: 0L, TICKV: dblarr(60), TICKNAME: strarr(60), GRIDSTYLE: 0L, TICKFORMAT: strarr(10), TICKINTERVAL: 0.00000000D, TICKLAYOUT: 0L, TICKUNITS: strarr(10) }
IM_DENSITY 0L
PS_SCALE_FACTOR 0S
WID 0L
IM_TRANSPARENT 0B
XSYSVAR { !AXIS, TITLE: '', TYPE: 0L, STYLE: 0L, TICKS: 0L, TICKLEN: 0.000000, THICK: 0.000000, RANGE: [0.00000000D, 0.00000000D], CRANGE: [0.00000000D, 0.00000000D], S: [0.00000000D, 0.00000000D], MARGIN: [0.000000, 0.000000], OMARGIN: [0.000000, 0.000000], WINDOW: [0.000000, 0.000000], REGION: [0.000000, 0.000000], CHARSIZE: 0.000000, MINOR: 0L, TICKV: dblarr(60), TICKNAME: strarr(60), GRIDSTYLE: 0L, TICKFORMAT: strarr(10), TICKINTERVAL: 0.00000000D, TICKLAYOUT: 0L, TICKUNITS: strarr(10) }
IM_OPTIONS ''
DRAWID 0L
PMULTI [0L, 0L, 0L, 0L, 0L]
YSYSVAR { !AXIS, TITLE: '', TYPE: 0L, STYLE: 0L, TICKS: 0L, TICKLEN: 0.000000, THICK: 0.000000, RANGE: [0.00000000D, 0.00000000D], CRANGE: [0.00000000D, 0.00000000D], S: [0.00000000D, 0.00000000D], MARGIN: [0.000000, 0.000000], OMARGIN: [0.000000, 0.000000], WINDOW: [0.000000, 0.000000], REGION: [0.000000, 0.000000], CHARSIZE: 0.000000, MINOR: 0L, TICKV: dblarr(60), TICKNAME: strarr(60), GRIDSTYLE: 0L, TICKFORMAT: strarr(10), TICKINTERVAL: 0.00000000D, TICKLAYOUT: 0L, TICKUNITS: strarr(10) }
DELAY 0.000000
PS_FONT 0S
BACKGROUND ptr_new()
PSYSVAR { !PLT, BACKGROUND: 0L, CHARSIZE: 0.000000, CHARTHICK: 0.000000, CLIP: lonarr(6), COLOR: 0L, FONT: 0L, LINESTYLE: 0L, MULTI: [0L, 0L, 0L, 0L, 0L], NOCLIP: 0L, NOERASE: 0L, NSUM: 0L, POSITION: [0.000000, 0.000000, 0.000000, 0.000000], PSYM: 0L, REGION: [0.000000, 0.000000, 0.000000, 0.000000], SUBTITLE: '', SYMSIZE: 0.000000, T: dblarr(4, 4), T3D: 0L, THICK: 0.000000, TITLE: '', TICKLEN: 0.000000, CHANNEL: 0L }
PDF_PATH ''
LASTWRITEDIR ''
TITLE ''
ERASEIT 0B
PS_METRIC 0L
PS_ENCAPSULATED 0L
PDF_UNIX_CONVERT_CMD ''
IM_RESIZE 0L
EVENT_HANDLER ''
TLB 0L
STORAGE ptr_new()
WASPECT 0.000000
PS_QUIET 0S
YOMARGIN [0.000000, 0.000000]
B ptr_new()
PS_DELETE 0L

Fields in cgPixmapWindow

VISIBLE 0L

Author information

Author

FANNING SOFTWARE CONSULTING:

  David W. Fanning
  1645 Sheely Drive
  Fort Collins, CO 80526 USA
  Phone: 970-221-0438
  E-mail: david@idlcoyote.com
  Coyote's Guide to IDL Programming: http://www.idlcoyote.com

Copyright

History

Change History:

  Created from cgCmdWindow, 7 February 2012. DWF.
  Problem with the ASPECT keyword, which should have been named WASPECT. 7 Oct 2012. DWF.
  Added WDestroyObjects keyword to destroy objects parameters, if needed. 11 November 2012. DWF.
  Confusion trying to change WBackground keyword to Background. Changed it back. Identical to ASPECT
     problem described above. 18 Jan 2013. DWF.

Routines

result = cgPixmapWindow::INIT( [parent] [, AltPS_Keywords=string] [, AltPS_Params=IntArr(3)], Command=string [, /EraseIt] [, Group_Leader=Group_Leader] [, /Method] [, Multi=intarr(5)] [, OXMargin=float] [, OYMargin=float] [, P1=any] [, P2=any] [, P3=any] [, P4=any] [, /ReplaceCmd] [, Storage=any], Visible=Visible [, WAspect=float] [, WBackground=varies] [, /WDestroyObjects] [, WXSize=integer] [, WYSize=integer] [, _Extra=_Extra]): This method initializes the pixmap object.
cgPixmapWindow::SetProperty [, /VISIBLE] [, _EXTRA=_EXTRA]: This method allows you to set the properties of the object.
cgPixmapWindow__Define [, class]: The definition module for the cgPixmapWindow object

Routine details

top cgPixmapWindow::INIT

result = cgPixmapWindow::INIT( [parent] [, AltPS_Keywords=string] [, AltPS_Params=IntArr(3)], Command=string [, /EraseIt] [, Group_Leader=Group_Leader] [, /Method] [, Multi=intarr(5)] [, OXMargin=float] [, OYMargin=float] [, P1=any] [, P2=any] [, P3=any] [, P4=any] [, /ReplaceCmd] [, Storage=any], Visible=Visible [, WAspect=float] [, WBackground=varies] [, /WDestroyObjects] [, WXSize=integer] [, WYSize=integer] [, _Extra=_Extra])

This method initializes the pixmap object.

Parameters

parent in optional

The parent base widget for this draw widget object. If not defined, the program will create its own top-level base widget.

Keywords

AltPS_Keywords in optional type=string: A structure containing alternative keyword names (as tags) and values for those keywords to be used when the current device is the PostScript device. See http://www.idlcoyote.com/cg_tips/kwexpressions.php and the examples below for details on how to use this keyword.
AltPS_Params in optional type=IntArr(3): A structure containing alternative parameter values to be used when the current device is the PostScript device. Structure names are restricted to the names "P1", "P2", "P3" and "P4"to correspond to the equivalent positional parameter. See http://www.idlcoyote.com/cg_tips/kwexpressions.php and the examples below for details on how to use this keyword.
Command in required type=string: The graphics procedure command to be executed. This parameter must be a string and the the command must be a procedure. Examples are 'Surface', 'Contour', 'Plot', 'cgPlot', cgContour, etc.
EraseIt in optional type=boolean default=0: Set this keyword to cause the window to be erased before graphics commands are drawn. This may need to be set, for example, to display images.
Group_Leader in optional: The identifier of a widget to serve as a group leader for this program. If the group leader is destroyed, this program is also destroyed. Used when calling this program from another widget program.
Method in optional type=boolean default=0: Set this keyword if the command is an object method call rather than a procedure call. If this keyword is set, the first positional parameter, p1, must be present and must be a valid object reference.
Multi in optional type=intarr(5): Set this keyword in exactly the same way you would set the !P.Multi keyword. It will allow you to display multi-plots in the cgWindow graphics window.
OXMargin in optional type=float: A two-element array indicating the left and right X outside margins for the graphical display. Used only when doing multiple plots with WMulti.
OYMargin in optional type=float: A two-element array indicating the bottom and top Y outside margins for the graphical display. Used only when doing multiple plots with WMulti.
P1 in optional type=any: The first positional parameter appropriate for the graphics command.
P2 in optional type=any: The second positional parameter appropriate for the graphics command.
P3 in optional type=any: The third positional parameter appropriate for the graphics command.
P4 in optional type=any: The fourth positional parameter appropriate for the graphics command.
ReplaceCmd in optional type=boolean default=0: Set this keyword to replace a graphics command from an cgWindow. If CmdIndex is undefined, *all* commands in the window are replaced. Use WinID to identify the cgWindow you are interested in. If WinID is undefined, the last cgWindow created is used for the replacement.
Storage in optional type=any: Any user-defined IDL variable will be stored in the object storage location. Defined here for convenience. Same as Storage keyword for the SetProperty method.
Visible
WAspect in optional type=float default=normal: Set this keyword to the aspect ratio you would like the window to have. The aspect ratio is calculated as (ysize/xsize). Must be a float value. If this keyword is set, the window will maintain this aspect ratio, even when it is resized.
WBackground in optional type=varies default=!P.Background: The background color of the window. Specifying a background color automatically sets the WErase keyword.
WDestroyObjects in optional type=boolean default=0: If this keyword is set, and any of the input parameters p1-p4 is an object, the object parameter will be destroyed when the window is destroyed.
WXSize in optional type=integer default=640: The x size in device coordinates of the graphics window.
WYSize in optional type=integer default=512: The y size in device coordinates of the the graphics window.
_Extra in optional: The "extra" keywords for the command that is being added to the window.

top cgPixmapWindow::SetProperty

cgPixmapWindow::SetProperty [, /VISIBLE] [, _EXTRA=_EXTRA]

This method allows you to set the properties of the object. Most properties are passed along to the superclass method.

Keywords

VISIBLE in optional type=boolean: Set this keyword to make the pixmap visible.
_EXTRA in optional: Any keywords appropriate for the SetProperty method of the superclass object.

top cgPixmapWindow__Define

cgPixmapWindow__Define [, class]

The definition module for the cgPixmapWindow object

Parameters

class out optional type=struct: The object class structure definition. Occasionally useful.

File attributes

Modification date:	Fri Mar 27 11:07:35 2015
Lines:	409
Docformat:	rst rst

Coyote Graphics Routines

Date: Fri Mar 27 12:14:20 2015

.\

cgpixmapwindow__define.pro

Class description for cgPixmapWindow

Inheritance

Properties

Properties in cgCmdWindow

Properties in cgPixmapWindow

Fields

Fields in cgCmdWindow

Fields in cgPixmapWindow

Author information

Routines

Routine details

top cgPixmapWindow::INIT

Parameters

Keywords

top cgPixmapWindow::SetProperty

Keywords

top cgPixmapWindow__Define

Parameters

File attributes