CIP C++ documentation for class "pfcScreenTransform"

Class pfcScreenTransform

# include <pfcBase.h> class pfcScreenTransform : public virtual xobject { xdeclare(pfcScreenTransform) ... }; This is a COMPACT class.

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(optional xreal, optional xreal, optional xreal)

Method Summary


`static pfcScreenTransform_ptr`	`Create (optional xreal PanX, optional xreal PanY, optional xreal Zoom)`
	Creates a new ScreenTransform object.

`optional xreal`	`GetPanX ()`
`void`	`SetPanX (optional xreal value)`
	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 xreal`	`GetPanY ()`
`void`	`SetPanY (optional xreal value)`
	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 xreal`	`GetZoom ()`
`void`	`SetZoom (optional xreal value)`
	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

`optional xreal`	`GetPanX`	`()`
`void`	`SetPanX`	`(optional xreal value)`

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.

Manual References:: Windows and Views: Transformations

`optional xreal`	`GetPanY`	`()`
`void`	`SetPanY`	`(optional xreal value)`

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.

Manual References:: Windows and Views: Transformations

`optional xreal`	`GetZoom`	`()`
`void`	`SetZoom`	`(optional xreal value)`

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.

Manual References:: Windows and Views: Transformations

static pfcScreenTransform_ptr Create (optional xreal PanX, optional xreal PanY, optional xreal Zoom)

Creates a new ScreenTransform object.

The pan and zoom values in a ScreenTransform object are applied to a window by using the pfcWindow::GetScreenTransform(pfcScreenTransform_ptr)

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