IDLgrClipboard

An IDLgrClipboard object will send Object Graphics output to the operating system native clipboard in bitmap format. The format of bitmaps sent to the clipboard is operating system dependent: output is stored as a PICT image on the Macintosh, as a device-independent bitmap under Windows, and as an Encapsulated PostScript (EPS) image under Unix and VMS.

Superclasses

This class has no superclasses.

Subclasses

This class has no subclasses.

Creation

See IDLgrClipboard::Init

Methods

Intrinsic Methods

This class has the following methods:

 

 


IDLgrClipboard::Cleanup

The IDLgrClipboard:: Cleanup procedure method performs all cleanup on the object. IDLgrClipboard is described above.

Calling Sequence

OBJ_DESTROY, Obj

or

Obj -> [IDLgrClipboard::] Cleanup                               ( In a subclass' Cleanup method only .)

Arguments

There are no arguments for this method.

Keywords

There are no keywords for this method.


IDLgrClipboard::Draw

The IDLgrClipboard:: Draw procedure method draws the given picture to this graphics destination. IDLgrClipboard is described above.

Calling Sequence

Obj -> [IDLgrClipboard::] Draw, Picture

Arguments

Picture

The view (an instance of an IDLgrView object), viewgroup (an instance of an IDLgrViewgroup object) or scene (an instance of an IDLgrScene object) to be drawn.

Keywords

There are no keywords for this method.


IDLgrClipboard::GetContiguousPixels

The IDLgrClipboard:: GetContiguousPixels function method returns an array of long integers whose length is equal to the number of colors available in the index color mode (that is, the value of the N_COLORS property).

The returned array marks contiguous pixels with the ranking of the range's size. This means that within the array, the elements in the largest available range are set to zero, the elements in the second-largest range are set to one, etc. Use this range to set an appropriate colormap for use with the SHADE_RANGE property of the IDLgrSurface and IDLgrPolygon object classes.

To get the largest contiguous range, you could use the following IDL command:

result = obj -> GetContiguousPixels()

Range0 = WHERE(result EQ 0)

A contiguous region in the colormap can be increasing or decreasing in values. The following would be considered contiguous:

[0,1,2,3,4]

[4,3,2,1,0]

IDLgrClipboard is described above.

Calling Sequence

Return = Obj -> [IDLgrClipboard::] GetContiguousPixels()

Arguments

There are no arguments for this method.

Keywords

There are no keywords for this method.


IDLgrClipboard::GetProperty

The IDLgrClipboard:: GetProperty procedure method retrieves the value of a property or group of properties for the clipboard buffer. IDLgrClipboard is described above.

Calling Sequence

Obj -> [IDLgrClipboard::] GetProperty

Arguments

There are no arguments for this method.

Keywords

Any keyword to IDLgrClipboard::Init

ALL

Set this keyword to a named variable that will contain an anonymous structure containing the values of all of the retrievable properties associated with this object.

SCREEN_DIMENSIONS

Set this keyword to a named variable that will contain a two-element vector of the form [ width , height ] specifying the maximum allowed dimensions (measured in device units) for the clipboard object.


IDLgrClipboard::GetTextDimensions

The IDLgrClipboard:: GetTextDimensions function method retrieves the dimensions of a text object that will be rendered in the clipboard buffer. The result is a 3-element floating-point vector [ xDim , yDim , zDim ] representing the dimensions of the text object, measured in data units. IDLgrClipboard is described above.

Calling Sequence

Result = Obj -> [IDLgrClipboard::] GetTextDimensions( TextObj )

Arguments

TextObj

The object reference to a text or axis object for which the text dimensions are requested.

Keywords

DESCENT

Set this keyword equal to a named variable that will contain an array of floating-point values (one for each string in the IDLgrText object). The values represent the distance to travel (parallel to the UPDIR vector) from the text baseline to reach the bottom of the lowest descender in the string. All values will be negative numbers, or zero. This keyword is valid only if TextObj is an IDLgrText object.


IDLgrClipboard::Init

The IDLgrClipboard:: Init function method initializes the clipboard object. IDLgrClipboard is described above.

Calling Sequence

Obj = OBJ_NEW('IDLgrClipboard')

or

Result = Obj -> [IDLgrClipboard::] Init( )         ( In a subclass' Init method only .)

Arguments

There are no arguments for this method.

Keywords

Properties retrievable via IDLgrClipboard::GetProperty

COLOR_MODEL (Get)

Set this keyword to the color model to be used for the clipboard buffer:

DIMENSIONS (Get, Set)

Set this keyword to a two-element vector of the form [ width , height ] to specify the dimensions of the clipboard buffer in units specified by the UNITS property. The default is [640,480].

GRAPHICS_TREE (Get, Set)

Set this keyword to an object reference of type IDLgrScene, IDLgrViewgroup, or IDLgrView. If this property is set to a valid object reference, calling the Draw method on the destination object with no arguments will cause the object reference associated with this property to be drawn. If this object is valid and the destination object is destroyed, this object reference will be destroyed as well. By default the GRAPHICS_TREE property is set equal to the null-object.

N_COLORS (Get)

Set this keyword to the number of colors (between 2 and 256) to be used if COLOR_MODEL is set to Color Index.

PALETTE (Get, Set)

Set this keyword to the object reference of a palette object (an instance of the IDLgrPalette object class) to specify the red, green, and blue values that are to be loaded into the clipboard buffer's color lookup table.

QUALITY (Get, Set)

Set this keyword to an integer indicating the rendering quality at which graphics are to be drawn to the clipboard buffer. Valid values are:

RESOLUTION (Get, Set)

Set this keyword to a two-element vector of the form [ xres , yres ] specifying the device resolution in centimeters per pixel. The default value is: [0.0352778, 0.0352778] (72 DPI).

 

UNITS (Get, Set)

Set this keyword to indicate the units of measure for the DIMENSIONS property. Valid values are:

UVALUE (Get, Set)

Set this keyword to a value of any type. You can use this "user value" to contain any information you wish. Remember that if you set the user value equal to a pointer or object reference, you should destroy the pointer or object reference explicitly when destroying the object it is a user value of.


IDLgrClipboard::SetProperty

The IDLgrClipboard::SetProperty procedure method sets the value of a property or group of properties for the clipboard buffer. IDLgrClipboard is described above.

Calling Sequence

Obj -> [IDLgrClipboard::] SetProperty

Arguments

There are no arguments for this method.

Keywords

Any keyword to IDLgrClipboard::Init