Screenplay Reference

Specific nodes referenced here are:

Tools > Screenplays > Screenplay: See Screenplay.
Tools > Screenplays > Screenplay > Action: See Action.
Tools > Screenplays > Screenplay > Action > Keyframe Sequence: See Keyframe Sequence.
Tools > Screenplays > Screenplay > Action > Keyframe Sequence > Keyframe: See Keyframe.
Tools > Screenplays > Screenplay > Director: See Director.

Screenplay

This node contains all the related action nodes and the Director node for controlling the animation.

Associated View Object: Choose a scene, plot, or layout for the animation. For details about layouts, see Assembling Layout Views.

Action

This node defines when and how long something happens. It contains the keyframe sequences.

Row: Sets the row to which the action block belongs. You can use this property to change the row for multiple action nodes at the same time (using multi-select).
Enabled: Activates and deactivates the Screenplay action. You can temporarily deactivate actions that require time consuming updates so that you are not delayed while you work on other parts of the Screenplay.
Time: Start time (in seconds) within the Screenplay timeline.
Duration: Length of time for the entire action (hence applies to all child keyframe sequences). For a toggle action, this value is zero. If you change this setting to a value other than zero, the action ceases to be a toggle action.

Keyframe Sequence

This node defines what post-processing properties are being animated. It contains keyframes.

Targets

Selects properties of post-processing objects for animation using the object selector. In the view panel of the object selector, the nodes of the objects appear, with the accessible properties as sub-nodes.

Interpolation Mode

Selects the interpolation technique:

Step—the value applied by a keyframe sequence is the value of a keyframe at its local position, until the next keyframe applies. No intermediate values are interpolated between adjacent keyframes.
Linear—the value applied by a keyframe sequence is the linearly interpolated form two adjacent keyframes.
Smooth Step—the value applied by a keyframe sequence is interpolated from two adjacent keyframes using a piece-wise smooth step function.
Spline—the value applied by a keyframe sequence is interpolated from three or more adjacent keyframes using a chordal Catmull-Rom spline, that is, a polynomial function fitted to the keyframe positions and values. Note that the smooth step mode applies implicitly if only two keyframes are provided.

Repeat Factor

Within the time duration of the parent action, repeats the keyframes of this keyframe sequence this number of times. For example, if you set this property to 3, Screenplay repeats the sequence 3 times instead of only once.

Repeat Mode

Repeat: goes through the sequence of keyframes in the same order each time.
Mirror: goes through the sequence of keyframes in reverse order on alternate repeats. For example, for 3 mirrored repeats, the order would be forward, reverse, forward.

Keyframe

Within a keyframe sequence, these nodes define the value of controlled properties at specific positions within the sequence. They contain position and value which can change over the course of the sequence.

These nodes can expose additional properties, or sub-nodes with properties, depending on the objects to which they are linked.

Position: Within the duration of the parent action, defines the relative moment at which the property value held by the keyframe is applied.; The position is shown in the label of the keyframe. By default every sequence has a start keyframe at 0.0 and an end keyframe at 1.0.
Hold: Accepts value between 0 and 1, and causes Screenplay to apply the value for the specific Hold period. You typically use this property in conjunction with the camera view attribute.; The values function as fractions, so if two adjacent keyframes claim adjacent space, Simcenter STAR-CCM+ calculates the available space for each object based on the fraction required by each.

Director

This node controls the animation settings of a Screenplay.

Target Frame Rate (fps): Determines the number of frames seen in the Screenplay editor frame scale.; During preview, this framerate is the maximum number of frames per second that Screenplay attempts to achieve. Actual framerate is reduced when previewing complex scenes or when less computing power is available. Sets the default framerate for an exported video file.
End Duration: Adds time to the last Screenplay action.
Loop: When activated, begins the playback over again.

Screenplay Editor Toolbar Reference

The following table lists the tools that are available, depending on the situation, in the Screenplay editor.


(Zoom In)	When clicked, shows an progressively narrower portion of the animation, with the frame and time scales consisting of smaller increments.
(Zoom Out)	When clicked, shows an progressively wider portion of the animation, with the frame and time scales consisting of larger increments.
(Scale)	Scales the duration of the animation by this factor.
(Play Screenplay Animation)	Plays the animation in the graphics window.
(Pause Screenplay Animation)	Pauses the animation. To continue the animation, click (Play Screenplay Animation).
(Stop and Rewind Screenplay Animation)	Stops the animation and brings the view back to the first frame.
(Record Screenplay Animation)	Records the animation to a video file. Depending on the quality and resolution, this process can take some time.
(Loop)	When activated, repeats the playback continually until you right-click and choose Stop.