Previous IDL Reference Guide: Graphics Object Classes Next

IDLgrScene Properties

IDLgrScene 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 IDLgrScene::GetProperty. Properties with the word "Yes" in the "Init" column of the property table can be set via IDLgrScene::Init. Properties with the word "Yes" in the "Set" column in the property table can be set via IDLgrScene::SetProperty.


Note
For a discussion of the property description tables shown below, see About Object Property Descriptions.

Objects of this class have the following properties.

In addition, objects of this class inherit:

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

COLOR

The color to which the scene should be erased before drawing. The color may be specified as a color lookup table index or a three-element vector [red, green, blue].

In a property sheet, this property appears as a color property.

Property Type
COLOR
Name String
Background color
Get: Yes
Set: Yes
Init: Yes
Registered: Yes

HIDE

A Boolean value or an enumerated list item indicating whether this object should be drawn:

Value
Property Sheet Value
Description
0
True
Draw graphic (the default)
1
False
Do not draw graphic

Property Type
ENUMLIST
Name String
Show
Get: No
Set: No
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.

For IDLgrScene, the available properties (and their iTool data types) are:

 

Property Type
Boolean
Name String
not displayed
Get: No
Set: No
Init: Yes
Registered: No

TRANSPARENT

A Boolean value that determines whether to disable window clearing. If this property is not set, the destination object in use by the scene is automatically erased when the scene is initialized.

Property Type
BOOLEAN
Name String
Transparent
Get: Yes
Set: Yes
Init: No
Registered: Yes

  IDL Online Help (March 06, 2007)