SoRenderArea

InventorModule

genre	View3D
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	SoViewers
definition	SoViewers.def
see also	SoExaminerViewer, SoView2D
keywords	inventor, viewer, 3D

Purpose

The module SoRenderArea is a simple renderer for Open Inventor scenes.

It offers functionality to record movies and to create snapshots.

Interaction

The following keyboard shortcuts are available (if Enable Key Commands is checked):

• F9 starts and stops a recording

• F10 shows a dialog for converting the recording to a movie (only while recording)

• F11 creates a screenshot

Input Fields

child

name: child, type: SoNode

Output Fields

outputImage

name: outputImage, type: Image

self (hidden)

name: self, type: SoNode

Parameter Fields

Field Index

antialiasing: Bool	File: String	Record Single Frame: Trigger
antialiasingNumPasses: Integer	Grab Framerate: Float	renderCaching: Enum
Append count: Bool	Grab Key Focus: Bool	renderCulling: Enum
autoRedrawWhenRecording: Bool	inputDevicesList: String	Show snapshot: Bool
Background: Color	miSelectedPointingAction: String	Snap Count: Integer
border: Bool	miSelectedPointingActionActive: Bool	Snapshot Format: Enum
boundingBoxCaching: Enum	miSelectedPointingActionProvider: String	Start: Trigger
Cancel: Trigger	Movie Framerate: Float	Status: String
Continue: Trigger	Num Samples: Integer	Stop: Trigger
Create Movie: Trigger	Output Movie File: String	Transparency: Enum
Create Snapshot: Trigger	outputSnapshotFileWritten: String	Update: Trigger
Enable Key Commands: Bool	pickCulling: Enum	Use Sample Buffers: Bool

Visible Fields

Background

name: background, type: Color, default: 0 0 0

Sets the background color.

Transparency

name: transparency, type: Enum, default: BLEND

Defines the type of transparency used in the rendering.

Values:

Title	Name
​Screen Door	​SCREEN_DOOR
​Add	​ADD
​Delayed Add	​DELAYED_ADD
​Sorted Object Add	​SORTED_OBJECT_ADD
​Blend	​BLEND
​Delayed Blend	​DELAYED_BLEND
​Sorted Object Blend	​SORTED_OBJECT_BLEND

Use Sample Buffers

name: useSampleBuffers, type: Bool, default: FALSE

If checked, the usage of sample buffers for multi-sample anti-aliasing (MSAA) is enabled.

Num Samples

name: numSamples, type: Integer, default: 8

Sets the number of sample buffers to use. 0 means the maximum supported number of sample buffers is used.

Grab Key Focus

name: grabKeyFocus, type: Bool, default: TRUE

If checked, the viewer grabs the key focus whenever the mouse cursor is moved over the viewer.

Otherwise, the user has to click onto the viewer to focus it.

Enable Key Commands

name: enableKeyCommands, type: Bool, default: TRUE

If checked, the keys F9, F10, and F11 can be used to create movie recordings and screenshots.

Snapshot Format

name: snapshotFormat, type: Enum, default: SNAPSHOT_RGB

Defines the format for snapshots.

Values:

Title	Name
​Rgb	​SNAPSHOT_RGB
​Grey	​SNAPSHOT_GREY

Start

name: startRecording, type: Trigger

When pressed, the recording of a movie is started.

Stop

name: stopRecording, type: Trigger

When pressed, a recording in process is stopped.

Cancel

name: cancelRecording, type: Trigger

When pressed, a recording in process is stopped and all saved images are being removed.

Record Single Frame

name: singleFrame, type: Trigger

When pressed, the currently rendered image is saved to disk as a part of a movie.

Continue

name: continueRecording, type: Trigger

When pressed, the recording of a movie is paused if running, or resumed if paused.

Create Movie

name: createAvi, type: Trigger

When pressed, a movie of the frames recorded after pressing the Start button is created.

Output Movie File

name: outputAviFile, type: String

Sets the name of the output movie file.

If no filename is given, the movies are automatically created in the screenshot gallery.

Grab Framerate

name: frameRate, type: Float, default: 7

Sets the refresh frame rate of the viewer.

Movie Framerate

name: frameRateAvi, type: Float, default: 15

Sets the frame rate for the target movie.

Status

name: status, type: String, persistent: no

Shows status information.

File

name: outputSnapshotFile, type: String, default: none

Sets the file name for the output snapshot file.

Append count

name: autoIncreaseFile, type: Bool, default: TRUE

If checked, the filenames bear the frame count in their names.

Update

name: updateMLOutput, type: Trigger

When pressed, the output ML image to current viewer image is being updated.

Create Snapshot

name: doSnapshot, type: Trigger

When pressed, a snapshot of the current rendering is saved.

However, better press F11 in a viewer to create a snapshot that is automatically saved to the screenshot gallery.

Show snapshot

name: showSnapshotWithShell, type: Bool, default: FALSE

If checked, a newly created snapshot is opened with the system’s default image viewer.

Snap Count

name: snapCount, type: Integer, default: 0

Sets a counter offset for consecutive snapshot file names.

Hidden Fields

renderCaching

name: renderCaching, type: Enum, default: AUTO

Values:

Title	Name
​On	​ON
​Off	​OFF
​Auto	​AUTO

boundingBoxCaching

name: boundingBoxCaching, type: Enum, default: AUTO

Values:

Title	Name
​On	​ON
​Off	​OFF
​Auto	​AUTO

renderCulling

name: renderCulling, type: Enum, default: AUTO

Values:

Title	Name
​On	​ON
​Off	​OFF
​Auto	​AUTO

pickCulling

name: pickCulling, type: Enum, default: AUTO

Values:

Title	Name
​On	​ON
​Off	​OFF
​Auto	​AUTO

border

name: border, type: Bool, default: FALSE

antialiasing

name: antialiasing, type: Bool, default: FALSE

antialiasingNumPasses

name: antialiasingNumPasses, type: Integer, default: 1

autoRedrawWhenRecording

name: autoRedrawWhenRecording, type: Bool, default: TRUE

outputSnapshotFileWritten

name: outputSnapshotFileWritten, type: String, default: none

inputDevicesList

name: inputDevicesList, type: String

miSelectedPointingAction

name: miSelectedPointingAction, type: String, persistent: no

Shows the name of the pointing action currently selected by the Managed Interaction framework.

If this pointing action is not currently active (see miSelectedPointingActionActive), it is at least used for highlighting and for selecting the cursor shape.

miSelectedPointingActionProvider

name: miSelectedPointingActionProvider, type: String, persistent: no

Shows the name of the interaction provider node that provides the currently selected pointing action (see miSelectedPointingAction).

miSelectedPointingActionActive

name: miSelectedPointingActionActive, type: Bool, persistent: no

Shows whether the currently selected pointing action (see miSelectedPointingAction) is used for clicking or dragging.