API Documentation > Interface Classes > 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:
User Guide References:
Method Summary
Creates a new ScreenTransform object.
void
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.
void
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.
void
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
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.
User Guide References:
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.
User Guide References:
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.
User Guide References:
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
Was this helpful?