Home Search

DriveWorks Pro 23
Create Preview Image

Send Feedback

Create Preview Image

When the Create Preview Image task is running, it will take a preview control and export a jpg or png of the rendered model to a specified target file path.

Properties

Property NameDescription
Preview Control NameName of the 3D Preview control.
Target File PathThe path to save the image to.
Image WidthThe width of the created image in pixels.

This defaults to 800 when the Task is added.

Image HeightThe height of the created image in pixels.

This defaults to 600 when the Task is added.

Camera OrientationThe camera orientation to take the image at. Values in the order: Horizontal Rotation, Vertical Rotation, Zoom Distance, Pan X, Pan Y, Pan Z. E.g "90|45|50|0|2|0".
  • Rotational value units are degrees.
  • Distance and Pan value units are meters.

Horizontal Rotation of the 3D Preview Control and Create Preview Image Task

DriveWorks 3D Documents face forward (positive along the Z axis) by default.

The default orientation of the 3D Preview Box camera is to look at the front of the 3D Document so the horizontal rotation is flipped 180°.

The Create Preview Image task will position a camera in the scene, bypassing the default orientation of the 3D Preview Control's camera, so the horizontal rotation of the Camera Orientation property will require to be flipped 180° to look at the front of the 3D Document.

For example, applying the following value to the Camera Orientation property, will create an image looking at the front of the 3D Document:

"180|0|0|0|0|0"

OverwriteTRUE to make the component overwrite the existing file (if one exists) regardless of a groups overwrite setting. FALSE to keep the existing file.

Using the Task in a Specification Macro

This task has different types of Outputs. For more information about Outputs see Specification Macros Task Node.

Outputs are only available within Specification Macros.

Status Outputs

This task supports Status Outputs. These can be used to perform different actions depending on what the status outcome of the task is. For more information see Status Outputs in the Task Node Outputs section of Specification Macros Task Node.

The status output navigation is as follows:

Success

  • The image was created successfully.

Success with Warnings

  • N/A - should never be fulfilled.

Failed (one of the following occurred)

  • Target File Path incorrect.
  • General failure - Check the specification report for more details.