Inventor Studio Rendered Image <IvStudioRenderedImage>

Synopsis

IvStudioRenderedImage produces renderings using the capabilities provided by Inventor Studio. With IvStudioRenderedImage one can specify geometry and settings for background, lights, and cameras to create a scene for a rendering in Inventor Studio. IvStudioRenderedImage can create still renderings of parts and assemblies quickly and with least effort to visualize the appearance of a design before it is built.

Mixins

IvMisc

IvStudioRenderedImageModifier

Parameters

Name Type Description
antialiasing name Sets the antialiasing level to use when rendering. There are three levels ? NoAntialiasing, LowAntialiasing and HighAntialiasing.
cameraName string Sets the camera to be used for rendering. The camera name should be one of those defined in Inventor Studio. If no camera name is passed then the camera setting equivalent to ?(Current View)? in the Render Image dialog in Inventor Studio is used.
document part Sets the document to render. Default is Parent.
height integer Sets the height of the output image in pixels. The value should be within the range of >=1 and 4096. The default value will be 480.
LightingStyleName string Sets the active lighting style to be used for rendering. If no lighting style name is passed then the lighting style setting equivalent to ?(Current Light)? in the Render Image dialog in Inventor Studio is used.
outputFile string Sets the name of the file to which the rendering will be saved. The name should be a full path with a file extension. The allowed file extensions are (.bmp, .jpg, .jpeg, .png, .gif, .tif, .tiff).
SceneStyleName string Sets the active scene style to be used for rendering. If no scene style name is passed then the scene style setting equivalent to ?(Current Background)? in the Render Image dialog in Inventor Studio is used.
useTrueReflection? boolean Sets whether to use true reflection or not when rendering.
width integer Sets the width of the output image in pixels. The value should be within the range of >=1 and 4096. The default value will be 640.
keepStudioEnvironment? boolean If set false then the active environment switches from Inventor Studio to whatever the active environment was before entering the Inventor Studio Environment. True will keep the Inventor Studio environment as the active environment after rendering.
okToOverwrite? boolean If a file already exists and if this parameter is true then the file will be overwritten.

Example 1

Child Name : studioRenderedImage_1
Child Design : IvStudioRenderedImage
Name Type Supplied
antialiasing name HighAntialiasing
document part Root
height integer 560
LightingStyleName string "Pleasant"
outputFile string "C:\Temp\MyRenderedImage.png"
SceneStyleName string "Galaxy"
useTrueReflection boolean True
width integer 640
keepStudioEnvironment? boolean False
okToOverwrite? boolean True