IDLgrPattern objects have the following properties. Properties with the word “Yes” in the “Get” column of the property table can be retrieved via IDLgrPattern::GetProperty. Properties with the word “Yes” in the “Init” column of the property table can be set via IDLgrPattern::Init. Properties with the word “Yes” in the “Set” column in the property table can be set via IDLgrPattern::SetProperty.
Note: For a discussion of the property description tables shown below, see Modifying Object Property Descriptions.
Objects of this class have the following properties.
ALL
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.
Note: The fields of this structure may change in subsequent releases of IDL.
|
Property Type
|
Structure |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: No |
Init: No |
Registered: No
|
NAME
A string giving the human-readable name of this object.
|
Property Type
|
STRING |
|
Name String
|
Name |
|
Get: Yes |
Set: Yes |
Init:Yes |
Registered: No
|
ORIENTATION
An integer representing the angle (measured in degrees counterclockwise from the horizontal) of the lines used in a Line Fill. This property is ignored unless the Style argument (or STYLE property) is set to one.
|
Property Type
|
Integer |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
PATTERN
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 CVTTOBM function. Each bit that is a 1 is drawn, each bit that is 0 is not drawn. Each bit in this array represents a 1 point by 1 point square area of pixels on the destination device. This property is ignored unless the Style argument (or STYLE property) is set to 2.
|
Property Type
|
Integer array |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
SPACING
A floating-point value representing the distance (measured in points) between the lines used for a Line Fill. This property is ignored unless the Style argument (or STYLE property) is set to 1. The default is 2.0 points.
|
Property Type
|
Floating-point |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
STYLE
An integer value that specifies the type of pattern, as follows:
- 0 = Solid (default)
- 1 = Line Fill
- 2 = Pattern
Specifying this property is the same as specifying the optional Style argument to the IDLgrPattern::Init method.
|
Property Type
|
Integer |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
THICK
A floating-point value between 0.0 and 10.0 that specifies the line thickness to be used to draw the pattern lines for a Line Fill, in points. A thickness of 0 displays a thin hairline on the chosen device. Out-of-range values are quietly clamped to the allowed range. The default is 1.0 points. This property is ignored unless the Style argument or STYLE property is set to 1.
|
Property Type
|
Floating-point |
|
Name String
|
not displayed
|
|
Get: No |
Set: No |
Init: Yes
|
Registered: No
|
UVALUE
A value of any type containing any information you wish.
Note: Object references or pointers contained in the UVALUE property are not automatically cleaned up when the IDLgrPattern object is destroyed.
|
Property Type
|
User Defined |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init:Yes |
Registered: No
|