Zoom

ZoomMap scale factor

Description:

This attribute holds the ZoomMap scale factor, by which coordinate values are multiplied. The default value is unity.

Note that the returned value describes the multiplication factor applied to the inputs by the forward transformation of the ZoomMap assuming the ZoomMap has not been inverted. If the ZoomMap has been inverted (e.g. by using astInvert), then the reciprocal of the returned factor will, in effect, be used by the forward transformation of the ZoomMap.

In general, Mapping attributes cannot be changed after the Mapping has been created (the exception to this is the Invert attribute, which can be changed at any time). However, several of the oldest Mapping classes - including the ZoomMap class - were introduced into the AST library before this restriction was enforced. To reduce the chances of breaking existing software, the attributes of such Mappings may still be changed, but only for Mapping instances that have exactly one active reference. In other words, an error will be reported if an attempt is made to set or clear an attribute of a Mapping (other than the Invert attribute) if that Mapping has been cloned. Mappings are cloned when they are incorporated into another object such as a CmpMap or FrameSet, or when the astClone function is used.

Type:
Double precision.

Applicability

ZoomMap
All ZoomMaps have this attribute.

Notes: