IDLgrROIGroup Properties

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

ALL

An anonymous structure with the values of all of the properties associated with the state of this object.

CLIP_PLANES

A 4-by-N floating-point array that specifies the coefficients of the clipping planes to be applied to this object. The four coefficients for each clipping plane are of the form [A, B, C, D], where Ax + By + Cz + D = 0. Portions of this object that fall in the half space Ax + By + Cz + D > 0 will be clipped. By default, the value of this property is a scalar (-1) indicating that no clipping planes are to be applied.

COLOR

A color index or a three-element vector [red, green, blue] specifying the color used to drawing the region group. The default color is [0,0,0].

DEPTH_TEST_DISABLE

An integer value that determines whether depth testing is disabled.

Disabling depth testing allows an object to draw itself on top of other objects already on the screen, even if the object is located behind them.

This property is registered as an enumerated list, but it is hidden by default.

DEPTH_TEST_FUNCTION

An integer value that determines the depth test function. Set this property to 0 (the default) to inherit the value set by the parent model or view. The parent view always sets a depth test function of LESS. A model may also set a depth test function value. The graphics device compares the object's depth at a particular pixel location with the depth stored in the depth buffer at that same pixel location. If the comparison test passes, the object's pixel is drawn at that location on the screen and the depth buffer is updated (if depth writing is enabled).

Set this property to any of the following values to use the desired function while rendering this object.

Less means closer to the viewer.

This property is registered as an enumerated list, but it is hidden by default.

DEPTH_WRITE_DISABLE

An integer value that determines whether depth writing is disabled.

Disabling depth writing allows an object to be overdrawn by other objects, even if the object is located in front of them.

This property is registered as an enumerated list, but it is hidden by default.

HIDE

A Boolean value indicating whether this region group should be drawn:

PARENT

An object reference to the object that contains this object.

XCOORD_CONV

A floating-point vector, [s₀, s₁], of scaling factors used to convert X coordinates from data units to normalized units. The formula for the conversion is as follows:

NormalizedX = s₀ + s₁*DataX

Recommended values are:

[(-X_min)/(X_max - X_min), 1.0/(X_max - X_min) ]

IDL converts, maintains, and returns this data as double-precision floating-point.

XRANGE

A two-element floating-point vector of the form [xmin, xmax] that specifies the range of x data coordinates covered by the graphic object. IDL maintains and returns this property in double-precision floating-point.

YCOORD_CONV

A floating-point vector, [s₀, s₁], of scaling factors used to convert Y coordinates from data units to normalized units. The formula for the conversion is as follows:

NormalizedY = s₀ + s₁*DataY

Recommended values are:

[(-Y_min)/(Y_max - Y_min), 1.0/(Y_max - Y_min) ]

IDL converts, maintains, and returns this data as double-precision floating-point.

YRANGE

A two-element floating-point vector of the form [ymin, ymax] that specifies the range of y data coordinates covered by the graphic object. IDL maintains and returns this property in double-precision floating-point.

ZCOORD_CONV

A floating-point vector, [s₀, s₁], of scaling factors used to convert Z coordinates from data units to normalized units. The formula for the conversion is as follows:

NormalizedZ = s₀ + s₁*DataZ

Recommended values are:

[(-Z_min)/(Z_max - Z_min), 1.0/(Z_max - Z_min) ]

IDL converts, maintains, and returns this data as double-precision floating-point.

ZRANGE

A two-element floating-point vector of the form [zmin, zmax] that specifies the range of z data coordinates covered by the graphic object. IDL maintains and returns this property in double-precision floating-point.