CIP JavaScript documentation for class " pfcScreenTransform"

Class pfcScreenTransform

Description

Stores pan and zoom values.

The pan and zoom values are applied to a window by calling the window's ScreenTransformSet() method.

See Also:: pfcScreenTransform.Create()

Property Summary


`/* optional */ number`	`PanX`
	A value between -1.0 and 1.0 that specifies the amount of horizontal panning. -1.0 pans one window width to the left; 1.0 pans one window width to the right. 0 specifies no horizontal panning. This attribute can be `null`, in which case 0 is used.

`/* optional */ number`	`PanY`
	A value between -1.0 and 1.0 that specifies the amount of vertical panning. -1.0 pans up by the height of the window; 1.0 pans down by the height of the window. 0 specifies no vertical panning. This attribute can be `null`, in which case 0 is used.

`/* optional */ number`	`Zoom`
	A value greater than 0 and the less than or equal to the value of the Creo Parametric variable `MAX_ZOOM_SCALE` that specifies the zoom factor. The value 0.1, for example, would zoom out by a factor of 10. This attribute can be `null`, in which case 1 (no zoom) is used.

Method Summary


`static pfcScreenTransform`	`Create ( /* optional / number PanX, / optional / number PanY, / optional */ number Zoom)`
	Creates a new ScreenTransform object.

Property Detail

/* optional */ number PanX

A value between -1.0 and 1.0 that specifies the amount of horizontal panning. -1.0 pans one window width to the left; 1.0 pans one window width to the right. 0 specifies no horizontal panning. This attribute can be null, in which case 0 is used.

/* optional */ number PanY

A value between -1.0 and 1.0 that specifies the amount of vertical panning. -1.0 pans up by the height of the window; 1.0 pans down by the height of the window. 0 specifies no vertical panning. This attribute can be null, in which case 0 is used.

/* optional */ number Zoom

A value greater than 0 and the less than or equal to the value of the Creo Parametric variable MAX_ZOOM_SCALE that specifies the zoom factor. The value 0.1, for example, would zoom out by a factor of 10.

This attribute can be null, in which case 1 (no zoom) is used.

Method Detail

static pfcScreenTransform Create ( /* optional */ number PanX, /* optional */ number PanY, /* optional */ number Zoom)

Creates a new ScreenTransform object.

The pan and zoom values in a ScreenTransform object are applied to a window by using the pfcWindow.ScreenTransform property.

Parameters:

PanX: A value between -1.0 and 1.0 that specifies the amount of horizontal panning. -1.0 pans one window width to the left; 1.0 pans one window width to the right. 0 specifies no horizontal panning. This attribute can be null, in which case 0 is used.
PanY: A value between -1.0 and 1.0 that specifies the amount of vertical panning. -1.0 pans up by the height of the window; 1.0 pans down by the height of the window. 0 specifies no vertical panning. This attribute can be null, in which case 0 is used.
Zoom: A value greater than 0 and the less than or equal to the value of the Creo Parametric variable MAX_ZOOM_SCALE that specifies the zoom factor. The value 0.1, for example, would zoom out by a factor of 10.
This attribute can be null, in which case 1 (no zoom) is used.

Returns:: The new ScreenTransform object