IDLgrVRML Properties
IDLgrVRML objects have the following properties in addition to properties inherited from any superclasses. Properties with the word “Yes” in the “Get” column of the property table can be retrieved via IDLgrVRML::GetProperty. Properties with the word “Yes” in the “Init” column of the property table can be set via IDLgrVRML::Init. Properties with the word “Yes” in the “Set” column in the property table can be set via IDLgrVRML::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
- COLOR_MODEL
- DIMENSIONS
- FILENAME
- GRAPHICS_TREE
- N_COLORS
- PALETTE
- QUALITY
- REGISTER_PROPERTIES
- RESOLUTION
- SCREEN_DIMENSIONS
- UNITS
- WORLDINFO
- WORLDTITLE
In addition, objects of this class inherit:
ALL
An anonymous structure containing the values of all of the retrievable properties associated with this object.
|
Property Type |
Structure |
||
|
Name String |
not displayed |
||
|
Get: Yes |
Set: No |
Init: No |
Registered: No |
COLOR_MODEL
An integer value or enumerated list item that determines the color model for the buffer:
|
Value |
Property Sheet Value |
Description |
|
0 |
RGB |
RGB (default) |
|
1 |
Indexed |
Color indexed |
|
Property Type |
ENUMLIST |
||
|
Name String |
Color model |
||
|
Get: Yes |
Set: No |
Init: Yes |
Registered: Yes |
DIMENSIONS
A two-element integer vector of the form [width, height] to specify the dimensions of the window in units specified by the UNITS property. The default is [640,480].
Note: The only use of this property is to support the use of normalized coordinates for the dimensions of the IDLgrView object passed to the IDLgrVRML::Draw method.
|
Property Type |
Integer vector |
||
|
Name String |
not displayed |
||
|
Get: Yes |
Set: Yes |
Init: Yes |
Registered: No |
FILENAME
A string that specifies the name of a file into which the vector data will be saved. The default is idl.wrl.
|
Property Type |
String |
||
|
Name String |
not displayed |
||
|
Get: Yes |
Set: Yes |
Init: Yes |
Registered: No |
GRAPHICS_TREE
An object reference of type 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. .
|
Property Type |
Object reference |
||
|
Name String |
not displayed |
||
|
Get: Yes |
Set: Yes |
Init: Yes |
Registered: No |
N_COLORS
An integer that specifies the number of colors (between 2 and 256) to be used if COLOR_MODEL is set to indexed.
|
Property Type |
Integer |
||
|
Name String |
Number of colors |
||
|
Get: Yes |
Set: No |
Init: Yes |
Registered: Yes |
PALETTE
An object reference to a palette object (an instance of the IDLgrPalette object class) that specifies the red, green, and blue values that are to be loaded into the buffer’s color lookup table.
Note: Objects specified via this property are not automatically cleaned up when the IDLgrVRML object is destroyed.
This property is registered as a user-defined property, but it is hidden by default.
|
Property Type |
USERDEF |
||
|
Name String |
Color palette |
||
|
Get: Yes |
Set: Yes |
Init: Yes |
Registered: Yes |
QUALITY
An integer value or enumerated list item indicating the rendering quality at which graphics are to be drawn to the buffer:
|
Value |
Property Sheet Value |
Description |
|
0 |
Low |
Low quality |
|
1 |
Medium |
Medium quality |
|
2 |
High |
High quality (the default) |
|
Property Type |
ENUMLIST |
||
|
Name String |
Quality |
||
|
Get: Yes |
Set: Yes |
Init: Yes |
Registered: Yes |
REGISTER_PROPERTIES
A Boolean value that determines whether to register properties available for this object. If this property is set, all properties marked in this properties section as “Registered: Yes” will be registered for display in a property sheet. This property is useful mainly when creating iTools. By default, no properties are registered.
|
Property Type |
Boolean |
||
|
Name String |
not displayed |
||
|
Get: No |
Set: No |
Init: Yes |
Registered: No |
RESOLUTION
A two-element floating-point vector of the form [xres, yres] specifying the device resolution in centimeters per pixel.
Note: This property is used for text scaling and partial aspect ratio preservation only. The default value is [0.0352778, 0.0352778] (72 DPI).
This property is registered as a user-defined property, but it is hidden by default.
|
Property Type |
USERDEF |
||
|
Name String |
Resolution |
||
|
Get: Yes |
Set: Yes |
Init: Yes |
Registered: Yes |
SCREEN_DIMENSIONS
A two-element integer vector of the form [width, height] specifying the dimensions of the overall screen dimensions for the screen with which this object associated. The screen dimensions are measured in device units.
|
Property Type |
Integer vector |
||
|
Name String |
not displayed |
||
|
Get: Yes |
Set: No |
Init: No |
Registered: No |
UNITS
An integer that indicates the units of measure for the DIMENSIONS property. Valid values are:
- 0 = Device (the default)
- 1 = Inches
- 2 = Centimeters
- 3 = Normalized (relative to 1600 x 1200)
|
Property Type |
Integer |
||
|
Name String |
not displayed |
||
|
Get: Yes |
Set: Yes |
Init: Yes |
Registered: No |
WORLDINFO
A list of strings for the info field of the VRML WorldInfo node. The default is an empty string, ''.
|
Property Type |
String |
||
|
Name String |
not displayed |
||
|
Get: No |
Set: No |
Init: Yes |
Registered: No |
WORLDTITLE
A string containing the title for the VRML WorldInfo node, TITLE field. The default is 'IDL VRML file'.
|
Property Type |
String |
||
|
Name String |
not displayed |
||
|
Get: No |
Set: No |
Init: Yes |
Registered: No |