IDLgrPattern

A pattern object describes which pixels are filled and which are left blank when an area is filled. Pattern objects are used by setting the FILL_PATTERN property of a polygon object equal to the object reference of the pattern object.

Superclasses

This class has no superclass.

Subclasses

This class has no subclasses.

Creation

See IDLgrPattern::Init

Methods

Intrinsic Methods

This class has this following methods:


IDLgrPattern::Cleanup

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

Calling Sequence

OBJ_DESTROY, Obj

or

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

Arguments

There are no arguments for this method.

Keywords

There are no keywords for this method.


IDLgrPattern::GetProperty

The IDLgrPattern:: GetProperty procedure method retrieves the value of a property or group of properties for the pattern. IDLgrPattern is described above.

Calling Sequence

Obj -> [IDLgrPattern::] GetProperty

Arguments

There are no arguments for this method.

Keywords

Any keyword to IDLgrPattern::Init

ALL

Set this keyword to a named variable that will contain an anonymous structure containing the values of all of the properties associated with the state of this object. State information about the object includes things like color, range, tick direction, etc., but not image, vertex, or connectivity data, or user values.


IDLgrPattern::Init

The IDLgrPattern:: Init function method initializes the pattern object. IDLgrPattern is described above.

Calling Sequence

Obj = OBJ_NEW('IDLgrPattern' [, Style] )

or

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

Arguments

Style

A integer value representing the type of pattern. Valid values are:

Keywords

Properties retrievable via IDLgrPattern::GetProperty

ORIENTATION (Get, Set)

Set this keyword to a scalar representing the angle (measured in degrees counterclockwise from the horizontal) of the lines used in a Line Fill. This keyword is ignored unless the Style argument (or STYLE property) is set to one.

NAME (Get, Set)

Set this keyword equal to a string containing the name associated with this object. The default is the null string, ' '.

PATTERN (Get, Set)

A 32 x 32 bit array (bitmap) describing the pattern that will be tiled over a polygon when a Pattern fill is used. The bitmap must be configured as a 4 x 32 "bitmap byte array" as created by the IDL CVTTOBM function. Each bit that is a 1 is drawn, each bit that is 0 is not drawn. This keyword is ignored unless the Style argument (or STYLE property) is set to two.

SPACING (Get, Set)

Set this keyword equal to a floating-point value representing the distance (measured in pixels) between the lines used for a Line Fill. This keyword is ignored unless the Style argument (or STYLE property) is set to one. The default is 2.0 pixels.

STYLE (Get, Set)

Set this keyword to specify the type of pattern to be used. Valid values are:

This keyword is the same as the Style argument described above.

THICK

Set this keyword to an integer value between 1 and 10, specifying the line thickness to be used to draw the pattern lines used for a Line Fill, in pixels. The default is one pixel. This keyword is ignored unless the Style argument (or STYLE property) is set to one.

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.


IDLgrPattern:SetProperty

The IDLgrPattern:: SetProperty procedure method sets the value of a property or group of properties for the pattern. IDLgrPattern is described above.

Calling Sequence

Obj -> [IDLgrPattern::] SetProperty

Arguments

There are no arguments for this method.

Keywords

Any keyword to IDLgrPattern::Init