Category
Rendering
Function
Increases or decreases size of all screen objects (e.g. captions and
colorbars) by specified factor.
Syntax
output, newcamera = ScaleScreen(object, scalefactor,
finalres, currentcamera);
Inputs
| Name
| Type
| Default
| Description
|
| object
| field
| none
| object to scale
|
| scalefactor
| scalar
| 1
| scale factor for screen objects
|
| finalres
| integer
| no default
| final (x) resolution of desired
image
|
| currentcamera
| camera
| no default
| current camera used to view
object
|
Outputs
| Name
| Type
| Description
|
| output
| object
| object with screen objects scaled
as specified
|
| newcamera
| camera
| current camera updated by
specified scale factors
|
Functional Details
The ScaleScreen module is used to scale all the screen objects within
object by a specified amount. It does not
affect the size of any other
objects in the input object. A typical use of
ScaleScreen is when you
have created an image for display using Render, and you wish to
re-render it at a higher resolution for printing, for example. You would
need to use ScaleScreen to increase the pixel size of any screen objects
(such as captions and color bars) in the object before re-rendering. Note
that ScaleScreen is called implicitly when you use the
"Allow Rerendering"
option of the Save/Print Image dialogs of the Image window, so you do
not need to use it. You would only need to use ScaleScreen if you are
doing the re-rendering yourself using Render or Display.
object
| specifies the object containing screen objects to be scaled.
|
scalefactor
| specifies the scale factor you intend to use on re-rendering;
for
example scalefactor
should be set to 2 if you want the re-rendered
image to be twice as large.
|
finalres
| is used as an alternative to
scalefactor,
if, for example, you know that you want your final resolution of your
image to be 1000 pixels. If you specify final_res,
you must also provide the currentcamera input.
|
currentcamera
| is the camera you are currently using to view your
object.
This can be the output of AutoCamera or Camera, or the
camera output of Image.
|
The output output is the object with all screen
objects scaled. If you specify currentcamera, then
the module will, in addition, output newcamera, which
is a new camera for you to use with Render or Display.
Components
All components in the input are propagated to the output. Only
screen objects are modified.
Example Visual Programs
SIMPLE/ScaleScreen.net
See Also
Render,
AutoCamera,
Camera,
Image